Skip to content

Commit

Permalink
docs(README): Update roadmap information
Browse files Browse the repository at this point in the history
Adds information about Kubernetes integration & custom repository
support as well as links to the relevant tracking issues.
  • Loading branch information
tazjin authored and Vincent Ambo committed Jul 29, 2019
1 parent 345308e commit 5981f60
Showing 1 changed file with 17 additions and 27 deletions.
44 changes: 17 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5981f60

Please sign in to comment.