Skip to content

Latest commit

 

History

History
executable file
·
87 lines (56 loc) · 3.29 KB

README.md

File metadata and controls

executable file
·
87 lines (56 loc) · 3.29 KB

Kubernetes compose (Kompose)

Build Status Join us on Slack

kompose is a tool to help users familiar with docker-compose move to Kubernetes. It 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. We don't assume that the transformation from docker compose format to Kubernetes API objects will be perfect, but it helps tremendously to start Kubernetizing your application.

Use Case

For example, if you have a Docker bundle like docker-compose-bundle.dsb, you can convert it into Kubernetes deployments and services like this:

$ kompose convert --bundle docker-compose-bundle.dsb
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

Download

Grab the latest release

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 go v1.5
  • You need to set export GO15VENDOREXPERIMENT=1 environment variable
  • If your working copy is not in your GOPATH, you need to set it accordingly.
$ go build -tags experimental -o kompose ./cli/main

You need -tags experimental because the current bundlefile package of docker/libcompose is still experimental.

Building multi-platform binaries with make

  • You need 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:

Incubation of kompose into the Kubernetes project will be discussed in the API Machinery SIG

RoadMap

  • September 15th 2016: Enter 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 support for Rancher compose/provider
  • 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.