mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-07-31 23:37:01 +00:00
Merge pull request #9780 from amygdala/gettingstarted
gce 'getting started' cleanup.
This commit is contained in:
Saad Ali
commit
92e5992489
@ -1,5 +1,23 @@
|
||||
|
||||
## Getting started on Google Compute Engine
|
||||
|
||||
**Table of Contents**
|
||||
|
||||
- [Before you start](#before-you-start)
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Starting a cluster](#starting-a-cluster)
|
||||
- [Installing the kubernetes command line tools on your workstation](#installing-the-kubernetes-command-line-tools-on-your-workstation)
|
||||
- [Getting started with your cluster](#getting-started-with-your-cluster)
|
||||
- [Inspect your cluster](#inspect-your-cluster)
|
||||
- [Run some examples](#run-some-examples)
|
||||
- [Tearing down the cluster](#tearing-down-the-cluster)
|
||||
- [Customizing](#customizing)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [Project settings](#project-settings)
|
||||
- [Cluster initialization hang](#cluster-initialization-hang)
|
||||
- [SSH](#ssh)
|
||||
- [Networking](#networking)
|
||||
|
||||
The example below creates a Kubernetes cluster with 4 worker node Virtual Machines and a master Virtual Machine (i.e. 5 VMs in your cluster). This cluster is set up and controlled from your workstation (or wherever you find convenient).
|
||||
|
||||
### Before you start
|
||||
@ -11,13 +29,14 @@ If you want to use custom binaries or pure open source Kubernetes, please contin
|
||||
### Prerequisites
|
||||
|
||||
1. You need a Google Cloud Platform account with billing enabled. Visit the [Google Developers Console](http://cloud.google.com/console) for more details.
|
||||
1. Make sure you have the `gcloud preview` command line component installed. Simply run `gcloud preview` at the command line - if it asks to install any components, go ahead and install them. If it simply shows help text, you're good to go. This is required as the cluster setup script uses GCE [Instance Groups](https://cloud.google.com/compute/docs/instance-groups/), which are in the gcloud preview namespace. You will also need to enable `Compute Engine Instance Group Manager API` in the developers console. `gcloud` can be installed as a part of the [Google Cloud SDK](https://cloud.google.com/sdk/)
|
||||
1. Install `gcloud` as necessary. `gcloud` can be installed as a part of the [Google Cloud SDK](https://cloud.google.com/sdk/).
|
||||
1. Then, make sure you have the `gcloud preview` command line component installed. Run `gcloud preview` at the command line - if it asks to install any components, go ahead and install them. If it simply shows help text, you're good to go. This is required as the cluster setup script uses GCE [Instance Groups](https://cloud.google.com/compute/docs/instance-groups/), which are in the gcloud preview namespace. You will also need to **enable `Compute Engine Instance Group Manager API`** in the developers console.
|
||||
1. Make sure that gcloud is set to use the Google Cloud Platform project you want. You can check the current project using `gcloud config list project` and change it via `gcloud config set project <project-id>`.
|
||||
1. Make sure you have credentials for GCloud by running ` gcloud auth login`.
|
||||
1. Make sure you can start up a GCE VM from the command line. At least make sure you can do the [Create an instance](https://cloud.google.com/compute/docs/quickstart#create_an_instance) part of the GCE Quickstart.
|
||||
1. Make sure you can ssh into the VM without interactive prompts. See the [Log in to the instance](https://cloud.google.com/compute/docs/quickstart#ssh) part of the GCE Quickstart.
|
||||
|
||||
### Starting a Cluster
|
||||
### Starting a cluster
|
||||
|
||||
You can install a client and start a cluster with this command:
|
||||
|
||||
@ -27,7 +46,15 @@ curl -sS https://get.k8s.io | bash
|
||||
|
||||
Once this command completes, you will have a master VM and four worker VMs, running as a Kubernetes cluster. By default, some containers will already be running on your cluster. Containers like `kibana` and `elasticsearch` provide [logging](../logging.md), while `heapster` provides [monitoring](../../cluster/addons/cluster-monitoring/README.md) services.
|
||||
|
||||
If you run into trouble please see the section on [troubleshooting](gce.md#troubleshooting), or come ask questions on IRC at #google-containers on freenode.
|
||||
Alternately, if you prefer, you can download and install the latest Kubernetes release from [this page](https://github.com/GoogleCloudPlatform/kubernetes/releases), then run the `<kubernetes>/cluster/kube-up.sh` script to start the cluster:
|
||||
|
||||
```bash
|
||||
cd kubernetes
|
||||
cluster/kube-up.sh
|
||||
```
|
||||
|
||||
If you run into trouble, please see the section on [troubleshooting](gce.md#troubleshooting), post to the
|
||||
[google-containers group](https://groups.google.com/forum/#!forum/google-containers), or come ask questions on IRC at #google-containers on freenode.
|
||||
|
||||
The next few steps will show you:
|
||||
|
||||
@ -39,6 +66,10 @@ The next few steps will show you:
|
||||
### Installing the kubernetes command line tools on your workstation
|
||||
|
||||
The cluster startup script will leave you with a running cluster and a ```kubernetes``` directory on your workstation.
|
||||
The next step is to make sure the `kubectl` tool is in your path.
|
||||
|
||||
The [kubectl](../kubectl.md) tool controls the Kubernetes cluster manager. It lets you inspect your cluster resources, create, delete, and update components, and much more.
|
||||
You will use it to look at your new cluster and bring up example apps.
|
||||
|
||||
Add the appropriate binary folder to your ```PATH``` to access kubectl:
|
||||
|
||||
@ -50,15 +81,62 @@ export PATH=<path/to/kubernetes-directory>/platforms/darwin/amd64:$PATH
|
||||
export PATH=<path/to/kubernetes-directory>/platforms/linux/amd64:$PATH
|
||||
```
|
||||
|
||||
Note: gcloud also ships with ```kubectl```, which by default is added to your path.
|
||||
**Note**: gcloud also ships with ```kubectl```, which by default is added to your path.
|
||||
However the gcloud bundled kubectl version may be older than the one downloaded by the
|
||||
get.k8s.io install script. We recommend you use the downloaded binary to avoid
|
||||
potential issues with client/server version skew.
|
||||
|
||||
### Getting started with your cluster
|
||||
See [a simple nginx example](../../examples/simple-nginx.md) to try out your new cluster.
|
||||
|
||||
For more complete applications, please look in the [examples directory](../../examples).
|
||||
#### Inspect your cluster
|
||||
|
||||
Once `kubectl` is in your path, you can use it to look at your cluster. E.g., running:
|
||||
|
||||
```shell
|
||||
$ kubectl get services
|
||||
```
|
||||
|
||||
should show a set of [services](../services.md) that look something like this:
|
||||
|
||||
```shell
|
||||
NAME LABELS SELECTOR IP(S) PORT(S)
|
||||
elasticsearch-logging k8s-app=elasticsearch-logging,kubernetes.io/cluster-service=true,kubernetes.io/name=Elasticsearch k8s-app=elasticsearch-logging 10.0.198.255 9200/TCP
|
||||
kibana-logging k8s-app=kibana-logging,kubernetes.io/cluster-service=true,kubernetes.io/name=Kibana k8s-app=kibana-logging 10.0.56.44 5601/TCP
|
||||
kube-dns k8s-app=kube-dns,kubernetes.io/cluster-service=true,kubernetes.io/name=KubeDNS k8s-app=kube-dns 10.0.0.10 53/UDP
|
||||
kubernetes component=apiserver,provider=kubernetes <none> 10.0.0.1 443/TCP
|
||||
```
|
||||
|
||||
Similarly, you can take a look at the set of [pods](../pods.md) that were created during cluster startup.
|
||||
You can do this via the
|
||||
|
||||
```shell
|
||||
$ kubectl get pods
|
||||
```
|
||||
command.
|
||||
|
||||
You'll see see a list of pods that looks something like this (the name specifics will be different):
|
||||
|
||||
```shell
|
||||
NAME READY REASON RESTARTS AGE
|
||||
NAME READY REASON RESTARTS AGE
|
||||
elasticsearch-logging-v1-ab87r 1/1 Running 0 1m
|
||||
elasticsearch-logging-v1-v9lqa 1/1 Running 0 1m
|
||||
fluentd-elasticsearch-kubernetes-minion-419y 1/1 Running 0 12s
|
||||
fluentd-elasticsearch-kubernetes-minion-k0xh 1/1 Running 0 1m
|
||||
fluentd-elasticsearch-kubernetes-minion-oa8l 1/1 Running 0 1m
|
||||
fluentd-elasticsearch-kubernetes-minion-xuj5 1/1 Running 0 1m
|
||||
kibana-logging-v1-cx2p8 1/1 Running 0 1m
|
||||
kube-dns-v3-pa3w9 3/3 Running 0 1m
|
||||
monitoring-heapster-v1-m1xkz 1/1 Running 0 1m
|
||||
```
|
||||
|
||||
Some of the pods may take a few seconds to start up (during this time they'll show `Pending`), but check that they all show as `Running` after a short period.
|
||||
|
||||
#### Run some examples
|
||||
|
||||
Then, see [a simple nginx example](../../examples/simple-nginx.md) to try out your new cluster.
|
||||
|
||||
For more complete applications, please look in the [examples directory](../../examples). The [guestbook example](../../examples/guestbook) is a good "getting started" walkthrough.
|
||||
|
||||
### Tearing down the cluster
|
||||
To remove/delete/teardown the cluster, use the `kube-down.sh` script.
|
||||
@ -88,11 +166,13 @@ can be done in the Google Cloud Console. See the [Google Cloud Storage JSON
|
||||
API Overview](https://cloud.google.com/storage/docs/json_api/) for more
|
||||
details.
|
||||
|
||||
Also ensure that-- as listed in the [Prerequsites section](#prerequisites)-- you've enabled the `Compute Engine Instance Group Manager API`, and can start up a GCE VM from the command line as in the [GCE Quickstart](https://cloud.google.com/compute/docs/quickstart) instructions.
|
||||
|
||||
#### Cluster initialization hang
|
||||
|
||||
If the Kubernetes startup script hangs waiting for the API to be reachable, you can troubleshoot by SSHing into the master and minion VMs and looking at logs such as `/var/log/startupscript.log`.
|
||||
|
||||
Once you fix the issue, you should run `kube-down.sh` to cleanup after the partial cluster creation, before running `kube-up.sh` to try again.
|
||||
**Once you fix the issue, you should run `kube-down.sh` to cleanup** after the partial cluster creation, before running `kube-up.sh` to try again.
|
||||
|
||||
#### SSH
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user