From 8f2e88234fdbacc79ab318ce5fb4d9123f629305 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Fri, 26 Jun 2020 13:47:21 +0300 Subject: [PATCH] docs: update the info that docker images are built on top of `alpine` image now A follow-up after the commit ff624c9125c45ba00bc6dec57cc5c784e319262b Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/522 --- README.md | 5 +++-- app/vmagent/README.md | 6 +++--- app/vmauth/README.md | 6 +++--- app/vmbackup/README.md | 6 +++--- app/vmrestore/README.md | 6 +++--- docs/Cluster-VictoriaMetrics.md | 5 +++-- docs/Single-server-VictoriaMetrics.md | 5 +++-- docs/vmagent.md | 6 +++--- docs/vmauth.md | 6 +++--- docs/vmbackup.md | 6 +++--- docs/vmrestore.md | 6 +++--- 11 files changed, 33 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index c77849c62..e453360a8 100644 --- a/README.md +++ b/README.md @@ -583,8 +583,9 @@ Run `make package-victoria-metrics`. It builds `victoriametrics/victoria-metrics `` is auto-generated image tag, which depends on source code in the repository. The `` may be manually set via `PKG_TAG=foobar make package-victoria-metrics`. -By default the image is built on top of `alpine` image for improved debuggability. It is possible to build the package on top of any other base image -by setting it via `` environment variable. For example, the following command builds the image on top of `scratch` image: +By default the image is built on top of [alpine](https://hub.docker.com/_/alpine) image for improved debuggability. +It is possible to build the package on top of any other base image by setting it via `` environment variable. +For example, the following command builds the image on top of [scratch](https://hub.docker.com/_/scratch) image: ```bash ROOT_IMAGE=scratch make package-victoria-metrics diff --git a/app/vmagent/README.md b/app/vmagent/README.md index cf2f1d444..48370d627 100644 --- a/app/vmagent/README.md +++ b/app/vmagent/README.md @@ -244,11 +244,11 @@ Run `make package-vmagent`. It builds `victoriametrics/vmagent:` docker `` is auto-generated image tag, which depends on source code in the repository. The `` may be manually set via `PKG_TAG=foobar make package-vmagent`. -By default the image is built on top of `scratch` image. It is possible to build the package on top of any other base image -by setting it via `` environment variable. For example, the following command builds the image on top of `alpine:3.11` image: +By default the image is built on top of [alpine](https://hub.docker.com/_/alpine) image. It is possible to build the package on top of any other base image +by setting it via `` environment variable. For example, the following command builds the image on top of [scratch](https://hub.docker.com/_/scratch) image: ```bash -ROOT_IMAGE=alpine:3.11 make package-vmagent +ROOT_IMAGE=scratch make package-vmagent ``` diff --git a/app/vmauth/README.md b/app/vmauth/README.md index af7e51214..8d8ec7f96 100644 --- a/app/vmauth/README.md +++ b/app/vmauth/README.md @@ -110,11 +110,11 @@ Run `make package-vmauth`. It builds `victoriametrics/vmauth:` docker i `` is auto-generated image tag, which depends on source code in the repository. The `` may be manually set via `PKG_TAG=foobar make package-vmauth`. -By default the image is built on top of `scratch` image. It is possible to build the package on top of any other base image -by setting it via `` environment variable. For example, the following command builds the image on top of `alpine:3.11` image: +By default the image is built on top of [alpine](https://hub.docker.com/_/alpine) image. It is possible to build the package on top of any other base image +by setting it via `` environment variable. For example, the following command builds the image on top of [scratch](https://hub.docker.com/_/scratch) image: ```bash -ROOT_IMAGE=alpine:3.11 make package-vmauth +ROOT_IMAGE=scratch make package-vmauth ``` diff --git a/app/vmbackup/README.md b/app/vmbackup/README.md index a75820ab8..93c1f9313 100644 --- a/app/vmbackup/README.md +++ b/app/vmbackup/README.md @@ -201,9 +201,9 @@ Run `make package-vmbackup`. It builds `victoriametrics/vmbackup:` dock `` is auto-generated image tag, which depends on source code in the repository. The `` may be manually set via `PKG_TAG=foobar make package-vmbackup`. -By default the image is built on top of `scratch` image. It is possible to build the package on top of any other base image -by setting it via `` environment variable. For example, the following command builds the image on top of `alpine:3.11` image: +By default the image is built on top of [alpine](https://hub.docker.com/_/alpine) image. It is possible to build the package on top of any other base image +by setting it via `` environment variable. For example, the following command builds the image on top of [scratch](https://hub.docker.com/_/scratch) image: ```bash -ROOT_IMAGE=alpine:3.11 make package-vmbackup +ROOT_IMAGE=scratch make package-vmbackup ``` diff --git a/app/vmrestore/README.md b/app/vmrestore/README.md index 10c02dfc7..9cf827083 100644 --- a/app/vmrestore/README.md +++ b/app/vmrestore/README.md @@ -98,9 +98,9 @@ Run `make package-vmrestore`. It builds `victoriametrics/vmrestore:` do `` is auto-generated image tag, which depends on source code in the repository. The `` may be manually set via `PKG_TAG=foobar make package-vmrestore`. -By default the image is built on top of `scratch` image. It is possible to build the package on top of any other base image -by setting it via `` environment variable. For example, the following command builds the image on top of `alpine:3.11` image: +By default the image is built on top of [alpine](https://hub.docker.com/_/alpine) image. It is possible to build the package on top of any other base image +by setting it via `` environment variable. For example, the following command builds the image on top of [scratch](https://hub.docker.com/_/scratch) image: ```bash -ROOT_IMAGE=alpine:3.11 make package-vmrestore +ROOT_IMAGE=scratch make package-vmrestore ``` diff --git a/docs/Cluster-VictoriaMetrics.md b/docs/Cluster-VictoriaMetrics.md index f0e311b9b..9fb4b2e2a 100644 --- a/docs/Cluster-VictoriaMetrics.md +++ b/docs/Cluster-VictoriaMetrics.md @@ -112,8 +112,9 @@ Run `make package`. It will build the following docker images locally: `` is auto-generated image tag, which depends on source code in the repository. The `` may be manually set via `PKG_TAG=foobar make package`. -By default images are built on top of `alpine` image in order to improve debuggability. It is possible to build an image on top of any other base image -by setting it via `` environment variable. For example, the following command builds images on top of `scratch` image: +By default images are built on top of [alpine](https://hub.docker.com/_/scratch) image in order to improve debuggability. +It is possible to build an image on top of any other base image by setting it via `` environment variable. +For example, the following command builds images on top of [scratch](https://hub.docker.com/_/scratch) image: ```bash ROOT_IMAGE=scratch make package diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index c77849c62..e453360a8 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -583,8 +583,9 @@ Run `make package-victoria-metrics`. It builds `victoriametrics/victoria-metrics `` is auto-generated image tag, which depends on source code in the repository. The `` may be manually set via `PKG_TAG=foobar make package-victoria-metrics`. -By default the image is built on top of `alpine` image for improved debuggability. It is possible to build the package on top of any other base image -by setting it via `` environment variable. For example, the following command builds the image on top of `scratch` image: +By default the image is built on top of [alpine](https://hub.docker.com/_/alpine) image for improved debuggability. +It is possible to build the package on top of any other base image by setting it via `` environment variable. +For example, the following command builds the image on top of [scratch](https://hub.docker.com/_/scratch) image: ```bash ROOT_IMAGE=scratch make package-victoria-metrics diff --git a/docs/vmagent.md b/docs/vmagent.md index cf2f1d444..48370d627 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -244,11 +244,11 @@ Run `make package-vmagent`. It builds `victoriametrics/vmagent:` docker `` is auto-generated image tag, which depends on source code in the repository. The `` may be manually set via `PKG_TAG=foobar make package-vmagent`. -By default the image is built on top of `scratch` image. It is possible to build the package on top of any other base image -by setting it via `` environment variable. For example, the following command builds the image on top of `alpine:3.11` image: +By default the image is built on top of [alpine](https://hub.docker.com/_/alpine) image. It is possible to build the package on top of any other base image +by setting it via `` environment variable. For example, the following command builds the image on top of [scratch](https://hub.docker.com/_/scratch) image: ```bash -ROOT_IMAGE=alpine:3.11 make package-vmagent +ROOT_IMAGE=scratch make package-vmagent ``` diff --git a/docs/vmauth.md b/docs/vmauth.md index af7e51214..8d8ec7f96 100644 --- a/docs/vmauth.md +++ b/docs/vmauth.md @@ -110,11 +110,11 @@ Run `make package-vmauth`. It builds `victoriametrics/vmauth:` docker i `` is auto-generated image tag, which depends on source code in the repository. The `` may be manually set via `PKG_TAG=foobar make package-vmauth`. -By default the image is built on top of `scratch` image. It is possible to build the package on top of any other base image -by setting it via `` environment variable. For example, the following command builds the image on top of `alpine:3.11` image: +By default the image is built on top of [alpine](https://hub.docker.com/_/alpine) image. It is possible to build the package on top of any other base image +by setting it via `` environment variable. For example, the following command builds the image on top of [scratch](https://hub.docker.com/_/scratch) image: ```bash -ROOT_IMAGE=alpine:3.11 make package-vmauth +ROOT_IMAGE=scratch make package-vmauth ``` diff --git a/docs/vmbackup.md b/docs/vmbackup.md index a75820ab8..93c1f9313 100644 --- a/docs/vmbackup.md +++ b/docs/vmbackup.md @@ -201,9 +201,9 @@ Run `make package-vmbackup`. It builds `victoriametrics/vmbackup:` dock `` is auto-generated image tag, which depends on source code in the repository. The `` may be manually set via `PKG_TAG=foobar make package-vmbackup`. -By default the image is built on top of `scratch` image. It is possible to build the package on top of any other base image -by setting it via `` environment variable. For example, the following command builds the image on top of `alpine:3.11` image: +By default the image is built on top of [alpine](https://hub.docker.com/_/alpine) image. It is possible to build the package on top of any other base image +by setting it via `` environment variable. For example, the following command builds the image on top of [scratch](https://hub.docker.com/_/scratch) image: ```bash -ROOT_IMAGE=alpine:3.11 make package-vmbackup +ROOT_IMAGE=scratch make package-vmbackup ``` diff --git a/docs/vmrestore.md b/docs/vmrestore.md index 10c02dfc7..9cf827083 100644 --- a/docs/vmrestore.md +++ b/docs/vmrestore.md @@ -98,9 +98,9 @@ Run `make package-vmrestore`. It builds `victoriametrics/vmrestore:` do `` is auto-generated image tag, which depends on source code in the repository. The `` may be manually set via `PKG_TAG=foobar make package-vmrestore`. -By default the image is built on top of `scratch` image. It is possible to build the package on top of any other base image -by setting it via `` environment variable. For example, the following command builds the image on top of `alpine:3.11` image: +By default the image is built on top of [alpine](https://hub.docker.com/_/alpine) image. It is possible to build the package on top of any other base image +by setting it via `` environment variable. For example, the following command builds the image on top of [scratch](https://hub.docker.com/_/scratch) image: ```bash -ROOT_IMAGE=alpine:3.11 make package-vmrestore +ROOT_IMAGE=scratch make package-vmrestore ```