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[0000]: Unsupported key networks - ignoring
file "redis-svc.json" created
file "web-svc.json" created
file "web-deployment.json" created
file "redis-deployment.json" created

$ kompose -f docker-compose.yml convert
WARN[0000]: Unsupported key networks - ignoring
file "redis-svc.json" created
file "web-svc.json" created
file "web-deployment.json" created
file "redis-deployment.json" created

Other examples are provided in the examples directory.

Installation

Grab the latest release for your OS, untar and extract the binary.

Linux example:

wget https://github.com/kubernetes-incubator/kompose/releases/download/v0.1.1/kompose_linux-amd64.tar.gz
tar -xvf kompose_linux-amd64.tar.gz --strip 1
sudo mv kompose /usr/local/bin

Otherwise, you could take the latest development package from master branch. Make sure your PATH includes the $GOPATH/bin directory so your commands can be easily used:

$ go get github.com/kubernetes-incubator/kompose
$ export PATH=$PATH:$GOPATH/bin

Bash completion

Running this below command in order to benefit from bash completion

$ PROG=kompose source script/bash_autocomplete

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 binary

Or go build:

$ go build -o kompose ./cli/main

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 ./cli/main

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

$ make binary-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

We follow the Kubernetes community principles.

Learn how to engage with the Kubernetes community on the community page.

You can reach the maintainers of this project at:

• Slack: #kompose

Incubation of kompose into the Kubernetes project is shepherd in the SIG-APPS.

@ericchiang is acting as Champion for incubation

We do a bi-weekly community meeting. Here is the link to agenda doc.

Meeting link: https://bluejeans.com/404059616

RoadMap

• September 15th 2016: Propose to Kubernetes incubator.
• September 30th 2016: Make the first official release of kompose, 0.1.0
• October 1st 2016: Add build support connected to a private registry run by Kubernetes
• October 15th 2016: Add multi-container Pods, PVC and service types support.
• November 1st 2016: Add preference file to specify preferred resources for conversion and preferred provider.
• November 15th 2016: Improve support for Docker bundles to target specific image layers.
• December 24th 2016: Second release of kompose, 0.2.0

Code of conduct

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