Go Shell Other
Clone or download
hangyan Merge pull request #1020 from hangyan/fix/env-file-env
Fix environment with env_file bug
Latest commit c0360e0 Jul 10, 2018
Permalink
Failed to load latest commit information.
build 1.15.0 Release (#1044) Jun 28, 2018
cmd Typo fix: erroring -> error (#1032) Jun 5, 2018
docs 1.15.0 Release (#1044) Jun 28, 2018
examples Convert registry to k8s.gcr.io Dec 22, 2017
pkg Merge pull request #1020 from hangyan/fix/env-file-env Jul 10, 2018
script Merge pull request #1020 from hangyan/fix/env-file-env Jul 10, 2018
vendor Fix failing issues with vendoring as well as compiling Nov 30, 2017
.gitignore Update the release script again Apr 28, 2017
.gitmodules Add rpm packaging Mar 17, 2017
.mention-bot Change bot message Aug 16, 2017
.travis.yml Merge pull request #871 from surajnarwade/stdin Jun 6, 2018
CHANGELOG.md 1.15.0 Release (#1044) Jun 28, 2018
CONTRIBUTING.md Go down to one ACK Aug 14, 2017
Jenkinsfile changing the organisation from kubernetes-incubator to kubernetes Aug 24, 2017
LICENSE remove executable perms from docs Sep 26, 2016
Makefile Merge pull request #871 from surajnarwade/stdin Jun 6, 2018
OWNERS Add surajnarwade in OWNER file (#1047) Jul 9, 2018
README.md 1.15.0 Release (#1044) Jun 28, 2018
RELEASE.md update release process doc Apr 10, 2017
ROADMAP.md kubernetes-incubator -> kubernetes Jul 12, 2017
SECURITY_CONTACTS Add security contacts (#1016) May 28, 2018
code-of-conduct.md Update code-of-conduct.md Dec 20, 2017
glide.lock Fix failing issues with vendoring as well as compiling Nov 30, 2017
glide.yaml Typo fix in conversion.md (#985) Apr 16, 2018
main.go kubernetes-incubator -> kubernetes Jul 12, 2017

README.md

Kompose (Kubernetes + Compose)

Build Status Widget Coverage Status Widget GoDoc Widget GoReportCard Widget

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

Convert docker-compose.yaml into Kubernetes deployments and services with one simple command:

$ kompose convert -f docker-compose.yaml
INFO Kubernetes file "frontend-service.yaml" created         
INFO Kubernetes file "redis-master-service.yaml" created     
INFO Kubernetes file "redis-slave-service.yaml" created      
INFO Kubernetes file "frontend-deployment.yaml" created      
INFO Kubernetes file "redis-master-deployment.yaml" created  
INFO Kubernetes file "redis-slave-deployment.yaml" created 

Other examples are provided in the examples directory.

Installation

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

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

Installation methods:

Binary installation

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

Linux and macOS:

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

# macOS
curl -L https://github.com/kubernetes/kompose/releases/download/v1.15.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.

Shell autocompletion

We support both Bash and Zsh autocompletion.

# Bash (add to .bashrc for persistence)
source <(kompose completion bash)

# Zsh (add to .zshrc for persistence)
source <(kompose completion zsh)

Development and building of Kompose

Building with go

Requisites:

  1. make
  2. Golang v1.6 or later
  3. Set GOPATH correctly or click SettingGOPATH for details

Steps:

  1. Clone repository
$ git clone https://github.com/kubernetes/kompose.git $GOPATH/src/github.com/kubernetes/kompose
  1. Build with make
$ make bin
  1. Or build with go
$ go build -o kompose main.go
  1. Test your changes
$ make test

Documentation

Documentation can be found at our kompose.io website or our docs folder.

Here is a list of all available docs:

Community, Discussion, Contribution, and Support

Issues: If you find any issues, please file it.

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

Chat (Slack): We're fairly active on Slack and you can find us in the #kompose channel.

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.