From a84165ebe52896741695c423df62a8f9cef027b9 Mon Sep 17 00:00:00 2001 From: aevesdocker Date: Fri, 6 Jun 2025 11:25:15 +0100 Subject: [PATCH 1/3] ENGDOCS-2709 --- content/manuals/compose/bridge/_index.md | 4 ++-- .../reference/cli/docker/compose/bridge/_index.md | 13 +++++++++++++ .../reference/cli/docker/compose/bridge/convert.md | 13 +++++++++++++ .../docker/compose/bridge/transformations/_index.md | 13 +++++++++++++ .../docker/compose/bridge/transformations/create.md | 13 +++++++++++++ .../docker/compose/bridge/transformations/list.md | 13 +++++++++++++ 6 files changed, 67 insertions(+), 2 deletions(-) create mode 100644 content/reference/cli/docker/compose/bridge/_index.md create mode 100644 content/reference/cli/docker/compose/bridge/convert.md create mode 100644 content/reference/cli/docker/compose/bridge/transformations/_index.md create mode 100644 content/reference/cli/docker/compose/bridge/transformations/create.md create mode 100644 content/reference/cli/docker/compose/bridge/transformations/list.md diff --git a/content/manuals/compose/bridge/_index.md b/content/manuals/compose/bridge/_index.md index b84dcb8dba60..3ec8d2a6d796 100644 --- a/content/manuals/compose/bridge/_index.md +++ b/content/manuals/compose/bridge/_index.md @@ -30,8 +30,8 @@ To get started with Compose Bridge, you need to: 1. Download and install Docker Desktop version 4.33 and later. 2. Sign in to your Docker account. -3. Navigate to the **Features in development** tab in **Settings**. -4. From the **Experimental features** tab, select **Enable Compose Bridge**. +3. Navigate to the **Beta features** tab in **Settings**. +4. Select **Enable Compose Bridge**. 5. Select **Apply & restart**. ## Feedback diff --git a/content/reference/cli/docker/compose/bridge/_index.md b/content/reference/cli/docker/compose/bridge/_index.md new file mode 100644 index 000000000000..a076d5f7d302 --- /dev/null +++ b/content/reference/cli/docker/compose/bridge/_index.md @@ -0,0 +1,13 @@ +--- +datafolder: compose-cli +datafile: docker_compose_bridge +title: docker compose bridge +layout: cli +--- + + \ No newline at end of file diff --git a/content/reference/cli/docker/compose/bridge/convert.md b/content/reference/cli/docker/compose/bridge/convert.md new file mode 100644 index 000000000000..c8310f0c0d70 --- /dev/null +++ b/content/reference/cli/docker/compose/bridge/convert.md @@ -0,0 +1,13 @@ +--- +datafolder: compose-cli +datafile: docker_compose_bridge_convert +title: docker compose bridge convert +layout: cli +--- + + \ No newline at end of file diff --git a/content/reference/cli/docker/compose/bridge/transformations/_index.md b/content/reference/cli/docker/compose/bridge/transformations/_index.md new file mode 100644 index 000000000000..d7e61d411c9d --- /dev/null +++ b/content/reference/cli/docker/compose/bridge/transformations/_index.md @@ -0,0 +1,13 @@ +--- +datafolder: compose-cli +datafile: docker_compose_bridge_transformations +title: docker compose bridge transformations +layout: cli +--- + + \ No newline at end of file diff --git a/content/reference/cli/docker/compose/bridge/transformations/create.md b/content/reference/cli/docker/compose/bridge/transformations/create.md new file mode 100644 index 000000000000..efc0801f27ed --- /dev/null +++ b/content/reference/cli/docker/compose/bridge/transformations/create.md @@ -0,0 +1,13 @@ +--- +datafolder: compose-cli +datafile: docker_compose_bridge_transformations_create +title: docker compose bridge transformations create +layout: cli +--- + + \ No newline at end of file diff --git a/content/reference/cli/docker/compose/bridge/transformations/list.md b/content/reference/cli/docker/compose/bridge/transformations/list.md new file mode 100644 index 000000000000..5af7198a69a7 --- /dev/null +++ b/content/reference/cli/docker/compose/bridge/transformations/list.md @@ -0,0 +1,13 @@ +--- +datafolder: compose-cli +datafile: docker_compose_bridge_transformations_list +title: docker compose bridge transformations list +layout: cli +--- + + \ No newline at end of file From 972b8a77c460e08bfb88ce9e4cc1d60d04c5fb45 Mon Sep 17 00:00:00 2001 From: aevesdocker Date: Fri, 6 Jun 2025 15:30:06 +0100 Subject: [PATCH 2/3] edits --- content/manuals/compose/bridge/advanced-integration.md | 6 +++--- content/manuals/compose/bridge/customize.md | 4 ++-- content/manuals/compose/bridge/usage.md | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/content/manuals/compose/bridge/advanced-integration.md b/content/manuals/compose/bridge/advanced-integration.md index db9e71837542..9de05ceaa05e 100644 --- a/content/manuals/compose/bridge/advanced-integration.md +++ b/content/manuals/compose/bridge/advanced-integration.md @@ -10,7 +10,7 @@ keywords: kubernetes, compose, compose bridge, plugin, advanced Compose Bridge can also function as a `kubectl` plugin, allowing you to integrate its capabilities directly into your Kubernetes command-line operations. This integration simplifies the process of converting and deploying applications from Docker Compose to Kubernetes. -## Use `compose-bridge` as a `kubectl` plugin +## Use `docker compose bridge` as a `kubectl` plugin To use the `compose-bridge` binary as a `kubectl` plugin, you need to make sure that the binary is available in your PATH and the name of the binary is prefixed with `kubectl-`. @@ -37,7 +37,7 @@ To use the `compose-bridge` binary as a `kubectl` plugin, you need to make sure 4. Now you can use `compose-bridge` as a `kubectl` plugin: ```console - $ kubectl compose-bridge [command] + $ kubectl docker compose bridge [command] ``` -Replace `[command]` with any `compose-bridge` command you want to use. +Replace `[command]` with any `docker compose bridge` command you want to use. diff --git a/content/manuals/compose/bridge/customize.md b/content/manuals/compose/bridge/customize.md index d978ecf6b9fa..cb1c6e2541f0 100644 --- a/content/manuals/compose/bridge/customize.md +++ b/content/manuals/compose/bridge/customize.md @@ -91,7 +91,7 @@ decisions and preferences, with various level of flexibility and effort. ### Modify the default templates You can extract templates used by the default transformation `docker/compose-bridge-kubernetes`, -by running `compose-bridge transformations create --from docker/compose-bridge-kubernetes my-template` +by running `docker compose bridge transformations create --from docker/compose-bridge-kubernetes my-template` and adjusting the templates to match your needs. The templates are extracted into a directory named after your template name, in this case `my-template`. @@ -106,7 +106,7 @@ $ docker build --tag mycompany/transform --push . You can then use your transformation as a replacement: ```console -$ compose-bridge convert --transformations mycompany/transform +$ docker compose bridge convert --transformations mycompany/transform ``` ### Add your own templates diff --git a/content/manuals/compose/bridge/usage.md b/content/manuals/compose/bridge/usage.md index 091457fbeefb..7228702b35f8 100644 --- a/content/manuals/compose/bridge/usage.md +++ b/content/manuals/compose/bridge/usage.md @@ -29,7 +29,7 @@ It also supplies a Kustomize overlay dedicated to Docker Desktop with: To use the default transformation run the following command: ```console -$ compose-bridge convert +$ docker compose bridge convert ``` Compose looks for a `compose.yaml` file inside the current directory and then converts it. @@ -69,13 +69,13 @@ the standard deployment command `kubectl apply -k out/overlays/desktop/`. If you want to convert a `compose.yaml` file that is located in another directory, you can run: ```console -$ compose-bridge convert -f /compose.yaml +$ docker compose bridge convert -f /compose.yaml ``` To see all available flags, run: ```console -$ compose-bridge convert --help +$ docker compose bridge convert --help ``` > [!TIP] From 85d437dc6ceee9d817da3b2b52e2627cd35d0912 Mon Sep 17 00:00:00 2001 From: aevesdocker Date: Fri, 6 Jun 2025 16:02:06 +0100 Subject: [PATCH 3/3] SME review --- content/manuals/compose/bridge/_index.md | 3 +- .../compose/bridge/advanced-integration.md | 43 ------------------- content/manuals/compose/bridge/customize.md | 6 +-- content/manuals/compose/bridge/usage.md | 5 +-- 4 files changed, 4 insertions(+), 53 deletions(-) delete mode 100644 content/manuals/compose/bridge/advanced-integration.md diff --git a/content/manuals/compose/bridge/_index.md b/content/manuals/compose/bridge/_index.md index 3ec8d2a6d796..37bf983320a0 100644 --- a/content/manuals/compose/bridge/_index.md +++ b/content/manuals/compose/bridge/_index.md @@ -41,5 +41,4 @@ To give feedback, report bugs, or receive support, email `desktop-preview@docker ## What's next? - [Use Compose Bridge](usage.md) -- [Explore how you can customize Compose Bridge](customize.md) -- [Explore the advanced integration](advanced-integration.md) +- [Explore how you can customize Compose Bridge](customize.md) \ No newline at end of file diff --git a/content/manuals/compose/bridge/advanced-integration.md b/content/manuals/compose/bridge/advanced-integration.md deleted file mode 100644 index 9de05ceaa05e..000000000000 --- a/content/manuals/compose/bridge/advanced-integration.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Advanced integration -linkTitle: Advanced -weight: 30 -description: Learn about how Compose Bridge can function a kubectl plugin -keywords: kubernetes, compose, compose bridge, plugin, advanced ---- - -{{< summary-bar feature_name="Compose bridge" >}} - -Compose Bridge can also function as a `kubectl` plugin, allowing you to integrate its capabilities directly into your Kubernetes command-line operations. This integration simplifies the process of converting and deploying applications from Docker Compose to Kubernetes. - -## Use `docker compose bridge` as a `kubectl` plugin - -To use the `compose-bridge` binary as a `kubectl` plugin, you need to make sure that the binary is available in your PATH and the name of the binary is prefixed with `kubectl-`. - -1. Rename or copy the `compose-bridge` binary to `kubectl-compose_bridge`: - - ```console - $ mv /path/to/compose-bridge /usr/local/bin/kubectl-compose_bridge - ``` - -2. Ensure that the binary is executable: - - ```console - $ chmod +x /usr/local/bin/kubectl-compose_bridge - ``` - -3. Verify that the plugin is recognized by `kubectl`: - - ```console - $ kubectl plugin list - ``` - - In the output, you should see `kubectl-compose_bridge`. - -4. Now you can use `compose-bridge` as a `kubectl` plugin: - - ```console - $ kubectl docker compose bridge [command] - ``` - -Replace `[command]` with any `docker compose bridge` command you want to use. diff --git a/content/manuals/compose/bridge/customize.md b/content/manuals/compose/bridge/customize.md index cb1c6e2541f0..390710053427 100644 --- a/content/manuals/compose/bridge/customize.md +++ b/content/manuals/compose/bridge/customize.md @@ -152,7 +152,7 @@ when transforming Compose models into Kubernetes in addition to other transformations: ```console -$ compose-bridge convert \ +$ docker compose bridge convert \ --transformation docker/compose-bridge-kubernetes \ --transformation mycompany/transform ``` @@ -184,7 +184,3 @@ CMD ["/usr/bin/kompose", "convert", "-f", "/in/compose.yaml", "--out", "/out"] This Dockerfile bundles Kompose and defines the command to run this tool according to the Compose Bridge transformation contract. - -## What's next? - -- [Explore the advanced integration](advanced-integration.md) diff --git a/content/manuals/compose/bridge/usage.md b/content/manuals/compose/bridge/usage.md index 7228702b35f8..47c418eff065 100644 --- a/content/manuals/compose/bridge/usage.md +++ b/content/manuals/compose/bridge/usage.md @@ -36,7 +36,7 @@ Compose looks for a `compose.yaml` file inside the current directory and then co The following output is displayed ```console -$ compose-bridge convert -f compose.yaml +$ docker compose bridge convert -f compose.yaml Kubernetes resource api-deployment.yaml created Kubernetes resource db-deployment.yaml created Kubernetes resource web-deployment.yaml created @@ -86,5 +86,4 @@ $ docker compose bridge convert --help ## What's next? -- [Explore how you can customize Compose Bridge](customize.md) -- [Explore the advanced integration](advanced-integration.md) +- [Explore how you can customize Compose Bridge](customize.md) \ No newline at end of file