Skip to content

Commit b89f990

Browse files
fvoznikashentubot
authored andcommitted
Update K8s support
Add pointers to Minikube and gvisor-containerd-shim. PiperOrigin-RevId: 224654334 Change-Id: Icefefbe531e901fe4807ba81904de8b01baf8a15
1 parent 9984138 commit b89f990

File tree

1 file changed

+12
-16
lines changed

1 file changed

+12
-16
lines changed

README.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -191,9 +191,9 @@ chmod a+x runsc
191191
sudo mv runsc /usr/local/bin
192192
```
193193

194-
### Configuring Docker
194+
### Running with Docker
195195

196-
Next, configure Docker to use `runsc` by adding a runtime entry to your Docker
196+
To use gVisor with Docker you must add `runsc` as a runtime to your Docker
197197
configuration (`/etc/docker/daemon.json`). You may have to create this file if
198198
it does not exist. Also, some Docker versions also require you to
199199
[specify the `storage-driver` field][docker-storage-driver].
@@ -229,20 +229,16 @@ Terminal support works too:
229229
docker run --runtime=runsc -it ubuntu /bin/bash
230230
```
231231

232-
### Kubernetes Support (Experimental)
232+
### Running with Kubernetes
233233

234-
gVisor can run sandboxed containers in a Kubernetes cluster with cri-o, although
235-
this is not recommended for production environments yet. Follow
236-
[these instructions][cri-o-k8s] to run [cri-o][cri-o] on a node in a Kubernetes
237-
cluster. Build `runsc` and put it on the node, and set it as the
238-
`runtime_untrusted_workload` in `/etc/crio/crio.conf`.
234+
gVisor can run sandboxed containers in a Kubernetes cluster with Minikube. After
235+
the gVisor addon is enabled, pods with `io.kubernetes.cri.untrusted-workload`
236+
set to true will execute with `runsc`. Follow [these instructions][minikube] to
237+
enable gVisor addon.
239238

240-
Any Pod without the `io.kubernetes.cri-o.TrustedSandbox` annotation (or with the
241-
annotation set to false) will be run with `runsc`.
242-
243-
Currently, gVisor only supports Pods with a single container (not counting the
244-
ever-present pause container). Support for multiple containers within a single
245-
Pod is coming soon.
239+
You can also setup Kubernetes node to use `gvisor-containerd-shim`. Pods with
240+
`io.kubernetes.cri.untrusted-workload` annotation will execute with `runsc`. You
241+
can find instructions [here][gvisor-containerd-shim].
246242

247243
## Advanced Usage
248244

@@ -444,14 +440,14 @@ See [Contributing.md](CONTRIBUTING.md).
444440
[bazel]: https://bazel.build
445441
[bug]: https://github.com/google/gvisor/issues
446442
[checkpoint-restore]: https://gvisor.googlesource.com/gvisor/+/master/g3doc/checkpoint_restore.md
447-
[cri-o-k8s]: https://github.com/kubernetes-incubator/cri-o/blob/master/kubernetes.md
448-
[cri-o]: https://github.com/kubernetes-incubator/cri-o
449443
[docker-storage-driver]: https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-storage-driver
450444
[docker]: https://www.docker.com
451445
[git]: https://git-scm.com
446+
[gvisor-containerd-shim]: https://github.com/google/gvisor-containerd-shim
452447
[gvisor-security-list]: https://groups.google.com/forum/#!forum/gvisor-security
453448
[gvisor-users-list]: https://groups.google.com/forum/#!forum/gvisor-users
454449
[kvm]: https://www.linux-kvm.org
450+
[minikube]: https://github.com/kubernetes/minikube/blob/master/deploy/addons/gvisor/README.md
455451
[netstack]: https://github.com/google/netstack
456452
[oci]: https://www.opencontainers.org
457453
[python]: https://python.org

0 commit comments

Comments
 (0)