kompose README

The project's README from github.com/kubernetes/kompose. As one markdown file: README.md.

Kompose (Kubernetes + Compose)

Build Status Widget Coverage Status Widget GoDoc Widget GoReportCard Widget

logo

kompose is a tool to help users who are familiar with docker-compose move to Kubernetes. kompose takes a Compose 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 the Compose Specification format to Kubernetes resources manifest may not be exact, but it helps tremendously when first deploying an application on Kubernetes.

Use Case

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

$ kompose convert -f compose.yaml
INFO Kubernetes file "frontend-service.yaml" created
INFO Kubernetes file "redis-leader-service.yaml" created
INFO Kubernetes file "redis-replica-service.yaml" created
INFO Kubernetes file "frontend-deployment.yaml" created
INFO Kubernetes file "redis-leader-deployment.yaml" created
INFO Kubernetes file "redis-replica-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.38.0/kompose-linux-amd64 -o kompose

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

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. Change directory to the cloned repo.
cd $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.

kompose (kubernetes/kompose)

Searching Database…

10.6K ·GitHub
Kompose
What is this?kompose is a command-line tool from the Kubernetes project that converts Docker Compose files into Kubernetes resources, built for developers moving from docker-compose to Kubernetes.
Is kompose a tool that runs my containers, or something else?It neither runs nor manages containers — it is a converter: you feed it a Compose Specification file and it generates Kubernetes manifests that you then deploy to a cluster yourself.
Do I need a running Kubernetes cluster to convert my Compose file?No — the conversion itself is local: kompose only reads your Compose file and produces Kubernetes resource manifests. A cluster is needed only when you actually deploy that output.
Is the Compose-to-Kubernetes conversion always exact?No — the README warns the transformation may not be exact. Expect to review and tweak the generated manifests, though it still saves a lot of work on a first deployment to Kubernetes.
Can I run it on Windows and macOS, or is it Linux-only?All three: there are binaries for Linux, macOS (via Homebrew or MacPorts) and Windows, plus packages for CentOS, openSUSE/SLE and NixOS, a Go install and a Docker option.
What does a conversion look like in practice?One simple command turns your compose.yaml into Kubernetes Deployments and Services. The examples directory in the repo shows more conversion scenarios.
Why use this instead of writing Kubernetes YAML by hand?It is a convenience bridge for people who know docker-compose and are adopting Kubernetes: the output may not be perfect, but it gets an application deployed on Kubernetes much faster than authoring manifests from scratch.
Does it support shell autocompletion?Yes — Bash, Zsh and Fish autocompletion are supported out of the box.
Is kompose an official Kubernetes project?It is part of the Kubernetes ecosystem in the kubernetes GitHub org, follows the Kubernetes community principles and Code of Conduct, and its team is active in the #kompose Slack channel. Full docs are on kompose.io.
What are similar projects?tilt, compose, skaffold, helm, kustomize, encore, velero, k9s
Which topics is it in?migration, converter, deployment, containers, cloud-native, microservices, kubernetes, docker-compose, utility, command-line, developers, devops
Creator
kubernetes
Size
44.2 MB
Stars
10.6K
Updated
CommitSep 30Releasev1.38.0Jan 15
Age
10y
Commits · 90 Days