diff options
| author | Bharath Vignesh J K <52282402+RazCrimson@users.noreply.github.com> | 2023-06-24 19:54:24 +0530 |
|---|---|---|
| committer | Bharath Vignesh J K <52282402+RazCrimson@users.noreply.github.com> | 2023-06-24 20:08:48 +0530 |
| commit | 6f71aee5b8c79021e03850474a36f22b66c4ce83 (patch) | |
| tree | 8718d94733c8ce2f4f200c03d75245465e2b4b87 | |
| parent | b4b62e9d329420b9b13ae4aa12357b009a1c021f (diff) | |
chg: docs(docker) - use table for image tag variantsissue2439
| -rw-r--r-- | docs/docker.rst | 45 |
1 files changed, 38 insertions, 7 deletions
diff --git a/docs/docker.rst b/docs/docker.rst index d7e9e2eb..9983dc45 100644 --- a/docs/docker.rst +++ b/docs/docker.rst @@ -9,16 +9,47 @@ Get the Glances container: .. code-block:: console - docker pull nicolargo/glances:<version> + docker pull nicolargo/glances:<version or tag> Available tags (all images are based on both Alpine and Ubuntu Operating System): -- *latest-full* for a full Alpine Glances image (latest release) with all dependencies -- *latest* for a basic Alpine Glances (latest release) version with minimal dependencies (Bottle and Docker) -- *dev* for a basic Alpine Glances image (based on development branch) with all dependencies (Warning: may be instable) -- *ubuntu-latest-full* for a full Ubuntu Glances image (latest release) with all dependencies -- *ubuntu-latest* for a basic Ubuntu Glances (latest release) version with minimal dependencies (Bottle and Docker) -- *ubuntu-dev* for a basic Ubuntu Glances image (based on development branch) with all dependencies (Warning: may be instable) +.. list-table:: + :widths: 25 15 25 35 + :header-rows: 1 + + * - Image Tag + - OS + - Target + - Installed Dependencies + * - `latest-full` + - Alpine + - Latest Release + - Full + * - `latest` + - Alpine + - Latest Release + - Minimal + (Bottle & Docker) + * - `dev` + - Alpine + - develop + - Full + * - `ubuntu-latest-full` + - Ubuntu + - Latest Release + - Full + * - `ubuntu-latest` + - Ubuntu + - Latest Release + - Minimal + (Bottle & Docker) + * - `ubuntu-dev` + - Ubuntu + - develop + - Full + +.. warning:: + Tags containing `dev` target the `develop` branch directly and could be unstable. + +For example, if you want a full Alpine Glances image (latest release) with all dependencies, go for `latest-full`. You can also specify a version (example: 3.4.0). All available versions can be found on `DockerHub`_. |