kompose

README

Kompose (Kubernetes + Compose)

in #kompose channel

kompose is a tool to help users who are familiar with docker-compose move to Kubernetes. kompose takes a Docker Compose file and translates it into Kubernetes resources.

kompose is a convenience tool to go from local Docker development to managing your application with Kubernetes. Transformation of the Docker Compose format to Kubernetes resources manifest may not be exact, but it helps tremendously when first deploying an application on Kubernetes.

Use Case

If you have a Docker Compose docker-compose.yml or a Docker Distributed Application Bundle docker-compose-bundle.dab file, you can convert it into Kubernetes deployments and services like this:

$ kompose --bundle docker-compose-bundle.dab convert
WARN Unsupported key networks - ignoring
file "redis-svc.yaml" created
file "web-svc.yaml" created
file "web-deployment.yaml" created
file "redis-deployment.yaml" created

$ kompose -f docker-compose.yml convert
WARN Unsupported key networks - ignoring
file "redis-svc.yaml" created
file "web-svc.yaml" created
file "web-deployment.yaml" created
file "redis-deployment.yaml" created

Other examples are provided in the examples directory.

Installation

We have multiple ways to install Kompose. Our prefered method is downloading the binary from the latest GitHub release.

Our entire list of installation methods are located in our setup.md document.

Installation methods:

• Binary (Prefered method)
• Go
• CentOS
• Fedora
• macOS (Homebrew)

Binary installation

Kompose is released via GitHub on a three-week cycle, you can see all current releases on the GitHub release page.

# Linux
curl -L https://github.com/kubernetes-incubator/kompose/releases/download/v0.7.0/kompose-linux-amd64 -o kompose

# macOS
curl -L https://github.com/kubernetes-incubator/kompose/releases/download/v0.7.0/kompose-darwin-amd64 -o kompose

# Windows
curl -L https://github.com/kubernetes-incubator/kompose/releases/download/v0.7.0/kompose-windows-amd64.exe -o kompose.exe

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

Alternatively, you can download the less-bandwidth intense tarball.

Shell autocompletion

We support both bash and zsh for autocompletion.

Bash:

source <(kompose completion bash)

Zsh:

source <(kompose completion zsh)

Building

Building with go

• You need make
• You need go v1.6 or later.
• If your working copy is not in your GOPATH, you need to set it accordingly.

You can either build via the Makefile:

$ make bin

Or go build:

$ go build -o kompose main.go

If you have go v1.5, it's still good to build kompose with the following settings:

$ CGO_ENABLED=0 GO15VENDOREXPERIMENT=1 go build -o kompose main.go

To create a multi-platform binary, use the cross command via make:

$ make cross

Contributing and Issues

kompose is a work in progress, we will see how far it takes us. We welcome any pull request to make it even better. If you find any issues, please file it.

Community, Discussion, Contribution, and Support

As part of the Kubernetes ecosystem, we follow the Kubernetes community principles. More information can be found on the community page.

You can reach the maintainers of this project on Slack in channel #kompose

kompose is being incubated into the Kubernetes community via SIG-APPS on kubernetes/community.

@ericchiang is acting champion for incubation.

We do a biweekly community meeting which is open to the public. Each week we outline what we have talked about in an agenda doc. This meeting occurs every two weeks on Wednesday 18:00-19:00 GMT.

Road Map

An up-to-date roadmap of upcoming releases is located at ROADMAP.md.

Code of Conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.