kubernetes
/
kops
mirror of https://github.com/kubernetes/kops.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: clean up installation instructions

This commit is contained in:
Justin Santa Barbara 2017-10-03 00:37:15 -04:00
parent 6ea6e3aa3f
commit 8b6e2eb8ad
2 changed files with 73 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/development/building.md Normal file
View File

@ -0,0 +1,35 @@
# Building from source
[Installation from a binary](../install.md) is recommended for normal kops operation. However, if you want
to build from source, it is straightforward:
If you don't have a GOPATH:
```
mkdir ~/kops
cd ~/kops
export GOPATH=`pwd`
```
Check out and build the code:
```
go get -d k8s.io/kops
cd ${GOPATH}/src/k8s.io/kops/
git checkout release
make
```
* The `release` branch is where releases are taken from. This is the stable code branch.
* The `master` branch _should_ also be functional, but is where active development happens, so may be less stable.
## Cross Compiling
Cross compiling for things like `nodeup` are now done automatically via `make nodeup`. `make push-aws-run TARGET=admin@$TARGET` will automatically choose the linux amd64 build from your `.build` directory.
## Troubleshooting
- Make sure `$GOPATH` is set, and your [workspace](https://golang.org/doc/code.html#Workspaces) is configured.
- kops will not compile with symlinks in `$GOPATH`. See issue go issue [17451](https://github.com/golang/go/issues/17451) for more information
- building kops requires go 1.8 or 1.9
- Kops will only compile if the source is checked out in `$GOPATH/src/k8s.io/kops`. If you try to use `$GOPATH/src/github.com/kubernetes/kops` you will run into issues with package imports not working as expected.

63
docs/install.md
View File

@ -1,59 +1,72 @@
# Installing Kops (Binaries)
# Installing kops (Binaries)
## Darwin (MacOS)
## MacOS
From Homebrew:
```bash
brew update && brew install --HEAD kops
brew update && brew install kops
```
# Installing Kops (Source)
From Github:
```
go get -d k8s.io/kops
cd ${GOPATH}/src/k8s.io/kops/
git checkout release
make
```bash
wget -O kops https://github.com/kubernetes/kops/releases/download/1.7.0/kops-darwin-amd64
chmod +x ./kops
sudo mv ./kops /usr/local/bin/
```
* The `release` branch is where releases are taken from. This is the stable code branch.
* The `master` branch _should_ also be functional, but is where active development happens, so may be less stable.
You can also [install from source](development/building.md).
## Cross Compiling
## Linux
Cross compiling for things like `nodeup` are now done automatically via `make nodeup`. `make push-aws-run TARGET=admin@$TARGET` will automatically choose the linux amd64 build from your `.build` directory.
From Github:
## Troubleshooting
```bash
wget -O kops https://github.com/kubernetes/kops/releases/download/1.7.0/kops-linux-amd64
chmod +x ./kops
sudo mv ./kops /usr/local/bin/
```
- Make sure `$GOPATH` is set, and your [workspace](https://golang.org/doc/code.html#Workspaces) is configured.
- kops will not compile with symlinks in `$GOPATH`. See issue go issue [17451](https://github.com/golang/go/issues/17451) for more information
- kops uses the relatively new Go vendoring, so building requires Go 1.6 or later, or you must export GO15VENDOREXPERIMENT=1 when building with Go 1.5. The makefile sets GO15VENDOREXPERIMENT for you. Go code generation does not honor the env var in 1.5, so for development you should use Go 1.6 or later
- Kops will only compile if the source is checked out in `$GOPATH/src/k8s.io/kops`. If you try to use `$GOPATH/src/github.com/kubernetes/kops` you will run into issues with package imports not working as expected.
You can also [install from source](development/building.md).
# Installing Other Dependencies
## Installing Kubectl
## kubectl
`kubectl` is the CLI tool to manage and operate Kubernetes clusters. You can install it as follows.
### Darwin (MacOS)
### MacOS
From Homebrew:
```
brew install kubernetes-cli
```
### Other Platforms
From the [official kubernetes kubectl release](https://kubernetes.io/docs/tasks/tools/install-kubectl/):
* [Kubernetes Latest Release](https://github.com/kubernetes/kubernetes/releases/latest)
* [Installation Guide](http://kubernetes.io/docs/user-guide/prereqs/)
```
wget -O kubectl https://storage.googleapis.com/kubernetes-release/release/`curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt`/bin/darwin/amd64/kubectl
chmod +x ./kubectl
sudo mv ./kubectl /usr/local/bin/kubectl
```
### Linux
From the [official kubernetes kubectl release](https://kubernetes.io/docs/tasks/tools/install-kubectl/):
```
wget -O kubectl https://storage.googleapis.com/kubernetes-release/release/`curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt`/bin/linux/amd64/kubectl
chmod +x ./kubectl
sudo mv ./kubectl /usr/local/bin/kubectl
```
## Installing AWS CLI Tools
### Darwin (MacOS)
### MacOS
The officially supported way of installing the tool is with `pip` as in
The officially supported way of installing the tool is with `pip`:
```bash
pip install awscli