From 011455dddf80a0afdfeff5c586121447d6d966f2 Mon Sep 17 00:00:00 2001 From: aevesdocker Date: Thu, 26 Jun 2025 15:55:37 +0100 Subject: [PATCH 1/2] Compose: more freshness --- content/manuals/compose/bridge/_index.md | 6 +++--- content/manuals/compose/bridge/customize.md | 15 ++++++++------- content/manuals/compose/bridge/usage.md | 13 +++++++------ content/manuals/compose/releases/migrate.md | 7 ++++--- .../manuals/compose/support-and-feedback/faq.md | 6 +++--- 5 files changed, 25 insertions(+), 22 deletions(-) diff --git a/content/manuals/compose/bridge/_index.md b/content/manuals/compose/bridge/_index.md index 37bf983320a0..db6b2c50b505 100644 --- a/content/manuals/compose/bridge/_index.md +++ b/content/manuals/compose/bridge/_index.md @@ -1,6 +1,6 @@ --- -description: Understand what Compose Bridge is and how it can be useful -keywords: compose, orchestration, kubernetes, bridge +description: Learn how Compose Bridge transforms Docker Compose files into Kubernetes manifests for seamless platform transitions +keywords: docker compose bridge, compose to kubernetes, docker compose kubernetes integration, docker compose kustomize, compose bridge docker desktop title: Overview of Compose Bridge linkTitle: Compose Bridge weight: 50 @@ -8,7 +8,7 @@ weight: 50 {{< summary-bar feature_name="Compose bridge" >}} -Compose Bridge lets you transform your Compose configuration file into configuration files for different platforms, primarily focusing on Kubernetes. The default transformation generates Kubernetes manifests and a Kustomize overlay which are designed for deployment on Docker Desktop with Kubernetes enabled. +Compose Bridge converts your Docker Compose configuration into platform-specific formats—primarily Kubernetes manifests. The default transformation generates Kubernetes manifests and a Kustomize overlay which are designed for deployment on Docker Desktop with Kubernetes enabled. It's a flexible tool that lets you either take advantage of the [default transformation](usage.md) or [create a custom transformation](customize.md) to suit specific project needs and requirements. diff --git a/content/manuals/compose/bridge/customize.md b/content/manuals/compose/bridge/customize.md index 390710053427..a27983e42a89 100644 --- a/content/manuals/compose/bridge/customize.md +++ b/content/manuals/compose/bridge/customize.md @@ -2,13 +2,14 @@ title: Customize Compose Bridge linkTitle: Customize weight: 20 -description: Learn about the Compose Bridge templates syntax -keywords: compose, bridge, templates +description: Learn how to customize Compose Bridge transformations using Go templates and Compose extensions +keywords: docker compose bridge, customize compose bridge, compose bridge templates, compose to kubernetes, compose bridge transformation, go templates docker + --- {{< summary-bar feature_name="Compose bridge" >}} -This page explains how Compose Bridge utilizes templating to efficiently translate Docker Compose files into Kubernetes manifests. It also explain how you can customize these templates for your specific requirements and needs, or how you can build your own transformation. +This page explains how Compose Bridge utilizes templating to efficiently translate Docker Compose files into Kubernetes manifests. It also explains how you can customize these templates for your specific requirements and needs, or how you can build your own transformation. ## How it works @@ -16,11 +17,11 @@ Compose bridge uses transformations to let you convert a Compose model into anot A transformation is packaged as a Docker image that receives the fully-resolved Compose model as `/in/compose.yaml` and can produce any target format file under `/out`. -Compose Bridge provides its transformation for Kubernetes using Go templates, so that it is easy to extend for customization by just replacing or appending your own templates. +Compose Bridge includes a default Kubernetes transformation using Go templates, which you can customize by replacing or extending templates. ### Syntax -Compose Bridge make use of templates to transform a Compose configuration file into Kubernetes manifests. Templates are plain text files that use the [Go templating syntax](https://pkg.go.dev/text/template). This enables the insertion of logic and data, making the templates dynamic and adaptable according to the Compose model. +Compose Bridge makes use of templates to transform a Compose configuration file into Kubernetes manifests. Templates are plain text files that use the [Go templating syntax](https://pkg.go.dev/text/template). This enables the insertion of logic and data, making the templates dynamic and adaptable according to the Compose model. When a template is executed, it must produce a YAML file which is the standard format for Kubernetes manifests. Multiple files can be generated as long as they are separated by `---` @@ -44,7 +45,7 @@ key: value ### Input -The input Compose model is the canonical YAML model you can get by running `docker compose config`. Within the templates, data from the `compose.yaml` is accessed using dot notation, allowing you to navigate through nested data structures. For example, to access the deployment mode of a service, you would use `service.deploy.mode`: +You can generate the input model by running docker compose config. This canonical YAML output serves as the input for Compose Bridge transformations. Within the templates, data from the `compose.yaml` is accessed using dot notation, allowing you to navigate through nested data structures. For example, to access the deployment mode of a service, you would use `service.deploy.mode`: ```yaml # iterate over a yaml sequence @@ -86,7 +87,7 @@ In the following example, the template checks if a healthcheck interval is speci As Kubernetes is a versatile platform, there are many ways to map Compose concepts into Kubernetes resource definitions. Compose Bridge lets you customize the transformation to match your own infrastructure -decisions and preferences, with various level of flexibility and effort. +decisions and preferences, with varying level of flexibility and effort. ### Modify the default templates diff --git a/content/manuals/compose/bridge/usage.md b/content/manuals/compose/bridge/usage.md index 47c418eff065..d2b6b2f620f3 100644 --- a/content/manuals/compose/bridge/usage.md +++ b/content/manuals/compose/bridge/usage.md @@ -2,13 +2,13 @@ title: Use the default Compose Bridge transformation linkTitle: Usage weight: 10 -description: Learn about and use the Compose Bridge default transformation -keywords: compose, bridge, kubernetes +description: Learn how to use the default Compose Bridge transformation to convert Compose files into Kubernetes manifests +keywords: docker compose bridge, compose kubernetes transform, kubernetes from compose, compose bridge convert, compose.yaml to kubernetes --- {{< summary-bar feature_name="Compose bridge" >}} -Compose Bridge supplies an out-of-the box transformation for your Compose configuration file. Based on an arbitrary `compose.yaml` file, Compose Bridge produces: +Compose Bridge supplies an out-of-the-box transformation for your Compose configuration file. Based on an arbitrary `compose.yaml` file, Compose Bridge produces: - A [Namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) so all your resources are isolated and don't conflict with resources from other deployments. - A [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) with an entry for each and every [config](/reference/compose-file/configs.md) resource in your Compose application. @@ -34,7 +34,8 @@ $ docker compose bridge convert Compose looks for a `compose.yaml` file inside the current directory and then converts it. -The following output is displayed +When successful, Compose Bridge generates Kubernetes manifests and logs output similar to the following: + ```console $ docker compose bridge convert -f compose.yaml Kubernetes resource api-deployment.yaml created @@ -62,7 +63,7 @@ These files are then stored within your project in the `/out` folder. The Kubernetes manifests can then be used to run the application on Kubernetes using the standard deployment command `kubectl apply -k out/overlays/desktop/`. -> [!NOTE] +> [!IMPORTANT] > > Make sure you have enabled Kubernetes in Docker Desktop before you deploy your Compose Bridge transformations. @@ -80,7 +81,7 @@ $ docker compose bridge convert --help > [!TIP] > -> You can now convert and deploy your Compose project to a Kubernetes cluster from the Compose file viewer. +> You can convert and deploy your Compose project to a Kubernetes cluster from the Compose file viewer. > > Make sure you are signed in to your Docker account, navigate to your container in the **Containers** view, and in the top-right corner select **View configurations** and then **Convert and Deploy to Kubernetes**. diff --git a/content/manuals/compose/releases/migrate.md b/content/manuals/compose/releases/migrate.md index 1fc0ef126697..df6305a72ea6 100644 --- a/content/manuals/compose/releases/migrate.md +++ b/content/manuals/compose/releases/migrate.md @@ -1,8 +1,9 @@ --- -title: Migrate to Compose v2 +linkTitle: Migrate to Compose v2 +Title: Migrate from Docker Compose v1 to v2 weight: 20 -description: How to migrate from Compose v1 to v2 -keywords: compose, upgrade, migration, v1, v2, docker compose vs docker-compose +description: Step-by-step guidance to migrate from Compose v1 to v2, including syntax differences, environment handling, and CLI changes +keywords: migrate docker compose, upgrade docker compose v2, docker compose migration, docker compose v1 vs v2, docker compose CLI changes, docker-compose to docker compose aliases: - /compose/compose-v2/ - /compose/cli-command-compatibility/ diff --git a/content/manuals/compose/support-and-feedback/faq.md b/content/manuals/compose/support-and-feedback/faq.md index 52a113bb04fc..106f16af2f3f 100644 --- a/content/manuals/compose/support-and-feedback/faq.md +++ b/content/manuals/compose/support-and-feedback/faq.md @@ -1,7 +1,7 @@ --- -description: Frequently asked questions for Docker Compose -keywords: documentation, docs, docker, compose, faq, docker compose vs docker-compose -title: Compose FAQs +description: Answers to common questions about Docker Compose, including v1 vs v2, commands, shutdown behavior, and development setup. +keywords: docker compose faq, docker compose questions, docker-compose vs docker compose, docker compose json, docker compose stop delay, run multiple docker compose +title: Frequently asked questions about Docker Compose linkTitle: FAQs weight: 10 tags: [FAQ] From 2127df8d11205beae4108702263f19fe8db7a17d Mon Sep 17 00:00:00 2001 From: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Date: Thu, 26 Jun 2025 16:41:32 +0100 Subject: [PATCH 2/2] Update content/manuals/compose/bridge/customize.md --- content/manuals/compose/bridge/customize.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/manuals/compose/bridge/customize.md b/content/manuals/compose/bridge/customize.md index a27983e42a89..36e6100805e7 100644 --- a/content/manuals/compose/bridge/customize.md +++ b/content/manuals/compose/bridge/customize.md @@ -45,7 +45,7 @@ key: value ### Input -You can generate the input model by running docker compose config. This canonical YAML output serves as the input for Compose Bridge transformations. Within the templates, data from the `compose.yaml` is accessed using dot notation, allowing you to navigate through nested data structures. For example, to access the deployment mode of a service, you would use `service.deploy.mode`: +You can generate the input model by running `docker compose config`. This canonical YAML output serves as the input for Compose Bridge transformations. Within the templates, data from the `compose.yaml` is accessed using dot notation, allowing you to navigate through nested data structures. For example, to access the deployment mode of a service, you would use `service.deploy.mode`: ```yaml # iterate over a yaml sequence