Repository files navigation

kompose is a tool to help users who are familiar withdocker-compose move toKubernetes.kompose takes aCompose Specification file and translates it into Kubernetes resources.

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

Convertcompose.yaml into Kubernetes deployments and services with one simple command:

$ kompose convert -f compose.yamlINFO Kubernetes file"frontend-service.yaml" createdINFO Kubernetes file"redis-leader-service.yaml" createdINFO Kubernetes file"redis-replica-service.yaml" createdINFO Kubernetes file"frontend-deployment.yaml" createdINFO Kubernetes file"redis-leader-deployment.yaml" createdINFO Kubernetes file"redis-replica-deployment.yaml" created

Other examples are provided in theexamplesdirectory.

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 ourinstallation.md document.

Installation methods:

• Binary (Preferred method)
• Go
• CentOS
• openSUSE/SLE
• NixOS
• macOS (Homebrew and MacPorts)
• Windows
• Docker

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

Linux and macOS:

# Linuxcurl -L https://github.com/kubernetes/kompose/releases/download/v1.37.0/kompose-linux-amd64 -o kompose# macOScurl -L https://github.com/kubernetes/kompose/releases/download/v1.37.0/kompose-darwin-amd64 -o komposechmod +x komposesudo mv ./kompose /usr/local/bin/kompose

Windows:

Download fromGitHub and add the binary to your PATH.

We support Bash, Zsh and Fish autocompletion.

# Bash (add to .bashrc for persistence)source<(kompose completion bash)# Zsh (add to .zshrc for persistence)source<(kompose completion zsh)# Fish autocompletionkompose completion fish|source

Requisites:

1. make
2. Golang v1.6 or later
3. SetGOPATH correctly or clickSettingGOPATH for details

Steps:

1. Clone repository

$git clone https://github.com/kubernetes/kompose.git$GOPATH/src/github.com/kubernetes/kompose

2. Change directory to the cloned repo.

cd $GOPATH/src/github.com/kubernetes/kompose

3. Build withmake

$make bin

4. Or build withgo

$go build -o kompose main.go

5. Test your changes

$maketest

Documentation can be found at ourkompose.io website or ourdocs folder.

Here is a list of all available docs:

• Quick start
• Installation
• User guide
• Conversion
• Architecture
• Development

Issues: If you find any issues, pleasefile it.

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

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

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