kompose/index.md
Charlie Drage 50e0408f6f
update references to just compose (#1869)
#### What type of PR is this?

Change from Docker Compose references to just Compose

<!--
Add one of the following kinds:
/kind bug
/kind cleanup
/kind documentation
/kind feature
-->

#### What this PR does / why we need it:

Compose is an open format and we should not say "Docker Compose".

#### Which issue(s) this PR fixes:
<!--
*Automatically closes linked issue when PR is merged.
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
-->

Fixes https://github.com/kubernetes/kompose/issues/1868

#### Special notes for your reviewer:

Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2024-04-26 10:24:55 +02:00

1.8 KiB

layout
default

Kubernetes + Compose = Kompose

A conversion tool to go from Compose to Kubernetes

What's Kompose?

Kompose is a conversion tool for Compose to container orchestrators such as Kubernetes (or OpenShift).

Why do developers love it?

  • Simplify your development process with Compose and then deploy your containers to a production cluster
  • Convert your docker-compose.yaml with one simple command kompose convert

It's as simple as 1-2-3

  1. Use an example docker-compose.yaml file or your own
  2. Run kompose convert
  3. Run kubectl apply and check your Kubernetes cluster for your newly deployed containers!
$ wget https://raw.githubusercontent.com/kubernetes/kompose/master/examples/docker-compose-v3.yaml -O docker-compose.yaml

$ kompose convert

$ kubectl apply -f .

$ kubectl get po
NAME                            READY     STATUS              RESTARTS   AGE
frontend-591253677-5t038        1/1       Running             0          10s
redis-master-2410703502-9hshf   1/1       Running             0          10s
redis-replica-4049176185-hr1lr  1/1       Running             0          10s

A more detailed guide is available in our getting started guide.

Install Kompose on Linux, macOS or Windows

Grab the Kompose binary!

# Linux
curl -L https://github.com/kubernetes/kompose/releases/download/v1.25.0/kompose-linux-amd64 -o kompose

# macOS
curl -L https://github.com/kubernetes/kompose/releases/download/v1.25.0/kompose-darwin-amd64 -o kompose

chmod +x kompose
sudo mv ./kompose /usr/local/bin/kompose

Windows: Download from GitHub and add the binary to your PATH.