Kubernetes Deployments
- Once you have a running Kubernetes cluster, you can deploy your containerized applications on top of it. To do so, you create a Kubernetes Deployment. The Deployment is responsible for creating and updating instances of your application. Once you've created a Deployment, the Kubernetes master schedules the application instances that the Deployment creates onto individual Nodes in the cluster.
+ Once you have a running Kubernetes cluster, you can deploy your containerized applications on top of it.
+ To do so, you create a Kubernetes Deployment configuration. The Deployment instructs Kubernetes
+ how to create and update instances of your application. Once you've created a Deployment, the Kubernetes
+ master schedules mentioned application instances onto individual Nodes in the cluster.
Once the application instances are created, a Kubernetes Deployment Controller continuously monitors those instances. If the Node hosting an instance goes down or is deleted, the Deployment controller replaces it. This provides a self-healing mechanism to address machine failure or maintenance.
diff --git a/docs/tutorials/object-management-kubectl/declarative-object-management-configuration.md b/docs/tutorials/object-management-kubectl/declarative-object-management-configuration.md
index d486086a75..74189782fd 100644
--- a/docs/tutorials/object-management-kubectl/declarative-object-management-configuration.md
+++ b/docs/tutorials/object-management-kubectl/declarative-object-management-configuration.md
@@ -30,7 +30,7 @@ the Kubernetes object definitions and configuration. Read and complete
the following documents if you have not already:
- [Managing Kubernetes Objects Using Imperative Commands](/docs/tutorials/object-management-kubectl/imperative-object-management-command/)
-- [Imperative Management of Kubernetes Objects Using Configuration Files](docs/tutorials/object-management-kubectl/imperative-object-management-configuration/)
+- [Imperative Management of Kubernetes Objects Using Configuration Files](/docs/tutorials/object-management-kubectl/imperative-object-management-configuration/)
Following are definitions for terms used in this document:
@@ -41,7 +41,7 @@ Following are definitions for terms used in this document:
values of an object, as observed by the Kubernetes cluster. These are kept in the Kubernetes
cluster storage, typically etcd.
- *declarative configuration writer / declarative writer*: A person or software component
- that makes updates to a live object. The live writers refered to in this topic make changes
+ that makes updates to a live object. The live writers referred to in this topic make changes
to object configuration files and run `kubectl apply` to write the changes.
## How to create objects
diff --git a/docs/tutorials/services/source-ip.md b/docs/tutorials/services/source-ip.md
index fb7ef48f99..bab393d37e 100644
--- a/docs/tutorials/services/source-ip.md
+++ b/docs/tutorials/services/source-ip.md
@@ -311,7 +311,7 @@ protocol between the loadbalancer and backend to communicate the true client IP
such as the HTTP [X-FORWARDED-FOR](https://en.wikipedia.org/wiki/X-Forwarded-For)
header, or the [proxy protocol](http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt).
Loadbalancers in the second category can leverage the feature described above
-by simply creating a HTTP health check pointing at the port stored in
+by simply creating an HTTP health check pointing at the port stored in
the `service.spec.healthCheckNodePort` field on the Service.
{% endcapture %}
diff --git a/docs/tutorials/stateful-application/cassandra-service.yaml b/docs/tutorials/stateful-application/cassandra-service.yaml
index 35b07733b5..31bee74b58 100644
--- a/docs/tutorials/stateful-application/cassandra-service.yaml
+++ b/docs/tutorials/stateful-application/cassandra-service.yaml
@@ -7,6 +7,6 @@ metadata:
spec:
clusterIP: None
ports:
- - port: 9042
+ - port: 9042
selector:
app: cassandra
diff --git a/docs/tutorials/stateful-application/cassandra.md b/docs/tutorials/stateful-application/cassandra.md
index f6172f4321..d17d6d9be6 100644
--- a/docs/tutorials/stateful-application/cassandra.md
+++ b/docs/tutorials/stateful-application/cassandra.md
@@ -46,7 +46,7 @@ Deploying stateful distributed applications, like Cassandra, within a clustered
**Cassandra Docker**
-The pods use the [```gcr.io/google-samples/cassandra:v12```](https://github.com/kubernetes/examples/blob/master/cassandra/image/Dockerfile)
+The Pods use the [`gcr.io/google-samples/cassandra:v12`](https://github.com/kubernetes/examples/blob/master/cassandra/image/Dockerfile)
image from Google's [container registry](https://cloud.google.com/container-registry/docs/).
The docker is based on `debian:jessie` and includes OpenJDK 8. This image includes a standard Cassandra installation from the Apache Debian repo. By using environment variables you can change values that are inserted into `cassandra.yaml`.
@@ -75,31 +75,30 @@ To complete this tutorial, you should already have a basic familiarity with [Pod
* Have a supported Kubernetes Cluster running
-**Note:** Please read the [getting started guides](https://kubernetes.io/docs/setup/pick-right-solution/) if you do not already have a cluster.
+**Note:** Please read the [getting started guides](https://kubernetes.io/docs/setup/pick-right-solution/) if you do not already have a cluster.
+{: .note}
### Additional Minikube Setup Instructions
-**Warning:** [Minikube](https://kubernetes.io/docs/getting-started-guides/minikube/) defaults to 1024MB of memory and 1 CPU which results in an insufficient resource errors.
+**Caution:** [Minikube](https://kubernetes.io/docs/getting-started-guides/minikube/) defaults to 1024MB of memory and 1 CPU which results in an insufficient resource errors during this tutorial.
+{: .caution}
To avoid these errors, run minikube with:
-```
-minikube start --memory 5120 --cpus=4
-```
+ minikube start --memory 5120 --cpus=4
+
{% endcapture %}
{% capture lessoncontent %}
## Creating a Cassandra Headless Service
A Kubernetes [Service](https://kubernetes.io/docs/concepts/services-networking/service/) describes a set of [Pods](https://kubernetes.io/docs/concepts/workloads/pods/pod/) that perform the same task.
-The following `Service` is used for DNS lookups between Cassandra pods and clients within the Kubernetes Cluster.
+The following `Service` is used for DNS lookups between Cassandra Pods and clients within the Kubernetes Cluster.
-1. `cd` to the folder you saved the .yaml files.
-2. Create a `Service` to track all Cassandra StatefulSet Nodes from the following `.yaml` file:
+1. Launch a terminal window in the directory you downloaded the manifest files.
+2. Create a `Service` to track all Cassandra StatefulSet Nodes from the `cassandra-service.yaml` file:
-```shell
-kubectl create -f cassandra-service.yaml
-```
+ kubectl create -f cassandra-service.yaml
{% include code.html language="yaml" file="cassandra-service.yaml" ghlink="/docs/tutorials/stateful-application/cassandra-service.yaml" %}
@@ -107,31 +106,26 @@ kubectl create -f cassandra-service.yaml
Get the Cassandra `Service`.
-```shell
-kubectl get svc cassandra
-```
+ kubectl get svc cassandra
The response should be
-```console
-NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE
-cassandra None
9042/TCP 45s
-```
+ NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE
+ cassandra None 9042/TCP 45s
If anything else returns, the service was not successfully created. Read [Debug Services](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-service/) for common issues.
## Using a StatefulSet to Create a Cassandra Ring
-The StatefulSet manifest, included below, creates a Cassandra ring that consists of three pods.
+The StatefulSet manifest, included below, creates a Cassandra ring that consists of three Pods.
-**Note:** This example uses the default provisioner for Minikube. Please update the following StatefulSet for the cloud you are working with.
+**Note:** This example uses the default provisioner for Minikube. Please update the following StatefulSet for the cloud you are working with.
+{: .note}
1. Update the StatefulSet if necessary.
-2. Create the Cassandra StatefulSet from the following `.yaml` file:
+2. Create the Cassandra StatefulSet from the `cassandra-statefulset.yaml` file:
-```shell
-kubectl create -f cassandra-statefulset.yaml
-```
+ kubectl create -f cassandra-statefulset.yaml
{% include code.html language="yaml" file="cassandra-statefulset.yaml" ghlink="/docs/tutorials/stateful-application/cassandra-statefulset.yaml" %}
@@ -139,131 +133,115 @@ kubectl create -f cassandra-statefulset.yaml
1. Get the Cassandra StatefulSet:
-```shell
-kubectl get statefulset cassandra
-```
+ kubectl get statefulset cassandra
The response should be
-```console
-NAME DESIRED CURRENT AGE
-cassandra 3 0 13s
-```
+ NAME DESIRED CURRENT AGE
+ cassandra 3 0 13s
- The StatefulSet resource deploys pods sequentially.
+ The StatefulSet resource deploys Pods sequentially.
-{:start="2"}
2. Get the Pods to see the ordered creation status:
-```shell
-kubectl get pods -l="app=cassandra"
-NAME READY STATUS RESTARTS AGE
-cassandra-0 1/1 Running 0 1m
-cassandra-1 0/1 ContainerCreating 0 8s
-```
+ kubectl get pods -l="app=cassandra"
+
+ The response should be
+
+ NAME READY STATUS RESTARTS AGE
+ cassandra-0 1/1 Running 0 1m
+ cassandra-1 0/1 ContainerCreating 0 8s
-**Note:** It can take up to ten minutes for all three pods to deploy.
+ **Note:** It can take up to ten minutes for all three Pods to deploy.
+ {: .note}
-Once all pods are deployed, the same command returns:
+ Once all Pods are deployed, the same command returns:
-```shell
-kubectl get pods -l="app=cassandra"
-NAME READY STATUS RESTARTS AGE
-cassandra-0 1/1 Running 0 10m
-cassandra-1 1/1 Running 0 9m
-cassandra-2 1/1 Running 0 8m
-```
+ NAME READY STATUS RESTARTS AGE
+ cassandra-0 1/1 Running 0 10m
+ cassandra-1 1/1 Running 0 9m
+ cassandra-2 1/1 Running 0 8m
-{:start="3"}
3. Run the Cassandra utility nodetool to display the status of the ring.
-```
-kubectl exec cassandra-0 -- nodetool status
-```
+ kubectl exec cassandra-0 -- nodetool status
-```console
-Datacenter: DC1-K8Demo
-======================
-Status=Up/Down
-|/ State=Normal/Leaving/Joining/Moving
--- Address Load Tokens Owns (effective) Host ID Rack
-UN 10.4.2.4 65.26 KiB 32 63.7% a9d27f81-6783-461d-8583-87de2589133e Rack1-K8Demo
-UN 10.4.0.4 102.04 KiB 32 66.7% 5559a58c-8b03-47ad-bc32-c621708dc2e4 Rack1-K8Demo
-UN 10.4.1.4 83.06 KiB 32 69.6% 9dce943c-581d-4c0e-9543-f519969cc805 Rack1-K8Demo
-```
+ The response is:
+
+ Datacenter: DC1-K8Demo
+ ======================
+ Status=Up/Down
+ |/ State=Normal/Leaving/Joining/Moving
+ -- Address Load Tokens Owns (effective) Host ID Rack
+ UN 172.17.0.5 83.57 KiB 32 74.0% e2dd09e6-d9d3-477e-96c5-45094c08db0f Rack1-K8Demo
+ UN 172.17.0.4 101.04 KiB 32 58.8% f89d6835-3a42-4419-92b3-0e62cae1479c Rack1-K8Demo
+ UN 172.17.0.6 84.74 KiB 32 67.1% a6a1e8c2-3dc5-4417-b1a0-26507af2aaad Rack1-K8Demo
## Modifying the Cassandra StatefulSet
Use `kubectl edit` to modify the size of of a Cassandra StatefulSet.
1. Run the following command:
-```shell
-kubectl edit statefulset cassandra
-```
- This command opens an editor in your terminal. The line you need to change is `Replicas`.
+ kubectl edit statefulset cassandra
+
+ This command opens an editor in your terminal. The line you need to change is the `replicas` field.
**Note:** The following sample is an excerpt of the StatefulSet file.
+ {: .note}
-```console
-# Please edit the object below. Lines beginning with a '#' will be ignored,
-# and an empty file will abort the edit. If an error occurs while saving this file will be
-# reopened with the relevant failures.
-#
-apiVersion: apps/v1beta1
-kind: StatefulSet
-metadata:
- creationTimestamp: 2016-08-13T18:40:58Z
- generation: 1
- labels:
- app: cassandra
- name: cassandra
- namespace: default
- resourceVersion: "323"
- selfLink: /apis/apps/v1beta1/namespaces/default/statefulsets/cassandra
- uid: 7a219483-6185-11e6-a910-42010a8a0fc0
-spec:
- replicas: 3
-```
+ ```yaml
+ # Please edit the object below. Lines beginning with a '#' will be ignored,
+ # and an empty file will abort the edit. If an error occurs while saving this file will be
+ # reopened with the relevant failures.
+ #
+ apiVersion: apps/v1beta1
+ kind: StatefulSet
+ metadata:
+ creationTimestamp: 2016-08-13T18:40:58Z
+ generation: 1
+ labels:
+ app: cassandra
+ name: cassandra
+ namespace: default
+ resourceVersion: "323"
+ selfLink: /apis/apps/v1beta1/namespaces/default/statefulsets/cassandra
+ uid: 7a219483-6185-11e6-a910-42010a8a0fc0
+ spec:
+ replicas: 3
+ ```
-{:start="2"}
-2. Increase the number of replicas to 4, and then save the manifest.
+2. Change the number of replicas to 4, and then save the manifest.
- The StatefulSet now contains 4 pods.
+ The StatefulSet now contains 4 Pods.
3. Get the Cassandra StatefulSet to verify:
-```shell
-kubectl get statefulset cassandra
-```
+ kubectl get statefulset cassandra
- The response should be
+ The response should be
-```console
-NAME DESIRED CURRENT AGE
-cassandra 4 4 36m
-```
+ NAME DESIRED CURRENT AGE
+ cassandra 4 4 36m
+
{% endcapture %}
{% capture cleanup %}
Deleting or scaling a StatefulSet down does not delete the volumes associated with the StatefulSet. This ensures safety first: your data is more valuable than an auto purge of all related StatefulSet resources.
-**Warning:** Depending on the storage class and reclaim policy, deleting the Persistent Volume Claims may cause the associated volumes to also be deleted. Never assume you’ll be able to access data if its volume claims are deleted.
+**Warning:** Depending on the storage class and reclaim policy, deleting the Persistent Volume Claims may cause the associated volumes to also be deleted. Never assume you’ll be able to access data if its volume claims are deleted.
+{: .warning}
1. Run the following commands to delete everything in a `StatefulSet`:
-```shell
-grace=$(kubectl get po cassandra-0 -o=jsonpath='{.spec.terminationGracePeriodSeconds}') \
- && kubectl delete statefulset -l app=cassandra \
- && echo "Sleeping $grace" \
- && sleep $grace \
- && kubectl delete pvc -l app=cassandra
-```
+ grace=$(kubectl get po cassandra-0 -o=jsonpath='{.spec.terminationGracePeriodSeconds}') \
+ && kubectl delete statefulset -l app=cassandra \
+ && echo "Sleeping $grace" \
+ && sleep $grace \
+ && kubectl delete pvc -l app=cassandra
2. Run the following command to delete the Cassandra `Service`.
-```shell
-kubectl delete service -l app=cassandra
-```
+ kubectl delete service -l app=cassandra
{% endcapture %}
diff --git a/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md b/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md
index 2ede41834a..22cb8bd142 100644
--- a/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md
+++ b/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md
@@ -1,5 +1,5 @@
---
-title: "Example: WordPress and MySQL with Persistent Volumes"
+title: "Example: Deploying WordPress and MySQL with Persistent Volumes"
---
-This example describes how to run a persistent installation of
-[WordPress](https://wordpress.org/) and
-[MySQL](https://www.mysql.com/) on Kubernetes. We'll use the
-[mysql](https://registry.hub.docker.com/_/mysql/) and
-[wordpress](https://registry.hub.docker.com/_/wordpress/) official
-[Docker](https://www.docker.com/) images for this installation. (The
-WordPress image includes an Apache server).
+{% capture overview %}
+This tutorial shows you how to deploy a WordPress site and a MySQL database using Minikube. Both applications use PersistentVolumes and PersistentVolumeClaims to store data.
-Demonstrated Kubernetes Concepts:
+A [PersistentVolume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) (PV) is a piece of storage in the cluster that has been provisioned by an administrator, and a [PeristentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) (PVC) is a set amout of storage in a PV. PersistentVolumes and PeristentVolumeClaims are independent from Pod lifecycles and preserve data through restarting, rescheduling, and even deleting Pods.
-* [Persistent Volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) to
- define persistent disks (disk lifecycle not tied to the Pods).
-* [Services](https://kubernetes.io/docs/concepts/services-networking/service/) to enable Pods to
- locate one another.
-* [External Load Balancers](https://kubernetes.io/docs/concepts/services-networking/service/#type-loadbalancer)
- to expose Services externally.
-* [Deployments](http://kubernetes.io/docs/user-guide/deployments/) to ensure Pods
- stay up and running.
-* [Secrets](http://kubernetes.io/docs/user-guide/secrets/) to store sensitive
- passwords.
+**Warning:** This deployment is not suitable for production use cases, as it uses single instance WordPress and MySQL Pods. Consider using [WordPress Helm Chart](https://github.com/kubernetes/charts/tree/master/stable/wordpress) to deploy WordPress in production.
+{: .warning}
-## Quickstart
+{% endcapture %}
-Put your desired MySQL password in a file called `password.txt` with
-no trailing newline. The first `tr` command will remove the newline if
-your editor added one.
+{% capture objectives %}
+* Create a PersistentVolume
+* Create a Secret
+* Deploy MySQL
+* Deploy WordPress
+* Clean up
-**Note:** if your cluster enforces **_selinux_** and you will be using [Host Path](#host-path) for storage, then please follow this [extra step](#selinux).
+{% endcapture %}
-```shell
-tr --delete '\n' .strippedpassword.txt && mv .strippedpassword.txt password.txt
-kubectl create -f https://raw.githubusercontent.com/kubernetes/examples/master/mysql-wordpress-pd/local-volumes.yaml
-kubectl create secret generic mysql-pass --from-file=password.txt
-kubectl create -f https://raw.githubusercontent.com/kubernetes/examples/master/mysql-wordpress-pd/mysql-deployment.yaml
-kubectl create -f https://raw.githubusercontent.com/kubernetes/examples/master/mysql-wordpress-pd/wordpress-deployment.yaml
-```
+{% capture prerequisites %}
-## Table of Contents
+{% include task-tutorial-prereqs.md %}
-
+Download the following configuration files:
-- [Persistent Installation of MySQL and WordPress on Kubernetes](#persistent-installation-of-mysql-and-wordpress-on-kubernetes)
- - [Quickstart](#quickstart)
- - [Table of Contents](#table-of-contents)
- - [Cluster Requirements](#cluster-requirements)
- - [Decide where you will store your data](#decide-where-you-will-store-your-data)
- - [Host Path](#host-path)
- - [SELinux](#selinux)
- - [GCE Persistent Disk](#gce-persistent-disk)
- - [Create the MySQL Password Secret](#create-the-mysql-password-secret)
- - [Deploy MySQL](#deploy-mysql)
- - [Deploy WordPress](#deploy-wordpress)
- - [Visit your new WordPress blog](#visit-your-new-wordpress-blog)
- - [Take down and restart your blog](#take-down-and-restart-your-blog)
- - [Next Steps](#next-steps)
+1. [local-volumes.yaml](https://kubernetes.io/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/local-volumes.yaml)
-
+1. [mysql-deployment.yaml](https://kubernetes.io/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/mysql-deployment.yaml)
-## Cluster Requirements
+1. [wordpress-deployment.yaml](https://kubernetes.io/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume//wordpress-deployment.yaml)
-Kubernetes runs in a variety of environments and is inherently
-modular. Not all clusters are the same. These are the requirements for
-this example.
+{% endcapture %}
-* Kubernetes version 1.2 is required due to using newer features, such
- at PV Claims and Deployments. Run `kubectl version` to see your
- cluster version.
-* [Cluster DNS](https://github.com/kubernetes/dns) will be used for service discovery.
-* An [external load balancer](https://kubernetes.io/docs/concepts/services-networking/service/#type-loadbalancer)
- will be used to access WordPress.
-* [Persistent Volume Claims](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)
- are used. You must create Persistent Volumes in your cluster to be
- claimed. This example demonstrates how to create two types of
- volumes, but any volume is sufficient.
+{% capture lessoncontent %}
-Consult a
-[Getting Started Guide](http://kubernetes.io/docs/getting-started-guides/)
-to set up a cluster and the
-[kubectl](http://kubernetes.io/docs/user-guide/prereqs/) command-line client.
+## Create a PersistentVolume
-## Decide where you will store your data
+MySQL and Wordpress each use a PersistentVolume to store data. While Kubernetes supports many different [types of PersistentVolumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#types-of-persistent-volumes), this tutorial covers [hostPath](https://kubernetes.io/docs/concepts/storage/volumes/#hostpath).
-MySQL and WordPress will each use a
-[Persistent Volume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
-to store their data. We will use a Persistent Volume Claim to claim an
-available persistent volume. This example covers HostPath and
-GCEPersistentDisk volumes. Choose one of the two, or see
-[Types of Persistent Volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#types-of-persistent-volumes)
-for more options.
+**Note:** If you have a Kubernetes cluster running on Google Container Engine, please follow [this guide](https://cloud.google.com/container-engine/docs/tutorials/persistent-disk).
+{: .note}
-### Host Path
+### Setting up a hostPath Volume
-Host paths are volumes mapped to directories on the host. **These
-should be used for testing or single-node clusters only**. The data
-will not be moved between nodes if the pod is recreated on a new
-node. If the pod is deleted and recreated on a new node, data will be
-lost.
+A `hostPath` mounts a file or directory from the host node’s filesystem into your Pod.
-##### SELinux
+**Warning:** Only use `hostPath` for developing and testing. With hostPath, your data lives on the node the Pod is scheduled onto and does not move between nodes. If a Pod dies and gets scheduled to another node in the cluster, the data is lost.
+{: .warning}
-On systems supporting selinux it is preferred to leave it enabled/enforcing.
-However, docker containers mount the host path with the "_svirt_sandbox_file_t_"
-label type, which is incompatible with the default label type for /tmp ("_tmp_t_"),
-resulting in a permissions error when the mysql container attempts to `chown`
-_/var/lib/mysql_.
-Therefore, on selinx systems using host path, you should pre-create the host path
-directory (/tmp/data/) and change it's selinux label type to "_svirt_sandbox_file_t_",
-as follows:
+1. Launch a terminal window in the directory you downloaded the manifest files.
-```shell
-## on every node:
-mkdir -p /tmp/data
-chmod a+rwt /tmp/data # match /tmp permissions
-chcon -Rt svirt_sandbox_file_t /tmp/data
-```
+2. Create two PersistentVolumes from the `local-volumes.yaml` file:
-Continuing with host path, create the persistent volume objects in Kubernetes using
-[local-volumes.yaml](https://git.k8s.io/examples/mysql-wordpress-pd/local-volumes.yaml):
+ kubectl create -f local-volumes.yaml
-```shell
-export KUBE_REPO=https://raw.githubusercontent.com/kubernetes/examples/master
-kubectl create -f $KUBE_REPO/mysql-wordpress-pd/local-volumes.yaml
-```
+{% include code.html language="yaml" file="mysql-wordpress-persistent-volume/local-volumes.yaml" ghlink="/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/local-volumes.yaml" %}
+{:start="3"}
+3. Run the following command to verify that two 20GiB PersistentVolumes are available:
-### GCE Persistent Disk
+ kubectl get pv
-This storage option is applicable if you are running on
-[Google Compute Engine](http://kubernetes.io/docs/getting-started-guides/gce/).
+ The response should be like this:
-Create two persistent disks. 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](https://git.k8s.io/kubernetes/cluster/gce/config-default.sh) file. Replace
-`` below with the appropriate zone. The names `wordpress-1` and
-`wordpress-2` must match the `pdName` fields we have specified in
-[gce-volumes.yaml](https://git.k8s.io/examples/mysql-wordpress-pd/gce-volumes.yaml).
+ NAME CAPACITY ACCESSMODES RECLAIMPOLICY STATUS CLAIM STORAGECLASS REASON AGE
+ local-pv-1 20Gi RWO Retain Available 1m
+ local-pv-2 20Gi RWO Retain Available 1m
-```shell
-gcloud compute disks create --size=20GB --zone= wordpress-1
-gcloud compute disks create --size=20GB --zone= wordpress-2
-```
+## Create a Secret for MySQL Password
-Create the persistent volume objects in Kubernetes for those disks:
+A [Secret](https://kubernetes.io/docs/concepts/configuration/secret/) is an object that stores a piece of sensitive data like a password or key. The manifest files are already configured to use a Secret, but you have to create your own Secret.
-```shell
-export KUBE_REPO=https://raw.githubusercontent.com/kubernetes/examples/master
-kubectl create -f $KUBE_REPO/mysql-wordpress-pd/gce-volumes.yaml
-```
+1. Create the Secret object from the following command:
-## Create the MySQL Password Secret
+ kubectl create secret generic mysql-pass --from-literal=password=YOUR_PASSWORD
+
+ **Note:** Replace `YOUR_PASSWORD` with the password you want to apply.
+ {: .note}
+
+2. Verify that the Secret exists by running the following command:
-Use a [Secret](http://kubernetes.io/docs/user-guide/secrets/) object
-to store the MySQL password. First create a file (in the same directory
-as the wordpress sample files) called
-`password.txt` and save your password in it. Make sure to not have a
-trailing newline at the end of the password. The first `tr` command
-will remove the newline if your editor added one. Then, create the
-Secret object.
+ kubectl get secrets
-```shell
-tr --delete '\n' .strippedpassword.txt && mv .strippedpassword.txt password.txt
-kubectl create secret generic mysql-pass --from-file=password.txt
-```
+ The response should be like this:
-This secret is referenced by the MySQL and WordPress pod configuration
-so that those pods will have access to it. The MySQL pod will set the
-database password, and the WordPress pod will use the password to
-access the database.
+ NAME TYPE DATA AGE
+ mysql-pass Opaque 1 42s
+
+ **Note:** To protect the Secret from exposure, neither `get` nor `describe` show its contents.
+ {: .note}
## Deploy MySQL
-Now that the persistent disks and secrets are defined, the Kubernetes
-pods can be launched. Start MySQL using
-[mysql-deployment.yaml](https://git.k8s.io/examples/mysql-wordpress-pd/mysql-deployment.yaml).
+The following manifest describes a single-instance MySQL Deployment. The MySQL container mounts the PersistentVolume at /var/lib/mysql. The `MYSQL_ROOT_PASSWORD` environment variable sets the database password from the Secret.
-```shell
-kubectl create -f $KUBE_REPO/mysql-wordpress-pd/mysql-deployment.yaml
-```
+{% include code.html language="yaml" file="mysql-wordpress-persistent-volume/mysql-deployment.yaml" ghlink="/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/mysql-deployment.yaml" %}
-Take a look at [mysql-deployment.yaml](https://git.k8s.io/examples/mysql-wordpress-pd/mysql-deployment.yaml), and
-note that we've defined a volume mount for `/var/lib/mysql`, and then
-created a Persistent Volume Claim that looks for a 20G volume. This
-claim is satisfied by any volume that meets the requirements, in our
-case one of the volumes we created above.
+1. Deploy MySQL from the `mysql-deployment.yaml` file:
-Also look at the `env` section and see that we specified the password
-by referencing the secret `mysql-pass` that we created above. Secrets
-can have multiple key:value pairs. Ours has only one key
-`password.txt` which was the name of the file we used to create the
-secret. The [MySQL image](https://hub.docker.com/_/mysql/) sets the
-database password using the `MYSQL_ROOT_PASSWORD` environment
-variable.
+ kubectl create -f mysql-deployment.yaml
-It may take a short period before the new pod reaches the `Running`
-state. List all pods to see the status of this new pod.
+2. Verify that the Pod is running by running the following command:
-```shell
-kubectl get pods
-```
+ kubectl get pods
-```
-NAME READY STATUS RESTARTS AGE
-wordpress-mysql-cqcf4-9q8lo 1/1 Running 0 1m
-```
+ **Note:** It can take up to a few minutes for the Pod's Status to be `RUNNING`.
+ {: .note}
-Kubernetes logs the stderr and stdout for each pod. Take a look at the
-logs for a pod by using `kubectl log`. Copy the pod name from the
-`get pods` command, and then:
+ The response should be like this:
-```shell
-kubectl logs
-```
-
-```
-...
-2016-02-19 16:58:05 1 [Note] InnoDB: 128 rollback segment(s) are active.
-2016-02-19 16:58:05 1 [Note] InnoDB: Waiting for purge to start
-2016-02-19 16:58:05 1 [Note] InnoDB: 5.6.29 started; log sequence number 1626007
-2016-02-19 16:58:05 1 [Note] Server hostname (bind-address): '*'; port: 3306
-2016-02-19 16:58:05 1 [Note] IPv6 is available.
-2016-02-19 16:58:05 1 [Note] - '::' resolves to '::';
-2016-02-19 16:58:05 1 [Note] Server socket created on IP: '::'.
-2016-02-19 16:58:05 1 [Warning] 'proxies_priv' entry '@ root@wordpress-mysql-cqcf4-9q8lo' ignored in --skip-name-resolve mode.
-2016-02-19 16:58:05 1 [Note] Event Scheduler: Loaded 0 events
-2016-02-19 16:58:05 1 [Note] mysqld: ready for connections.
-Version: '5.6.29' socket: '/var/run/mysqld/mysqld.sock' port: 3306 MySQL Community Server (GPL)
-```
-
-Also in [mysql-deployment.yaml](https://git.k8s.io/examples/mysql-wordpress-pd/mysql-deployment.yaml) we created a
-service to allow other pods to reach this mysql instance. The name is
-`wordpress-mysql` which resolves to the pod IP.
-
-Up to this point one Deployment, one Pod, one PVC, one Service, one Endpoint,
-two PVs, and one Secret have been created, shown below:
-
-```shell
-kubectl get deployment,pod,svc,endpoints,pvc -l app=wordpress -o wide && \
- kubectl get secret mysql-pass && \
- kubectl get pv
-```
-
-```shell
-NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
-deploy/wordpress-mysql 1 1 1 1 3m
-NAME READY STATUS RESTARTS AGE IP NODE
-po/wordpress-mysql-3040864217-40soc 1/1 Running 0 3m 172.17.0.2 127.0.0.1
-NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE SELECTOR
-svc/wordpress-mysql None 3306/TCP 3m app=wordpress,tier=mysql
-NAME ENDPOINTS AGE
-ep/wordpress-mysql 172.17.0.2:3306 3m
-NAME STATUS VOLUME CAPACITY ACCESSMODES AGE
-pvc/mysql-pv-claim Bound local-pv-2 20Gi RWO 3m
-NAME TYPE DATA AGE
-mysql-pass Opaque 1 3m
-NAME CAPACITY ACCESSMODES STATUS CLAIM REASON AGE
-local-pv-1 20Gi RWO Available 3m
-local-pv-2 20Gi RWO Bound default/mysql-pv-claim 3m
-```
+ NAME READY STATUS RESTARTS AGE
+ wordpress-mysql-1894417608-x5dzt 1/1 Running 0 40s
## Deploy WordPress
-Next deploy WordPress using
-[wordpress-deployment.yaml](https://git.k8s.io/examples/mysql-wordpress-pd/wordpress-deployment.yaml):
+The following manifest describes a single-instance WordPress Deployment and Service. It uses many of the same features like a PVC for persistent storage and a Secret for the password. But it also uses a different setting: `type: NodePort`. This setting exposes WordPress to traffic from outside of the cluster.
-```shell
-kubectl create -f $KUBE_REPO/mysql-wordpress-pd/wordpress-deployment.yaml
-```
+{% include code.html language="yaml" file="mysql-wordpress-persistent-volume/mysql-deployment.yaml" ghlink="/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/wordpress-deployment.yaml" %}
-Here we are using many of the same features, such as a volume claim
-for persistent storage and a secret for the password.
+1. Create a WordPress Service and Deployment from the `wordpress-deployment.yaml` file:
-The [WordPress image](https://hub.docker.com/_/wordpress/) accepts the
-database hostname through the environment variable
-`WORDPRESS_DB_HOST`. We set the env value to the name of the MySQL
-service we created: `wordpress-mysql`.
+ kubectl create -f wordpress-deployment.yaml
-The WordPress service has the setting `type: LoadBalancer`. This will
-set up the wordpress service behind an external IP.
+2. Verify that the Service is running by running the following command:
-Find the external IP for your WordPress service. **It may take a minute
-to have an external IP assigned to the service, depending on your
-cluster environment.**
+ kubectl get services wordpress
-```shell
-kubectl get services wordpress
-```
+ The response should be like this:
-```
-NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE
-wordpress 10.0.0.5 1.2.3.4 80/TCP 19h
-```
+ NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE
+ wordpress 10.0.0.89 80:32406/TCP 4m
-## Visit your new WordPress blog
+ **Note:** Minikube can only expose Services through `NodePort`.
The `EXTERNAL-IP` is always ``.
+ {: .note}
-Now, we can visit the running WordPress app. Use the external IP of
-the service that you obtained above.
+3. Run the following command to get the IP Address for the WordPress Service:
-```
-http://
-```
+ minikube service wordpress --url
-You should see the familiar WordPress init page.
+ The response should be like this:
-
+ http://1.2.3.4:32406
-> Warning: Do not leave your WordPress installation on this page. If
-> it is found by another user, they can set up a website on your
-> instance and use it to serve potentially malicious content. You
-> should either continue with the installation past the point at which
-> you create your username and password, delete your instance, or set
-> up a firewall to restrict access.
+4. Copy the IP address, and load the page in your browser to view your site.
-## Take down and restart your blog
+ You should see the WordPress set up page similar to the following screenshot.
-Set up your WordPress blog and play around with it a bit. Then, take
-down its pods and bring them back up again. Because you used
-persistent disks, your blog state will be preserved.
+ 
-All of the resources are labeled with `app=wordpress`, so you can
-easily bring them down using a label selector:
+ **Warning:** Do not leave your WordPress installation on this page. If another user finds it, they can set up a website on your instance and use it to serve malicious content.
Either install WordPress by creating a username and password or delete your instance.
+ {: .warning}
-```shell
-kubectl delete deployment,service -l app=wordpress
-kubectl delete secret mysql-pass
-```
+{% endcapture %}
-Later, re-creating the resources with the original commands will pick
-up the original disks with all your data intact. Because we did not
-delete the PV Claims, no other pods in the cluster could claim them
-after we deleted our pods. Keeping the PV Claims also ensured
-recreating the Pods did not cause the PD to switch Pods.
+{% capture cleanup %}
-If you are ready to release your persistent volumes and the data on them, run:
+1. Run the following command to delete your Secret:
-```shell
-kubectl delete pvc -l app=wordpress
-```
+ kubectl delete secret mysql-pass
-And then delete the volume objects themselves:
+2. Run the following commands to delete all Deployments and Services:
-```shell
-kubectl delete pv local-pv-1 local-pv-2
-```
+ kubectl delete deployment -l app=wordpress
+ kubectl delete service -l app=wordpress
-or
+3. Run the following commands to delete the PersistentVolumeClaims and the PersistentVolumes:
-```shell
-kubectl delete pv wordpress-pv-1 wordpress-pv-2
-```
+ kubectl delete pvc -l app=wordpress
+ kubectl delete pv local-pv-1 local-pv-2
+
+ **Note:** Any other Type of PersistentVolume would allow you to recreate the Deployments and Services at this point without losing data, but `hostPath` loses the data as soon as the Pod stops running.
+ {: .note}
-## Next Steps
+{% endcapture %}
-* [Introspection and Debugging](http://kubernetes.io/docs/user-guide/introspection-and-debugging/)
-* [Jobs](http://kubernetes.io/docs/user-guide/jobs/) may be useful to run SQL queries.
-* [Exec](http://kubernetes.io/docs/user-guide/getting-into-containers/)
-* [Port Forwarding](http://kubernetes.io/docs/user-guide/connecting-to-applications-port-forward/)
+{% capture whatsnext %}
+
+* Learn more about [Introspection and Debugging](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-application-introspection/)
+* Learn more about [Jobs](https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/)
+* Learn more about [Port Forwarding](https://kubernetes.io/docs/tasks/access-application-cluster/port-forward-access-application-cluster/)
+* Learn how to [Get a Shell to a Container](https://kubernetes.io/docs/tasks/debug-application-cluster/get-shell-running-container/)
+
+{% endcapture %}
+
+{% include templates/tutorial.md %}
[]()
diff --git a/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/local-volumes.yaml b/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/local-volumes.yaml
new file mode 100644
index 0000000000..8964113336
--- /dev/null
+++ b/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/local-volumes.yaml
@@ -0,0 +1,27 @@
+apiVersion: v1
+kind: PersistentVolume
+metadata:
+ name: local-pv-1
+ labels:
+ type: local
+spec:
+ capacity:
+ storage: 20Gi
+ accessModes:
+ - ReadWriteOnce
+ hostPath:
+ path: /tmp/data/pv-1
+---
+apiVersion: v1
+kind: PersistentVolume
+metadata:
+ name: local-pv-2
+ labels:
+ type: local
+spec:
+ capacity:
+ storage: 20Gi
+ accessModes:
+ - ReadWriteOnce
+ hostPath:
+ path: /tmp/data/pv-2
diff --git a/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/mysql-deployment.yaml b/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/mysql-deployment.yaml
new file mode 100644
index 0000000000..2253600de6
--- /dev/null
+++ b/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/mysql-deployment.yaml
@@ -0,0 +1,61 @@
+apiVersion: v1
+kind: Service
+metadata:
+ name: wordpress-mysql
+ labels:
+ app: wordpress
+spec:
+ ports:
+ - port: 3306
+ selector:
+ app: wordpress
+ tier: mysql
+ clusterIP: None
+---
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+ name: mysql-pv-claim
+ labels:
+ app: wordpress
+spec:
+ accessModes:
+ - ReadWriteOnce
+ resources:
+ requests:
+ storage: 20Gi
+---
+apiVersion: extensions/v1beta1
+kind: Deployment
+metadata:
+ name: wordpress-mysql
+ labels:
+ app: wordpress
+spec:
+ strategy:
+ type: Recreate
+ template:
+ metadata:
+ labels:
+ app: wordpress
+ tier: mysql
+ spec:
+ containers:
+ - image: mysql:5.6
+ name: mysql
+ env:
+ - name: MYSQL_ROOT_PASSWORD
+ valueFrom:
+ secretKeyRef:
+ name: mysql-pass
+ key: password
+ ports:
+ - containerPort: 3306
+ name: mysql
+ volumeMounts:
+ - name: mysql-persistent-storage
+ mountPath: /var/lib/mysql
+ volumes:
+ - name: mysql-persistent-storage
+ persistentVolumeClaim:
+ claimName: mysql-pv-claim
diff --git a/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/wordpress-deployment.yaml b/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/wordpress-deployment.yaml
new file mode 100644
index 0000000000..e15edc5998
--- /dev/null
+++ b/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/wordpress-deployment.yaml
@@ -0,0 +1,63 @@
+apiVersion: v1
+kind: Service
+metadata:
+ name: wordpress
+ labels:
+ app: wordpress
+spec:
+ ports:
+ - port: 80
+ selector:
+ app: wordpress
+ tier: frontend
+ type: LoadBalancer
+---
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+ name: wp-pv-claim
+ labels:
+ app: wordpress
+spec:
+ accessModes:
+ - ReadWriteOnce
+ resources:
+ requests:
+ storage: 20Gi
+---
+apiVersion: extensions/v1beta1
+kind: Deployment
+metadata:
+ name: wordpress
+ labels:
+ app: wordpress
+spec:
+ strategy:
+ type: Recreate
+ template:
+ metadata:
+ labels:
+ app: wordpress
+ tier: frontend
+ spec:
+ containers:
+ - image: wordpress:4.8-apache
+ name: wordpress
+ env:
+ - name: WORDPRESS_DB_HOST
+ value: wordpress-mysql
+ - name: WORDPRESS_DB_PASSWORD
+ valueFrom:
+ secretKeyRef:
+ name: mysql-pass
+ key: password
+ ports:
+ - containerPort: 80
+ name: wordpress
+ volumeMounts:
+ - name: wordpress-persistent-storage
+ mountPath: /var/www/html
+ volumes:
+ - name: wordpress-persistent-storage
+ persistentVolumeClaim:
+ claimName: wp-pv-claim
diff --git a/docs/tutorials/stateless-application/expose-external-ip-address.md b/docs/tutorials/stateless-application/expose-external-ip-address.md
index ea7e1e7a36..39b7bfaa0c 100644
--- a/docs/tutorials/stateless-application/expose-external-ip-address.md
+++ b/docs/tutorials/stateless-application/expose-external-ip-address.md
@@ -117,7 +117,7 @@ external IP address.
1. Use the external IP address to access the Hello World application:
- curl http://:
+ curl http://:
where `` is the external IP address of your Service,
and `` is the value of `Port` in your Service description.
diff --git a/docs/tutorials/stateless-application/guestbook.md b/docs/tutorials/stateless-application/guestbook.md
index 331e489922..ca47e5d16e 100644
--- a/docs/tutorials/stateless-application/guestbook.md
+++ b/docs/tutorials/stateless-application/guestbook.md
@@ -61,12 +61,12 @@ This tutorial shows you how to build and deploy a simple, multi-tier web applica
{% include task-tutorial-prereqs.md %}
Download the following configuration files:
-1. [redis-master-deployment.yaml](/docs/tutorials/stateless-application/guestbook/redis-master-deployment.yaml)
-1. [redis-master-service.yaml](/docs/tutorials/stateless-application/guestbook/redis-master-service.yaml)
-1. [redis-slave-deployment.yaml](/docs/tutorials/stateless-application/guestbook/redis-slave-deployment.yaml)
-1. [redis-slave-service.yaml](/docs/tutorials/stateless-application/guestbook/redis-slave-service.yaml)
-1. [frontend-deployment.yaml](/docs/tutorials/stateless-application/guestbook/frontend-deployment.yaml)
-1. [frontend-service.yaml](/docs/tutorials/stateless-application/guestbook/frontend-service.yaml)
+1. [redis-master-deployment.yaml](https://kubernetes.io/docs/tutorials/stateless-application/guestbook/redis-master-deployment.yaml)
+1. [redis-master-service.yaml](https://kubernetes.io/docs/tutorials/stateless-application/guestbook/redis-master-service.yaml)
+1. [redis-slave-deployment.yaml](https://kubernetes.io/docs/tutorials/stateless-application/guestbook/redis-slave-deployment.yaml)
+1. [redis-slave-service.yaml](https://kubernetes.io/docs/tutorials/stateless-application/guestbook/redis-slave-service.yaml)
+1. [frontend-deployment.yaml](https://kubernetes.io/docs/tutorials/stateless-application/guestbook/frontend-deployment.yaml)
+1. [frontend-service.yaml](https://kubernetes.io/docs/tutorials/stateless-application/guestbook/frontend-service.yaml)
{% endcapture %}
diff --git a/docs/user-guide/configmap/README.md b/docs/user-guide/configmap/README.md
index 9a23a29a01..f4c4022053 100644
--- a/docs/user-guide/configmap/README.md
+++ b/docs/user-guide/configmap/README.md
@@ -74,7 +74,7 @@ KUBE_CONFIG_2=value-2
## Step Three: Create a pod that sets the command line using ConfigMap
Use the [`command-pod.yaml`](command-pod.yaml) file to create a Pod with a container
-whose command is injected with the keys of a ConfigMap
+whose command is injected with the keys of a ConfigMap:
```shell
$ kubectl create -f docs/user-guide/configmap/command-pod.yaml
@@ -89,7 +89,7 @@ value-1 value-2
## Step Four: Create a pod that consumes a configMap in a volume
-Pods can also consume ConfigMaps in volumes. Use the [`volume-pod.yaml`](volume-pod.yaml) file to create a Pod that consume the ConfigMap in a volume.
+Pods can also consume ConfigMaps in volumes. Use the [`volume-pod.yaml`](volume-pod.yaml) file to create a Pod that consumes the ConfigMap in a volume.
```shell
$ kubectl create -f docs/user-guide/configmap/volume-pod.yaml
diff --git a/docs/user-guide/docker-cli-to-kubectl.md b/docs/user-guide/docker-cli-to-kubectl.md
index ffbc4cc2a6..cddbd1eda0 100644
--- a/docs/user-guide/docker-cli-to-kubectl.md
+++ b/docs/user-guide/docker-cli-to-kubectl.md
@@ -54,7 +54,7 @@ kubectl run [-i] [--tty] --attach --image=
Unlike `docker run ...`, if `--attach` is specified, we attach to `stdin`, `stdout` and `stderr`, there is no ability to control which streams are attached (`docker -a ...`).
Because we start a Deployment for your container, it will be restarted if you terminate the attached process (e.g. `ctrl-c`), this is different from `docker run -it`.
-To destroy the Deployment (and its pods) you need to run `kubectl delete deployment `
+To destroy the Deployment (and its pods) you need to run `kubectl delete deployment `.
#### docker ps
@@ -78,7 +78,7 @@ nginx-app-5jyvm 1/1 Running 0 1h
#### docker attach
-How do I attach to a process that is already running in a container? Checkout [kubectl attach](/docs/user-guide/kubectl/{{page.version}}/#attach)
+How do I attach to a process that is already running in a container? Checkout [kubectl attach](/docs/user-guide/kubectl/{{page.version}}/#attach).
With docker:
@@ -178,7 +178,7 @@ See [Logging and Monitoring Cluster Activity](/docs/concepts/cluster-administrat
How do I stop and delete a running process? Checkout [kubectl delete](/docs/user-guide/kubectl/{{page.version}}/#delete).
-With docker
+With docker:
```shell
$ docker ps
diff --git a/docs/user-guide/jobs/work-queue-2/redis-service.yaml b/docs/user-guide/jobs/work-queue-2/redis-service.yaml
index 85f2ca2271..519ea60fb9 100644
--- a/docs/user-guide/jobs/work-queue-2/redis-service.yaml
+++ b/docs/user-guide/jobs/work-queue-2/redis-service.yaml
@@ -4,7 +4,7 @@ metadata:
name: redis
spec:
ports:
- - port: 6379
- targetPort: 6379
+ - port: 6379
+ targetPort: 6379
selector:
app: redis
diff --git a/docs/user-guide/jsonpath.md b/docs/user-guide/jsonpath.md
index 0ca17dc318..0efc779a78 100644
--- a/docs/user-guide/jsonpath.md
+++ b/docs/user-guide/jsonpath.md
@@ -5,7 +5,7 @@ title: JSONPath Support
JSONPath template is composed of JSONPath expressions enclosed by {}.
And we add three functions in addition to the original JSONPath syntax:
-1. The `$` operator is optional since the expression always start from the root object by default.
+1. The `$` operator is optional since the expression always starts from the root object by default.
2. We can use `""` to quote text inside JSONPath expressions.
3. We can use `range` operator to iterate lists.
diff --git a/docs/user-guide/kubectl-cheatsheet.md b/docs/user-guide/kubectl-cheatsheet.md
index 7aca9473ef..ddba577c75 100644
--- a/docs/user-guide/kubectl-cheatsheet.md
+++ b/docs/user-guide/kubectl-cheatsheet.md
@@ -18,7 +18,7 @@ $ source <(kubectl completion zsh) # setup autocomplete in zsh
## Kubectl Context and Configuration
-Set which Kubernetes cluster `kubectl` communicates with and modify configuration
+Set which Kubernetes cluster `kubectl` communicates with and modifies configuration
information. See [Authenticating Across Clusters with kubeconfig](/docs/concepts/cluster-administration/authenticate-across-clusters-kubeconfig/) documentation for
detailed config file information.
@@ -231,7 +231,7 @@ $ kubectl taint nodes foo dedicated=special-user:NoSchedule
## Resource types
-The following table includes a list of all the supported resource types and their abbreviated aliases.
+The following table includes a list of all the supported resource types and their abbreviated aliases:
Resource type | Abbreviated alias
-------------------- | --------------------
diff --git a/docs/user-guide/kubectl-overview.md b/docs/user-guide/kubectl-overview.md
index ccfbd5662d..ba735d7fee 100644
--- a/docs/user-guide/kubectl-overview.md
+++ b/docs/user-guide/kubectl-overview.md
@@ -19,20 +19,23 @@ where `command`, `TYPE`, `NAME`, and `flags` are:
* `command`: Specifies the operation that you want to perform on one or more resources, for example `create`, `get`, `describe`, `delete`.
* `TYPE`: Specifies the [resource type](#resource-types). Resource types are case-sensitive and you can specify the singular, plural, or abbreviated forms. For example, the following commands produce the same output:
- ```shell
$ kubectl get pod pod1
$ kubectl get pods pod1
$ kubectl get po pod1
- ```
+
* `NAME`: Specifies the name of the resource. Names are case-sensitive. If the name is omitted, details for all resources are displayed, for example `$ kubectl get pods`.
When performing an operation on multiple resources, you can specify each resource by type and name or specify one or more files:
+
* To specify resources by type and name:
- * To group resources if they are all the same type: `TYPE1 name1 name2 name<#>`
+
+ * To group resources if they are all the same type: `TYPE1 name1 name2 name<#>`.
Example: `$ kubectl get pod example-pod1 example-pod2`
- * To specify multiple resource types individually: `TYPE1/name1 TYPE1/name2 TYPE2/name3 TYPE<#>/name<#>`
+
+ * To specify multiple resource types individually: `TYPE1/name1 TYPE1/name2 TYPE2/name3 TYPE<#>/name<#>`.
Example: `$ kubectl get pod/example-pod1 replicationcontroller/example-rc1`
- * To specify resources with one or more files: `-f file1 -f file2 -f file<#>`
+
+ * To specify resources with one or more files: `-f file1 -f file2 -f file<#>`
[Use YAML rather than JSON](/docs/concepts/configuration/overview/#general-config-tips) since YAML tends to be more user-friendly, especially for configuration files.
Example: `$ kubectl get pod -f ./pod.yaml`
* `flags`: Specifies optional flags. For example, you can use the `-s` or `--server` flags to specify the address and port of the Kubernetes API server.
diff --git a/docs/user-guide/kubectl/v1.5/README.md b/docs/user-guide/kubectl/v1.5/README.md
index f6799c18b9..18abdc4c8b 100644
--- a/docs/user-guide/kubectl/v1.5/README.md
+++ b/docs/user-guide/kubectl/v1.5/README.md
@@ -6,7 +6,7 @@ Static compilation of html from markdown including processing for grouping code
\> bdocs-tab:kubectl Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).
-bdocs-tab:tab will be stripped during rendering and utilized to with CSS to show or hide the prefered tab. kubectl indicates the desired tab, since blockquotes have no specific syntax highlighting.
+bdocs-tab:tab will be stripped during rendering and utilized to with CSS to show or hide the preferred tab. kubectl indicates the desired tab, since blockquotes have no specific syntax highlighting.
\`\`\`bdocs-tab:kubectl_yaml
apiVersion: extensions/v1beta1
@@ -38,7 +38,7 @@ With specific tokens on blockquotes and code blocks, the chunks can be placed ac
Clone the repository, then add documents into documents directory. Modify the manifest.json to contain the document filenames in the order desired. The docs field is an array of objects with a filename key.
-As a NodeJS program, a valid installation of node is required. Once node is installed, verify it can be run from command line.
+As a NodeJS program, a valid installation of node is required. Once node is installed, verify if it can be run from command line.
```
node --version
```
@@ -66,4 +66,4 @@ Apache License Version 2.0
## FAQ
Q: Why is it named brodocs?
-A: This project was born out of a collaboration with my brother to create a suitable docs app for his purposes. It was a fun name for the the two of us to use as actual brothers.
\ No newline at end of file
+A: This project was born out of a collaboration with my brother to create a suitable docs app for his purposes. It was a fun name for the the two of us to use as actual brothers.
diff --git a/docs/user-guide/kubectl/v1.6/README.md b/docs/user-guide/kubectl/v1.6/README.md
index f6799c18b9..18abdc4c8b 100644
--- a/docs/user-guide/kubectl/v1.6/README.md
+++ b/docs/user-guide/kubectl/v1.6/README.md
@@ -6,7 +6,7 @@ Static compilation of html from markdown including processing for grouping code
\> bdocs-tab:kubectl Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).
-bdocs-tab:tab will be stripped during rendering and utilized to with CSS to show or hide the prefered tab. kubectl indicates the desired tab, since blockquotes have no specific syntax highlighting.
+bdocs-tab:tab will be stripped during rendering and utilized to with CSS to show or hide the preferred tab. kubectl indicates the desired tab, since blockquotes have no specific syntax highlighting.
\`\`\`bdocs-tab:kubectl_yaml
apiVersion: extensions/v1beta1
@@ -38,7 +38,7 @@ With specific tokens on blockquotes and code blocks, the chunks can be placed ac
Clone the repository, then add documents into documents directory. Modify the manifest.json to contain the document filenames in the order desired. The docs field is an array of objects with a filename key.
-As a NodeJS program, a valid installation of node is required. Once node is installed, verify it can be run from command line.
+As a NodeJS program, a valid installation of node is required. Once node is installed, verify if it can be run from command line.
```
node --version
```
@@ -66,4 +66,4 @@ Apache License Version 2.0
## FAQ
Q: Why is it named brodocs?
-A: This project was born out of a collaboration with my brother to create a suitable docs app for his purposes. It was a fun name for the the two of us to use as actual brothers.
\ No newline at end of file
+A: This project was born out of a collaboration with my brother to create a suitable docs app for his purposes. It was a fun name for the the two of us to use as actual brothers.
diff --git a/docs/user-guide/kubectl/v1.7/README.md b/docs/user-guide/kubectl/v1.7/README.md
index f6799c18b9..18abdc4c8b 100644
--- a/docs/user-guide/kubectl/v1.7/README.md
+++ b/docs/user-guide/kubectl/v1.7/README.md
@@ -6,7 +6,7 @@ Static compilation of html from markdown including processing for grouping code
\> bdocs-tab:kubectl Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).
-bdocs-tab:tab will be stripped during rendering and utilized to with CSS to show or hide the prefered tab. kubectl indicates the desired tab, since blockquotes have no specific syntax highlighting.
+bdocs-tab:tab will be stripped during rendering and utilized to with CSS to show or hide the preferred tab. kubectl indicates the desired tab, since blockquotes have no specific syntax highlighting.
\`\`\`bdocs-tab:kubectl_yaml
apiVersion: extensions/v1beta1
@@ -38,7 +38,7 @@ With specific tokens on blockquotes and code blocks, the chunks can be placed ac
Clone the repository, then add documents into documents directory. Modify the manifest.json to contain the document filenames in the order desired. The docs field is an array of objects with a filename key.
-As a NodeJS program, a valid installation of node is required. Once node is installed, verify it can be run from command line.
+As a NodeJS program, a valid installation of node is required. Once node is installed, verify if it can be run from command line.
```
node --version
```
@@ -66,4 +66,4 @@ Apache License Version 2.0
## FAQ
Q: Why is it named brodocs?
-A: This project was born out of a collaboration with my brother to create a suitable docs app for his purposes. It was a fun name for the the two of us to use as actual brothers.
\ No newline at end of file
+A: This project was born out of a collaboration with my brother to create a suitable docs app for his purposes. It was a fun name for the the two of us to use as actual brothers.
diff --git a/docs/user-guide/kubectl/v1.7/node_modules/jquery.scrollto/CHANGELOG.md b/docs/user-guide/kubectl/v1.7/node_modules/jquery.scrollto/CHANGELOG.md
index 874087615c..cdec0977f3 100644
--- a/docs/user-guide/kubectl/v1.7/node_modules/jquery.scrollto/CHANGELOG.md
+++ b/docs/user-guide/kubectl/v1.7/node_modules/jquery.scrollto/CHANGELOG.md
@@ -111,7 +111,7 @@
- In addition to window/document, if html or body are received, the plugin will choose the right one.
### Fix
- The plugin accepts floating numbers, Thanks Ramin
-- Using jQuery.nodeName where neccessary so that this works on xml+xhtml
+- Using jQuery.nodeName where necessary so that this works on xml+xhtml
- The max() internal function wasn't completely accurrate, now it is 98% (except for IE on quirks mode and it's not too noticeable).
## 1.4
@@ -183,4 +183,4 @@
- Two axes can be scrolled together, this is set with the option 'axis'.
- In case 2 axes are chosen, the scrolling can be queued: one scrolls, and then the other.
- There's an intermediary event, 'onAfterFirst' called in case the axes are queued, after the first ends.
-- If the option 'margin' is set to true, the plugin will take in account, the margin of the target(no use if target is a value).
\ No newline at end of file
+- If the option 'margin' is set to true, the plugin will take in account, the margin of the target(no use if target is a value).
diff --git a/docs/user-guide/kubectl/v1.7/node_modules/marked/README.md b/docs/user-guide/kubectl/v1.7/node_modules/marked/README.md
index efa71aaaab..bb4b3a9652 100644
--- a/docs/user-guide/kubectl/v1.7/node_modules/marked/README.md
+++ b/docs/user-guide/kubectl/v1.7/node_modules/marked/README.md
@@ -297,7 +297,7 @@ $ cat hello.html
The point of marked was to create a markdown compiler where it was possible to
frequently parse huge chunks of markdown without having to worry about
-caching the compiled output somehow...or blocking for an unnecesarily long time.
+caching the compiled output somehow...or blocking for an unnecessarily long time.
marked is very concise and still implements all markdown features. It is also
now fully compatible with the client-side.
diff --git a/docs/user-guide/services/load-balancer-sample.yaml b/docs/user-guide/services/load-balancer-sample.yaml
index 28b1dd3014..0f53c3a524 100644
--- a/docs/user-guide/services/load-balancer-sample.yaml
+++ b/docs/user-guide/services/load-balancer-sample.yaml
@@ -4,8 +4,8 @@ metadata:
name: myapp
spec:
ports:
- - port: 8765
- targetPort: 9376
+ - port: 8765
+ targetPort: 9376
selector:
app: example
type: LoadBalancer
diff --git a/docs/user-guide/services/service-sample.yaml b/docs/user-guide/services/service-sample.yaml
index c819df7ac5..1563884931 100644
--- a/docs/user-guide/services/service-sample.yaml
+++ b/docs/user-guide/services/service-sample.yaml
@@ -4,7 +4,7 @@ metadata:
name: myapp
spec:
ports:
- - port: 8765
- targetPort: 9376
+ - port: 8765
+ targetPort: 9376
selector:
app: example
diff --git a/update-imported-tutorials.py b/update-imported-tutorials.py
index ba235d1ce5..81b14181f6 100755
--- a/update-imported-tutorials.py
+++ b/update-imported-tutorials.py
@@ -42,7 +42,12 @@ TUTORIALS = [
}),
('mysql-wordpress-pd/README.md',
'./docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md',
- "Example: WordPress and MySQL with Persistent Volumes", {}),
+ "Example: Deploying WordPress and MySQL with Persistent Volumes",
+ {
+ "mysql-wordpress-pd/local-volumes.yaml": "./docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/local-volumes.yaml",
+ "mysql-wordpress-pd/mysql-deployment.yaml": "./docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/mysql-deployment.yaml",
+ "mysql-wordpress-pd/wordpress-deployment.yaml": "./docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/wordpress-deployment.yaml",
+ }),
('cassandra/README.md',
'./docs/tutorials/stateful-application/cassandra.md',
"Example: Deploying Cassandra with Stateful Sets",