mirror of https://github.com/docker/docs.git
Compose: more freshness (#22929)
<!--Delete sections as needed --> ## Description Freshness for Bridge, Support and releases ## Related issues or tickets <!-- Related issues, pull requests, or Jira tickets --> ## Reviews <!-- Notes for reviewers here --> <!-- List applicable reviews (optionally @tag reviewers) --> - [ ] Technical review - [ ] Editorial review - [ ] Product review
This commit is contained in:
Allie Sadler
GitHub
parent
b786ac3c28
commit
6d04fd78ce
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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**.
|
||||
|
||||
|
|
|
|||
|
|
@ -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/
|
||||
|
|
|
|||
|
|
@ -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]
|
||||
|
|
|
|||
Loading…
Reference in New Issue