Misc. doc updates: Go setup, ssh reqd. on GCE, etcd reqd. for local, moved community links to wiki

pull/6/head
Brian Grant 2014-09-11 20:10:49 +00:00
parent 7de0989a4e
commit 276df0bf2a
4 changed files with 36 additions and 18 deletions

View File

@ -39,10 +39,7 @@ Check out examples of Kubernetes in action, and community projects in the larger
* [Detailed example application](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/examples/guestbook/README.md)
* [Example of dynamic updates](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/examples/update-demo/README.md)
* [Cluster monitoring with heapster and cAdvisor](https://github.com/GoogleCloudPlatform/heapster)
* [OpenShift 3 and developer focused workflows](https://github.com/openshift/origin)
* [Kubernetes-on-Mesos framework](https://github.com/mesosphere/kubernetes-mesos)
* [Configure dynamic container networking with CoreOS Rudder](https://coreos.com/blog/introducing-rudder/)
* [Azure Kubernetes visualizer](https://github.com/Azure/azure-kubernetes-visualizer)
* [Community projects](https://github.com/GoogleCloudPlatform/kubernetes/wiki/Kubernetes-Community)
Or fork and start hacking!
@ -58,7 +55,7 @@ If you are a company and are looking for a more formal engagement with Google ar
### Go development environment
Kubernetes is written in [Go](http://golang.org) programming language. If you haven't set up Go development environment, please follow [this instruction](http://golang.org/doc/code.html) to install go tool and set up GOPATH.
Kubernetes is written in [Go](http://golang.org) programming language. If you haven't set up Go development environment, please follow [this instruction](http://golang.org/doc/code.html) to install go tool and set up GOPATH. Ensure your version of Go is at least 1.3.
### Put kubernetes into GOPATH
@ -74,9 +71,11 @@ $ git clone git@github.com:GoogleCloudPlatform/kubernetes.git
The commands above will not work if there are more than one directory in ``$GOPATH``.
(Obviously, clone your own fork of Kubernetes if you plan to do development.)
### godep and dependency management
Kubernetes uses [godep](https://github.com/tools/godep) to manage dependencies. It is not required for building Kubernetes but it is required when managing dependencies under the Godeps/ tree. Please make sure that ``godep`` is installed and in your ``$PATH``.
Kubernetes uses [godep](https://github.com/tools/godep) to manage dependencies. It is not strictly required for building Kubernetes but it is required when managing dependencies under the Godeps/ tree, and is required by a number of the build and test scripts. Please make sure that ``godep`` is installed and in your ``$PATH``.
#### Installing godep
There are many ways to build and host go binaries. Here is an easy way to get utilities like ```godep``` installed:
@ -86,14 +85,15 @@ source control system). Use ```apt-get install mercurial``` or ```yum install m
directly from mercurial.
2. Create a new GOPATH for your tools and install godep:
```
GOPATH=$HOME/src/go-tools
export GOPATH=$HOME/go-tools
mkdir -p $GOPATH
go get github.com/tools/godep
```
3. Add $HOME/src/go-tools/bin to your path. Typically you'd add this to your ~/.profile:
3. Add $GOPATH/bin to your path. Typically you'd add this to your ~/.profile:
```
export PATH=$PATH:$HOME/src/go-tools/bin
export GOPATH=$HOME/go-tools
export PATH=$PATH:$GOPATH/bin
```
#### Using godep

View File

@ -5,12 +5,13 @@
1. You need a Google Cloud Platform account with billing enabled. Visit
[http://cloud.google.com/console](http://cloud.google.com/console) for more details.
2. Make sure you can start up a GCE VM. At least make sure you can do the [Create an instance](https://developers.google.com/compute/docs/quickstart#addvm) part of the GCE Quickstart.
3. You need to have the Google Storage API, and the Google Storage JSON API enabled.
4. You must have Go (version 1.2 or later) installed: [www.golang.org](http://www.golang.org).
5. You must have the [`gcloud` components](https://developers.google.com/cloud/sdk/) installed.
6. Ensure that your `gcloud` components are up-to-date by running `gcloud components update`.
7. Install godep (optional, only required when modifying package dependencies). [Instructions here](https://github.com/GoogleCloudPlatform/kubernetes#installing-godep)
8. Get the Kubernetes source:
3. Make sure you can ssh into the VM without interactive prompts. You'll need to set up a ssh key and expose port 22 in the firewall if you choose to use a network other than the default network (`gcutil addfirewall --description "SSH allowed from anywhere" --allowed=tcp:22 default-ssh`)
4. You need to have the Google Storage API, and the Google Storage JSON API enabled.
5. You must have Go (version 1.2 or later) installed: [www.golang.org](http://www.golang.org).
6. You must have the [`gcloud` components](https://developers.google.com/cloud/sdk/) installed.
7. Ensure that your `gcloud` components are up-to-date by running `gcloud components update`.
8. Install godep (optional, only required when modifying package dependencies). [Instructions here](https://github.com/GoogleCloudPlatform/kubernetes#installing-godep)
9. Get the Kubernetes source:
* Kubernetes 0.2 \[[.tar.gz](https://github.com/GoogleCloudPlatform/kubernetes/archive/v0.2.tar.gz)\] \[[.zip](https://github.com/GoogleCloudPlatform/kubernetes/archive/v0.2.zip)\]
### Setup

View File

@ -2,11 +2,28 @@
### Requirements
- Linux
- Docker 1.0.0+
#### Linux
Not running Linux? Consider running Linux in a local virtual machine with [Vagrant](vagrant.md), or on a cloud provider like [Google Compute Engine](gce.md)
#### Docker
At least Docker 1.0.0+. Ensure the Docker daemon is running and can be contacted by the user you plan to run as (try `docker ps`).
#### etcd
You need an etcd somewhere in your path. To get from head:
```
go get github.com/coreos/etcd
go install github.com/coreos/etcd
sudo ln -s "$GOPATH/bin/etcd" /usr/bin/etcd
# Or just use the packaged one:
sudo ln -s "$REPO_ROOT/target/bin/etcd" /usr/bin/etcd
```
### Starting the cluster
In a separate tab of your terminal, run:
```

View File

@ -6,7 +6,7 @@ The example combines a web frontend, a redis master for storage and a replicated
### Step Zero: Prerequisites
This example assumes that you have forked the repository and [turned up a Kubernetes cluster](https://github.com/GoogleCloudPlatform/kubernetes-new#contents):
This example assumes that you have forked the repository and [turned up a Kubernetes cluster](https://github.com/GoogleCloudPlatform/kubernetes#contents):
### Step One: Turn up the redis master.