-
Notifications
You must be signed in to change notification settings - Fork 8.1k
build: add guides #14905
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
build: add guides #14905
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -125,8 +125,6 @@ guides: | |
| title: Dockerfile best practices | ||
| - path: /develop/develop-images/build_enhancements/ | ||
| title: Build images with BuildKit | ||
| - path: /develop/develop-images/multistage-build/ | ||
| title: Use multi-stage builds | ||
| - path: /develop/develop-images/image_management/ | ||
| title: Manage images | ||
| - path: /develop/develop-images/baseimages/ | ||
|
|
@@ -1396,6 +1394,40 @@ manuals: | |
| title: Working with Buildx | ||
| - path: /build/buildx/install/ | ||
| title: Install Buildx | ||
| - sectiontitle: Bake | ||
| section: | ||
| - path: /build/bake/ | ||
| title: Overview | ||
| - path: /build/bake/file-definition/ | ||
| title: File definition | ||
| - path: /build/bake/configuring-build/ | ||
| title: Configuring builds | ||
| - path: /build/bake/hcl-funcs/ | ||
| title: User defined HCL functions | ||
| - path: /build/bake/build-contexts/ | ||
| title: Build contexts and linking targets | ||
| - path: /build/bake/compose-file/ | ||
| title: Building from Compose file | ||
| - sectiontitle: Guides | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ahh this seems strange to me, but not sure whether there's a better alternative. Having a section in Manuals called Guides, when we have a Guides category 🤔 I feel like it's better to maybe be consistent with the rest of our docs for now, and put it into Guides? Other options:
|
||
| section: | ||
| - path: /build/guides/cni-networking/ | ||
| title: CNI networking | ||
| - path: /build/guides/custom-network/ | ||
| title: Using a custom network | ||
| - path: /build/guides/custom-registry-config/ | ||
| title: Using a custom registry config | ||
| - path: /build/guides/kubernetes-builder/ | ||
| title: Kubernetes builder | ||
| - path: /build/guides/multi-stage-build/ | ||
| title: Multi-stage builds | ||
| - path: /build/guides/opentelemetry/ | ||
| title: OpenTelemetry support | ||
| - path: /build/guides/registry-mirror/ | ||
| title: Define a registry mirror | ||
| - path: /build/guides/remote-builder/ | ||
| title: Remote builder | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We should group this near the kubernetes builder. Maybe we also want to call it |
||
| - path: /build/guides/resource-limiting/ | ||
| title: Resource limiting | ||
|
|
||
| - sectiontitle: Docker Compose | ||
| section: | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -157,25 +157,7 @@ FROM alpine | |
| COPY --from=build /log /log | ||
| ``` | ||
|
|
||
| ## High-level build options | ||
|
|
||
| Buildx also aims to provide support for high-level build concepts that go beyond | ||
| invoking a single build command. | ||
|
|
||
| BuildKit efficiently handles multiple concurrent build requests and de-duplicating | ||
| work. The build commands can be combined with general-purpose command runners | ||
| (for example, `make`). However, these tools generally invoke builds in sequence | ||
| and therefore cannot leverage the full potential of BuildKit parallelization, | ||
| or combine BuildKit’s output for the user. For this use case, we have added a | ||
| command called [`docker buildx bake`](../../engine/reference/commandline/buildx_bake.md). | ||
|
|
||
| The `bake` command supports building images from compose files, similar to | ||
| [`docker-compose build`](../../engine/reference/commandline/compose_build.md), | ||
| but allowing all the services to be built concurrently as part of a single | ||
| request. | ||
|
|
||
| There is also support for custom build rules from HCL/JSON files allowing | ||
| better code reuse and different target groups. The design of bake is in very | ||
| early stages, and we are looking for feedback from users. Let us know your | ||
| feedback by creating an issue in the [Docker Buildx](https://github.com/docker/buildx/issues){:target="_blank" rel="noopener" class="_"} | ||
| GitHub repository. | ||
| ## High-level build options with Bake | ||
|
|
||
| Check out our guide about [Bake](../bake/index.md) to get started with the | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we want to call out that bake is still experimental here as well? |
||
| [`docker buildx bake` command](../../engine/reference/commandline/buildx_bake.md). | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure what we're doing here, is this about removing something from the docs that is some repo? If so, I'm not sure that is the right way forward.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are fetching markdown files from buildx repo in https://github.com/docker/buildx/tree/master/docs/guides (except ci-cd) and add them to
build/guidesfolder here.Will be available in
Manuals > Docker Build > Guides. See https://deploy-preview-14905--docsdocker.netlify.app/build/guides/cni-networking/