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
Что это такое?kompose — это консольная утилита из проекта Kubernetes, которая преобразует файлы Docker Compose в ресурсы Kubernetes. Она создана для разработчиков, которые переходят с docker-compose на Kubernetes.
kompose сам запускает мои контейнеры или делает что-то другое?Он не запускает и не управляет контейнерами — это конвертер: вы даёте ему файл по спецификации Compose, а он генерирует манифесты Kubernetes, которые вы потом сами разворачиваете в кластере.
Мне нужен работающий кластер Kubernetes, чтобы конвертировать мой Compose-файл?Нет — сама конвертация выполняется локально: kompose лишь читает ваш Compose-файл и создаёт манифесты ресурсов Kubernetes. Кластер понадобится только когда вы реально будете разворачивать результат.
Конвертация из Compose в Kubernetes всегда получается точной?Нет — в README предупреждают, что преобразование может быть неточным. Стоит ожидать, что сгенерированные манифесты придётся просмотреть и подправить, хотя для первого развёртывания в Kubernetes это всё равно сильно экономит работу.
Можно запустить на Windows и macOS, или это только для Linux?Работает на всех трёх: есть бинарники для Linux, macOS (через Homebrew или MacPorts) и Windows, а также пакеты для CentOS, openSUSE/SLE и NixOS, установка через Go и вариант с Docker.
Как конвертация выглядит на практике?Одна простая команда превращает ваш compose.yaml в Deployment'ы и Service'ы Kubernetes. Больше сценариев конвертации показано в каталоге examples в репозитории.
Чем это лучше, чем писать YAML для Kubernetes руками?Это удобный мост для тех, кто знает docker-compose и осваивает Kubernetes: результат может быть не идеальным, но приложение удастся развернуть в Kubernetes гораздо быстрее, чем писать манифесты с нуля.
Есть ли автодополнение в шелле?Да — автодополнение для Bash, Zsh и Fish работает сразу, из коробки.
kompose — это официальный проект Kubernetes?Он входит в экосистему Kubernetes и находится в GitHub-организации kubernetes, следует принципам сообщества Kubernetes и Code of Conduct, а его команда активна в Slack-канале #kompose. Полная документация — на kompose.io.
What are similar projects?tilt, compose, skaffold, helm, kustomize, encore, k9s, velero
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