* 'master' of https://github.com/kubernetes/kubernetes.github.io:
  Fix typo 'bash' -> 'brew'
  update pod persistent volume example storage class (#3979)
  Change Task titles to imperative: Admin. (#4033)
  Change Task titles to imperative: Daemons, GPUs. (#4032)
  Change Task titles to imperative: Federation. (#4031)
  Change Task titles to imperative: TLS. (#4030)
  Change Task titles to imperative: Access Extend. (#4029)
  Change Task titles to imperative: Monitor. (#4028)
  Change Task titles to imperative: Access Apps. (#4027)
  Change Task title to imperative: Run Job. (#4026)
  Change Task titles to imperative: Run Apps. (#4025)
  Change Task titles to imperative: Inject. (#4024)
  Change Task titles to imperative: Tools. (#4023)
  Change Task titles to imperative. (#4022)
  Fix typo in update-imported-docs.sh
  Add internal provisioner support matrix (#4009)

# Conflicts:
#	docs/tasks/administer-cluster/declare-network-policy.md
This commit is contained in:
Andrew Chen
2017-06-19 10:15:52 -07:00
81 changed files with 185 additions and 156 deletions
+15 -15
View File
@@ -3,13 +3,13 @@ abstract: "Step-by-step instructions for performing operations with Kubernetes."
toc:
- docs/tasks/index.md
- title: Installing Tools
- title: Install Tools
section:
- docs/tasks/tools/install-kubectl.md
- docs/tasks/tools/install-minikube.md
- docs/setup/independent/install-kubeadm.md
- title: Configuring Pods and Containers
- title: Configure Pods and Containers
section:
- docs/tasks/configure-pod-container/assign-cpu-ram-container.md
- docs/tasks/configure-pod-container/configure-volume-storage.md
@@ -25,7 +25,7 @@ toc:
- docs/tasks/configure-pod-container/configure-pod-configmap.md
- docs/tools/kompose/user-guide.md
- title: Injecting Data Into Applications
- title: Inject Data Into Applications
section:
- docs/tasks/inject-data-application/define-command-argument-container.md
- docs/tasks/inject-data-application/define-environment-variable-container.md
@@ -34,7 +34,7 @@ toc:
- docs/tasks/inject-data-application/distribute-credentials-secure.md
- docs/tasks/inject-data-application/podpreset.md
- title: Running Applications
- title: Run Applications
section:
- docs/tasks/run-application/run-stateless-application-deployment.md
- docs/tasks/run-application/run-single-instance-stateful-application.md
@@ -47,13 +47,13 @@ toc:
- docs/tasks/run-application/horizontal-pod-autoscale.md
- docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md
- title: Running Jobs
- title: Run Jobs
section:
- docs/tasks/job/parallel-processing-expansion.md
- docs/tasks/job/coarse-parallel-processing-work-queue/index.md
- docs/tasks/job/fine-parallel-processing-work-queue/index.md
- title: Accessing Applications in a Cluster
- title: Access Applications in a Cluster
section:
- docs/tasks/access-application-cluster/web-ui-dashboard.md
- docs/tasks/access-application-cluster/access-cluster.md
@@ -69,7 +69,7 @@ toc:
- title: Configuring DNS for a Cluster
path: https://github.com/kubernetes/kubernetes/tree/release-1.5/examples/cluster-dns
- title: Monitoring, Logging, and Debugging
- title: Monitor, Log, and Debug
section:
- docs/tasks/debug-application-cluster/resource-usage-monitoring.md
- docs/tasks/debug-application-cluster/get-shell-running-container.md
@@ -85,20 +85,20 @@ toc:
- docs/tasks/debug-application-cluster/debug-stateful-set.md
- docs/tasks/debug-application-cluster/debug-application-introspection.md
- docs/tasks/debug-application-cluster/audit.md
- title: Using Explorer to Examine the Runtime Environment
- title: Use Explorer to Examine the Runtime Environment
path: https://github.com/kubernetes/kubernetes/tree/release-1.5/examples/explorer
- title: Accessing and Extending the Kubernetes API
- title: Access and Extend the Kubernetes API
section:
- docs/tasks/access-kubernetes-api/http-proxy-access-api.md
- docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions.md
- docs/tasks/access-kubernetes-api/extend-api-third-party-resource.md
- title: Using TLS
- title: TLS
section:
- docs/tasks/tls/managing-tls-in-a-cluster.md
- title: Administering a Cluster
- title: Administer a Cluster
section:
- docs/tasks/administer-cluster/access-cluster-api.md
- docs/tasks/administer-cluster/access-cluster-services.md
@@ -127,10 +127,10 @@ toc:
- docs/tasks/administer-cluster/running-cloud-controller.md
- docs/tasks/administer-cluster/highly-available-master.md
- docs/tasks/administer-cluster/configure-multiple-schedulers.md
- title: Changing Cluster Size
- title: Change Cluster Size
path: https://github.com/kubernetes/kubernetes/wiki/User-FAQ#how-do-i-change-the-size-of-my-cluster/
- title: Federation - Running an App on Multiple Clusters
- title: Federation - Run an App on Multiple Clusters
section:
- docs/tasks/federation/federation-service-discovery.md
- docs/tasks/federation/set-up-cluster-federation-kubefed.md
@@ -145,11 +145,11 @@ toc:
- docs/tasks/administer-federation/replicaset.md
- docs/tasks/administer-federation/secret.md
- title: Managing Cluster Daemons
- title: Manage Cluster Daemons
section:
- docs/tasks/manage-daemon/update-daemon-set.md
- title: Managing GPUs
- title: Manage GPUs
section:
- docs/tasks/manage-gpus/scheduling-gpus.md
@@ -411,6 +411,27 @@ parameters:
Storage classes have a provisioner that determines what volume plugin is used
for provisioning PVs. This field must be specified.
| Volume Plugin | Internal Provisioner| Config Example |
| :--- | :---: | :---: |
| AWSElasticBlockStore | ✓ | [AWS](#aws) |
| AzureFile | ✓ | - |
| AzureDisk | ✓ | [Azure Disk](#azure-disk) |
| CephFS | - | - |
| Cinder | ✓ | [OpenStack Cinder](#openstack-cinder)|
| FC | - | - |
| FlexVolume | - | - |
| Flocker | ✓ | - |
| GCEPersistentDisk | ✓ | [GCE](#gce) |
| Glusterfs | ✓ | [Glusterfs](#glusterfs) |
| iSCSI | - | - |
| PhotonPersistentDisk | ✓ | - |
| Quobyte | ✓ | [Quobyte](#quobyte) |
| NFS | - | - |
| RBD | ✓ | [Ceph RBD](#ceph-rbd) |
| VsphereVolume | ✓ | [vSphere](#vsphere) |
| PortworxVolume | ✓ | [Portworx Volume](#portworx-volume) |
| ScaleIO | ✓ | [ScaleIO](#scaleio) |
You are not restricted to specifying the "internal" provisioners
listed here (whose names are prefixed with "kubernetes.io" and shipped
alongside Kubernetes). You can also run and specify external provisioners,
@@ -421,6 +442,11 @@ run, what volume plugin it uses (including Flex), etc. The repository [kubernete
houses a library for writing external provisioners that implements the bulk of
the specification plus various community-maintained external provisioners.
For example, NFS doesn't provide an internal provisioner, but an external provisioner
can be used. Some external provisioners are listed under the repository [kubernetes-incubator/external-storage](https://github.com/kubernetes-incubator/external-storage).
There are also cases when 3rd party storage vendors provide their own external
provisioner.
### Parameters
Storage classes have parameters that describe volumes belonging to the storage
class. Different parameters may be accepted depending on the `provisioner`. For
@@ -2,7 +2,7 @@
assignees:
- mikedanese
- thockin
title: Authenticating Across Clusters with kubeconfig
title: Authenticate Across Clusters with kubeconfig
redirect_from:
- "/docs/user-guide/kubeconfig-file/"
- "/docs/user-guide/kubeconfig-file.html"
@@ -1,5 +1,5 @@
---
title: Communicating Between Containers in the Same Pod Using a Shared Volume
title: Communicate Between Containers in the Same Pod Using a Shared Volume
redirect_from:
- "/docs/user-guide/pods/multi-container/"
- "/docs/user-guide/pods/multi-container.html"
@@ -2,7 +2,7 @@
assignees:
- bprashanth
- davidopp
title: Configuring Your Cloud Provider's Firewalls
title: Configure Your Cloud Provider's Firewalls
redirect_from:
- "/docs/user-guide/services-firewalls/"
- "/docs/user-guide/services-firewalls.html"
@@ -1,5 +1,5 @@
---
title: Connecting a Front End to a Back End Using a Service
title: Connect a Front End to a Back End Using a Service
redirect_from:
- "/docs/user-guide/services/operations/"
- "/docs/user-guide/services/operations.html"
@@ -1,5 +1,5 @@
---
title: Creating an External Load Balancer
title: Create an External Load Balancer
redirect_from:
- "/docs/user-guide/load-balancer/"
- "/docs/user-guide/load-balancer.html"
@@ -163,4 +163,4 @@ Internal pod to pod traffic should behave similar to ClusterIP services, with eq
{% endcapture %}
{% include templates/task.md %}
{% include templates/task.md %}
@@ -1,5 +1,5 @@
---
title: Listing All Container Images Running in a Cluster
title: List All Container Images Running in a Cluster
redirect_from:
- "/docs/tasks/kubectl/list-all-running-container-images/"
- "/docs/tasks/kubectl/list-all-running-container-images.html"
@@ -1,5 +1,5 @@
---
title: Providing Load-Balanced Access to an Application in a Cluster
title: Provide Load-Balanced Access to an Application in a Cluster
---
{% capture overview %}
@@ -1,5 +1,5 @@
---
title: Using Port Forwarding to Access Applications in a Cluster
title: Use Port Forwarding to Access Applications in a Cluster
redirect_from:
- "/docs/user-guide/connecting-to-applications-port-forward/"
- "/docs/user-guide/connecting-to-applications-port-forward.html"
@@ -1,5 +1,5 @@
---
title: Using a Service to Access an Application in a Cluster
title: Use a Service to Access an Application in a Cluster
redirect_from:
- "/docs/user-guide/quick-start/"
- "/docs/user-guide/quick-start.html"
@@ -1,7 +1,7 @@
---
assignees:
- IanLewis
title: Extending the Kubernetes API Using Third Party Resources
title: Extend the Kubernetes API Using Third Party Resources
redirect_from:
- "/docs/user-guide/thirdpartyresources/"
- "/docs/user-guide/thirdpartyresources.html"
@@ -1,5 +1,5 @@
---
title: Using an HTTP Proxy to Access the Kubernetes API
title: Use an HTTP Proxy to Access the Kubernetes API
redirect_from:
- "/docs/user-guide/connecting-to-applications-proxy/"
- "/docs/user-guide/connecting-to-applications-proxy.html"
@@ -1,5 +1,5 @@
---
title: Accessing Clusters Using the Kubernetes API
title: Access Clusters Using the Kubernetes API
redirect_from:
- "/docs/user-guide/accessing-the-cluster/"
- "/docs/user-guide/accessing-the-cluster.html"
@@ -1,5 +1,5 @@
---
title: Accessing Services Running on Clusters
title: Access Services Running on Clusters
redirect_from:
- "/docs/user-guide/accessing-the-cluster/"
- "/docs/user-guide/accessing-the-cluster.html"
@@ -112,4 +112,4 @@ You may be able to put an apiserver proxy url into the address bar of a browser.
{% endcapture %}
{% include templates/task.md %}
{% include templates/task.md %}
@@ -2,7 +2,7 @@
assignees:
- derekwaynecarr
- janetkuo
title: Applying Resource Quotas and Limits
title: Apply Resource Quotas and Limits
redirect_from:
- "/docs/admin/resourcequota/walkthrough/"
- "/docs/admin/resourcequota/walkthrough.html"
@@ -1,7 +1,7 @@
---
assignees:
- caseydavenport
title: Using Calico for NetworkPolicy
title: Use Calico for NetworkPolicy
redirect_from:
- "/docs/getting-started-guides/network-policy/calico/"
- "/docs/getting-started-guides/network-policy/calico.html"
@@ -1,5 +1,5 @@
---
title: Changing the default StorageClass
title: Change the default StorageClass
---
{% capture overview %}
@@ -1,5 +1,5 @@
---
title: Changing the Reclaim Policy of a PersistentVolume
title: Change the Reclaim Policy of a PersistentVolume
---
{% capture overview %}
@@ -2,7 +2,7 @@
assignees:
- davidopp
- madhusudancs
title: Configuring Multiple Schedulers
title: Configure Multiple Schedulers
redirect_from:
- "/docs/admin/multiple-schedulers/"
- "/docs/admin/multiple-schedulers.html"
@@ -1,7 +1,7 @@
---
assignees:
- davidopp
title: Configuring a Pod Disruption Budget
title: Configure a Pod Disruption Budget
redirect_from:
- "/docs/admin/disruptions/"
- "/docs/admin/disruptions.html"
@@ -2,7 +2,7 @@
assignees:
- mml
- wojtek-t
title: Configuring, Upgrading, and Rolling Back etcd
title: Configure, Upgrade, and Roll Back etcd
redirect_from:
- "/docs/concepts/storage/etcd-store-api-object/"
- "/docs/concepts/storage/etcd-store-api-object.html"
@@ -2,7 +2,7 @@
assignees:
- derekwaynecarr
- janetkuo
title: Setting Pod CPU and Memory Limits
title: Set Pod CPU and Memory Limits
redirect_from:
- "/docs/admin/limitrange/"
- "/docs/admin/limitrange/index.html"
@@ -2,7 +2,7 @@
assignees:
- caseydavenport
- danwinship
title: Declaring Network Policy
title: Declare Network Policy
redirect_from:
- "/docs/getting-started-guides/network-policy/walkthrough/"
- "/docs/getting-started-guides/network-policy/walkthrough.html"
@@ -1,5 +1,5 @@
---
title: Autoscaling the DNS Service in a Cluster
title: Autoscale the DNS Service in a Cluster
---
{% capture overview %}
@@ -1,7 +1,7 @@
---
assignees:
- jszczepkowski
title: Setting up High-Availability Kubernetes Masters
title: Set up High-Availability Kubernetes Masters
redirect_from:
- "/docs/admin/ha-master-gce/"
- "/docs/admin/ha-master-gce.html"
@@ -1,5 +1,5 @@
---
title: Limiting Storage Consumption
title: Limit Storage Consumption
redirect_from:
- "/docs/admin/resourcequota/limitstorageconsumption/"
- "/docs/admin/resourcequota/limitstorageconsumption.html"
+1 -1
View File
@@ -2,7 +2,7 @@
assignees:
- derekwaynecarr
- janetkuo
title: Sharing a Cluster with Namespaces
title: Share a Cluster with Namespaces
redirect_from:
- "/docs/admin/namespaces/"
- "/docs/admin/namespaces/index.html"
@@ -3,7 +3,7 @@ assignees:
- derekwaynecarr
- vishh
- timstclair
title: Configuring Out Of Resource Handling
title: Configure Out Of Resource Handling
redirect_from:
- "/docs/admin/out-of-resource/"
- "/docs/admin/out-of-resource.html"
@@ -3,7 +3,7 @@ assignees:
- vishh
- derekwaynecarr
- dashpole
title: Reserving Compute Resources for System Daemons
title: Reserve Compute Resources for System Daemons
redirect_from:
- "/docs/admin/node-allocatable/"
- "/docs/admin/node-allocatable.html"
@@ -1,7 +1,7 @@
---
assignees:
- chrismarino
title: Using Romana for NetworkPolicy
title: Romana for NetworkPolicy
redirect_from:
- "/docs/getting-started-guides/network-policy/romana/"
- "/docs/getting-started-guides/network-policy/romana.html"
@@ -1,7 +1,7 @@
---
assignees:
- thockin
title: Building and Running cloud-controller-manager
title: Build and Run cloud-controller-manager
redirect_from:
- "/docs/getting-started-guides/running-cloud-controller/"
- "/docs/getting-started-guides/running-cloud-controller.html"
@@ -1,7 +1,7 @@
---
assignees:
- davidopp
title: Safely Draining a Node while Respecting Application SLOs
title: Safely Drain a Node while Respecting Application SLOs
---
{% capture overview %}
@@ -2,7 +2,7 @@
assignees:
- mikedanese
- thockin
title: Sharing Cluster Access with kubeconfig
title: Share Cluster Access with kubeconfig
redirect_from:
- "/docs/user-guide/sharing-clusters/"
- "/docs/user-guide/sharing-clusters.html"
@@ -1,7 +1,7 @@
---
assignees:
- bboreham
title: Using Weave Net for NetworkPolicy
title: Weave Net for NetworkPolicy
redirect_from:
- "/docs/getting-started-guides/network-policy/weave/"
- "/docs/getting-started-guides/network-policy/weave.html"
@@ -1,5 +1,5 @@
---
title: Assigning CPU and RAM Resources to a Container
title: Assign CPU and RAM Resources to a Container
description: When you create a Pod, you can request CPU and RAM resources for the containers that run in the Pod. You can also set limits for CPU and RAM use.
---
@@ -20,7 +20,7 @@ in a Kubernetes Pod.
{% capture steps %}
## Assigning CPU and RAM resources to a container
## Assign CPU and RAM resources to a container
When you create a Pod, you can request CPU and RAM resources for the containers
that run in the Pod. You can also set limits for CPU and RAM resources. To
@@ -65,7 +65,7 @@ for the `Pod`:
cpu: 250m
memory: 64Mi
## Understanding CPU and RAM units
## CPU and RAM units
The CPU resource is measured in *cpu*s. Fractional values are allowed. You can
use the suffix *m* to mean mili. For example 100m cpu is 100 milicpu, and is
@@ -1,5 +1,5 @@
---
title: Assigning Pods to Nodes
title: Assign Pods to Nodes
redirect_from:
- "/docs/tasks/administer-cluster/assign-pods-nodes/"
- "/docs/tasks/administer-cluster/assign-pods-nodes.html"
@@ -18,7 +18,7 @@ Kubernetes cluster.
{% capture steps %}
## Adding a label to a node
## Add a label to a node
1. List the nodes in your cluster:
@@ -52,7 +52,7 @@ Kubernetes cluster.
In the preceding output, you can see that the `worker0` node has a
`disktype=ssd` label.
## Creating a pod that gets scheduled to your chosen node
## Create a pod that gets scheduled to your chosen node
This pod configuration file describes a pod that has a node selector,
`disktype: ssd`. This means that the pod will get scheduled on a node that has
@@ -1,5 +1,5 @@
---
title: Attaching Handlers to Container Lifecycle Events
title: Attach Handlers to Container Lifecycle Events
---
{% capture overview %}
@@ -21,7 +21,7 @@ Container is terminated.
{% capture steps %}
## Defining postStart and preStop handlers
## Define postStart and preStop handlers
In this exercise, you create a Pod that has one Container. The Container has handlers
for the postStart and preStop events.
@@ -24,7 +24,7 @@ This page shows you how to configure an application using a ConfigMap.
{% capture steps %}
## Using kubectl to create a ConfigMap
## Use kubectl to create a ConfigMap
Use the `kubectl create configmap` command to create configmaps from [directories](#creating-configmaps-from-directories), [files](#creating-configmaps-from-files), or [literal values](#creating-configmaps-from-literal-values):
@@ -41,7 +41,7 @@ The data source corresponds to a key-value pair in the ConfigMap, where
You can use [`kubectl describe`](docs/user-guide/kubectl/v1.6/#describe) or [`kubectl get`](docs/user-guide/kubectl/v1.6/#get) to retrieve information about a ConfigMap. The former shows a summary of the ConfigMap, while the latter returns the full contents of the ConfigMap.
### Creating ConfigMaps from directories
### Create ConfigMaps from directories
You can use `kubectl create configmap` to create a ConfigMap from multiple files in the same directory.
@@ -106,7 +106,7 @@ metadata:
uid: b4952dc3-d670-11e5-8cd0-68f728db1985
```
### Creating ConfigMaps from files
### Create ConfigMaps from files
You can use `kubectl create configmap` to create a ConfigMap from an individual file, or from multiple files.
@@ -188,7 +188,7 @@ metadata:
uid: 05f8da22-d671-11e5-8cd0-68f728db1985
```
### Creating ConfigMaps from literal values
### Create ConfigMaps from literal values
You can use `kubectl create configmap` with the `--from-literal` argument to define a literal value from the command line:
@@ -2,7 +2,7 @@
redirect_from:
- "/docs/user-guide/liveness/"
- "/docs/user-guide.liveness.html"
title: Configuring Liveness and Readiness Probes
title: Configure Liveness and Readiness Probes
---
{% capture overview %}
@@ -30,7 +30,7 @@ When a Pod is not ready, it is removed from Service load balancers.
{% capture steps %}
## Defining a liveness command
## Define a liveness command
Many applications running for long periods of time eventually transition to
broken states, and cannot recover except by being restarted. Kubernetes provides
@@ -117,7 +117,7 @@ NAME READY STATUS RESTARTS AGE
liveness-exec 1/1 Running 1 1m
```
## Defining a liveness HTTP request
## Define a liveness HTTP request
Another kind of liveness probe uses an HTTP GET request. Here is the configuration
file for a Pod that runs a container based on the `gcr.io/google_containers/liveness`
@@ -174,7 +174,7 @@ the Container has been restarted:
kubectl describe pod liveness-http
```
## Defining a TCP liveness probe
## Define a TCP liveness probe
A third type of liveness probe uses a TCP Socket. With this configuration, the
kubelet will attempt to open a socket to your container on the specified port.
@@ -196,7 +196,7 @@ starts. Just like the readiness probe, this will attempt to connect to the
`goproxy` container on port 8080. If the liveness probe fails, the container
will be restarted.
## Using a named port
## Use a named port
You can use a named
[ContainerPort](/docs/api-reference/v1.6/#containerport-v1-core)
@@ -214,7 +214,7 @@ livenessProbe:
port: liveness-port
```
## Defining readiness probes
## Define readiness probes
Sometimes, applications are temporarily unable to serve traffic.
For example, an application might need to load large data or configuration
@@ -244,7 +244,7 @@ Readiness and liveness probes can be used in parallel for the same container.
Using both can ensure that traffic does not reach a container that is not ready
for it, and that containers are restarted when they fail.
## Configuring Probes
## Configure Probes
{% comment %}
Eventually, some of this section could be moved to a concept topic.
@@ -1,5 +1,5 @@
---
title: Configuring a Pod to Use a PersistentVolume for Storage
title: Configure a Pod to Use a PersistentVolume for Storage
redirect_from:
- "/docs/user-guide/persistent-volumes/walkthrough/"
- "/docs/user-guide/persistent-volumes/walkthrough.html"
@@ -34,7 +34,7 @@ do not already have a single-node cluster, you can create one by using
{% capture steps %}
## Creating an index.html file on your Node
## Create an index.html file on your Node
Open a shell to the Node in your cluster. How you open a shell depends on how
you set up your cluster. For example, if you are using Minikube, you can open a
@@ -48,7 +48,7 @@ In the `/tmp/data` directory, create an `index.html` file:
echo 'Hello from Kubernetes storage' > /tmp/data/index.html
## Creating a PersistentVolume
## Create a PersistentVolume
In this exercise, you create a *hostPath* PersistentVolume. Kubernetes supports
hostPath for development and testing on a single-node cluster. A hostPath
@@ -68,7 +68,9 @@ Here is the configuration file for the hostPath PersistentVolume:
The configuration file specifies that the volume is at `/tmp/data` on the
the cluster's Node. The configuration also specifies a size of 10 gibibytes and
an access mode of `ReadWriteOnce`, which means the volume can be mounted as
read-write by a single Node.
read-write by a single Node. It defines the [StorageClass name](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#class)
`manual` for the PersistentVolume, which will be used to bind
PersistentVolumeClaim requests to this PersistentVolume.
Create the PersistentVolume:
@@ -81,11 +83,10 @@ View information about the PersistentVolume:
The output shows that the PersistentVolume has a `STATUS` of `Available`. This
means it has not yet been bound to a PersistentVolumeClaim.
NAME CAPACITY ACCESSMODES RECLAIMPOLICY STATUS CLAIM REASON AGE
task-pv-volume 10Gi RWO Retain Available 17s
NAME CAPACITY ACCESSMODES RECLAIMPOLICY STATUS CLAIM STORAGECLASS REASON AGE
task-pv-volume 10Gi RWO Retain Available manual 4s
## Creating a PersistentVolumeClaim
## Create a PersistentVolumeClaim
The next step is to create a PersistentVolumeClaim. Pods use PersistentVolumeClaims
to request physical storage. In this exercise, you create a PersistentVolumeClaim
@@ -102,7 +103,8 @@ Create the PersistentVolumeClaim:
After you create the PersistentVolumeClaim, the Kubernetes control plane looks
for a PersistentVolume that satisfies the claim's requirements. If the control
plane finds a suitable PersistentVolume, it binds the claim to the volume.
plane finds a suitable PersistentVolume with the same StorageClass, it binds the
claim to the volume.
Look again at the PersistentVolume:
@@ -110,9 +112,8 @@ Look again at the PersistentVolume:
Now the output shows a `STATUS` of `Bound`.
kubectl get pv task-pv-volume
NAME CAPACITY ACCESSMODES RECLAIMPOLICY STATUS CLAIM REASON AGE
task-pv-volume 10Gi RWO Retain Bound default/task-pv-claim 8m
NAME CAPACITY ACCESSMODES RECLAIMPOLICY STATUS CLAIM STORAGECLASS REASON AGE
task-pv-volume 10Gi RWO Retain Bound default/task-pv-claim manual 2m
Look at the PersistentVolumeClaim:
@@ -121,10 +122,10 @@ Look at the PersistentVolumeClaim:
The output shows that the PersistentVolumeClaim is bound to your PersistentVolume,
`task-pv-volume`.
NAME STATUS VOLUME CAPACITY ACCESSMODES AGE
task-pv-claim Bound task-pv-volume 10Gi RWO 5s
NAME STATUS VOLUME CAPACITY ACCESSMODES STORAGECLASS AGE
task-pv-claim Bound task-pv-volume 10Gi RWO manual 30s
## Creating a Pod
## Create a Pod
The next step is to create a Pod that uses your PersistentVolumeClaim as a volume.
@@ -1,5 +1,5 @@
---
title: Using ConfigMap Data in Pods
title: Use ConfigMap Data in Pods
---
{% capture overview %}
@@ -14,7 +14,7 @@ This page provides a series of usage examples demonstrating how to configure Pod
{% capture steps %}
## Defining Pod environment variables using ConfigMap data
## Define Pod environment variables using ConfigMap data
### Define a Pod environment variable with data from a single ConfigMap
@@ -144,7 +144,7 @@ Note: This functionality is available to users running Kubernetes v1.6 and later
1. Save the changes to the Pod specification. Now, the Pod's output includes `SPECIAL_LEVEL=very` and `SPECIAL_TYPE=charm`.
## Using ConfigMap-defined environment variables in Pod commands
## Use ConfigMap-defined environment variables in Pod commands
You can use ConfigMap-defined environment variables in the `command` section of the Pod specification using the `$(VAR_NAME)` Kubernetes substitution syntax.
@@ -182,7 +182,7 @@ produces the following output in the `test-container` container:
very charm
```
## Adding ConfigMap data to a Volume
## Add ConfigMap data to a Volume
As explained in [Configure Containers Using a ConfigMap](/docs/tasks/configure-pod-container/configmap.html), when you create a ConfigMap using ``--from-file``, the filename becomes a key stored in the `data` section of the ConfigMap. The file contents become the key's value.
@@ -268,7 +268,7 @@ When the pod runs, the command (`"cat /etc/config/keys/special.level"`) produces
very
```
### Projecting keys to specific paths and file permissions
### Project keys to specific paths and file permissions
You can project keys to specific paths and specific permissions on a per-file
basis. The [Secrets](/docs/concepts/configuration/secret#using-secrets-as-files-from-a-pod) user guide explains the syntax.
@@ -1,5 +1,5 @@
---
title: Configuring Pod Initialization
title: Configure Pod Initialization
---
{% capture overview %}
@@ -16,7 +16,7 @@ application Container runs.
{% capture steps %}
## Creating a Pod that has an Init Container
## Create a Pod that has an Init Container
In this exercise you create a Pod that has one application Container and one
Init Container. The init container runs to completion before the application
@@ -2,7 +2,7 @@
assignees:
- jpeeler
- pmorie
title: Configuring a Pod to Use a Projected Volume for Storage
title: Configure a Pod to Use a Projected Volume for Storage
redirect_from:
- "/docs/tasks/configure-pod-container/projected-volume/"
- "/docs/user-guide/projected-volume/"
@@ -3,7 +3,7 @@ assignees:
- bprashanth
- liggitt
- thockin
title: Configuring Service Accounts for Pods
title: Configure Service Accounts for Pods
redirect_from:
- "/docs/user-guide/service-accounts/"
- "/docs/user-guide/service-accounts.html"
@@ -26,7 +26,7 @@ cluster). Processes in containers inside pods can also contact the apiserver.
When they do, they are authenticated as a particular Service Account (e.g.
`default`).
## Using the Default Service Account to access the API server.
## Use the Default Service Account to access the API server.
When you create a pod, if you do not specify a service account, it is
automatically assigned the `default` service account in the same namespace.
@@ -65,7 +65,7 @@ spec:
The pod spec takes precedence over the service account if both specify a `automountServiceAccountToken` value.
## Using Multiple Service Accounts.
## Use Multiple Service Accounts.
Every namespace has a default service account resource called `default`.
You can list this and any other serviceAccount resources in the namespace with this command:
@@ -164,7 +164,7 @@ namespace: 7 bytes
> Note that the content of `token` is elided here.
## Adding ImagePullSecrets to a service account
## Add ImagePullSecrets to a service account
First, create an imagePullSecret, as described [here](/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod)
Next, verify it has been created. For example:
@@ -1,5 +1,5 @@
---
title: Configuring a Pod to Use a Volume for Storage
title: Configure a Pod to Use a Volume for Storage
---
{% capture overview %}
@@ -23,7 +23,7 @@ key-value cache and store.
{% capture steps %}
## Configuring a volume for a Pod
## Configure a volume for a Pod
In this exercise, you create a Pod that runs one Container. This Pod has a
Volume of type
@@ -1,5 +1,5 @@
---
title: Pulling an Image from a Private Registry
title: Pull an Image from a Private Registry
---
{% capture overview %}
@@ -20,7 +20,7 @@ private Docker registry or repository.
{% capture steps %}
## Logging in to Docker
## Log in to Docker
docker login
@@ -45,7 +45,7 @@ The output contains a section similar to this:
NOTE: If you use a Docker credentials store, you won't see that `auth` entry but a `credsStore` entry with the name of the store as value.
## Creating a Secret that holds your authorization token
## Create a Secret that holds your authorization token
Create a Secret named `regsecret`:
@@ -95,7 +95,7 @@ The output is similar to this:
Notice that the secret data contains the authorization token from your
`config.json` file.
## Creating a Pod that uses your Secret
## Create a Pod that uses your Secret
Here is a configuration file for a Pod that needs access to your secret data:
@@ -3,6 +3,7 @@ apiVersion: v1
metadata:
name: task-pv-claim
spec:
storageClassName: manual
accessModes:
- ReadWriteOnce
resources:
@@ -5,6 +5,7 @@ metadata:
labels:
type: local
spec:
storageClassName: manual
capacity:
storage: 10Gi
accessModes:
@@ -2,7 +2,7 @@
assignees:
- mikedanese
- thockin
title: Troubleshooting Applications
title: Troubleshoot Applications
redirect_from:
- "/docs/user-guide/application-troubleshooting/"
- "/docs/user-guide/application-troubleshooting.html"
@@ -1,7 +1,7 @@
---
assignees:
- davidopp
title: Troubleshooting Clusters
title: Troubleshoot Clusters
redirect_from:
- "/docs/admin/cluster-troubleshooting/"
- "/docs/admin/cluster-troubleshooting.html"
@@ -7,7 +7,7 @@ assignees:
- janetkuo
- kow3ns
- smarterclayton
title: Debugging Init Containers
title: Debug Init Containers
redirect_from:
- "/docs/tasks/troubleshoot/debug-init-containers/"
- "/docs/tasks/troubleshoot/debug-init-containers.html"
@@ -1,7 +1,7 @@
---
assignees:
- bprashanth
title: Debugging Pods and Replication Controllers
title: Debug Pods and Replication Controllers
redirect_from:
- "/docs/user-guide/debugging-pods-and-replication-controllers/"
- "/docs/user-guide/debugging-pods-and-replication-controllers.html"
@@ -3,7 +3,7 @@ assignees:
- bprashanth
- janetkuo
- thockin
title: Debugging Services
title: Debug Services
redirect_from:
- "/docs/user-guide/debugging-services/"
- "/docs/user-guide/debugging-services.html"
@@ -7,7 +7,7 @@ assignees:
- janetkuo
- kow3ns
- smarterclayton
title: Debugging a StatefulSet
title: Debug a StatefulSet
redirect_from:
- "/docs/tasks/manage-stateful-set/debugging-a-statefulset/"
- "/docs/tasks/manage-stateful-set/debugging-a-statefulset.html"
@@ -1,5 +1,5 @@
---
title: Determining the Reason for Pod Failure
title: Determine the Reason for Pod Failure
---
{% capture overview %}
@@ -2,7 +2,7 @@
assignees:
- caesarxuchao
- mikedanese
title: Getting a Shell to a Running Container
title: Get a Shell to a Running Container
redirect_from:
- "/docs/user-guide/getting-into-containers/"
- "/docs/user-guide/getting-into-containers.html"
@@ -2,7 +2,7 @@
assignees:
- Random-Liu
- dchen1107
title: Monitoring Node Health
title: Monitor Node Health
redirect_from:
- "/docs/admin/node-problem/"
- "/docs/admin/node-problem.html"
@@ -1,7 +1,7 @@
---
assignees:
- madhusudancs
title: Setting up Cluster Federation with Kubefed
title: Set up Cluster Federation with Kubefed
redirect_from:
- "/docs/admin/federation/kubefed/"
- "/docs/admin/federation/kubefed.html"
@@ -1,5 +1,5 @@
---
title: Setting up CoreDNS as DNS provider for Cluster Federation
title: Set up CoreDNS as DNS provider for Cluster Federation
redirect_from:
- "/docs/tutorials/federation/set-up-coredns-provider-federation/"
- "/docs/tutorials/federation/set-up-coredns-provider-federation.html"
@@ -1,5 +1,5 @@
---
title: Defining a Command and Arguments for a Container
title: Define a Command and Arguments for a Container
redirect_from:
- "/docs/concepts/configuration/container-command-args/"
- "/docs/concepts/configuration/container-command-arg.html"
@@ -22,7 +22,7 @@ in a Kubernetes Pod.
{% capture steps %}
## Defining a command and arguments when you create a Pod
## Define a command and arguments when you create a Pod
When you create a Pod, you can define a command and arguments for the
containers that run in the Pod. To define a command, include the `command`
@@ -62,7 +62,7 @@ from the Pod:
command-demo
tcp://10.3.240.1:443
## Using environment variables to define arguments
## Use environment variables to define arguments
In the preceding example, you defined the arguments directly by
providing strings. As an alternative to providing strings directly,
@@ -83,7 +83,7 @@ and
NOTE: The environment variable appears in parentheses, `"$(VAR)"`. This is
required for the variable to be expanded in the `command` or `args` field.
## Running a command in a shell
## Run a command in a shell
In some cases, you need your command to run in a shell. For example, your
command might consist of several commands piped together, or it might be a shell
@@ -1,5 +1,5 @@
---
title: Defining Environment Variables for a Container
title: Define Environment Variables for a Container
redirect_from:
- "/docs/tasks/configure-pod-container/define-environment-variable-container/"
- "/docs/tasks/configure-pod-container/define-environment-variable-container.html"
@@ -22,7 +22,7 @@ in a Kubernetes Pod.
{% capture steps %}
## Defining an environment variable for a container
## Define an environment variable for a container
When you create a Pod, you can set environment variables for the containers
that run in the Pod. To set environment variables, include the `env` or
@@ -1,5 +1,5 @@
---
title: Distributing Credentials Securely Using Secrets
title: Distribute Credentials Securely Using Secrets
redirect_from:
- "/docs/user-guide/secrets/walkthrough/"
- "/docs/user-guide/secrets/walkthrough.html"
@@ -20,7 +20,7 @@ encryption keys, into Pods.
{% capture steps %}
## Converting your secret data to a base-64 representation
## Convert your secret data to a base-64 representation
Suppose you want to have two pieces of secret data: a username `my-app` and a password
`39528$vdg7Jb`. First, use [Base64 encoding](https://www.base64encode.org/) to
@@ -33,7 +33,7 @@ example:
The output shows that the base-64 representation of your username is `bXktYXBw`,
and the base-64 representation of your password is `Mzk1MjgkdmRnN0pi`.
## Creating a Secret
## Create a Secret
Here is a configuration file you can use to create a Secret that holds your
username and password:
@@ -77,7 +77,7 @@ username and password:
password: 13 bytes
username: 7 bytes
## Creating a Pod that has access to the secret data through a Volume
## Create a Pod that has access to the secret data through a Volume
Here is a configuration file you can use to create a Pod:
@@ -124,7 +124,7 @@ is exposed:
my-app
39528$vdg7Jb
## Creating a Pod that has access to the secret data through environment variables
## Create a Pod that has access to the secret data through environment variables
Here is a configuration file you can use to create a Pod:
@@ -1,5 +1,5 @@
---
title: Exposing Pod Information to Containers Through Files
title: Expose Pod Information to Containers Through Files
redirect_from:
- "/docs/user-guide/downward-api/"
- "/docs/user-guide/downward-api/index.html"
@@ -36,7 +36,7 @@ There are two ways to expose Pod and Container fields to a running Container:
Together, these two ways of exposing Pod and Container fields are called the
*Downward API*.
## Storing Pod fields
## Store Pod fields
In this exercise, you create a Pod that has one Container.
Here is the configuration file for the Pod:
@@ -147,7 +147,7 @@ Exit the shell:
/# exit
```
## Storing Container fields
## Store Container fields
The preceding exercise, you stored Pod fields in a DownwardAPIVolumeFile.
In this next exercise, you store Container fields. Here is the configuration
@@ -213,7 +213,7 @@ DownwardAPIVolumeFiles.
**Note**: If CPU and memory limits are not specified for a Container, the
Downward API defaults to the node allocatable value for CPU and memory.
## Projecting keys to specific paths and file permissions
## Project keys to specific paths and file permissions
You can project keys to specific paths and specific permissions on a per-file
basis. For more information, see
@@ -1,5 +1,5 @@
---
title: Exposing Pod Information to Containers Through Environment Variables
title: Expose Pod Information to Containers Through Environment Variables
redirect_from:
- "/docs/user-guide/environment-guide/"
- "/docs/user-guide/environment-guide/index.html"
@@ -42,7 +42,7 @@ Together, these two ways of exposing Pod and Container fields are called the
*Downward API*.
## Using Pod fields as values for environment variables
## Use Pod fields as values for environment variables
In this exercise, you create a Pod that has one Container. Here is the
configuration file for the Pod:
@@ -117,7 +117,7 @@ MY_NODE_NAME=minikube
MY_POD_NAME=dapi-envars-fieldref
```
## Using Container fields as values for environment variables
## Use Container fields as values for environment variables
In the preceding exercise, you used Pod fields as the values for environment
variables. In this next exercise, you use Container fields as the values for
@@ -1,7 +1,7 @@
---
assignees:
- jessfraz
title: Injecting Information into Pods Using a PodPreset
title: Inject Information into Pods Using a PodPreset
redirect_from:
- "/docs/user-guide/pod-preset/index/"
- "/docs/user-guide/pod-preset/index.html"
@@ -54,7 +54,7 @@ modified by a `PodPreset`. The annotation is of the form
`podpreset.admission.kubernetes.io/<pod-preset name>": "<resource version>"`.
## Enabling Pod Preset
## Enable Pod Preset
In order to use Pod Presets in your cluster you must ensure the
following
@@ -63,7 +63,7 @@ following
1. You have enabled the admission controller `PodPreset`
1. You have defined your pod presets
## Creating a Pod Preset
## Create a Pod Preset
### Simple Pod Spec Example
@@ -1,7 +1,7 @@
---
assignees:
- janetkuo
title: Performing a Rolling Update on a DaemonSet
title: Perform a Rolling Update on a DaemonSet
---
{% capture overview %}
+1 -1
View File
@@ -1,7 +1,7 @@
---
assignees:
- vishh
title: Scheduling GPUs
title: Schedule GPUs
redirect_from:
- "/docs/user-guide/gpus/"
- "/docs/user-guide/gpus.html"
@@ -5,7 +5,7 @@ assignees:
- foxish
- janetkuo
- smarterclayton
title: Deleting a Stateful Set
title: Delete a Stateful Set
redirect_from:
- "/docs/tasks/manage-stateful-set/deleting-a-statefulset/"
- "/docs/tasks/manage-stateful-set/deleting-a-statefulset.html"
@@ -4,7 +4,7 @@ assignees:
- erictune
- foxish
- smarterclayton
title: Force Deleting StatefulSet Pods
title: Force Delete StatefulSet Pods
redirect:from:
- "/docs/tasks/manage-stateful-set/delete-pods/"
- "/docs/tasks/manage-stateful-set/delete-pods.html"
@@ -30,7 +30,7 @@ In normal operation of a StatefulSet, there is **never** a need to force delete
Manual force deletion should be undertaken with caution, as it has the potential to violate the at most one semantics inherent to StatefulSet. StatefulSets may be used to run distributed and clustered applications which have a need for a stable network identity and stable storage. These applications often have configuration which relies on an ensemble of a fixed number of members with fixed identities. Having multiple members with the same identity can be disastrous and may lead to data loss (e.g. split brain scenario in quorum-based systems).
## Deleting Pods
## Delete Pods
You can perform a graceful pod deletion with the following command:
@@ -1,7 +1,7 @@
---
assignees:
- janetkuo
title: Performing a Rolling Update Using a Replication Controller
title: Perform Rolling Update Using a Replication Controller
redirect_from:
- "/docs/user-guide/rolling-updates/"
- "/docs/user-guide/rolling-updates.html"
@@ -7,7 +7,7 @@ assignees:
- janetkuo
- kow3ns
- smarterclayton
title: Running a Replicated Stateful Application
title: Run a Replicated Stateful Application
redirect_from:
- "/docs/tutorials/stateful-application/run-replicated-stateful-application/"
- "/docs/tutorials/stateful-application/run-replicated-stateful-application.html"
@@ -52,7 +52,7 @@ on general patterns for running stateful applications in Kubernetes.
{% capture lessoncontent %}
## Deploying MySQL
## Deploy MySQL
The example MySQL deployment consists of a ConfigMap, two Services,
and a StatefulSet.
@@ -1,5 +1,5 @@
---
title: Running a Single-Instance Stateful Application
title: Run a Single-Instance Stateful Application
redirect_from:
- "/docs/tutorials/stateful-application/run-stateful-application/"
- "/docs/tutorials/stateful-application/run-stateful-application.html"
@@ -1,5 +1,5 @@
---
title: Running a Stateless Application Using a Deployment
title: Run a Stateless Application Using a Deployment
redirect_from:
- "/docs/user-guide/simple-nginx/"
- "/docs/user-guide/simple-nginx.html"
@@ -7,7 +7,7 @@ assignees:
- janetkuo
- kow3ns
- smarterclayton
title: Scaling a StatefulSet
title: Scale a StatefulSet
redirect_from:
- "/docs/tasks/manage-stateful-set/scale-stateful-set/"
- "/docs/tasks/manage-stateful-set/scale-stateful-set.html"
@@ -7,7 +7,7 @@ assignees:
- janetkuo
- kow3ns
- smarterclayton
title: Upgrading from PetSets to StatefulSets
title: Upgrade from PetSets to StatefulSets
redirect_from:
- "/docs/tasks/manage-stateful-set/upgrade-pet-set-to-stateful-set/"
- "/docs/tasks/manage-stateful-set/upgrade-pet-set-to-stateful-set.html"
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Managing TLS Certificates in a Cluster
title: Manage TLS Certificates in a Cluster
assignees:
- mikedanese
- beacham
+3 -3
View File
@@ -2,7 +2,7 @@
assignees:
- bgrant0607
- mikedanese
title: Installing and Setting Up kubectl
title: Install and Set Up kubectl
redirect_from:
- "/docs/tasks/kubectl/install/"
- "/docs/tasks/kubectl/install.html"
@@ -122,7 +122,7 @@ touch config
```
Edit the config file with a text editor of your choice, such as Notepad for example.
## Configuring kubectl
## Configure kubectl
In order for kubectl to find and access a Kubernetes cluster, it needs a [kubeconfig file](/docs/concepts/cluster-administration/authenticate-across-clusters-kubeconfig/), which is created automatically when you create a cluster using kube-up.sh or successfully deploy a Minikube cluster. See the [getting started guides](/docs/getting-started-guides/) for more about creating clusters. If you need access to a cluster you didn't create, see the [Sharing Cluster Access document](/docs/tasks/administer-cluster/share-configuration/).
By default, kubectl configuration is located at `~/.kube/config`.
@@ -164,7 +164,7 @@ On macOS, you will need to install bash-completion support via [Homebrew](https:
## If running Bash 3.2 included with macOS
brew install bash-completion
## or, if running Bash 4.1+
bash install bash-completion@2
brew install bash-completion@2
```
Follow the "caveats" section of brew's output to add the appropriate bash completion path to your local .bashrc.
+4 -4
View File
@@ -1,5 +1,5 @@
---
title: Installing Minikube
title: Install Minikube
---
{% capture overview %}
@@ -16,7 +16,7 @@ VT-x or AMD-v virtualization must be enabled in your computer's BIOS.
{% capture steps %}
## Installing a Hypervisor
## Install a Hypervisor
If you do not already have a hypervisor installed, install one now.
@@ -33,11 +33,11 @@ If you do not already have a hypervisor installed, install one now.
[VirtualBox](https://www.virtualbox.org/wiki/Downloads) or
[Hyper-V](https://msdn.microsoft.com/en-us/virtualization/hyperv_on_windows/quick_start/walkthrough_install).
## Installing kubectl
## Install kubectl
* [Install kubectl](/docs/tasks/tools/install-kubectl/).
## Installing Minikube
## Install Minikube
* Install Minikube according to the instructions for the
[latest release](https://github.com/kubernetes/minikube/releases).
+1 -1
View File
@@ -3,7 +3,7 @@
assignees:
- cdrage
title: Translating a Docker Compose File to Kubernetes Resources
title: Translate a Docker Compose File to Kubernetes Resources
redirect_from:
- "/docs/tools/kompose/"
- "/docs/tools/kompose/index.html"
+1 -1
View File
@@ -142,7 +142,7 @@ BINARIES="federation-apiserver.md federation-controller-manager.md kube-apiserve
cd docs/admin
for bin in $BINARIES; do
sed -i -e '/<!-- BEGIN MUNGE: IS_VERSIONED -->/,/<!-- END MUNGE: IS_VERSIONED -->/d' "$bin"
sed -i -e '/<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->/,/<!-- END MUNGE: UNVERSIONED_WARNINgG -->/d' "$bin"
sed -i -e '/<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->/,/<!-- END MUNGE: UNVERSIONED_WARNING -->/d' "$bin"
sed -i -e '1 i\
---' "$bin"
sed -i -e '1 i\