Skip to content

Commit 3dcc256

Browse files
Add limitations to README.md.
1 parent 143ca24 commit 3dcc256

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,19 @@ This will destroy your vagrant VM.
133133
## Currently supported environments
134134
Ubuntu (>= 16.04)
135135

136+
## Limitations
137+
138+
`nomad-driver-containerd` [`v0.1`](https://github.com/Roblox/nomad-driver-containerd/releases/tag/v0.1) is **not** production ready.
139+
There are some open items which are currently being worked on.
140+
141+
1) **Logging**: Logging is currently not supported i.e `nomad alloc logs` command won't work out-of-the-box for containers launched using `nomad-driver-containerd`. As a workaround, one can use `containerd` command line tool `ctr` to attach to container `stdout/stderr`. Both the issue and workaround is documented [`here`](https://github.com/Roblox/nomad-driver-containerd/issues/30)
142+
143+
2) **Networking**: Networking is **not in scope** of containerd as described [`here`](https://kubernetes.io/blog/2017/11/containerd-container-runtime-options-kubernetes/). However an external CNI plugin can be used to add networking to the container. We are researching on how to enable networking for our internal use-cases, and would publish (open-source) that work at some point.
144+
145+
3) **Port forwarding**: The ability to map a host port to a container port. This is currently not supported, but could be supported in future.
146+
147+
4) **Consul connect**: When a user launches a job in `nomad`, s/he can add a [`service stanza`](https://www.nomadproject.io/docs/job-specification/service) which will instruct `nomad` to register the service with `consul` for service discovery. This is currently not supported.
148+
136149
## License
137150

138151
Copyright 2020 Roblox Corporation

0 commit comments

Comments
 (0)