diff options
| author | Vincent Ambo <tazjin@google.com> | 2019-07-29T20·03+0100 |
|---|---|---|
| committer | Vincent Ambo <github@tazj.in> | 2019-07-29T20·10+0100 |
| commit | 33d876fda87e98477de487cff3b553941eca30db (patch) | |
| tree | f8ebce1d3d1fc17c0e04222bbdec81fff88afd12 | |
| parent | 93a3985298c31168836a2b3f0585a47889db65ea (diff) | |
docs(README): Update roadmap information
Adds information about Kubernetes integration & custom repository support as well as links to the relevant tracking issues.
| -rw-r--r-- | tools/nixery/README.md | 44 |
1 files changed, 17 insertions, 27 deletions
diff --git a/tools/nixery/README.md b/tools/nixery/README.md index 5a4d766b0314..72185047e6d0 100644 --- a/tools/nixery/README.md +++ b/tools/nixery/README.md @@ -44,35 +44,25 @@ bash-4.4# curl --version curl 7.64.0 (x86_64-pc-linux-gnu) libcurl/7.64.0 OpenSSL/1.0.2q zlib/1.2.11 libssh2/1.8.0 nghttp2/1.35.1 ``` -## Kubernetes integration (in the future) - -**Note**: The Kubernetes integration is not yet implemented. - -The basic idea of the Kubernetes integration is to provide a way for users to -specify the contents of a container image as an API object in Kubernetes which -will be transparently built by Nix when the container is started up. - -For example, given a resource that looks like this: - -```yaml ---- -apiVersion: k8s.nixos.org/v1alpha -kind: NixImage -metadata: - name: curl-and-jq -data: - tag: v1 - contents: - - curl - - jq - - bash -``` +## Roadmap + +### Custom Nix repository support + +One part of the Nixery vision is support for a custom Nix repository that +provides, for example, the internal packages of an organisation. + +It should be possible to configure Nixery to build images from such a repository +and serve them in order to make container images themselves close to invisible +to the user. + +See [issue #3](https://github.com/google/nixery/issues/3). + +### Kubernetes integration (in the future) -One could create a container that references the `curl-and-jq` image, which will -then be created by Nix when the container image is pulled. +It should be trivial to deploy Nixery inside of a Kubernetes cluster with +correct caching behaviour, addressing and so on. -The controller itself runs as a daemonset on every node in the cluster, -providing a host-mounted `/nix/store`-folder for caching purposes. +See [issue #4](https://github.com/google/nixery/issues/4). [Nix]: https://nixos.org/ [gist]: https://gist.github.com/tazjin/08f3d37073b3590aacac424303e6f745 |