go
/
gvisor
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Re-add apt-based installation instructions.

This commit is contained in:
Adin Scannell 2019-11-05 17:55:06 -05:00 committed by Adin Scannell
parent 68e72050df
commit 4e4d55b943
1 changed files with 29 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
content/docs/user_guide/install.md
View File

@ -13,12 +13,21 @@ release channels. You should pick the version you'd like to install. For
experimentation, the nightly release is recommended. For production use, the experimentation, the nightly release is recommended. For production use, the
latest release is recommended. latest release is recommended.
<!--
After selecting an appropriate release channel from the options below, proceed After selecting an appropriate release channel from the options below, proceed
to the preferred installation mechanism: manual or from an `apt` repository. to the preferred installation mechanism: manual or from an `apt` repository.
--> ### HEAD
Binaries are available for every commit on the `master` branch, and are
available at the following URL:
`https://storage.googleapis.com/gvisor/releases/master/latest/runsc`
Checksums for the release binary are at:
`https://storage.googleapis.com/gvisor/releases/master/latest/runsc.sha512`
For `apt` installation, use the `master` as the `${DIST}` below.
### Nightly ### Nightly
@ -37,10 +46,7 @@ Specific nightly releases can be found at:
Note that a release may not be available for every day. Note that a release may not be available for every day.
<!-- For `apt` installation, use the `nightly` as the `${DIST}` below.
To use a nightly release, use one of the above URLs for `URL` in the manual
instructions below. For `apt`, use `nightly` for `DIST` below.
### Latest release ### Latest release
@ -48,8 +54,7 @@ The latest official release is available at the following URL:
`https://storage.googleapis.com/gvisor/releases/release/latest` `https://storage.googleapis.com/gvisor/releases/release/latest`
To use the latest release, use the above URL for `URL` in the manual For `apt` installation, use the `release` as the `${DIST}` below.
instructions below. For `apt`, use `latest` for `DIST` below.
### Specific release ### Specific release
@ -59,11 +64,10 @@ A given release release is available at the following URL:
See the [releases][releases] page for information about specific releases. See the [releases][releases] page for information about specific releases.
For `apt` installation of a specific release, which may include point updates,
use the date of the release, e.g. `${yyyymmdd}`, as the `${DIST}` below.
This will include point updates for the release, if required. To use a specific > Note: only newer releases may be available as `apt` repositories.
release, use the above URL for `URL` in the manual instructions below. For
`apt`, use `${yyyymmdd}` for `DIST` below.
### Point release ### Point release
@ -71,14 +75,9 @@ A given point release is available at the following URL:
`https://storage.googleapis.com/gvisor/releases/release/${yyyymmdd}.${rc}` `https://storage.googleapis.com/gvisor/releases/release/${yyyymmdd}.${rc}`
Note that `apt` installation of a specific point release is not supported.
Unlike the specific release above, which may include updates, this release will ## Install from an `apt` repository
not change. To use a specific point release, use the above URL for `URL` in the
manual instructions below. For apt, use `${yyyymmdd}.${rc}` for `DIST` below.
-->
<!-- Install from an `apt` repository
First, appropriate dependencies must be installed to allow `apt` to install First, appropriate dependencies must be installed to allow `apt` to install
packages via https: packages via https:
@ -102,27 +101,21 @@ curl -fsSL https://gvisor.dev/archive.key | sudo apt-key add -
Based on the release type, you will need to substitute `${DIST}` below, using Based on the release type, you will need to substitute `${DIST}` below, using
one of: one of:
* `nightly`: For all nightly releases. * `master`: For HEAD.
* `latest`: For the latest release. * `nightly`: For nightly releases.
* `${yyyymmdd}`: For specific releases. * `release`: For the latest release.
* `${yyyymmdd}.${rc}`: For a specific point release. * `${yyyymmdd}`: For a specific releases (see above).
The repository for the release you wish to install should be added: The repository for the release you wish to install should be added:
```bash ```bash
sudo add-apt-repository \ sudo add-apt-repository "deb https://storage.googleapis.com/gvisor/releases ${DIST} main"
"deb https://storage.googleapis.com/gvisor/releases" \
"${DIST}" \
main
``` ```
For example, to install the latest official release, you can use: For example, to install the latest official release, you can use:
```bash ```bash
sudo add-apt-repository \ sudo add-apt-repository "deb https://storage.googleapis.com/gvisor/releases release main"
"deb https://storage.googleapis.com/gvisor/releases" \
latest \
main
``` ```
Now the runsc package can be installed: Now the runsc package can be installed:
@ -133,10 +126,11 @@ sudo apt-get update && sudo apt-get install -y runsc
If you have Docker installed, it will be automatically configured. If you have Docker installed, it will be automatically configured.
--> ## Install directly
For example, the latest nightly binary can be downloaded, validated, The binary URLs provided above can be used to install directly. For example, the
and placed in an appropriate location by running: latest nightly binary can be downloaded, validated, and placed in an appropriate
location by running:
```bash ```bash
( (