Merge pull request #1232 from crazy-max/docs-remove-frontmatter

docs: remove frontmatter section
This commit is contained in:
CrazyMax 2022-07-25 11:25:15 +02:00 committed by GitHub
commit bc19deb5d0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 15 additions and 69 deletions

View File

@ -1,7 +1,4 @@
--- # Defining additional build contexts and linking targets
title: "Defining additional build contexts and linking targets"
keywords: build, buildx, bake, buildkit, hcl
---
In addition to the main `context` key that defines the build context each target In addition to the main `context` key that defines the build context each target
can also define additional named contexts with a map defined with key `contexts`. can also define additional named contexts with a map defined with key `contexts`.

View File

@ -1,7 +1,4 @@
--- # Building from Compose file
title: "Building from Compose file"
keywords: build, buildx, bake, buildkit, compose
---
## Specification ## Specification

View File

@ -1,7 +1,4 @@
--- # Configuring builds
title: "Configuring builds"
keywords: build, buildx, bake, buildkit, hcl, json
---
Bake supports loading build definition from files, but sometimes you need even Bake supports loading build definition from files, but sometimes you need even
more flexibility to configure this definition. more flexibility to configure this definition.

View File

@ -1,7 +1,4 @@
--- # Bake file definition
title: "Bake file definition"
keywords: build, buildx, bake, buildkit, hcl, json, compose
---
`buildx bake` supports HCL, JSON and Compose file format for defining build `buildx bake` supports HCL, JSON and Compose file format for defining build
[groups](#group), [targets](#target) as well as [variables](#variable) and [groups](#group), [targets](#target) as well as [variables](#variable) and

View File

@ -1,7 +1,4 @@
--- # User defined HCL functions
title: "User defined HCL functions"
keywords: build, buildx, bake, buildkit, hcl
---
## Using interpolation to tag an image with the git sha ## Using interpolation to tag an image with the git sha

View File

@ -1,7 +1,4 @@
--- # High-level build options with Bake
title: "High-level build options with Bake"
keywords: build, buildx, bake, buildkit, hcl, json, compose
---
> This command is experimental. > This command is experimental.
> >

View File

@ -1,8 +1,4 @@
--- # CNI networking
title: "CNI networking"
description: "Enhance your builder with CNI networking"
keywords: build, buildx, buildkit, cni, network
---
It can be useful to use a bridge network for your builder if for example you 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 encounter a network port contention during multiple builds. If you're using

View File

@ -1,8 +1,4 @@
--- # Color output controls
title: "Color output controls"
description: "Modifying colors of progress output"
keywords: build, buildx, buildkit
---
Buildx has support for modifying the colors that are used to output information 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 to the terminal. You can set the environment variable `BUILDKIT_COLORS` to

View File

@ -1,8 +1,4 @@
--- # Using a custom network
title: "Using a custom network"
description: "Create and use a custom network for your build"
keywords: build, buildx, buildkit, network
---
[Create a network](https://docs.docker.com/engine/reference/commandline/network_create/) [Create a network](https://docs.docker.com/engine/reference/commandline/network_create/)
named `foonet`: named `foonet`:

View File

@ -1,8 +1,4 @@
--- # Using a custom registry configuration
title: "Using a custom registry configuration"
description: "Set registry configuration in your builder"
keywords: build, buildx, buildkit, registry
---
If you [create a `docker-container` or `kubernetes` builder](https://docs.docker.com/engine/reference/commandline/buildx_create/) and 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), have specified certificates for registries in the [BuildKit daemon configuration](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md),

View File

@ -1,8 +1,4 @@
--- # Kubernetes builder
title: "Kubernetes builder"
description: "Connect buildx to a kubernetes cluster"
keywords: build, buildx, buildkit
---
The buildx kubernetes driver allows connecting your local development or ci The buildx kubernetes driver allows connecting your local development or ci
environments to your kubernetes cluster to allow access to more powerful environments to your kubernetes cluster to allow access to more powerful

View File

@ -1,8 +1,4 @@
--- # OpenTelemetry support
title: "OpenTelemetry support"
description: "OpenTelemetry support for your builder"
keywords: build, buildx, buildkit, opentelemetry, tracing
---
To capture the trace to [Jaeger](https://github.com/jaegertracing/jaeger), set To capture the trace to [Jaeger](https://github.com/jaegertracing/jaeger), set
`JAEGER_TRACE` environment variable to the collection address using a `driver-opt`. `JAEGER_TRACE` environment variable to the collection address using a `driver-opt`.

View File

@ -1,8 +1,4 @@
--- # Registry mirror
title: "Registry mirror"
description: "Using a registry mirror in your build"
keywords: build, buildx, buildkit, registry
---
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) 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). while creating a builder with the [`--config` flags](https://docs.docker.com/engine/reference/commandline/buildx_create/#config).

View File

@ -1,8 +1,4 @@
--- # Remote builder
title: "Remote builder"
description: "Connect buildx to an external buildkitd instance"
keywords: build, buildx, buildkit
---
The buildx remote driver allows for more complex custom build workloads that The buildx remote driver allows for more complex custom build workloads that
allow users to connect to external buildkit instances. This is useful for allow users to connect to external buildkit instances. This is useful for

View File

@ -1,8 +1,4 @@
--- # Resource limiting
title: "Resource limiting"
description: "Max parallelism and limit on TCP connection in your build"
keywords: build, buildx, buildkit, compute, network
---
## Max parallelism ## Max parallelism