You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Charlie Drage 6b018fab7b
Fix tests (#1274)
2 months ago
build 1.21.0 Release (#1249) 4 months ago
cmd Add server flag for kompose down (#1260) 4 months ago
docs Add server flag for kompose down (#1260) 4 months ago
examples Revert "Add node references (#1123)" 1 year ago
pkg Fix annotations missing for ingress (#1248) 3 months ago
script Fix tests (#1274) 2 months ago
vendor Support export yaml with indent (#1219) 6 months ago
.gitignore Add kompose.image-pull-secret and kompose.image-pull-policy (#1091) 1 year ago
.gitmodules submodule with a 'go get'-friendly url 1 year ago
.mention-bot Change bot message 2 years ago
.travis.yml Use new go version for build (#1209) 6 months ago
CHANGELOG.md 1.21.0 Release (#1249) 4 months ago
CONTRIBUTING.md Go down to one ACK 2 years ago
Dockerfile Add Dockerfile (#1101) 11 months ago
Jenkinsfile changing the organisation from kubernetes-incubator to kubernetes 2 years ago
LICENSE Set template k8s project 4 years ago
Makefile Fix tests (#1274) 2 months ago
OWNERS Update OWNERS (#1177) 8 months ago
README.md 1.21.0 Release (#1249) 4 months ago
RELEASE.md update release process doc 3 years ago
SECURITY_CONTACTS Update embargo doc link in SECURITY_OWNERS and changes PST to PSC (#1115) 1 year ago
code-of-conduct.md Update code-of-conduct.md 2 years ago
glide.lock Support export yaml with indent (#1219) 6 months ago
glide.yaml Support export yaml with indent (#1219) 6 months ago
main.go kubernetes-incubator -> kubernetes 3 years ago

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.21.0/kompose-linux-amd64 -o kompose

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

Note: kompose up is not supported on windows.

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.

Code of Conduct

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