Kompose (Kubernetes + Compose)

[![Build Status Widget]][Build Status] [![Coverage Status Widget]][Coverage Status] [![GoDoc Widget]][GoDoc] [![GoReportCard Widget]][GoReportCardResult]

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:

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

Steps:

Clone repository

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

Change directory to the cloned repo.

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

Build with make

$ make bin

Or build with go

$ go build -o kompose main.go

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.

[Build Status]: https://github.com/kubernetes/kompose/actions?query=workflow%3A%22Kompose+CI%22 [Build Status Widget]: https://github.com/kubernetes/kompose/workflows/Kompose%20CI/badge.svg [GoDoc]: https://godoc.org/github.com/kubernetes/kompose [GoDoc Widget]: https://godoc.org/github.com/kubernetes/kompose?status.svg [Coverage Status Widget]: https://coveralls.io/repos/github/kubernetes/kompose/badge.svg?branch=main [Coverage Status]: https://coveralls.io/github/kubernetes/kompose?branch=main [GoReportCard Widget]: https://goreportcard.com/badge/github.com/kubernetes/kompose [GoReportCardResult]: https://goreportcard.com/report/github.com/kubernetes/kompose

🔗 More in this category