Skip to content
This repository was archived by the owner on Jul 18, 2025. It is now read-only.

Commit 6e09afe

Browse files
committed
Add installation steps of compose on kubernetes on Docker Desktop
Signed-off-by: Lorena Rangel <[email protected]>
1 parent 78e6a00 commit 6e09afe

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,29 @@ More documentation can be found in the [docs/](./docs) directory. This includes:
1717

1818
# Get started
1919

20-
Compose on Kubernetes comes installed on
21-
[Docker Desktop](https://www.docker.com/products/docker-desktop) and
22-
[Docker Enterprise](https://www.docker.com/products/docker-enterprise).
20+
## Install Compose on Kubernetes on Docker Desktop
21+
22+
### Pre-requisites
23+
24+
- [Docker Desktop](https://www.docker.com/products/docker-desktop).
25+
- To install etcd using these instructions, you must have [Helm](https://helm.sh) in your client environment.
26+
- [Download the Compose on Kubernetes installer](https://github.com/docker/compose-on-kubernetes/releases).
2327

2428
On Docker Desktop you will need to activate Kubernetes in the settings to use
2529
Compose on Kubernetes.
2630

31+
### Create compose namespace
32+
33+
- Create a compose namespace by running `kubectl create namespace compose`
34+
35+
### Deploy etcd
36+
37+
Compose on Kubernetes requires an etcd instance (in addition to the kube-system etcd instance). Please follow [How to deploy etcd](./docs/deploy-etcd.md).
38+
39+
### Deploy Compose on Kubernetes
40+
41+
Run `installer-[darwin|linux|windows.exe] -namespace=compose -etcd-servers=http://compose-etcd-client:2379`.
42+
2743
## Check that Compose on Kubernetes is installed
2844

2945
You can check that Compose on Kubernetes is installed by checking for the

0 commit comments

Comments
 (0)