Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use replication controller for redis master. #4133

Merged
merged 1 commit into from
Feb 4, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 8 additions & 10 deletions docs/getting-started-guides/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
IaaS Provider | Config. Mgmt | OS | Docs | Support Level | Notes
-------------- | ------------ | ------ | ---------------------------------------------------- | ---------------------------- | -----
GCE | Saltstack | Debian | [docs](../../docs/getting-started-guides/gce.md) | Project | Tested with 0.9.2 by @satnam6502
IaaS Provider | Config. Mgmt | OS | Docs | Support Level | Notes
-------------- | ------------ | ------ | ---------------------------------------------------- | ---------------------------- | -----
GCE | Saltstack | Debian | [docs](../../docs/getting-started-guides/gce.md) | Project | Tested with 0.9.2 by @satnam6502
Vagrant | Saltstack | Fedora | [docs](../../docs/getting-started-guides/vagrant.md) | Project |
Vagrant | | Fedora | [docs](../../docs/getting-started-guides/fedora/fedora_manual_config.md) | Project | Uses K8s v0.5-8
Vagrant | Ansible | Fedora | [docs](../../docs/getting-started-guides/fedora/fedora_ansible.md) | Project | Uses K8s v0.5-8
Expand All @@ -10,12 +10,12 @@ GCE | CoreOS | CoreOS | [docs](../../docs/getting-started-guide
Vagrant | CoreOS | CoreOS | [docs](../../docs/getting-started-guides/coreos.md) | Community (@pires) | Uses K8s version 0.9.1
CloudStack | Ansible | CoreOS | [docs](../../docs/getting-started-guides/cloudstack.md)| Community (@sebgoa) | Uses K8s version 0.9.1
Vmware | | Debian | [docs](../../docs/getting-started-guides/vsphere.md) | Community (@pietern) | Uses K8s version 0.9.1
AWS | Saltstack | Ubuntu | [docs](../../docs/getting-started-guides/aws.md) | Community (@justinsb) | Uses K8s version 0.5.0
AWS | Saltstack | Ubuntu | [docs](../../docs/getting-started-guides/aws.md) | Community (@justinsb) | Uses K8s version 0.5.0
Vmware | CoreOS | CoreOS | [docs](../../docs/getting-started-guides/coreos.md) | Community (@kelseyhightower) |
Azure | Saltstack | Ubuntu | [docs](../../docs/getting-started-guides/azure.md) | Community (@jeffmendoza) |
Local | | | [docs](../../docs/getting-started-guides/locally.md) | Inactive |
Azure | Saltstack | Ubuntu | [docs](../../docs/getting-started-guides/azure.md) | Community (@jeffmendoza) |
Local | | | [docs](../../docs/getting-started-guides/locally.md) | Inactive |
Ovirt | | | [docs](../../docs/getting-started-guides/ovirt.md) | Inactive |
Rackspace | CoreOS | CoreOS | [docs](../../docs/getting-started-guides/rackspace.md) | Inactive |
Rackspace | CoreOS | CoreOS | [docs](../../docs/getting-started-guides/rackspace.md) | Inactive |

Definition of columns:
- **IaaS Provider** is who/what provides the virtual or physical machines (nodes) that Kubernetes runs on.
Expand All @@ -24,9 +24,7 @@ Definition of columns:
nodes.
- Support Levels
- **Project**: Kubernetes Committers regularly use this configuration, so it usually works with the latest release
of Kubernetes.
of Kubernetes.
- **Commercial**: A commercial offering with its own support arrangements.
- **Community**: Actively supported by community contributions. May not work with more recent releases of kubernetes.
- **Inactive**: No active maintainer. Not recommended for first-time K8s users, and may be deleted soon.


101 changes: 48 additions & 53 deletions examples/guestbook-go/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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#contents):
This example assumes that you have forked the repository and [turned up a Kubernetes cluster](../../docs/getting-started-guides):

```shell
$ cd kubernetes
Expand All @@ -15,71 +15,68 @@ $ hack/dev-build-and-up.sh

### Step One: Turn up the redis master.

Use the file `examples/guestbook-go/redis-master-pod.json` which describes a single pod running a redis key-value server in a container.
Use the file `examples/guestbook-go/redis-master-controller.json` to create a replication controller which manages a single pod. 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 the pod will benefit from self-healing mechanism in kubernetes.

Create the redis pod in your Kubernetes cluster using the `kubectl` CLI:
Create the redis master replication controller in your Kubernetes cluster using the `kubectl` CLI:

```shell
$ cluster/kubectl.sh create -f examples/guestbook-go/redis-master-pod.json
$ cluster/kubectl.sh create -f examples/guestbook-go/redis-master-controller.json
```

Once that's up you can list the pods in the cluster, to verify that the master is running:

Once that's up you can list the replication controllers in the cluster:
```shell
$ cluster/kubectl.sh get pods
$ cluster/kubectl.sh get rc
CONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS
redis-master-controller redis-master gurpartap/redis name=redis,role=master 1
```

You'll see a single redis master pod. It will also display the machine that the pod is running on once it gets placed (may take up to thirty seconds).
List pods in cluster to verify the master is running. You'll see a single redis master pod. It will also display the machine that the pod is running on once it gets placed (may take up to thirty seconds).

```
ID IMAGE(S) HOST LABELS STATUS
redis-master-pod gurpartap/redis kubernetes-minion-3.c.thockin-dev.internal/86.75.30.9 name=redis,role=master Waiting
```shell
$ cluster/kubectl.sh get pods
POD IP CONTAINER(S) IMAGE(S) HOST LABELS STATUS
redis-master-pod-hh2gd 10.244.3.7 redis-master gurpartap/redis kubernetes-minion-4.c.lucid-walker-725.internal/104.154.49.134 name=redis,role=master Running
```

If you ssh to that machine, you can run `docker ps` to see the actual pod:

```shell
me@workstation$ gcloud compute ssh --zone us-central1-b kubernetes-minion-3
me@workstation$ gcloud compute ssh --zone us-central1-b kubernetes-minion-4

me@kubernetes-minion-3:~$ sudo docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS
e443647cd064 gurpartap/redis:latest redis-server /etc/r 2 minutes ago Up 2 minutes
CONTAINER ID IMAGE COMMAND CREATED STATUS
d5c458dabe50 gurpartap/redis:latest "/usr/local/bin/redi 5 minutes ago Up 5 minutes
```

(Note that initial `docker pull` may take a few minutes, depending on network conditions.)

### Step Two: Turn up the master service.
A Kubernetes 'service' 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. Services find the containers to load balance based on pod labels.

The pod that you created in Step One has the label `name=redis` and `role=master`. The selector field of the service determines which pods will receive the traffic sent to the service. Use the file `examples/guestbook-go/redis-master-service.json`

To create the service with the `kubectl` cli:
The pod that you created in Step One has the label `name=redis` and `role=master`. The selector field of the service determines which pods will receive the traffic sent to the service. Use the file `examples/guestbook-go/redis-master-service.json` to create the service in the `kubectl` cli:

```shell
$ cluster/kubectl.sh create -f examples/guestbook-go/redis-master-service.json

$ cluster/kubectl.sh get services
ID LABELS SELECTOR PORT
redis-master name=redis,role=master 6379
NAME LABELS SELECTOR IP PORT
redis-master <none> name=redis,role=master 10.0.186.234 6379
```

This will cause all new pods to see the redis master apparently running on $REDIS_MASTER_SERVICE_HOST at port 6379.

Once created, the service proxy on each minion is configured to set up a proxy on the specified port (in this case port 6379).
This will cause all new pods to see the redis master apparently running on $REDIS_MASTER_SERVICE_HOST at port 6379. Once created, the service proxy on each node is configured to set up a proxy on the specified port (in this case port 6379).

### Step Three: Turn up the replicated slave pods.
Although the redis master is a single pod, the redis read slaves are a 'replicated' pod. In Kubernetes, a replication controller is responsible for managing multiple instances of a replicated pod.

Use the file `examples/guestbook-go/redis-slave-controller.json`

to create the replication controller by running:
Use the file `examples/guestbook-go/redis-slave-controller.json` to create the replication controller:

```shell
$ cluster/kubectl.sh create -f examples/guestbook-go/redis-slave-controller.json

$ cluster/kubectl.sh get replicationControllers
ID IMAGE(S) SELECTOR REPLICAS
redis-slave-controller gurpartap/redis name=redis,role=slave 2
$ cluster/kubectl.sh get rc
CONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS
redis-master-controller redis-master gurpartap/redis name=redis,role=master 1
redis-slave-controller redis-slave gurpartap/redis name=redis,role=slave 2
```

The redis slave configures itself by looking for the Kubernetes service environment variables in the container environment. In particular, the redis slave is started with the following command:
Expand All @@ -92,10 +89,10 @@ Once that's up you can list the pods in the cluster, to verify that the master a

```shell
$ cluster/kubectl.sh get pods
ID IMAGE(S) HOST LABELS STATUS
redis-master-pod gurpartap/redis kubernetes-minion-1.c.thockin-dev.internal/86.75.30.9 name=redis,role=master Running
1472fd26-54d6-11e4-90fd-42010af00690 gurpartap/redis kubernetes-minion-4.c.thockin-dev.internal/12.34.56.78 name=redis,replicationController=redis-slave-controller,role=slave Running
1473363e-54d6-11e4-90fd-42010af00690 gurpartap/redis kubernetes-minion-3.c.thockin-dev.internal/9.3.19.76 name=redis,replicationController=redis-slave-controller,role=slave Running
POD IP CONTAINER(S) IMAGE(S) HOST LABELS STATUS
redis-master-pod-hh2gd 10.244.3.7 redis-master gurpartap/redis kubernetes-minion-4.c.lucid-walker-725.internal/104.154.49.134 name=redis,role=master Running
redis-slave-controller-i7hvs 10.244.2.7 redis-slave gurpartap/redis kubernetes-minion-3.c.lucid-walker-725.internal/104.154.52.39 name=redis,role=slave Running
redis-slave-controller-nyxxv 10.244.1.6 redis-slave gurpartap/redis kubernetes-minion-2.c.lucid-walker-725.internal/130.211.144.5 name=redis,role=slave Running
```

You will see a single redis master pod and two redis slave pods.
Expand All @@ -112,40 +109,38 @@ Now that you have created the service specification, create it in your cluster w
$ cluster/kubectl.sh create -f examples/guestbook-go/redis-slave-service.json

$ cluster/kubectl.sh get services
ID LABELS SELECTOR PORT
redis-master name=redis,role=master 6379
redis-slave name=redis,role=slave name=redis,role=slave 6379
NAME LABELS SELECTOR IP PORT
redis-master <none> name=redis,role=master 10.0.186.234 6379
redis-slave name=redis,role=slave name=redis,role=slave 10.0.22.180 6379
```

### Step Five: Create the guestbook pod.

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. It exposes a simple JSON interface, and serves a jQuery-Ajax based UX. Like the redis read slaves it is a replicated service instantiated by a replication controller.

The pod is described in the file `examples/guestbook-go/guestbook-controller.json`:

Using this file, you can turn up your guestbook with:
The pod is described in the file `examples/guestbook-go/guestbook-controller.json`. Using this file, you can turn up your guestbook with:

```shell
$ cluster/kubectl.sh create -f examples/guestbook-go/guestbook-controller.json

$ cluster/kubectl.sh get replicationControllers
ID IMAGE(S) SELECTOR REPLICAS
redis-slave-controller gurpartap/redis name=redis,role=slave 2
guestbook-controller kubernetes/guestbook name=guestbook 3
CONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS
guestbook-controller guestbook kubernetes/guestbook name=guestbook 3
redis-master-controller redis-master gurpartap/redis name=redis,role=master 1
redis-slave-controller redis-slave gurpartap/redis name=redis,role=slave 2
```

Once that's up (it may take ten to thirty seconds to create the pods) you can list the pods in the cluster, to verify that the master, slaves and guestbook frontends are running:

```shell
$ cluster/kubectl.sh get pods
ID IMAGE(S) HOST LABELS STATUS
redis-master-pod gurpartap/redis kubernetes-minion-1.c.thockin-dev.internal/86.75.30.9 name=redis,role=master Running
1472fd26-54d6-11e4-90fd-42010af00690 gurpartap/redis kubernetes-minion-4.c.thockin-dev.internal/12.34.56.78 name=redis,replicationController=redis-slave-controller,role=slave Running
1473363e-54d6-11e4-90fd-42010af00690 gurpartap/redis kubernetes-minion-3.c.thockin-dev.internal/9.3.19.76 name=redis,replicationController=redis-slave-controller,role=slave Running
fc58aa01-54d6-11e4-90fd-42010af00690 kubernetes/guestbook kubernetes-minion-1.c.thockin-dev.internal/1.18.19.78 name=guestbook,replicationController=guestbook-controller Running
fc592fbb-54d6-11e4-90fd-42010af00690 kubernetes/guestbook kubernetes-minion-1.c.thockin-dev.internal/12.9.20.9 name=guestbook,replicationController=guestbook-controller Running
fc59569e-54d6-11e4-90fd-42010af00690 kubernetes/guestbook kubernetes-minion-2.c.thockin-dev.internal/1.11.20.13 name=guestbook,replicationController=guestbook-controller Running

POD IP CONTAINER(S) IMAGE(S) HOST LABELS STATUS
guestbook-controller-182tv 10.244.2.8 guestbook kubernetes/guestbook kubernetes-minion-3.c.lucid-walker-725.internal/104.154.52.39 name=guestbook Running
guestbook-controller-jzjpe 10.244.0.7 guestbook kubernetes/guestbook kubernetes-minion-1.c.lucid-walker-725.internal/104.154.37.86 name=guestbook Running
guestbook-controller-zwk1b 10.244.3.8 guestbook kubernetes/guestbook kubernetes-minion-4.c.lucid-walker-725.internal/104.154.49.134 name=guestbook Running
redis-master-pod-hh2gd 10.244.3.7 redis-master gurpartap/redis kubernetes-minion-4.c.lucid-walker-725.internal/104.154.49.134 name=redis,role=master Running
redis-slave-controller-i7hvs 10.244.2.7 redis-slave gurpartap/redis kubernetes-minion-3.c.lucid-walker-725.internal/104.154.52.39 name=redis,role=slave Running
redis-slave-controller-nyxxv 10.244.1.6 redis-slave gurpartap/redis kubernetes-minion-2.c.lucid-walker-725.internal/130.211.144.5 name=redis,role=slave Running
```

You will see a single redis master pod, two redis slaves, and three guestbook pods.
Expand All @@ -158,10 +153,10 @@ Just like the others, you want a service to group your guestbook pods. The serv
$ cluster/kubectl.sh create -f examples/guestbook-go/guestbook-service.json

$ cluster/kubectl.sh get services
ID LABELS SELECTOR IP PORT
redis-master name=redis,role=master 10.0.0.1 6379
redis-slave name=redis,role=slave name=redis,role=slave 10.0.0.2 6379
guestbook name=guestbook 10.0.0.3 3000
NAME LABELS SELECTOR IP PORT
guestbook <none> name=guestbook 10.0.12.110 3000
redis-master <none> name=redis,role=master 10.0.186.234 6379
redis-slave name=redis,role=slave name=redis,role=slave 10.0.22.180 6379
```

To play with the service itself, find the external IP of the load balancer from the [Google Cloud Console][cloud-console] or the `gcloud` tool, and visit `http://<ip>:3000`.
Expand Down