Skip to content
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

ENGDOCS-2078 #19927

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

ENGDOCS-2078 #19927

wants to merge 4 commits into from

Conversation

aevesdocker
Copy link
Contributor

@aevesdocker aevesdocker commented Apr 30, 2024

Description

Compose Bridge docs

Related issues or tickets

Reviews

NOTE FOR EDITORIAL REVIEW
⭐ This is not a perfect documentation set. This is for early access that we're hoping to get feedback on. Gaps are intentional

  • Technical review
  • Editorial review
  • Product review

@github-actions github-actions bot added the area/compose Relates to docker-compose.yml spec or docker-compose binary label Apr 30, 2024
Copy link

netlify bot commented Apr 30, 2024

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit d392a1a
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/6643785209b2c30008a19f8f
😎 Deploy Preview https://deploy-preview-19927--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@aevesdocker aevesdocker requested a review from glours May 14, 2024 11:40
content/compose/bridge/_index.md Outdated Show resolved Hide resolved
content/compose/bridge/usage.md Outdated Show resolved Hide resolved
content/compose/bridge/usage.md Outdated Show resolved Hide resolved
@aevesdocker aevesdocker requested a review from glours May 14, 2024 14:42
Copy link
Contributor

@glours glours left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@aevesdocker aevesdocker requested a review from a team May 14, 2024 16:34
@aevesdocker aevesdocker marked this pull request as ready for review May 14, 2024 16:34
Copy link
Contributor

@craig-osterhout craig-osterhout left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple small typos and a nitpick, otherwise LGTM.


{{< include "compose-bridge-early-access.md" >}}

Compose Bridge supplies an out-of-the box transformation for you Compose configuration file. Based on an arbitrary `compose.yaml` file, Compose Bridge produces:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Compose Bridge supplies an out-of-the box transformation for you 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 [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) with an entry for each and every [config](../compose-file/08-configs.md) resource in your Compose application.
- [Deployments](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) for application services. This ensures that the specified number of instances of your application are maintained in the Kubernetes cluster.
- [Services](https://kubernetes.io/docs/concepts/services-networking/service/) for ports exposed by your services, used for service-to-service communication.
- [Services](https://kubernetes.io/docs/concepts/services-networking/service/) for ports published by your services, with type `LoadBalancer` so that Docker Desktop will also expose same port on the host.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [Services](https://kubernetes.io/docs/concepts/services-networking/service/) for ports published by your services, with type `LoadBalancer` so that Docker Desktop will also expose same port on the host.
- [Services](https://kubernetes.io/docs/concepts/services-networking/service/) for ports published by your services, with type `LoadBalancer` so that Docker Desktop will also expose the same port on the host.

- [Services](https://kubernetes.io/docs/concepts/services-networking/service/) for ports published by your services, with type `LoadBalancer` so that Docker Desktop will also expose same port on the host.
- [Network policies](https://kubernetes.io/docs/concepts/services-networking/network-policies/) to replicate the networking topology defined in your `compose.yaml` file.
- [PersistentVolumeClaims](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) for your volumes, using `hostpath` storage class so that Docker Desktop manages volume creation.
- [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/) with your secret encoded. This is designed for local use in a testing environment
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/) with your secret encoded. This is designed for local use in a testing environment
- [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/) with your secret encoded. This is designed for local use in a testing environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/compose Relates to docker-compose.yml spec or docker-compose binary status/review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants