From 2a770229484975e5df1487d3c43a518bfc7a891c Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Mon, 30 Jan 2017 14:53:01 -0500 Subject: [PATCH] Combine install and build instructions Previously this information was scattered in multiple places, combine this into one location. --- docs/aws.md | 27 ++------------------------- docs/{build.md => install.md} | 29 +++++++++++++++++++++++++++-- 2 files changed, 29 insertions(+), 27 deletions(-) rename docs/{build.md => install.md} (72%) diff --git a/docs/aws.md b/docs/aws.md index 908b41b3c0..9c3753286f 100644 --- a/docs/aws.md +++ b/docs/aws.md @@ -2,38 +2,15 @@

- - # Getting Started ## Install kops -From Homebrew: - -```bash -brew update && brew install --HEAD kops -``` - -From Source: - -```bash -go get -d k8s.io/kops -cd ${GOPATH}/src/k8s.io/kops/ -git checkout release -make -``` - -See our [installation guide](build.md) for more information +Before we can bring up the cluster we need to [install the CLI tool](install.md) `kops`. ## Install kubectl -It is a good idea to grab a fresh copy of `kubectl` now if you don't already have it. - -#### OS X - -``` -brew install kubernetes-cli -``` +In order to control Kubernetes clusters we need to [install the CLI tool](install.md) `kubectl`. #### Other Platforms diff --git a/docs/build.md b/docs/install.md similarity index 72% rename from docs/build.md rename to docs/install.md index c8bc65bcc6..ec988ddfe3 100644 --- a/docs/build.md +++ b/docs/install.md @@ -1,4 +1,30 @@ -# Building from source +# Installing Kops (Binaries) + +## Darwin (MacOS) + +From Homebrew: + +```bash +brew update && brew install --HEAD kops +``` + + +# Installing Kubectl + +`kubectl` is the CLI tool to manage and operate Kubernetes clusters. You can install it as follows. + +## Darwin (MacOS) + +``` +brew install kubernetes-cli +``` + +## Other Platforms + +* [Kubernetes Latest Release](https://github.com/kubernetes/kubernetes/releases/latest) +* [Installation Guide](http://kubernetes.io/docs/user-guide/prereqs/) + +# Installing Kops (Source) ``` go get -d k8s.io/kops @@ -10,7 +36,6 @@ 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.