From 1ea71e358a7de85cdbad4a610d5c8767e2d83472 Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Wed, 1 Mar 2023 10:21:02 +0100 Subject: [PATCH] docs: guides moved to docs website Signed-off-by: CrazyMax --- docs/guides/cicd.md | 47 +----------------- docs/guides/cni-networking.md | 22 +-------- docs/guides/color-output.md | 19 +------- docs/guides/custom-network.md | 33 +------------ docs/guides/custom-registry-config.md | 62 +----------------------- docs/guides/opentelemetry.md | 30 +----------- docs/guides/registry-mirror.md | 61 +---------------------- docs/guides/resource-limiting.md | 32 +----------- docs/manuals/README.md | 14 ------ docs/manuals/bake/build-contexts.md | 2 +- docs/manuals/bake/compose-file.md | 2 +- docs/manuals/bake/configuring-build.md | 2 +- docs/manuals/bake/file-definition.md | 2 +- docs/manuals/bake/hcl-funcs.md | 2 +- docs/manuals/bake/index.md | 2 +- docs/manuals/cache/backends/azblob.md | 2 +- docs/manuals/cache/backends/gha.md | 2 +- docs/manuals/cache/backends/index.md | 2 +- docs/manuals/cache/backends/inline.md | 2 +- docs/manuals/cache/backends/local.md | 2 +- docs/manuals/cache/backends/registry.md | 2 +- docs/manuals/cache/backends/s3.md | 2 +- docs/manuals/drivers/docker-container.md | 2 +- docs/manuals/drivers/docker.md | 2 +- docs/manuals/drivers/index.md | 2 +- docs/manuals/drivers/kubernetes.md | 2 +- docs/manuals/drivers/remote.md | 2 +- docs/manuals/exporters/image-registry.md | 2 +- docs/manuals/exporters/index.md | 2 +- docs/manuals/exporters/local-tar.md | 2 +- docs/manuals/exporters/oci-docker.md | 2 +- 31 files changed, 30 insertions(+), 334 deletions(-) delete mode 100644 docs/manuals/README.md diff --git a/docs/guides/cicd.md b/docs/guides/cicd.md index c68aa466..9eaca1e3 100644 --- a/docs/guides/cicd.md +++ b/docs/guides/cicd.md @@ -1,48 +1,3 @@ # CI/CD -## GitHub Actions - -Docker provides a [GitHub Action that will build and push your image](https://github.com/docker/build-push-action/#about) -using Buildx. Here is a simple workflow: - -```yaml -name: ci - -on: - push: - branches: - - 'main' - -jobs: - docker: - runs-on: ubuntu-latest - steps: - - - name: Set up QEMU - uses: docker/setup-qemu-action@v2 - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v2 - - - name: Login to DockerHub - uses: docker/login-action@v2 - with: - username: ${{ secrets.DOCKERHUB_USERNAME }} - password: ${{ secrets.DOCKERHUB_TOKEN }} - - - name: Build and push - uses: docker/build-push-action@v2 - with: - push: true - tags: user/app:latest -``` - -In this example we are also using 3 other actions: - -* [`setup-buildx`](https://github.com/docker/setup-buildx-action) action will create and boot a builder using by -default the `docker-container` [builder driver](https://docs.docker.com/engine/reference/commandline/buildx_create/#driver). -This is **not required but recommended** using it to be able to build multi-platform images, export cache, etc. -* [`setup-qemu`](https://github.com/docker/setup-qemu-action) action can be useful if you want -to add emulation support with QEMU to be able to build against more platforms. -* [`login`](https://github.com/docker/login-action) action will take care to log -in against a Docker registry. +This page has moved to [Docker Docs website](https://docs.docker.com/build/ci/) diff --git a/docs/guides/cni-networking.md b/docs/guides/cni-networking.md index 2af87897..23eb0341 100644 --- a/docs/guides/cni-networking.md +++ b/docs/guides/cni-networking.md @@ -1,23 +1,3 @@ # CNI networking -It can be useful to use a bridge network for your builder if for example you -encounter a network port contention during multiple builds. If you're using -the BuildKit image, CNI is not yet available in it, but you can create -[a custom BuildKit image with CNI support](https://github.com/moby/buildkit/blob/master/docs/cni-networking.md). - -Now build this image: - -```console -$ docker buildx build --tag buildkit-cni:local --load . -``` - -Then [create a `docker-container` builder](https://docs.docker.com/engine/reference/commandline/buildx_create/) that -will use this image: - -```console -$ docker buildx create --use \ - --name mybuilder \ - --driver docker-container \ - --driver-opt "image=buildkit-cni:local" \ - --buildkitd-flags "--oci-worker-net=cni" -``` +This page has moved to [Docker Docs website](https://docs.docker.com/build/buildkit/configure/#cni-networking) diff --git a/docs/guides/color-output.md b/docs/guides/color-output.md index 22a25e08..5dd08048 100644 --- a/docs/guides/color-output.md +++ b/docs/guides/color-output.md @@ -1,20 +1,3 @@ # Color output controls -Buildx has support for modifying the colors that are used to output information -to the terminal. You can set the environment variable `BUILDKIT_COLORS` to -something like `run=123,20,245:error=yellow:cancel=blue:warning=white` to set -the colors that you would like to use: - -![Progress output custom colors](https://user-images.githubusercontent.com/1951866/180584033-24522385-cafd-4a54-a4a2-18f5ce74eb27.png) - -Setting `NO_COLOR` to anything will disable any colorized output as recommended -by [no-color.org](https://no-color.org/): - -![Progress output no color](https://user-images.githubusercontent.com/1951866/180584037-e28f9997-dd4c-49cf-8b26-04864815de19.png) - -> **Note** -> -> Parsing errors will be reported but ignored. This will result in default -> color values being used where needed. - -See also [the list of pre-defined colors](https://github.com/moby/buildkit/blob/master/util/progress/progressui/colors.go). +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/env-vars/#buildkit_colors) diff --git a/docs/guides/custom-network.md b/docs/guides/custom-network.md index c1dd2155..37b044a1 100644 --- a/docs/guides/custom-network.md +++ b/docs/guides/custom-network.md @@ -1,34 +1,3 @@ # Using a custom network -[Create a network](https://docs.docker.com/engine/reference/commandline/network_create/) -named `foonet`: - -```console -$ docker network create foonet -``` - -[Create a `docker-container` builder](https://docs.docker.com/engine/reference/commandline/buildx_create/) -named `mybuilder` that will use this network: - -```console -$ docker buildx create --use \ - --name mybuilder \ - --driver docker-container \ - --driver-opt "network=foonet" -``` - -Boot and [inspect `mybuilder`](https://docs.docker.com/engine/reference/commandline/buildx_inspect/): - -```console -$ docker buildx inspect --bootstrap -``` - -[Inspect the builder container](https://docs.docker.com/engine/reference/commandline/inspect/) -and see what network is being used: - -{% raw %} -```console -$ docker inspect buildx_buildkit_mybuilder0 --format={{.NetworkSettings.Networks}} -map[foonet:0xc00018c0c0] -``` -{% endraw %} +This page has moved to [Docker Docs website](https://docs.docker.com/build/drivers/docker-container/#custom-network) diff --git a/docs/guides/custom-registry-config.md b/docs/guides/custom-registry-config.md index 7aa1381b..c33f188e 100644 --- a/docs/guides/custom-registry-config.md +++ b/docs/guides/custom-registry-config.md @@ -1,63 +1,3 @@ # Using a custom registry configuration -If you [create a `docker-container` or `kubernetes` builder](https://docs.docker.com/engine/reference/commandline/buildx_create/) and -have specified certificates for registries in the [BuildKit daemon configuration](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md), -the files will be copied into the container under `/etc/buildkit/certs` and -configuration will be updated to reflect that. - -Take the following `buildkitd.toml` configuration that will be used for -pushing an image to this registry using self-signed certificates: - -```toml -# /etc/buildkitd.toml -debug = true -[registry."myregistry.com"] - ca=["/etc/certs/myregistry.pem"] - [[registry."myregistry.com".keypair]] - key="/etc/certs/myregistry_key.pem" - cert="/etc/certs/myregistry_cert.pem" -``` - -Here we have configured a self-signed certificate for `myregistry.com` registry. - -Now [create a `docker-container` builder](https://docs.docker.com/engine/reference/commandline/buildx_create/) -that will use this BuildKit configuration: - -```console -$ docker buildx create --use \ - --name mybuilder \ - --driver docker-container \ - --config /etc/buildkitd.toml -``` - -Inspecting the builder container, you can see that buildkitd configuration -has changed: - -```console -$ docker exec -it buildx_buildkit_mybuilder0 cat /etc/buildkit/buildkitd.toml -``` -```toml -debug = true - -[registry] - - [registry."myregistry.com"] - ca = ["/etc/buildkit/certs/myregistry.com/myregistry.pem"] - - [[registry."myregistry.com".keypair]] - cert = "/etc/buildkit/certs/myregistry.com/myregistry_cert.pem" - key = "/etc/buildkit/certs/myregistry.com/myregistry_key.pem" -``` - -And certificates copied inside the container: - -```console -$ docker exec -it buildx_buildkit_mybuilder0 ls /etc/buildkit/certs/myregistry.com/ -myregistry.pem myregistry_cert.pem myregistry_key.pem -``` - -Now you should be able to push to the registry with this builder: - -```console -$ docker buildx build --push --tag myregistry.com/myimage:latest . -``` +This page has moved to [Docker Docs website](https://docs.docker.com/build/buildkit/configure/#setting-registry-certificates) diff --git a/docs/guides/opentelemetry.md b/docs/guides/opentelemetry.md index 191c5986..e51f8cc3 100644 --- a/docs/guides/opentelemetry.md +++ b/docs/guides/opentelemetry.md @@ -1,31 +1,3 @@ # OpenTelemetry support -To capture the trace to [Jaeger](https://github.com/jaegertracing/jaeger), set -`JAEGER_TRACE` environment variable to the collection address using a `driver-opt`. - -First create a Jaeger container: - -```console -$ docker run -d --name jaeger -p "6831:6831/udp" -p "16686:16686" --restart unless-stopped jaegertracing/all-in-one -``` - -Then [create a `docker-container` builder](https://docs.docker.com/engine/reference/commandline/buildx_create/) -that will use the Jaeger instance via the `JAEGER_TRACE` env var: - -```console -$ docker buildx create --use \ - --name mybuilder \ - --driver docker-container \ - --driver-opt "network=host" \ - --driver-opt "env.JAEGER_TRACE=localhost:6831" -``` - -Boot and [inspect `mybuilder`](https://docs.docker.com/engine/reference/commandline/buildx_inspect/): - -```console -$ docker buildx inspect --bootstrap -``` - -Buildx commands should be traced at `http://127.0.0.1:16686/`: - -![OpenTelemetry Buildx Bake](https://user-images.githubusercontent.com/1951866/124468052-ef085400-dd98-11eb-84ab-7ac8e261dd52.png) +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/opentelemetry/) diff --git a/docs/guides/registry-mirror.md b/docs/guides/registry-mirror.md index f22198b6..12355034 100644 --- a/docs/guides/registry-mirror.md +++ b/docs/guides/registry-mirror.md @@ -1,62 +1,3 @@ # Registry mirror -You can define a registry mirror to use for your builds by providing a [BuildKit daemon configuration](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md) -while creating a builder with the [`--config` flags](https://docs.docker.com/engine/reference/commandline/buildx_create/#config). - -```toml -# /etc/buildkitd.toml -debug = true -[registry."docker.io"] - mirrors = ["mirror.gcr.io"] -``` - -> **Note** -> -> `debug = true` has been added to be able to debug requests -> in the BuildKit daemon and see if the mirror is effectively used. - -Then [create a `docker-container` builder](https://docs.docker.com/engine/reference/commandline/buildx_create/) -that will use this BuildKit configuration: - -```console -$ docker buildx create --use \ - --name mybuilder \ - --driver docker-container \ - --config /etc/buildkitd.toml -``` - -Boot and [inspect `mybuilder`](https://docs.docker.com/engine/reference/commandline/buildx_inspect/): - -```console -$ docker buildx inspect --bootstrap -``` - -Build an image: - -```console -$ docker buildx build --load . -f-< **Note** -> -> The markdown files in this directory (excluding this README) are reused -> downstream by the -> [Docker documentation repository](https://github.com/docker/docs). -> -> If you wish to contribute to these docs, be sure to first review the -> [documentation contribution guidelines](https://docs.docker.com/contribute/overview/). -> -> Thank you! diff --git a/docs/manuals/bake/build-contexts.md b/docs/manuals/bake/build-contexts.md index 6155197d..17de164d 100644 --- a/docs/manuals/bake/build-contexts.md +++ b/docs/manuals/bake/build-contexts.md @@ -1,3 +1,3 @@ # Defining additional build contexts and linking targets -Moved to [docs.docker.com](https://docs.docker.com/build/bake/build-contexts) +This page has moved to [Docker Docs website](https://docs.docker.com/build/bake/build-contexts) diff --git a/docs/manuals/bake/compose-file.md b/docs/manuals/bake/compose-file.md index c7031921..5c4339f1 100644 --- a/docs/manuals/bake/compose-file.md +++ b/docs/manuals/bake/compose-file.md @@ -1,3 +1,3 @@ # Building from Compose file -Moved to [docs.docker.com](https://docs.docker.com/build/bake/compose-file) +This page has moved to [Docker Docs website](https://docs.docker.com/build/bake/compose-file) diff --git a/docs/manuals/bake/configuring-build.md b/docs/manuals/bake/configuring-build.md index 68c63937..3d70c942 100644 --- a/docs/manuals/bake/configuring-build.md +++ b/docs/manuals/bake/configuring-build.md @@ -1,3 +1,3 @@ # Configuring builds -Moved to [docs.docker.com](https://docs.docker.com/build/bake/configuring-build) +This page has moved to [Docker Docs website](https://docs.docker.com/build/bake/configuring-build) diff --git a/docs/manuals/bake/file-definition.md b/docs/manuals/bake/file-definition.md index 461a5ce8..6e3b8ae6 100644 --- a/docs/manuals/bake/file-definition.md +++ b/docs/manuals/bake/file-definition.md @@ -1,3 +1,3 @@ # Bake file definition -Moved to [docs.docker.com](https://docs.docker.com/build/bake/file-definition) +This page has moved to [Docker Docs website](https://docs.docker.com/build/bake/file-definition) diff --git a/docs/manuals/bake/hcl-funcs.md b/docs/manuals/bake/hcl-funcs.md index ebc866a4..4fd59e94 100644 --- a/docs/manuals/bake/hcl-funcs.md +++ b/docs/manuals/bake/hcl-funcs.md @@ -1,3 +1,3 @@ # User defined HCL functions -Moved to [docs.docker.com](https://docs.docker.com/build/bake/hcl-funcs) +This page has moved to [Docker Docs website](https://docs.docker.com/build/bake/hcl-funcs) diff --git a/docs/manuals/bake/index.md b/docs/manuals/bake/index.md index 08411051..f431b4ca 100644 --- a/docs/manuals/bake/index.md +++ b/docs/manuals/bake/index.md @@ -1,3 +1,3 @@ # High-level build options with Bake -Moved to [docs.docker.com](https://docs.docker.com/build/bake) +This page has moved to [Docker Docs website](https://docs.docker.com/build/bake) diff --git a/docs/manuals/cache/backends/azblob.md b/docs/manuals/cache/backends/azblob.md index 3acc0d39..cf1453e3 100644 --- a/docs/manuals/cache/backends/azblob.md +++ b/docs/manuals/cache/backends/azblob.md @@ -1,3 +1,3 @@ # Azure Blob Storage cache storage -Moved to [docs.docker.com](https://docs.docker.com/build/building/cache/backends/azblob) +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/cache/backends/azblob) diff --git a/docs/manuals/cache/backends/gha.md b/docs/manuals/cache/backends/gha.md index 5aa34180..63d4e71f 100644 --- a/docs/manuals/cache/backends/gha.md +++ b/docs/manuals/cache/backends/gha.md @@ -1,3 +1,3 @@ # GitHub Actions cache storage -Moved to [docs.docker.com](https://docs.docker.com/build/building/cache/backends/gha) +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/cache/backends/gha) diff --git a/docs/manuals/cache/backends/index.md b/docs/manuals/cache/backends/index.md index c1b0a3cb..780d2b87 100644 --- a/docs/manuals/cache/backends/index.md +++ b/docs/manuals/cache/backends/index.md @@ -1,3 +1,3 @@ # Cache storage backends -Moved to [docs.docker.com](https://docs.docker.com/build/building/cache/backends) +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/cache/backends) diff --git a/docs/manuals/cache/backends/inline.md b/docs/manuals/cache/backends/inline.md index 81223265..c78c7653 100644 --- a/docs/manuals/cache/backends/inline.md +++ b/docs/manuals/cache/backends/inline.md @@ -1,3 +1,3 @@ # Inline cache storage -Moved to [docs.docker.com](https://docs.docker.com/build/building/cache/backends/inline) +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/cache/backends/inline) diff --git a/docs/manuals/cache/backends/local.md b/docs/manuals/cache/backends/local.md index 8d65b30d..b625ac99 100644 --- a/docs/manuals/cache/backends/local.md +++ b/docs/manuals/cache/backends/local.md @@ -1,3 +1,3 @@ # Local cache storage -Moved to [docs.docker.com](https://docs.docker.com/build/building/cache/backends/local) +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/cache/backends/local) diff --git a/docs/manuals/cache/backends/registry.md b/docs/manuals/cache/backends/registry.md index f9151263..70df8388 100644 --- a/docs/manuals/cache/backends/registry.md +++ b/docs/manuals/cache/backends/registry.md @@ -1,3 +1,3 @@ # Registry cache storage -Moved to [docs.docker.com](https://docs.docker.com/build/building/cache/backends/registry) +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/cache/backends/registry) diff --git a/docs/manuals/cache/backends/s3.md b/docs/manuals/cache/backends/s3.md index c759d5a4..da59f1ee 100644 --- a/docs/manuals/cache/backends/s3.md +++ b/docs/manuals/cache/backends/s3.md @@ -1,3 +1,3 @@ # Amazon S3 cache storage -Moved to [docs.docker.com](https://docs.docker.com/build/building/cache/backends/s3) +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/cache/backends/s3) diff --git a/docs/manuals/drivers/docker-container.md b/docs/manuals/drivers/docker-container.md index 047b9c81..ff13cbb6 100644 --- a/docs/manuals/drivers/docker-container.md +++ b/docs/manuals/drivers/docker-container.md @@ -1,3 +1,3 @@ # Docker container driver -Moved to [docs.docker.com](https://docs.docker.com/build/building/drivers/docker-container) +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/drivers/docker-container) diff --git a/docs/manuals/drivers/docker.md b/docs/manuals/drivers/docker.md index 3381f572..f4ede129 100644 --- a/docs/manuals/drivers/docker.md +++ b/docs/manuals/drivers/docker.md @@ -1,3 +1,3 @@ # Docker driver -Moved to [docs.docker.com](https://docs.docker.com/build/building/drivers/docker) +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/drivers/docker) diff --git a/docs/manuals/drivers/index.md b/docs/manuals/drivers/index.md index 16832cd1..97fa0ac1 100644 --- a/docs/manuals/drivers/index.md +++ b/docs/manuals/drivers/index.md @@ -1,3 +1,3 @@ # Buildx drivers overview -Moved to [docs.docker.com](https://docs.docker.com/build/building/drivers) +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/drivers) diff --git a/docs/manuals/drivers/kubernetes.md b/docs/manuals/drivers/kubernetes.md index 516dcbb2..7845fdbf 100644 --- a/docs/manuals/drivers/kubernetes.md +++ b/docs/manuals/drivers/kubernetes.md @@ -1,3 +1,3 @@ # Kubernetes driver -Moved to [docs.docker.com](https://docs.docker.com/build/building/drivers/kubernetes) +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/drivers/kubernetes) diff --git a/docs/manuals/drivers/remote.md b/docs/manuals/drivers/remote.md index c8d4fbad..978b1e0d 100644 --- a/docs/manuals/drivers/remote.md +++ b/docs/manuals/drivers/remote.md @@ -1,3 +1,3 @@ # Remote driver -Moved to [docs.docker.com](https://docs.docker.com/build/building/drivers/remote) +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/drivers/remote) diff --git a/docs/manuals/exporters/image-registry.md b/docs/manuals/exporters/image-registry.md index 8e671fb8..710d1527 100644 --- a/docs/manuals/exporters/image-registry.md +++ b/docs/manuals/exporters/image-registry.md @@ -1,3 +1,3 @@ # Image and registry exporters -Moved to [docs.docker.com](https://docs.docker.com/build/building/exporters/image-registry) +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/exporters/image-registry) diff --git a/docs/manuals/exporters/index.md b/docs/manuals/exporters/index.md index 4ee284ac..db005727 100644 --- a/docs/manuals/exporters/index.md +++ b/docs/manuals/exporters/index.md @@ -1,3 +1,3 @@ # Exporters overview -Moved to [docs.docker.com](https://docs.docker.com/build/building/exporters) +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/exporters) diff --git a/docs/manuals/exporters/local-tar.md b/docs/manuals/exporters/local-tar.md index 6a480eea..009c84ab 100644 --- a/docs/manuals/exporters/local-tar.md +++ b/docs/manuals/exporters/local-tar.md @@ -1,3 +1,3 @@ # Local and tar exporters -Moved to [docs.docker.com](https://docs.docker.com/build/building/exporters/local-tar) +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/exporters/local-tar) diff --git a/docs/manuals/exporters/oci-docker.md b/docs/manuals/exporters/oci-docker.md index ca89f9d4..4582d8de 100644 --- a/docs/manuals/exporters/oci-docker.md +++ b/docs/manuals/exporters/oci-docker.md @@ -1,3 +1,3 @@ # OCI and Docker exporters -Moved to [docs.docker.com](https://docs.docker.com/build/building/exporters/oci-docker) +This page has moved to [Docker Docs website](https://docs.docker.com/build/building/exporters/oci-docker)