LaconicNetwork/kompose
9
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
996 Commits 2 Branches 1 Tag 32 MiB
Go 87.6%
Shell 11.2%
Makefile 0.8%
Dockerfile 0.4%
471578c92f
Go to file
Suraj Narwade 471578c92f Updated --help page for kompose up 
This PR will add customhelp section in `kompose up --help` section,
which will show consistency in help section.
Issue reference: #842

for example,

```
$ kompose up --help
Deploy your Dockerized application to a container orchestrator. (default "kubernetes")

Usage:
  kompose up [flags]

OpenShift Flags:
      --build-branch             Specify repository branch to use for buildconfig (default is current branch name)
      --build-repo               Specify source repository for buildconfig (default is current branch's remote url
      --insecure-repository      Specify to use insecure docker repository while generating Openshift image stream object

Flags:
      --build string       Set the type of build ("local"|"build-config" (OpenShift only)|"none") (default "local")
  -h, --help               help for up
      --namespace string   Specify Namespace to deploy your application (default "default")
      --replicas int       Specify the number of replicas generated (default 1)
      --volumes string     Volumes to be generated ("persistentVolumeClaim"|"emptyDir") (default "persistentVolumeClaim")

Global Flags:
      --error-on-warning    Treat any warning as an error
  -f, --file stringArray    Specify an alternative compose file
      --provider string     Specify a provider. Kubernetes or OpenShift. (default "kubernetes")
      --suppress-warnings   Suppress all warnings
  -v, --verbose             verbose output
```
2017-10-13 18:03:33 +05:30
build 1.3.0 Release 2017-10-10 15:24:44 -04:00
cmd Updated --help page for kompose up 2017-10-13 18:03:33 +05:30
docs Fix Redirecting Error in README.md 2017-10-12 14:12:08 +05:30
examples Remove dab examples 2017-08-21 10:32:43 -04:00
pkg Update vendoring 2017-10-10 12:55:57 -04:00
script Redirects not working 2017-10-11 14:18:48 -04:00
vendor Update vendoring 2017-10-10 12:55:57 -04:00
.gitignore Update the release script again 2017-04-28 09:43:40 -04:00
.gitmodules Add rpm packaging 2017-03-17 10:55:21 -04:00
.mention-bot Change bot message 2017-08-17 01:59:29 +08:00
.travis.yml add correct secrets for bintray 2017-08-21 17:18:47 +02:00
CHANGELOG.md 1.3.0 Release 2017-10-10 15:24:44 -04:00
code-of-conduct.md Update Community Code of Conduct 2017-08-15 18:39:12 +05:30
CONTRIBUTING.md Go down to one ACK 2017-08-14 12:45:42 -04:00
glide.lock Update vendoring 2017-10-10 12:55:57 -04:00
glide.yaml Update vendoring 2017-10-10 12:55:57 -04:00
Jenkinsfile changing the organisation from kubernetes-incubator to kubernetes 2017-08-24 15:20:44 +05:30
LICENSE remove executable perms from docs 2016-09-26 15:15:16 -04:00
main.go kubernetes-incubator -> kubernetes 2017-07-12 15:42:13 -04:00
Makefile build and upload master builds to bintray 2017-08-21 17:06:33 +02:00
OWNERS Update contributing doc for reviewing, update owners file 2017-04-06 13:01:21 -04:00
README.md 1.3.0 Release 2017-10-10 15:24:44 -04:00
RELEASE.md update release process doc 2017-04-10 12:30:02 +02:00
ROADMAP.md kubernetes-incubator -> kubernetes 2017-07-12 15:42:13 -04:00

README.md

Kompose (Kubernetes + Compose)

Build Status Widget Coverage Status Widget GoDoc Widget GoReportCard Widget Slack Widget

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

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

Development and building of Kompose

Downloading the latest (master) binary

"Nightly" binaries are generated on a per-merge basis and uploaded to Bintray

Linux and macOS:

# Linux 
curl -L https://dl.bintray.com/kompose/kompose/latest/kompose-linux-amd64 -o kompose

# macOS
curl -L https://dl.bintray.com/kompose/kompose/latest/kompose-darwin-amd64 -o kompose

chmod +x kompose
sudo mv ./kompose /usr/local/bin/kompose

Windows:

Download from Bintray and add the binary to your PATH.

Building with go

  • You need make
  • You need go v1.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.