kubernetes/kompose

Folders and files

Name	Last commit message	Last commit date
Latest commit k8s-ci-robot Merge pull request #1930 from kubernetes/dependabot/go_modules/golang… 5b563e7 · Sep 13, 2024 History 1,723 Commits
.github	chore(deps): bump minimum Go version to 1.21	Mar 19, 2024
.openvex/templates	Add VEX Feed	Dec 16, 2023
build	1.34.0 Release (#1890 )	Jun 3, 2024
client	fix client/convert (issue #1818 )	Feb 4, 2024
cmd	[completion] Add header #compdef (#1915 )	Sep 13, 2024
docs	1.34.0 Release (#1890 )	Jun 3, 2024
examples	feature: change example to use non-root (#1879 )	May 30, 2024
pkg	feature: support UID:GID in the user key	Aug 31, 2024
script	chore: upgrade fsouza/godockerclient and docker/docker packages (#1921 )	Aug 9, 2024
.gitignore	feat(1765): update tests, move unit test to proper file, improve remo…	Jan 1, 2024
.gitmodules	remove build/rpm submodule (#1587 )	Feb 14, 2023
.golangci.yml	feat: migrate from libcompose to compose-go (#1547 )	Jan 13, 2023
.mention-bot	Change bot message	Aug 17, 2017
.pre-commit-config.yaml	feat: integrate pre-commit hooks (#1559 )	Feb 11, 2023
CONTRIBUTING.md	Fixes typos (#1557 )	Feb 9, 2023
Dockerfile	#1821 update Dockerfile to alwyas use head Alpine	Feb 13, 2024
Jenkinsfile	Cleanup glide (#1353 )	Nov 9, 2020
licence	remove executable perms from docs	Sep 27, 2016
Makefile	chore: fix test file names (#1889 )	May 31, 2024
OWNERS	update owners (#1888 )	May 30, 2024
README.md	1.34.0 Release (#1890 )	Jun 3, 2024
RELEASE.md	Fixes typos (#1557 )	Feb 9, 2023
SECURITY.md	Add SECURITY.md	Jul 28, 2020
SECURITY_CONTACTS	owners: Remove surajssd (#1555 )	Jan 19, 2023
code-of-conduct.md	Update code-of-conduct.md	Dec 21, 2017
go.mod	Merge pull request #1930 from kubernetes/dependabot/go_modules/golang…	Sep 13, 2024
go.sum	Merge pull request #1930 from kubernetes/dependabot/go_modules/golang…	Sep 13, 2024
gover.coverprofile	1.26.0 Release (#1460 )	Nov 13, 2021
index.md	update references to just compose (#1869 )	Apr 26, 2024
main.go	cleanup debug logs & remove duplicated output (#1348 )	Nov 4, 2020

Kompose (Kubernetes + Compose)

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

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