Add setup.md

Adds setup.md to the docs folder in order to sync with changes to
http://kompose.io site (whenever we update setup.md here, it'll update
on the gh-pages branch).
This commit is contained in:
Charlie Drage 2017-04-10 09:21:47 -04:00
parent c01bcce02e
commit 12b106f129
2 changed files with 66 additions and 34 deletions

View File

@ -35,7 +35,16 @@ Other examples are provided in the _examples_ [directory](./examples).
We have multiple ways to install Kompose. Our prefered method is downloading the binary from the latest GitHub release.
#### GitHub release
Our entire list of installation methods are located in our [setup.md](/docs/setup.md) document.
Installation methods:
- [Binary (Prefered method)](README.md)
- [Go](/docs/setup.md#go)
- [CentOS](/docs/setup.md#centos)
- [Fedora](/docs/setup.mdfedora)
- [macOS (Homebrew)](/docs/setup.md#macos)
#### Binary installation
Kompose is released via GitHub on a three-week cycle, you can see all current releases on the [GitHub release page](https://github.com/kubernetes-incubator/kompose/releases).
@ -55,39 +64,6 @@ sudo mv ./kompose /usr/local/bin/kompose
Alternatively, you can download the [tarball](https://github.com/kubernetes-incubator/kompose/releases).
#### Go
Installing using `go get` pulls from the master branch with the latest development changes.
```sh
go get -u github.com/kubernetes-incubator/kompose
```
#### CentOS
Kompose is in [EPEL](https://fedoraproject.org/wiki/EPEL) CentOS repository.
If you don't have [EPEL](https://fedoraproject.org/wiki/EPEL) repository already installed and enabled you can do it by running `sudo yum install epel-release`
If you have [EPEL](https://fedoraproject.org/wiki/EPEL) enabled in your system, you can install Kompose like any other package.
```bash
sudo yum -y install kompose
```
#### Fedora
Kompose is in Fedora 24 and 25 repositories. You can install it just like any other package.
```bash
sudo dnf -y install kompose
```
#### Mac OS X
On Mac OS X you can install latest release via [Homebrew](https://brew.sh):
```bash
brew install kompose
```
## Shell autocompletion
We support both `bash` and `zsh` for autocompletion.

56
docs/setup.md Normal file
View File

@ -0,0 +1,56 @@
## Installation
We have multiple ways to install Kompose. Our prefered method is downloading the binary from the latest GitHub release.
#### GitHub release
Kompose is released via GitHub on a three-week cycle, you can see all current releases on the [GitHub release page](https://github.com/kubernetes-incubator/kompose/releases).
```sh
# Linux
curl -L https://github.com/kubernetes-incubator/kompose/releases/download/v0.5.0/kompose-linux-amd64 -o kompose
# macOS
curl -L https://github.com/kubernetes-incubator/kompose/releases/download/v0.5.0/kompose-darwin-amd64 -o kompose
# Windows
curl -L https://github.com/kubernetes-incubator/kompose/releases/download/v0.5.0/kompose-windows-amd64.exe -o kompose.exe
chmod +x kompose
sudo mv ./kompose /usr/local/bin/kompose
```
Alternatively, you can download the [tarball](https://github.com/kubernetes-incubator/kompose/releases).
#### Go
Installing using `go get` pulls from the master branch with the latest development changes.
```sh
go get -u github.com/kubernetes-incubator/kompose
```
#### CentOS
Kompose is in [EPEL](https://fedoraproject.org/wiki/EPEL) CentOS repository.
If you don't have [EPEL](https://fedoraproject.org/wiki/EPEL) repository already installed and enabled you can do it by running `sudo yum install epel-release`
If you have [EPEL](https://fedoraproject.org/wiki/EPEL) enabled in your system, you can install Kompose like any other package.
```bash
sudo yum -y install kompose
```
#### Fedora
Kompose is in Fedora 24 and 25 repositories. You can install it just like any other package.
```bash
sudo dnf -y install kompose
```
#### macOS
On macOS you can install latest release via [Homebrew](https://brew.sh):
```bash
brew install kompose
```