summaryrefslogtreecommitdiffhomepage
path: root/content/docs/user_guide
diff options
context:
space:
mode:
authorIan Lewis <ianmlewis@gmail.com>2019-10-18 02:40:54 -0400
committerIan Lewis <ianlewis@google.com>2019-10-24 10:20:30 +0900
commit514f16b290229cc1105cdaf8102fee59b1365aee (patch)
tree856fede0fd091098bdab4996b027ebe8e8179613 /content/docs/user_guide
parent53e921eb38e38867363f2203d2f883dadf3b5a2d (diff)
Fix links on website.
Diffstat (limited to 'content/docs/user_guide')
-rw-r--r--content/docs/user_guide/FAQ.md22
-rw-r--r--content/docs/user_guide/debugging.md2
-rw-r--r--content/docs/user_guide/quick_start/docker.md9
3 files changed, 20 insertions, 13 deletions
diff --git a/content/docs/user_guide/FAQ.md b/content/docs/user_guide/FAQ.md
index 19358e8db..2cee17477 100644
--- a/content/docs/user_guide/FAQ.md
+++ b/content/docs/user_guide/FAQ.md
@@ -25,15 +25,15 @@ Binaries run in gVisor should be built for the
### Can I run Docker images using gVisor.
-Yes. Please see the [Docker Quick Start](/docs/user_guide/docker/).
+Yes. Please see the [Docker Quick Start][docker].
### Can I run Kubernetes pods using gVisor.
-Yes. Please see the [Docker Quick Start](/docs/user_guide/kubernetes/).
+Yes. Please see the [Docker Quick Start][k8s].
### What's the security model?
-See the [Security Model](../../architecture_guide/security/).
+See the [Security Model][security-model].
## Troubleshooting
@@ -41,18 +41,18 @@ See the [Security Model](../../architecture_guide/security/).
If you’re having problems running a container with `runsc` it’s most likely due
to a compatibility issue or a missing feature in gVisor. See
-[Debugging](../debugging/).
+[Debugging][debugging].
### When I run my container, docker fails with: `open /run/containerd/.../<containerid>/log.json: no such file or directory`
You are using an older version of Linux which doesn't support `memfd_create`.
gVisor requires Linux {{< required_linux >}} ([older Linux][old-linux]).
-[comment]: # (TODO[gvisor.dev/issue/268] remove when better error messages are implemented.)
+This is tracked in [bug #268](https://gvisor.dev/issue/268).
### When I run my container, docker fails with: `flag provided but not defined: -console`
-You're using an old version of Docker. See [Docker Quick Start](../docker/).
+You're using an old version of Docker. See [Docker Quick Start][docker].
### I can’t see a file copied with: `docker cp`
@@ -61,9 +61,9 @@ not realize a new file was copied to a given directory. To invalidate the cache
and force a refresh, create a file under the directory in question and list the
contents again.
-As a workaround, shared root filesystem can be enabled. See [Filesystem](../filesystem/).
+As a workaround, shared root filesystem can be enabled. See [Filesystem][filesystem].
-This bug is tracked in [bug #4](https://github.com/google/gvisor/issues/4).
+This bug is tracked in [bug #4](https://gvisor.dev/issue/4).
Note that `kubectl cp` works because it does the copy by exec'ing inside the
sandbox, and thus gVisor's internal cache is made aware of the new files and
@@ -96,6 +96,10 @@ sandbox isolation. There are a few different workarounds you can try:
* Use IPs instead of container names.
* Use [Kubernetes][k8s]. Container name lookup works fine in Kubernetes.
+[security-model]: /docs/architecture_guide/security/
[old-linux]: /docs/user_guide/networking/#gso
[host-net]: /docs/user_guide/networking/#network-passthrough
-[k8s]: /docs/user_guide/kubernetes \ No newline at end of file
+[debugging]: /docs/user_guide/debugging/
+[filesystem]: /docs/user_guide/filesystem/
+[docker]: /docs/user_guide/quick_start/docker/
+[k8s]: /docs/user_guide/quick_start/kubernetes/
diff --git a/content/docs/user_guide/debugging.md b/content/docs/user_guide/debugging.md
index e6f024de6..4d26d557c 100644
--- a/content/docs/user_guide/debugging.md
+++ b/content/docs/user_guide/debugging.md
@@ -4,7 +4,7 @@ weight = 120
+++
To enable debug and system call logging, add the `runtimeArgs` below to your
-[Docker](../docker/) configuration (`/etc/docker/daemon.json`):
+[Docker](../quick_start/docker/) configuration (`/etc/docker/daemon.json`):
```json
{
diff --git a/content/docs/user_guide/quick_start/docker.md b/content/docs/user_guide/quick_start/docker.md
index 523831c1b..f599e3ae1 100644
--- a/content/docs/user_guide/quick_start/docker.md
+++ b/content/docs/user_guide/quick_start/docker.md
@@ -85,9 +85,12 @@ $ docker run --runtime=runsc -it ubuntu dmesg
Note that this is easily replicated by an attacker so applications should never
use `dmesg` to verify the runtime in a security sensitive context.
-Next, look at the different options available for gVisor: [platform](../platforms/),
-[network](../networking/), [filesystem](../filesystem/).
+Next, look at the different options available for gVisor: [platform][platforms],
+[network][networking], [filesystem][filesystem].
[docker]: https://docs.docker.com/install/
-
[storage-driver]: https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-storage-driver
+
+[filesystem]: /docs/user_guide/filesystem/
+[networking]: /docs/user_guide/networking/
+[platforms]: /docs/user_guide/platforms/