summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorIan Lewis <ianmlewis@gmail.com>2019-04-14 18:43:24 -0400
committerIan Lewis <ianlewis@google.com>2019-04-15 13:17:37 -0700
commit0e00a7d2da990ef8bd846c19c9a286539ad819a3 (patch)
treef6c62aba9b68aca0f4ba2eb5610e2604c6a79d1b
parent676d4dc5a31ac9e2edec8cd1ee051f61606c66a7 (diff)
Add some basic questions to the FAQ
- Adds some basic questions and answers to the FAQ about supported CPU architectures and binary formats. - Adds a variable and shortcode for the minimium required Linux version.
-rw-r--r--config.toml3
-rw-r--r--content/docs/includes/install_gvisor.md2
-rw-r--r--content/docs/user_guide/FAQ.md26
-rw-r--r--content/docs/user_guide/docker.md2
-rw-r--r--content/docs/user_guide/oci.md2
-rw-r--r--layouts/shortcodes/required_linux.html1
6 files changed, 34 insertions, 2 deletions
diff --git a/config.toml b/config.toml
index bd47b8367..0539093be 100644
--- a/config.toml
+++ b/config.toml
@@ -137,3 +137,6 @@ no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY
url = "https://groups.google.com/forum/#!forum/gvisor-dev"
icon = "fa fa-envelope"
desc = "Get info on the development of gVisor"
+
+[params.vars]
+required_linux = "3.17+"
diff --git a/content/docs/includes/install_gvisor.md b/content/docs/includes/install_gvisor.md
index a3ca52d2b..f4c7a7d8b 100644
--- a/content/docs/includes/install_gvisor.md
+++ b/content/docs/includes/install_gvisor.md
@@ -1,5 +1,3 @@
-> Note: gVisor supports only x86\_64 and requires Linux 3.17+.
-
The easiest way to get `runsc` is from the [latest nightly
build][latest-nightly]. After you download the binary, check it against the
SHA512 [checksum file][latest-hash].
diff --git a/content/docs/user_guide/FAQ.md b/content/docs/user_guide/FAQ.md
index 5e166ace3..da881f171 100644
--- a/content/docs/user_guide/FAQ.md
+++ b/content/docs/user_guide/FAQ.md
@@ -3,6 +3,32 @@ title = "FAQ"
weight = 1000
+++
+### What operating systems are supported?
+
+gVisor requires Linux {{< required_linux >}}.
+
+### What CPU architectures are supported?
+
+gVisor currently supports [x86_64/AMD64](https://en.wikipedia.org/wiki/X86-64)
+compatible processors.
+
+### Do I need to modify my Linux application to use gVisor?
+
+No. gVisor is capable of running unmodified Linux binaries.
+
+### What binary formats does gVisor support?
+
+gVisor supports Linux
+[ELF](https://en.wikipedia.org/wiki/Executable_and_Linkable_Format) binaries.
+Binaries run in gVisor should be built for the
+[AMD64](https://en.wikipedia.org/wiki/X86-64) CPU architecture.
+
+### Can I run Docker images using gVisor.
+
+Yes. Please see the [Docker Quick Start](/docs/user_guide/docker/).
+
+## Troubleshooting
+
### My container runs fine with `runc` but fails with `runsc`
If you’re having problems running a container with `runsc` it’s most likely due
diff --git a/content/docs/user_guide/docker.md b/content/docs/user_guide/docker.md
index 78c1271b1..4b8f3acb6 100644
--- a/content/docs/user_guide/docker.md
+++ b/content/docs/user_guide/docker.md
@@ -7,6 +7,8 @@ gVisor.
## Install gVisor
+> Note: gVisor supports only x86\_64 and requires Linux {{< required_linux >}}.
+
{{% readfile file="docs/includes/install_gvisor.md" markdown="true" %}}
## Configuring Docker
diff --git a/content/docs/user_guide/oci.md b/content/docs/user_guide/oci.md
index bc605ad44..cfde696e9 100644
--- a/content/docs/user_guide/oci.md
+++ b/content/docs/user_guide/oci.md
@@ -7,6 +7,8 @@ container using the runtime directly with the default platform.
## Install gVisor
+> Note: gVisor supports only x86\_64 and requires Linux {{< required_linux >}}.
+
{{% readfile file="docs/includes/install_gvisor.md" markdown="true" %}}
## Run an OCI compatible container
diff --git a/layouts/shortcodes/required_linux.html b/layouts/shortcodes/required_linux.html
new file mode 100644
index 000000000..af6158606
--- /dev/null
+++ b/layouts/shortcodes/required_linux.html
@@ -0,0 +1 @@
+{{ .Site.Params.vars.required_linux }}