cc45d293e2
This is a simplified version of the configs found in the Vitess repo: https://github.com/youtube/vitess/tree/master/examples/kubernetes Here we use a single script to start all of Vitess, since the aim is just to show the end result. The full tutorial on our site goes into much more detail on each step: http://vitess.io/getting-started/
134 lines
4.8 KiB
Markdown
134 lines
4.8 KiB
Markdown
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
|
|
|
|
<!-- BEGIN STRIP_FOR_RELEASE -->
|
|
|
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
|
width="25" height="25">
|
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
|
width="25" height="25">
|
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
|
width="25" height="25">
|
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
|
width="25" height="25">
|
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
|
width="25" height="25">
|
|
|
|
<h2>PLEASE NOTE: This document applies to the HEAD of the source tree</h2>
|
|
|
|
If you are using a released version of Kubernetes, you should
|
|
refer to the docs that go with that version.
|
|
|
|
<strong>
|
|
The latest 1.0.x release of this document can be found
|
|
[here](http://releases.k8s.io/release-1.0/examples/vitess/README.md).
|
|
|
|
Documentation for other releases can be found at
|
|
[releases.k8s.io](http://releases.k8s.io).
|
|
</strong>
|
|
--
|
|
|
|
<!-- END STRIP_FOR_RELEASE -->
|
|
|
|
<!-- END MUNGE: UNVERSIONED_WARNING -->
|
|
|
|
## Vitess Example
|
|
|
|
This example shows how to run a [Vitess](http://vitess.io) cluster in Kubernetes.
|
|
Vitess is a MySQL clustering system developed at YouTube that makes sharding
|
|
transparent to the application layer. It also makes scaling MySQL within
|
|
Kubernetes as simple as launching more pods.
|
|
|
|
The example brings up a database with 2 shards, and then runs a pool of
|
|
[sharded guestbook](https://github.com/youtube/vitess/tree/master/examples/kubernetes/guestbook)
|
|
pods. The guestbook app was ported from the original
|
|
[guestbook](../../examples/guestbook-go/)
|
|
example found elsewhere in this tree, modified to use Vitess as the backend.
|
|
|
|
For a more detailed, step-by-step explanation of this example setup, see the
|
|
[Vitess on Kubernetes](http://vitess.io/getting-started/) guide.
|
|
|
|
### Prerequisites
|
|
|
|
You'll need to install [Go 1.4+](https://golang.org/doc/install) to build
|
|
`vtctlclient`, the command-line admin tool for Vitess.
|
|
|
|
We also assume you have a running Kubernetes cluster with `kubectl` pointing to
|
|
it by default. See the [Getting Started guides](../../docs/getting-started-guides/)
|
|
for how to get to that point. Note that your Kubernetes cluster needs to have
|
|
enough resources (CPU+RAM) to schedule all the pods. By default, this example
|
|
requires a cluster-wide total of at least 6 virtual CPUs and 10GiB RAM. You can
|
|
tune these requirements in the
|
|
[resource limits](../../docs/user-guide/compute-resources.md)
|
|
section of each YAML file.
|
|
|
|
Lastly, you need to open ports 30000 (for the Vitess admin daemon) and 80 (for
|
|
the guestbook app) in your firewall. See the
|
|
[Services and Firewalls](../../docs/user-guide/services-firewalls.md)
|
|
guide for examples of how to do that.
|
|
|
|
### Start Vitess
|
|
|
|
``` console
|
|
./vitess-up.sh
|
|
```
|
|
|
|
This will run through the steps to bring up Vitess. At the end, you should see
|
|
something like this:
|
|
|
|
``` console
|
|
****************************
|
|
* Complete!
|
|
* Use the following line to make an alias to kvtctl:
|
|
* alias kvtctl='$GOPATH/bin/vtctlclient -server 104.197.47.173:30000'
|
|
* See the vtctld UI at: http://104.197.47.173:30000
|
|
****************************
|
|
```
|
|
|
|
### Start the Guestbook app
|
|
|
|
``` console
|
|
./guestbook-up.sh
|
|
```
|
|
|
|
The guestbook service is configured with `type: LoadBalancer` to tell Kubernetes
|
|
to expose it on an external IP. It may take a minute to set up, but you should
|
|
soon see the external IP show up under the internal one like this:
|
|
|
|
``` console
|
|
$ kubectl get service guestbook
|
|
NAME LABELS SELECTOR IP(S) PORT(S)
|
|
guestbook <none> name=guestbook 10.67.253.173 80/TCP
|
|
104.197.151.132
|
|
```
|
|
|
|
Visit the external IP in your browser to view the guestbook. Note that in this
|
|
modified guestbook, there are multiple pages to demonstrate range-based sharding
|
|
in Vitess. Each page number is assigned to one of the shards using a
|
|
[consistent hashing](https://en.wikipedia.org/wiki/Consistent_hashing) scheme.
|
|
|
|
### Tear down
|
|
|
|
``` console
|
|
./guestbook-down.sh
|
|
./vitess-down.sh
|
|
```
|
|
|
|
You may also want to remove any firewall rules you created.
|
|
|
|
### Limitations
|
|
|
|
Currently this example cluster is not configured to use the built-in
|
|
[Backup/Restore](http://vitess.io/user-guide/backup-and-restore.html) feature of
|
|
Vitess, because as of
|
|
[Vitess v2.0.0-alpha2](https://github.com/youtube/vitess/releases) that feature
|
|
requires a network-mounted directory. Usually this system is used to restore
|
|
from the latest backup when a pod is moved or added in an existing deployment.
|
|
As part of the final Vitess v2.0.0 release, we plan to provide support for
|
|
saving backups in a cloud-based blob store (such as Google Cloud Storage or
|
|
Amazon S3), which we believe will be better suited to running in Kubernetes.
|
|
|
|
|
|
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
|
|
[]()
|
|
<!-- END MUNGE: GENERATED_ANALYTICS -->
|