Skip to content

K
k3s
Commit 9b3ab4d6 authored by qiaolei's avatar qiaolei Committed by root
Browse files
Options

Fix some errors in guestbook-go

Fix some errors in guestbook-go README.md: 1. fix some markdown errors by removing the `<nop>` tag 2. replace some (not all of them) `containers` with `pods` 3. `gcloud comput` -> `gcloud compute` 4. improved sentences that has `list all` to make the descriptions more accurate 5. other tiny fixes
parent 360d0e0a
Hide whitespace changes
Inline Side-by-side
Showing with 18 additions and 18 deletions
examples/guestbook-go/README.md
View file @ 9b3ab4d6
...@@ -59,14 +59,14 @@ This example assumes that you have a working cluster. See the [Getting Started G ...@@ -59,14 +59,14 @@ This example assumes that you have a working cluster. See the [Getting Started G
Use the `examples/guestbook-go/redis-master-controller.json` file to create a [replication controller](../../docs/user-guide/replication-controller.md) and Redis master [pod](../../docs/user-guide/pods.md). The pod runs a Redis key-value server in a container. Using a replication controller is the preferred way to launch long-running pods, even for 1 replica, so that the pod benefits from the self-healing mechanism in Kubernetes (keeps the pods alive). Use the `examples/guestbook-go/redis-master-controller.json` file to create a [replication controller](../../docs/user-guide/replication-controller.md) and Redis master [pod](../../docs/user-guide/pods.md). The pod runs a Redis key-value server in a container. Using a replication controller is the preferred way to launch long-running pods, even for 1 replica, so that the pod benefits from the self-healing mechanism in Kubernetes (keeps the pods alive).
<nop>1. Use the [redis-master-controller.json](redis-master-controller.json) file to create the Redis master replication controller in your Kubernetes cluster by running the `kubectl create -f` *`filename`* command: 1. Use the [redis-master-controller.json](redis-master-controller.json) file to create the Redis master replication controller in your Kubernetes cluster by running the `kubectl create -f` *`filename`* command:
```console ```console
$ kubectl create -f examples/guestbook-go/redis-master-controller.json $ kubectl create -f examples/guestbook-go/redis-master-controller.json
replicationcontrollers/redis-master replicationcontrollers/redis-master
``` ```
<nop>2. To verify that the redis-master-controller is up, list all the replication controllers in the cluster with the `kubectl get rc` command: 2. To verify that the redis-master controller is up, list the replication controllers you created in the cluster with the `kubectl get rc` command(if you don't specify a `--namespace`, the `default` namespace will be used. The same below):
```console ```console
$ kubectl get rc $ kubectl get rc
...@@ -77,7 +77,7 @@ Use the `examples/guestbook-go/redis-master-controller.json` file to create a [r ...@@ -77,7 +77,7 @@ Use the `examples/guestbook-go/redis-master-controller.json` file to create a [r
Result: The replication controller then creates the single Redis master pod. Result: The replication controller then creates the single Redis master pod.
<nop>3. To verify that the redis-master pod is running, list all the pods in cluster with the `kubectl get pods` command: 3. To verify that the redis-master pod is running, list the pods you created in cluster with the `kubectl get pods` command:
```console ```console
$ kubectl get pods $ kubectl get pods
...@@ -88,7 +88,7 @@ Use the `examples/guestbook-go/redis-master-controller.json` file to create a [r ...@@ -88,7 +88,7 @@ Use the `examples/guestbook-go/redis-master-controller.json` file to create a [r
Result: You'll see a single Redis master pod and the machine where the pod is running after the pod gets placed (may take up to thirty seconds). Result: You'll see a single Redis master pod and the machine where the pod is running after the pod gets placed (may take up to thirty seconds).
<nop>4. To verify what containers are running in the redis-master pod, you can SSH to that machine with `gcloud comput ssh --zone` *`zone_name`* *`host_name`* and then run `docker ps`: 4. To verify what containers are running in the redis-master pod, you can SSH to that machine with `gcloud compute ssh --zone` *`zone_name`* *`host_name`* and then run `docker ps`:
```console ```console
me@workstation$ gcloud compute ssh --zone us-central1-b kubernetes-minion-bz1p me@workstation$ gcloud compute ssh --zone us-central1-b kubernetes-minion-bz1p
...@@ -102,18 +102,18 @@ Use the `examples/guestbook-go/redis-master-controller.json` file to create a [r ...@@ -102,18 +102,18 @@ Use the `examples/guestbook-go/redis-master-controller.json` file to create a [r
### Step Two: Create the Redis master service <a id="step-two"></a> ### Step Two: Create the Redis master service <a id="step-two"></a>
A Kubernetes '[service](../../docs/user-guide/services.md)' is a named load balancer that proxies traffic to one or more containers. The services in a Kubernetes cluster are discoverable inside other containers via environment variables or DNS. A Kubernetes [service](../../docs/user-guide/services.md) is a named load balancer that proxies traffic to one or more pods. The services in a Kubernetes cluster are discoverable inside other pods via environment variables or DNS.
Services find the containers to load balance based on pod labels. The pod that you created in Step One has the label `app=redis` and `role=master`. The selector field of the service determines which pods will receive the traffic sent to the service. Services find the pods to load balance based on pod labels. The pod that you created in Step One has the label `app=redis` and `role=master`. The selector field of the service determines which pods will receive the traffic sent to the service.
<nop>1. Use the [redis-master-service.json](redis-master-service.json) file to create the service in your Kubernetes cluster by running the `kubectl create -f` *`filename`* command: 1. Use the [redis-master-service.json](redis-master-service.json) file to create the service in your Kubernetes cluster by running the `kubectl create -f` *`filename`* command:
```console ```console
$ kubectl create -f examples/guestbook-go/redis-master-service.json $ kubectl create -f examples/guestbook-go/redis-master-service.json
services/redis-master services/redis-master
``` ```
<nop>2. To verify that the redis-master service is up, list all the services in the cluster with the `kubectl get services` command: 2. To verify that the redis-master service is up, list the services you created in the cluster with the `kubectl get services` command:
```console ```console
$ kubectl get services $ kubectl get services
...@@ -129,14 +129,14 @@ Services find the containers to load balance based on pod labels. The pod that y ...@@ -129,14 +129,14 @@ Services find the containers to load balance based on pod labels. The pod that y
The Redis master we created earlier is a single pod (REPLICAS = 1), while the Redis read slaves we are creating here are 'replicated' pods. In Kubernetes, a replication controller is responsible for managing the multiple instances of a replicated pod. The Redis master we created earlier is a single pod (REPLICAS = 1), while the Redis read slaves we are creating here are 'replicated' pods. In Kubernetes, a replication controller is responsible for managing the multiple instances of a replicated pod.
<nop>1. Use the file [redis-slave-controller.json](redis-slave-controller.json) to create the replication controller by running the `kubectl create -f` *`filename`* command: 1. Use the file [redis-slave-controller.json](redis-slave-controller.json) to create the replication controller by running the `kubectl create -f` *`filename`* command:
```console ```console
$ kubectl create -f examples/guestbook-go/redis-slave-controller.json $ kubectl create -f examples/guestbook-go/redis-slave-controller.json
replicationcontrollers/redis-slave replicationcontrollers/redis-slave
``` ```
<nop>2. To verify that the guestbook replication controller is running, run the `kubectl get rc` command: 2. To verify that the redis-slave controller is running, run the `kubectl get rc` command:
```console ```console
$ kubectl get rc $ kubectl get rc
...@@ -155,7 +155,7 @@ The Redis master we created earlier is a single pod (REPLICAS = 1), while the Re ...@@ -155,7 +155,7 @@ The Redis master we created earlier is a single pod (REPLICAS = 1), while the Re
redis-server --slaveof redis-master 6379 redis-server --slaveof redis-master 6379
``` ```
<nop>3. To verify that the Redis master and slaves pods are running, run the `kubectl get pods` command: 3. To verify that the Redis master and slaves pods are running, run the `kubectl get pods` command:
```console ```console
$ kubectl get pods $ kubectl get pods
...@@ -172,14 +172,14 @@ The Redis master we created earlier is a single pod (REPLICAS = 1), while the Re ...@@ -172,14 +172,14 @@ The Redis master we created earlier is a single pod (REPLICAS = 1), while the Re
Just like the master, we want to have a service to proxy connections to the read slaves. In this case, in addition to discovery, the Redis slave service provides transparent load balancing to clients. Just like the master, we want to have a service to proxy connections to the read slaves. In this case, in addition to discovery, the Redis slave service provides transparent load balancing to clients.
<nop>1. Use the [redis-slave-service.json](redis-slave-service.json) file to create the Redis slave service by running the `kubectl create -f` *`filename`* command: 1. Use the [redis-slave-service.json](redis-slave-service.json) file to create the Redis slave service by running the `kubectl create -f` *`filename`* command:
```console ```console
$ kubectl create -f examples/guestbook-go/redis-slave-service.json $ kubectl create -f examples/guestbook-go/redis-slave-service.json
services/redis-slave services/redis-slave
``` ```
<nop>2. To verify that the redis-slave service is up, list all the services in the cluster with the `kubectl get services` command: 2. To verify that the redis-slave service is up, list the services you created in the cluster with the `kubectl get services` command:
```console ```console
$ kubectl get services $ kubectl get services
...@@ -197,14 +197,14 @@ Tip: It is helpful to set labels on your services themselves--as we've done here ...@@ -197,14 +197,14 @@ Tip: It is helpful to set labels on your services themselves--as we've done here
This is a simple Go `net/http` ([negroni](https://github.com/codegangsta/negroni) based) server that is configured to talk to either the slave or master services depending on whether the request is a read or a write. The pods we are creating expose a simple JSON interface and serves a jQuery-Ajax based UI. Like the Redis read slaves, these pods are also managed by a replication controller. This is a simple Go `net/http` ([negroni](https://github.com/codegangsta/negroni) based) server that is configured to talk to either the slave or master services depending on whether the request is a read or a write. The pods we are creating expose a simple JSON interface and serves a jQuery-Ajax based UI. Like the Redis read slaves, these pods are also managed by a replication controller.
<nop>1. Use the [guestbook-controller.json](guestbook-controller.json) file to create the guestbook replication controller by running the `kubectl create -f` *`filename`* command: 1. Use the [guestbook-controller.json](guestbook-controller.json) file to create the guestbook replication controller by running the `kubectl create -f` *`filename`* command:
```console ```console
$ kubectl create -f examples/guestbook-go/guestbook-controller.json $ kubectl create -f examples/guestbook-go/guestbook-controller.json
replicationcontrollers/guestbook replicationcontrollers/guestbook
``` ```
<nop>2. To verify that the guestbook replication controller is running, run the `kubectl get rc` command: 2. To verify that the guestbook replication controller is running, run the `kubectl get rc` command:
```console ```console
$ kubectl get rc $ kubectl get rc
...@@ -215,7 +215,7 @@ This is a simple Go `net/http` ([negroni](https://github.com/codegangsta/negroni ...@@ -215,7 +215,7 @@ This is a simple Go `net/http` ([negroni](https://github.com/codegangsta/negroni
... ...
``` ```
<nop>3. To verify that the guestbook pods are running (it might take up to thirty seconds to create the pods), list all the pods in cluster with the `kubectl get pods` command: 3. To verify that the guestbook pods are running (it might take up to thirty seconds to create the pods), list the pods you created in cluster with the `kubectl get pods` command:
```console ```console
$ kubectl get pods $ kubectl get pods
...@@ -235,14 +235,14 @@ This is a simple Go `net/http` ([negroni](https://github.com/codegangsta/negroni ...@@ -235,14 +235,14 @@ This is a simple Go `net/http` ([negroni](https://github.com/codegangsta/negroni
Just like the others, we create a service to group the guestbook pods but this time, to make the guestbook front-end externally visible, we specify `"type": "LoadBalancer"`. Just like the others, we create a service to group the guestbook pods but this time, to make the guestbook front-end externally visible, we specify `"type": "LoadBalancer"`.
<nop>1. Use the [guestbook-service.json](guestbook-service.json) file to create the guestbook service by running the `kubectl create -f` *`filename`* command: 1. Use the [guestbook-service.json](guestbook-service.json) file to create the guestbook service by running the `kubectl create -f` *`filename`* command:
```console ```console
$ kubectl create -f examples/guestbook-go/guestbook-service.json $ kubectl create -f examples/guestbook-go/guestbook-service.json
``` ```
<nop>2. To verify that the guestbook service is up, list all the services in the cluster with the `kubectl get services` command: 2. To verify that the guestbook service is up, list the services you created in the cluster with the `kubectl get services` command:
```console ```console
$ kubectl get services $ kubectl get services
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment