Kompose (Kubernetes + Compose)
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.
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.
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.
- Binary (Preferred method)
- macOS (Homebrew and MacPorts)
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.26.1/kompose-linux-amd64 -o kompose # macOS curl -L https://github.com/kubernetes/kompose/releases/download/v1.26.1/kompose-darwin-amd64 -o kompose chmod +x kompose sudo mv ./kompose /usr/local/bin/kompose
Download from GitHub 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 autocompletion kompose completion fish | source
Development and building of Kompose
- Clone repository
$ git clone https://github.com/kubernetes/kompose.git $GOPATH/src/github.com/kubernetes/kompose
- Change directory to the cloned repo.
- Build with
$ make bin
- Or build with
$ go build -o kompose main.go
- Test your changes
$ make test
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.