e89e41b9fb
Uses the local kompose binary that was built, not the one stored in the GOPATH bin folder. For example, using `./kompose` instead of `kompose`. Disables `make bin` generation for Kubernetes tests. |
||
|---|---|---|
| build | ||
| cmd | ||
| docs | ||
| examples | ||
| pkg | ||
| script | ||
| vendor | ||
| .gitignore | ||
| .gitmodules | ||
| .mention-bot | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| code-of-conduct.md | ||
| CONTRIBUTING.md | ||
| glide.lock | ||
| glide.yaml | ||
| Jenkinsfile | ||
| LICENSE | ||
| main.go | ||
| Makefile | ||
| OWNERS | ||
| README.md | ||
| RELEASE.md | ||
| ROADMAP.md | ||
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.
Use Case
Convert 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.
Installation
We have multiple ways to install Kompose. Our prefered 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.0.0/kompose-linux-amd64 -o kompose
# macOS
curl -L https://github.com/kubernetes/kompose/releases/download/v1.0.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 both Bash and Zsh autocompletion.
# Bash (add to .bashrc for persistence)
source <(kompose completion bash)
# Zsh (add to .zshrc for persistence)
source <(kompose completion zsh)
Building
Building with go
- You need
make - You need
gov1.6 or later. - If your working copy is not in your
GOPATH, you need to set it accordingly.
You can either build via the Makefile:
$ make bin
Or go build:
$ go build -o kompose main.go
If you have go v1.5, it's still good to build kompose with the following settings:
$ CGO_ENABLED=0 GO15VENDOREXPERIMENT=1 go build -o kompose main.go
To create a multi-platform binary, use the cross command via make:
$ make cross
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.
Kubernetes Incubation: Kompose is being incubated into the Kubernetes community via SIG-APPS on kubernetes/community. @ericchiang is acting champion for incubation.
Chat (Slack): We're fairly active on Slack and you can find us in the #kompose channel.
Road Map
An up-to-date roadmap of upcoming releases is located at ROADMAP.md.
Code of Conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.