diff options
Diffstat (limited to 'content/docs/user_guide')
| -rw-r--r-- | content/docs/user_guide/checkpoint_restore.md | 8 | ||||
| -rw-r--r-- | content/docs/user_guide/debugging.md | 8 | ||||
| -rw-r--r-- | content/docs/user_guide/install.md | 15 | ||||
| -rw-r--r-- | content/docs/user_guide/platforms.md | 8 | ||||
| -rw-r--r-- | content/docs/user_guide/quick_start/_index.md | 6 | ||||
| -rw-r--r-- | content/docs/user_guide/quick_start/kubernetes.md | 2 |
6 files changed, 20 insertions, 27 deletions
diff --git a/content/docs/user_guide/checkpoint_restore.md b/content/docs/user_guide/checkpoint_restore.md index bbc08a5f2..fef4c1dfa 100644 --- a/content/docs/user_guide/checkpoint_restore.md +++ b/content/docs/user_guide/checkpoint_restore.md @@ -20,7 +20,7 @@ file will be called `checkpoint.img` and necessary directories will be created if they do not yet exist. > Note: Two checkpoints cannot be saved to the same directory; every image-path -provided must be unique. +> provided must be unique. ```bash runsc checkpoint --image-path=<path> <container id> @@ -31,11 +31,11 @@ continue to run after the checkpoint has been made. (By default, containers stop their processes after committing a checkpoint.) > Note: All top-level runsc flags needed when calling run must be provided to -checkpoint if --leave-running is used. +> checkpoint if --leave-running is used. > Note: --leave-running functions by causing an immediate restore so the -container, although will maintain its given container id, may have a different -process id. +> container, although will maintain its given container id, may have a different +> process id. ```bash runsc checkpoint --image-path=<path> --leave-running <container id> diff --git a/content/docs/user_guide/debugging.md b/content/docs/user_guide/debugging.md index 4d26d557c..49f9638d7 100644 --- a/content/docs/user_guide/debugging.md +++ b/content/docs/user_guide/debugging.md @@ -106,9 +106,9 @@ Then restart docker to refresh the runtime options. While the container is runni execute `runsc debug` to collect profile information and save to a file. Here are the options available: - * **--profile-heap:** Generates heap profile to the speficied file. - * **--profile-cpu:** Enables CPU profiler, waits for `--profile-delay` seconds - and generates CPU profile to the speficied file. +* **--profile-heap:** Generates heap profile to the speficied file. +* **--profile-cpu:** Enables CPU profiler, waits for `--profile-delay` seconds + and generates CPU profile to the speficied file. For example: @@ -120,7 +120,7 @@ sudo runsc --root /var/run/docker/runtime-runsc-prof/moby debug --profile-heap=/ sudo runsc --root /var/run/docker/runtime-runsc-prof/moby debug --profile-cpu=/tmp/cpu.prof --profile-delay=30 63254c6ab3a6989623fa1fb53616951eed31ac605a2637bb9ddba5d8d404b35b ``` -The resulting files can be opened using `go tool pprof` or [pprof]. The examples +The resulting files can be opened using `go tool pprof` or [pprof][]. The examples below create image file (`.svg`) with the heap profile and writes the top functions using CPU to the console: diff --git a/content/docs/user_guide/install.md b/content/docs/user_guide/install.md index a76383b06..f25bc0d73 100644 --- a/content/docs/user_guide/install.md +++ b/content/docs/user_guide/install.md @@ -101,10 +101,10 @@ curl -fsSL https://gvisor.dev/archive.key | sudo apt-key add - Based on the release type, you will need to substitute `${DIST}` below, using one of: - * `master`: For HEAD. - * `nightly`: For nightly releases. - * `release`: For the latest release. - * `${yyyymmdd}`: For a specific releases (see above). +* `master`: For HEAD. +* `nightly`: For nightly releases. +* `release`: For the latest release. +* `${yyyymmdd}`: For a specific releases (see above). The repository for the release you wish to install should be added: @@ -158,12 +158,5 @@ optionally automatically configure Docker: runsc install ``` -[latest-nightly]: https://storage.googleapis.com/gvisor/releases/nightly/latest/runsc - -[latest-hash]: https://storage.googleapis.com/gvisor/releases/nightly/latest/runsc.sha512 - -[oci]: https://www.opencontainers.org - [old-linux]: /docs/user_guide/networking/#gso - [releases]: https://github.com/google/gvisor/releases diff --git a/content/docs/user_guide/platforms.md b/content/docs/user_guide/platforms.md index e15072068..b0b76c0ee 100644 --- a/content/docs/user_guide/platforms.md +++ b/content/docs/user_guide/platforms.md @@ -58,10 +58,10 @@ If you are using a virtual machine you will need to make sure that nested virtualization is configured. Here are links to documents on how to set up nested virtualization in several popular environments: - * Google Cloud: [Enabling Nested Virtualization for VM Instances][nested-gcp] - * Microsoft Azure: [How to enable nested virtualization in an Azure VM][nested-azure] - * VirtualBox: [Nested Virtualization][nested-virtualbox] - * KVM: [Nested Guests][nested-kvm] +* Google Cloud: [Enabling Nested Virtualization for VM Instances][nested-gcp] +* Microsoft Azure: [How to enable nested virtualization in an Azure VM][nested-azure] +* VirtualBox: [Nested Virtualization][nested-virtualbox] +* KVM: [Nested Guests][nested-kvm] ### Configuring Docker diff --git a/content/docs/user_guide/quick_start/_index.md b/content/docs/user_guide/quick_start/_index.md index 770fd8893..3d1524bc8 100644 --- a/content/docs/user_guide/quick_start/_index.md +++ b/content/docs/user_guide/quick_start/_index.md @@ -7,6 +7,6 @@ gVisor can be used with Docker, Kubernetes, or directly using `runsc` with crafted OCI spec for your container. Use the links below to see detailed instructions for each of them: - * [Docker](./docker/): The quickest and easiest way to get started. - * [Kubernetes](./kubernetes/): Isolate Pods in your K8s cluster with gVisor. - * [OCI](./oci/): Expert mode. Customize gVisor for your environment. +* [Docker](./docker/): The quickest and easiest way to get started. +* [Kubernetes](./kubernetes/): Isolate Pods in your K8s cluster with gVisor. +* [OCI](./oci/): Expert mode. Customize gVisor for your environment. diff --git a/content/docs/user_guide/quick_start/kubernetes.md b/content/docs/user_guide/quick_start/kubernetes.md index b3b5e0a55..e21abbc70 100644 --- a/content/docs/user_guide/quick_start/kubernetes.md +++ b/content/docs/user_guide/quick_start/kubernetes.md @@ -36,4 +36,4 @@ WordPress site. You can view the full documentation [here][gke-sandbox-docs]. [gke-sandbox-docs]: https://cloud.google.com/kubernetes-engine/docs/how-to/sandbox-pods [gvisor-containerd-shim]: https://github.com/google/gvisor-containerd-shim [runtimeclass]: https://kubernetes.io/docs/concepts/containers/runtime-class/ -[wordpress-quick]: /docs/tutorials/kubernetes/
\ No newline at end of file +[wordpress-quick]: /docs/tutorials/kubernetes/ |