From 9a065638e1de81c8a608b0b7a93c18ca30e109f7 Mon Sep 17 00:00:00 2001 From: Alex Chesser Date: Thu, 19 Nov 2015 23:07:19 -0500 Subject: [PATCH] Included explicit instructions for obtaining code A novice may require this additional step and might not know that the kubernetes repository is sufficient to run the code locally. --- docs/getting-started-guides/locally.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/getting-started-guides/locally.md b/docs/getting-started-guides/locally.md index 1ab64ddc8b4..b98bb5d35c4 100644 --- a/docs/getting-started-guides/locally.md +++ b/docs/getting-started-guides/locally.md @@ -40,6 +40,7 @@ Getting started locally - [Docker](#docker) - [etcd](#etcd) - [go](#go) +- [Clone the repository](#clone-the-repository) - [Starting the cluster](#starting-the-cluster) - [Running a container](#running-a-container) - [Running a user defined pod](#running-a-user-defined-pod) @@ -71,6 +72,14 @@ You need an [etcd](https://github.com/coreos/etcd/releases) in your path, please You need [go](https://golang.org/doc/install) at least 1.3+ in your path, please make sure it is installed and in your ``$PATH``. +### Clone the repository + +In order to run kubernetes you must have the kubernetes code on the local machine. Cloning this repository is sufficient. + +```$ git clone --depth=1 https://github.com/kubernetes/kubernetes.git``` + +The `--depth=1` parameter is optional and will ensure a smaller download. + ### Starting the cluster In a separate tab of your terminal, run the following (since one needs sudo access to start/stop Kubernetes daemons, it is easier to run the entire script as root):