Merge pull request #9629 from jeffmendoza/patch-1

examples/meteor/README.md

@@ -4,6 +4,40 @@ Meteor on Kuberenetes
 This example shows you how to package and run a
 [Meteor](https://www.meteor.com/) app on Kubernetes.
 
+Get started on Google Compute Engine
+------------------------------------
+
+Meteor uses MongoDB, and we will use the `GCEPersistentDisk` type of
+volume for persistent storage. Therefore, this example is only
+applicable to [Google Compute
+Engine](https://cloud.google.com/compute/). Take a look at the
+[volumes documentation](/docs/volumes.md) for other options.
+
+First, if you have not already done so:
+
+1. [Create](https://cloud.google.com/compute/docs/quickstart) a
+[Google Cloud Platform](https://cloud.google.com/) project.
+2. [Enable
+billing](https://developers.google.com/console/help/new/#billing).
+3. Install the [gcloud SDK](https://cloud.google.com/sdk/).
+
+Authenticate with gcloud and set the gcloud default project name to
+point to the project you want to use for your Kubernetes cluster:
+
+```shell
+gcloud auth login
+gcloud config set project <project-name>
+```
+
+Next, start up a Kubernetes cluster:
+```shell
+wget -q -O - https://get.k8s.io | bash
+```
+
+Please see the [GCE getting started
+guide](http://docs.k8s.io/getting-started-guides/gce.md) for full
+details and other options for starting a cluster.
+
 Build a container for your Meteor app
 -------------------------------------
 
@@ -65,13 +99,13 @@ Running
 -------
 
 Now that you have containerized your Meteor app it's time to set up
-your cluster. Edit [`meteor-controller.json`](meteor-controller.json) and make sure the `image`
-points to the container you just pushed to the Docker Hub or GCR.
+your cluster. Edit [`meteor-controller.json`](meteor-controller.json)
+and make sure the `image:` points to the container you just pushed to
+the Docker Hub or GCR.
 
-As you may know, Meteor uses MongoDB, and we'll need to provide it a
-persistent Kuberetes volume to store its data. See the [volumes
-documentation](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/volumes.md)
-for options. We're going to use Google Compute Engine persistent
+We will need to provide MongoDB a persistent Kuberetes volume to
+store its data. See the [volumes documentation](/docs/volumes.md) for
+options. We're going to use Google Compute Engine persistent
 disks. Create the MongoDB disk by running:
 ```
 gcloud compute disks create --size=200GB mongo-disk
@@ -128,16 +162,16 @@ Here we can see the MongoDB host and port information being passed
 into the Meteor app. The `MONGO_SERVICE...` environment variables are
 set by Kubernetes, and point to the service named `mongo` specified in
 [`mongo-service.json`](mongo-service.json). See the [environment
-documentation](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/container-environment.md)
-for more details.
+documentation](/docs/container-environment.md) for more details.
 
 As you may know, Meteor uses long lasting connections, and requires
 _sticky sessions_. With Kubernetes you can scale out your app easily
-with session affinity. The [`meteor-service.json`](meteor-service.json) file contains
+with session affinity. The
+[`meteor-service.json`](meteor-service.json) file contains
 `"sessionAffinity": "ClientIP"`, which provides this for us. See the
 [service
-documentation](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/services.md#virtual-ips-and-service-proxies)
-for more information.
+documentation](/docs/services.md#virtual-ips-and-service-proxies) for
+more information.
 
 As mentioned above, the mongo container uses a volume which is mapped
 to a persistent disk by Kubernetes. In [`mongo-pod.json`](mongo-pod.json) the container

examples/mysql-wordpress-pd/README.md

-
 # Persistent Installation of MySQL and WordPress on Kubernetes
 
 This example describes how to run a persistent installation of [Wordpress](https://wordpress.org/) using the [volumes](/docs/volumes.md) feature of Kubernetes, and [Google Compute Engine](https://cloud.google.com/compute/docs/disks) [persistent disks](/docs/volumes.md#gcepersistentdisk).
@@ -9,51 +8,48 @@ We'll create two Kubernetes [pods](http://docs.k8s.io/pods.md) to run mysql and
 
 This example demonstrates several useful things, including: how to set up and use persistent disks with Kubernetes pods; how to define Kubernetes services to leverage docker-links-compatible service environment variables; and use of an external load balancer to expose the wordpress service externally and make it transparent to the user if the wordpress pod moves to a different cluster node.
 
-## Install gcloud and start up a Kubernetes cluster
+## Get started on Google Compute Engine
 
-First, if you have not already done so, [create](https://cloud.google.com/compute/docs/quickstart) a [Google Cloud Platform](https://cloud.google.com/) project, and install the [gcloud SDK](https://cloud.google.com/sdk/).
+Because we're using the `GCEPersistentDisk` type of volume for persistent storage, this example is only applicable to [Google Compute Engine](https://cloud.google.com/compute/). Take a look at the [volumes documentation](/docs/volumes.md) for other options.
 
-Then, set the gcloud default project name to point to the project you want to use for your Kubernetes cluster:
+First, if you have not already done so:
 
-```
-gcloud config set project <project-name>
-```
+1. [Create](https://cloud.google.com/compute/docs/quickstart) a [Google Cloud Platform](https://cloud.google.com/) project.
+2. [Enable billing](https://developers.google.com/console/help/new/#billing).
+3. Install the [gcloud SDK](https://cloud.google.com/sdk/).
 
-Next, grab the Kubernetes [release binary](https://github.com/GoogleCloudPlatform/kubernetes/releases) and start up a Kubernetes cluster:
-```
-$ cluster/kube-up.sh
-```
-where `<kubernetes>` is the path to your Kubernetes installation.
+Authenticate with gcloud and set the gcloud default project name to point to the project you want to use for your Kubernetes cluster:
 
-Or, as [described here](http://docs.k8s.io/getting-started-guides/gce.md), you can do this via:
 ```shell
-wget -q -O - https://get.k8s.io | bash
+gcloud auth login
+gcloud config set project <project-name>
 ```
-or
+
+Next, start up a Kubernetes cluster:
 ```shell
-curl -sS https://get.k8s.io | bash
+wget -q -O - https://get.k8s.io | bash
 ```
 
+Please see the [GCE getting started guide](http://docs.k8s.io/getting-started-guides/gce.md) for full details and other options for starting a cluster.
+
 ## Create two persistent disks
 
 For this WordPress installation, we're going to configure our Kubernetes [pods](http://docs.k8s.io/pods.md) to use [persistent disks](https://cloud.google.com/compute/docs/disks). This means that we can preserve installation state across pod shutdown and re-startup.
 
-You will need to create the disks in the same [GCE zone](https://cloud.google.com/compute/docs/zones) as the Kubernetes cluster. The `cluster/kube-up.sh` script will create the cluster in the `us-central1-b` zone by default, as seen in the [config-default.sh](/cluster/gce/config-default.sh) file. Replace `$ZONE` below with the appropriate zone.
+You will need to create the disks in the same [GCE zone](https://cloud.google.com/compute/docs/zones) as the Kubernetes cluster. The default setup script will create the cluster in the `us-central1-b` zone, as seen in the [config-default.sh](/cluster/gce/config-default.sh) file. Replace `$ZONE` below with the appropriate zone.
 
-Before doing anything else, we'll create the persistent disks that we'll use for the installation: one for the mysql pod, and one for the wordpress pod.
-The general series of steps required is as described [here](http://docs.k8s.io/volumes.md), where $DISK_SIZE is specified as, e.g. '500GB'.  In future, this process will be more streamlined.
+We will create two disks: one for the mysql pod, and one for the wordpress pod. In this example, we create 20GB disks, which will be sufficient for this demo. Feel free to change the size to align with your needs, as wordpress requirements can vary. Also, keep in mind that [disk performance scales with size](https://cloud.google.com/compute/docs/disks/#comparison_of_disk_types).
 
-So for the two disks used in this example, do the following.
-First create the mysql disk, setting the disk size to meet your needs:
+First create the mysql disk.
 
 ```shell
-gcloud compute disks create --size=$DISK_SIZE --zone=$ZONE mysql-disk
+gcloud compute disks create --size=20GB --zone=$ZONE mysql-disk
 ```
 
-Then create the wordpress disk.  Note that you may not want as large a disk size for the wordpress code as for the mysql disk.
+Then create the wordpress disk.
 
 ```shell
-gcloud compute disks create --size=$DISK_SIZE --zone=$ZONE wordpress-disk
+gcloud compute disks create --size=20GB --zone=$ZONE wordpress-disk
 ```
 
 ## Start the Mysql Pod and Service
@@ -304,12 +300,4 @@ $ cluster/kube-down.sh
 ```
 
 
-
-
-
-
-
-
-
-
 [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/examples/mysql-wordpress-pd/README.md?pixel)]()