Skip to content

Conversation

@ndeloof
Copy link
Contributor

@ndeloof ndeloof commented Mar 27, 2024

Description

Compose Bridge documentation

Related issues or tickets

https://docker.atlassian.net/browse/COMP-505

Reviews

  • Technical review
  • Editorial review
  • Product review

@ndeloof ndeloof requested a review from aevesdocker as a code owner March 27, 2024 15:41
@github-actions github-actions bot added the area/compose Relates to docker-compose.yml spec or docker-compose binary label Mar 27, 2024
@netlify
Copy link

netlify bot commented Mar 27, 2024

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 5f2e2b6
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/6627feb48fd1c40008c70023
😎 Deploy Preview https://deploy-preview-19702--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.

@ndeloof ndeloof marked this pull request as draft March 27, 2024 15:59
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
Copy link
Contributor

@aevesdocker aevesdocker left a comment

Choose a reason for hiding this comment

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

thank you @ndeloof and @glours. I've done a 'light' review (sorry for the number of comments)
I think this is fine for customer 0/EAP to get some initial feedback on Compose Bridge. I have lots of questions!

Could we also add to the top of each page the following callout (see example screenshot) with 'Compose Bridge is an early access product.'

Screenshot 2024-04-16 at 16 56 46

I actually also think we should add this to the Table of contents with an early access badge.

- A [Namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) so all your resources are isolated and don't colide with another deployment
- A [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) with an entry for each and every config resource in your compose model
- [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/)s for application services
- [Service](https://kubernetes.io/docs/concepts/services-networking/service/)s for ports exposed by your services, used for service-to-service communication
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
- [Service](https://kubernetes.io/docs/concepts/services-networking/service/)s for ports exposed by your services, used for service-to-service communication
- [Services](https://kubernetes.io/docs/concepts/services-networking/service/) for ports exposed by your services, used for service-to-service communication

- A [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) with an entry for each and every config resource in your compose model
- [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/)s for application services
- [Service](https://kubernetes.io/docs/concepts/services-networking/service/)s for ports exposed by your services, used for service-to-service communication
- [Service](https://kubernetes.io/docs/concepts/services-networking/service/)s for ports published by your services, with type `LoadBalancer` so that Docker Desktop will also expose same port on 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
- [Service](https://kubernetes.io/docs/concepts/services-networking/service/)s for ports published by your services, with type `LoadBalancer` so that Docker Desktop will also expose same port on 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 host

- [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/)s for application services
- [Service](https://kubernetes.io/docs/concepts/services-networking/service/)s for ports exposed by your services, used for service-to-service communication
- [Service](https://kubernetes.io/docs/concepts/services-networking/service/)s for ports published by your services, with type `LoadBalancer` so that Docker Desktop will also expose same port on host
- [Network Policies](https://kubernetes.io/docs/concepts/services-networking/network-policies/) to replicate the networking topology expressed in compose
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
- [Network Policies](https://kubernetes.io/docs/concepts/services-networking/network-policies/) to replicate the networking topology expressed in compose
- [Network policies](https://kubernetes.io/docs/concepts/services-networking/network-policies/) to replicate the networking topology expressed in Compose

- [Service](https://kubernetes.io/docs/concepts/services-networking/service/)s for ports exposed by your services, used for service-to-service communication
- [Service](https://kubernetes.io/docs/concepts/services-networking/service/)s for ports published by your services, with type `LoadBalancer` so that Docker Desktop will also expose same port on host
- [Network Policies](https://kubernetes.io/docs/concepts/services-networking/network-policies/) to replicate the networking topology expressed in compose
- [PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)s for your volumes, using `hostpath` storage class so that Docker Desktop manage volume creation
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
- [PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)s for your volumes, using `hostpath` storage class so that Docker Desktop manage volume creation
- [PersistentVolumeClaims](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) for your volumes, using `hostpath` storage class so that Docker Desktop manages volume creation

- [Service](https://kubernetes.io/docs/concepts/services-networking/service/)s for ports published by your services, with type `LoadBalancer` so that Docker Desktop will also expose same port on host
- [Network Policies](https://kubernetes.io/docs/concepts/services-networking/network-policies/) to replicate the networking topology expressed in compose
- [PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)s for your volumes, using `hostpath` storage class so that Docker Desktop manage volume creation
- [Secret](https://kubernetes.io/docs/concepts/configuration/secret/)s 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
- [Secret](https://kubernetes.io/docs/concepts/configuration/secret/)s 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

@aevesdocker aevesdocker changed the title WiP Compose Bridge early access Apr 16, 2024
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
@aevesdocker aevesdocker marked this pull request as ready for review April 29, 2024 12:49
@aevesdocker
Copy link
Contributor

As discussed, merging now and will create follow-up PR to harmonize with docs

@aevesdocker aevesdocker merged commit 9e4a918 into docker:main Apr 29, 2024
elegantcoder pushed a commit to elegantcoder/docs that referenced this pull request Aug 28, 2024
* compose-bridge doc - release v0.0.1

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>

* Apply Ally's suggestions from first code review

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>

* manually adapt some review feedback

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>

---------

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
Co-authored-by: Guillaume Lours <705411+glours@users.noreply.github.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants