ENGDOCS-2709 (#22799)

<!--Delete sections as needed -->

## Description

Fixes Compose Bridge CLI docs not displaying and updates the docs to the
new commands

## 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 2025-06-10 08:04:55 +01:00 committed by GitHub
parent 27a9303e96
commit 521f328b86
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 76 additions and 60 deletions

View File

@ -30,8 +30,8 @@ To get started with Compose Bridge, you need to:
1. Download and install Docker Desktop version 4.33 and later. 1. Download and install Docker Desktop version 4.33 and later.
2. Sign in to your Docker account. 2. Sign in to your Docker account.
3. Navigate to the **Features in development** tab in **Settings**. 3. Navigate to the **Beta features** tab in **Settings**.
4. From the **Experimental features** tab, select **Enable Compose Bridge**. 4. Select **Enable Compose Bridge**.
5. Select **Apply & restart**. 5. Select **Apply & restart**.
## Feedback ## Feedback
@ -41,5 +41,4 @@ To give feedback, report bugs, or receive support, email `desktop-preview@docker
## What's next? ## What's next?
- [Use Compose Bridge](usage.md) - [Use Compose Bridge](usage.md)
- [Explore how you can customize Compose Bridge](customize.md) - [Explore how you can customize Compose Bridge](customize.md)
- [Explore the advanced integration](advanced-integration.md)

View File

@ -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 `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 compose-bridge [command]
```
Replace `[command]` with any `compose-bridge` command you want to use.

View File

@ -91,7 +91,7 @@ decisions and preferences, with various level of flexibility and effort.
### Modify the default templates ### Modify the default templates
You can extract templates used by the default transformation `docker/compose-bridge-kubernetes`, 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. 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`. 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: You can then use your transformation as a replacement:
```console ```console
$ compose-bridge convert --transformations mycompany/transform $ docker compose bridge convert --transformations mycompany/transform
``` ```
### Add your own templates ### Add your own templates
@ -152,7 +152,7 @@ when transforming Compose models into Kubernetes in addition to other
transformations: transformations:
```console ```console
$ compose-bridge convert \ $ docker compose bridge convert \
--transformation docker/compose-bridge-kubernetes \ --transformation docker/compose-bridge-kubernetes \
--transformation mycompany/transform --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 This Dockerfile bundles Kompose and defines the command to run this tool according
to the Compose Bridge transformation contract. to the Compose Bridge transformation contract.
## What's next?
- [Explore the advanced integration](advanced-integration.md)

View File

@ -29,14 +29,14 @@ It also supplies a Kustomize overlay dedicated to Docker Desktop with:
To use the default transformation run the following command: To use the default transformation run the following command:
```console ```console
$ compose-bridge convert $ docker compose bridge convert
``` ```
Compose looks for a `compose.yaml` file inside the current directory and then converts it. Compose looks for a `compose.yaml` file inside the current directory and then converts it.
The following output is displayed The following output is displayed
```console ```console
$ compose-bridge convert -f compose.yaml $ docker compose bridge convert -f compose.yaml
Kubernetes resource api-deployment.yaml created Kubernetes resource api-deployment.yaml created
Kubernetes resource db-deployment.yaml created Kubernetes resource db-deployment.yaml created
Kubernetes resource web-deployment.yaml created Kubernetes resource web-deployment.yaml created
@ -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: If you want to convert a `compose.yaml` file that is located in another directory, you can run:
```console ```console
$ compose-bridge convert -f <path-to-file>/compose.yaml $ docker compose bridge convert -f <path-to-file>/compose.yaml
``` ```
To see all available flags, run: To see all available flags, run:
```console ```console
$ compose-bridge convert --help $ docker compose bridge convert --help
``` ```
> [!TIP] > [!TIP]
@ -86,5 +86,4 @@ $ compose-bridge convert --help
## What's next? ## What's next?
- [Explore how you can customize Compose Bridge](customize.md) - [Explore how you can customize Compose Bridge](customize.md)
- [Explore the advanced integration](advanced-integration.md)

View File

@ -0,0 +1,13 @@
---
datafolder: compose-cli
datafile: docker_compose_bridge
title: docker compose bridge
layout: cli
---
<!--
Sorry, but the contents of this page are automatically generated from
Docker's source code. If you want to suggest a change to the text that appears
here, you'll need to find the string by searching this repo:
https://github.com/docker/compose
-->

View File

@ -0,0 +1,13 @@
---
datafolder: compose-cli
datafile: docker_compose_bridge_convert
title: docker compose bridge convert
layout: cli
---
<!--
Sorry, but the contents of this page are automatically generated from
Docker's source code. If you want to suggest a change to the text that appears
here, you'll need to find the string by searching this repo:
https://github.com/docker/compose
-->

View File

@ -0,0 +1,13 @@
---
datafolder: compose-cli
datafile: docker_compose_bridge_transformations
title: docker compose bridge transformations
layout: cli
---
<!--
Sorry, but the contents of this page are automatically generated from
Docker's source code. If you want to suggest a change to the text that appears
here, you'll need to find the string by searching this repo:
https://github.com/docker/compose
-->

View File

@ -0,0 +1,13 @@
---
datafolder: compose-cli
datafile: docker_compose_bridge_transformations_create
title: docker compose bridge transformations create
layout: cli
---
<!--
Sorry, but the contents of this page are automatically generated from
Docker's source code. If you want to suggest a change to the text that appears
here, you'll need to find the string by searching this repo:
https://github.com/docker/compose
-->

View File

@ -0,0 +1,13 @@
---
datafolder: compose-cli
datafile: docker_compose_bridge_transformations_list
title: docker compose bridge transformations list
layout: cli
---
<!--
Sorry, but the contents of this page are automatically generated from
Docker's source code. If you want to suggest a change to the text that appears
here, you'll need to find the string by searching this repo:
https://github.com/docker/compose
-->