From 94a6bbaeb244cd9f41a96d158a704ca027245514 Mon Sep 17 00:00:00 2001 From: Steve Perry Date: Wed, 25 Oct 2017 22:10:00 -0700 Subject: [PATCH] Put orphaned topics in TOC. (#6051) --- _data/concepts.yml | 1 + _data/reference.yml | 2 + _redirects | 3 + .../labels-annotations-taints.md | 7 -- docs/contribute/README.md | 1 - docs/getting-started-guides/docker.md | 5 - docs/tabs-example.md | 119 ------------------ docs/user-guide/configmap/README.md | 106 ---------------- docs/user-guide/downward-api/README.md | 52 -------- docs/user-guide/liveness/image/README.md | 1 - docs/user-guide/pods/_viewing-a-pod.md | 58 --------- docs/user-guide/simple-yaml.md | 7 -- .../update-demo/images/kitten/README.md | 1 - .../update-demo/images/nautilus/README.md | 1 - 14 files changed, 6 insertions(+), 358 deletions(-) delete mode 100644 docs/api-reference/labels-annotations-taints.md delete mode 100644 docs/contribute/README.md delete mode 100644 docs/getting-started-guides/docker.md delete mode 100644 docs/tabs-example.md delete mode 100644 docs/user-guide/configmap/README.md delete mode 100644 docs/user-guide/downward-api/README.md delete mode 100644 docs/user-guide/liveness/image/README.md delete mode 100644 docs/user-guide/pods/_viewing-a-pod.md delete mode 100644 docs/user-guide/simple-yaml.md delete mode 100644 docs/user-guide/update-demo/images/kitten/README.md delete mode 100644 docs/user-guide/update-demo/images/nautilus/README.md diff --git a/_data/concepts.yml b/_data/concepts.yml index cb457699fa2d8..06f877a6901bf 100644 --- a/_data/concepts.yml +++ b/_data/concepts.yml @@ -42,6 +42,7 @@ toc: - docs/concepts/workloads/pods/init-containers.md - docs/concepts/workloads/pods/podpreset.md - docs/concepts/workloads/pods/disruptions.md + - docs/concepts/abstractions/pod-termination.md - title: Controllers section: - docs/concepts/workloads/controllers/replicaset.md diff --git a/_data/reference.yml b/_data/reference.yml index 48abc0b2d68f0..08842016084af 100644 --- a/_data/reference.yml +++ b/_data/reference.yml @@ -83,10 +83,12 @@ toc: - title: Config Reference section: - docs/admin/kubelet.md + - docs/admin/kubelet-authentication-authorization.md - docs/admin/kube-apiserver.md - docs/admin/kube-controller-manager.md - docs/admin/kube-proxy.md - docs/admin/kube-scheduler.md + - docs/admin/kubelet-tls-bootstrapping.md - docs/admin/federation-apiserver.md - docs/admin/federation-controller-manager.md diff --git a/_redirects b/_redirects index e342566db07ca..8b2dc56ff9d50 100644 --- a/_redirects +++ b/_redirects @@ -66,6 +66,7 @@ /docs/api-reference/certificates.k8s.io/v1alpha1/definitions/ https://v1-4.docs.kubernetes.io/docs/api-reference/certificates.k8s.io/v1alpha1/definitions/ 301 /docs/api-reference/certificates/v1alpha1/operations/ https://v1-4.docs.kubernetes.io/docs/api-reference/certificates/v1alpha1/operations/ 301 /docs/api-reference/extensions/v1beta1/operations/ https://v1-4.docs.kubernetes.io/docs/api-reference/extensions/v1beta1/operations/ 301 +/docs/api-reference/labels-annotations-taints/ /docs/reference/labels-annotations-taints/ 301 /docs/api-reference/policy/v1alpha1/definitions/ https://v1-4.docs.kubernetes.io/docs/api-reference/policy/v1alpha1/definitions/ 301 /docs/api-reference/policy/v1beta1/definitions/ https://v1-4.docs.kubernetes.io/docs/api-reference/policy/v1beta1/definitions/ 301 /docs/api-reference/README/ https://v1-4.docs.kubernetes.io/docs/api-reference/README/ 301 @@ -278,6 +279,7 @@ /docs/user-guide/compute-resources/ /docs/concepts/configuration/manage-compute-resources-container/ 301 /docs/user-guide/config-best-practices/ /docs/concepts/configuration/overview/ 301 /docs/user-guide/configmap/ /docs/tasks/configure-pod-container/configmap/ 301 +/docs/user-guide/configmap/README/ /docs/tasks/configure-pod-container/configure-pod-configmap/ 301 /docs/user-guide/configuring-containers/ /docs/tasks/ 301 /docs/user-guide/connecting-applications/ /docs/concepts/services-networking/connect-applications-service/ 301 /docs/user-guide/connecting-to-applications-port-forward/ /docs/tasks/access-application-cluster/port-forward-access-application-cluster/ 301 @@ -290,6 +292,7 @@ /docs/user-guide/deploying-applications/ /docs/tasks/run-application/run-stateless-application-deployment/ 301 /docs/user-guide/deployments/ /docs/concepts/workloads/controllers/deployment/ 301 /docs/user-guide/downward-api/ /docs/tasks/inject-data-application/downward-api-volume-expose-pod-information/ 301 +/docs/user-guide/downward-api/README/ /docs/tasks/inject-data-application/downward-api-volume-expose-pod-information/ 301 /docs/user-guide/downward-api/volume/ /docs/tasks/inject-data-application/downward-api-volume-expose-pod-information/ 301 /docs/user-guide/environment-guide/ /docs/tasks/inject-data-application/environment-variable-expose-pod-information/ 301 /docs/user-guide/federation/ /docs/concepts/cluster-administration/federation/ 301 diff --git a/docs/api-reference/labels-annotations-taints.md b/docs/api-reference/labels-annotations-taints.md deleted file mode 100644 index 492237bd57370..0000000000000 --- a/docs/api-reference/labels-annotations-taints.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Well-Known Labels, Annotations and Taints ---- - -{% include api-reference-content-moved.md %} - -* [Well-Known Labels, Annotations and Taints](/docs/reference/labels-annotations-taints/) diff --git a/docs/contribute/README.md b/docs/contribute/README.md deleted file mode 100644 index fd8137c3e776d..0000000000000 --- a/docs/contribute/README.md +++ /dev/null @@ -1 +0,0 @@ -This directory is deprecated and its contents have been moved to /docs/home/contribute/. \ No newline at end of file diff --git a/docs/getting-started-guides/docker.md b/docs/getting-started-guides/docker.md deleted file mode 100644 index 889e5e5b891a7..0000000000000 --- a/docs/getting-started-guides/docker.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -sitemap: false -redirect_to: -- "https://github.com/kubernetes/minikube" ---- diff --git a/docs/tabs-example.md b/docs/tabs-example.md deleted file mode 100644 index 425b487044f22..0000000000000 --- a/docs/tabs-example.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -approvers: -- chenopis -title: Tabs Example ---- - -In a markdown page (.md file) on this site, you can add a tab set to display multiple flavors of a given solution. - -## Demo - -{% capture default_tab %} -Select one of the tabs. -{% endcapture %} - -{% capture calico %} -```shell -kubectl apply -f "http://docs.projectcalico.org/v2.4/getting-started/kubernetes/installation/hosted/kubeadm/calico.yaml" -``` -{% endcapture %} - -{% capture flannel %} -```shell -kubectl apply -f "https://github.com/coreos/flannel/blob/master/Documentation/kube-flannel.yml?raw=true" -``` -{% endcapture %} - -{% capture romana %} -```shell -kubectl apply -f "https://raw.githubusercontent.com/romana/romana/master/containerize/specs/romana-kubeadm.yml" -``` -{% endcapture %} - -{% capture weave_net %} -```shell -kubectl apply -f "https://git.io/weave-kube" -``` -{% endcapture %} - -{% assign tab_names = "Default,Calico,Flannel,Romana,Weave Net" | split: ',' | compact %} -{% assign tab_contents = site.emptyArray | push: default_tab | push: calico | push: flannel | push: romana | push: weave_net %} - -{% include tabs.md %} - -## Example Liquid template code for tabs - -Below is the [Liquid](https://shopify.github.io/liquid/) template code for the tabs demo above to illustrate how to specify the contents of each tab. The [`/_includes/tabs.md`](https://git.k8s.io/website/_includes/tabs.md) file included at the end then uses those elements to render the actual tab set. - -### The code - -````liquid -{{ "{% capture default_tab " }}%} -Select one of the tabs. -{{ "{% endcapture " }}%} - -{{ "{% capture calico " }}%} -```shell -kubectl apply -f "http://docs.projectcalico.org/v2.4/getting-started/kubernetes/installation/hosted/kubeadm/calico.yaml" -``` -{{ "{% endcapture " }}%} - -{{ "{% capture flannel " }}%} -```shell -kubectl apply -f "https://github.com/coreos/flannel/blob/master/Documentation/kube-flannel.yml?raw=true" -``` -{{ "{% endcapture " }}%} - -{{ "{% capture romana " }}%} -```shell -kubectl apply -f "https://raw.githubusercontent.com/romana/romana/master/containerize/specs/romana-kubeadm.yml" -``` -{{ "{% endcapture " }}%} - -{{ "{% capture weave_net " }}%} -```shell -kubectl apply -f "https://git.io/weave-kube" -``` -{{ "{% endcapture " }}%} - -{{ "{% assign tab_names = 'Default,Calico,Flannel,Romana,Weave Net' | split: ',' | compact " }}%} -{{ "{% assign tab_contents = site.emptyArray | push: default_tab | push: calico | push: flannel | push: romana | push: weave_net " }}%} - -{{ "{% include tabs.md " }}%} -```` - -### Capturing tab content - -````liquid -{{ "{% capture calico " }}%} -```shell -kubectl apply -f "http://docs.projectcalico.org/v2.4/getting-started/kubernetes/installation/hosted/kubeadm/calico.yaml" -``` -{{ "{% endcapture " }}%} -```` - -The `capture [variable_name]` tags store text or markdown content and assign them to the specified variable. - -### Assigning tab names - -````liquid -{{ "{% assign tab_names = 'Default,Calico,Flannel,Romana,Weave Net' | split: ',' | compact " }}%} -```` - -The `assign tab_names` tag takes a list of labels to use for the tabs. Label text can include spaces. The given comma delimited string is split into an array and assigned to the `tab_names` variable. - -### Assigning tab contents - -````liquid -{{ "{% assign tab_contents = site.emptyArray | push: default_tab | push: calico | push: flannel | push: romana | push: weave_net " }}%} -```` - -The `assign tab_contents` tag adds the contents of each tab pane, captured above, as elements to the `tab_contents` array. - -### Including the tabs.md template - -````liquid -{{ "{% include tabs.md " }}%} -```` - -`{{ "{% include tabs.md " }}%}` pulls in the tabs template code, which uses the `tab_names` and `tab_contents` variables to render the tab set. diff --git a/docs/user-guide/configmap/README.md b/docs/user-guide/configmap/README.md deleted file mode 100644 index f4c402205397e..0000000000000 --- a/docs/user-guide/configmap/README.md +++ /dev/null @@ -1,106 +0,0 @@ -# ConfigMap example - - - -## Step Zero: Prerequisites - -This example assumes you have a Kubernetes cluster installed and running, and that you have -installed the `kubectl` command line tool somewhere in your path. Please see [pick the right solution -started](/docs/setup/pick-right-solution/) for installation instructions for your platform. - -## Step One: Create the ConfigMap - -A ConfigMap contains a set of named strings. - -Use the [`configmap.yaml`](configmap.yaml) file to create a ConfigMap: - -```shell -$ kubectl create -f docs/user-guide/configmap/configmap.yaml -``` - -You can use `kubectl` to see information about the ConfigMap: - -```shell -$ kubectl get configmap -NAME DATA AGE -test-configmap 2 6s - -$ kubectl describe configMap test-configmap -Name: test-configmap -Labels: -Annotations: - -Data -==== -data-1: 7 bytes -data-2: 7 bytes -``` - -View the values of the keys with `kubectl get`: - -```shell -$ kubectl get configmaps test-configmap -o yaml -apiVersion: v1 -data: - data-1: value-1 - data-2: value-2 -kind: ConfigMap -metadata: - creationTimestamp: 2016-02-18T20:28:50Z - name: test-configmap - namespace: default - resourceVersion: "1090" - selfLink: /api/v1/namespaces/default/configmaps/test-configmap - uid: 384bd365-d67e-11e5-8cd0-68f728db1985 -``` - -## Step Two: Create a pod that consumes a configMap in environment variables - -Use the [`env-pod.yaml`](env-pod.yaml) file to create a Pod that consumes the -ConfigMap in environment variables. - -```shell -$ kubectl create -f docs/user-guide/configmap/env-pod.yaml -``` - -This pod runs the `env` command to display the environment of the container: - -```shell -$ kubectl logs config-env-test-pod | grep KUBE_CONFIG -KUBE_CONFIG_1=value-1 -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: - -```shell -$ kubectl create -f docs/user-guide/configmap/command-pod.yaml -``` - -This pod runs an `echo` command to display the keys: - -```shell -$ kubectl logs config-cmd-test-pod -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 consumes the ConfigMap in a volume. - -```shell -$ kubectl create -f docs/user-guide/configmap/volume-pod.yaml -``` - -This pod runs a `cat` command to print the value of one of the keys in the volume: - -```shell -$ kubectl logs config-volume-test-pod -value-1 -``` - -Alternatively you can use [`mount-file-pod.yaml`](mount-file-pod.yaml) file to mount -only a file from ConfigMap, preserving original content of /etc directory. diff --git a/docs/user-guide/downward-api/README.md b/docs/user-guide/downward-api/README.md deleted file mode 100644 index 6c2f4fff4411d..0000000000000 --- a/docs/user-guide/downward-api/README.md +++ /dev/null @@ -1,52 +0,0 @@ -Following these examples, you will create a pod with a container that consumes the pod's name, -namespace, and resource values using the [downward API](/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information/). - -## Step Zero: Prerequisites - -This example assumes you have a Kubernetes cluster installed and running, and that you have -installed the `kubectl` command line tool somewhere in your path. Please see [pick the right solution](/docs/setup/pick-right-solution/) for installation instructions for your platform. - -## Step One: Create the pod - -Containers consume the downward API using environment variables. The downward API allows -containers to be injected with the name and namespace of the pod the container is in. - -Use the [`dapi-pod.yaml`](dapi-pod.yaml) file to create a Pod with a container that consumes the -downward API. - -```shell -$ kubectl create -f docs/user-guide/downward-api/dapi-pod.yaml -``` - -### Examine the logs - -This pod runs the `env` command in a container that consumes the downward API. You can grep -through the pod logs to see that the pod was injected with the correct values: - -```shell -$ kubectl logs dapi-test-pod | grep POD_ -2015-04-30T20:22:18.568024817Z MY_POD_NAME=dapi-test-pod -2015-04-30T20:22:18.568087688Z MY_POD_NAMESPACE=default -2015-04-30T20:22:18.568092435Z MY_POD_IP=10.0.1.6 -``` - -## Example of environment variables with container resources - -Use the [`dapi-container-resources.yaml`](dapi-container-resources.yaml) file to create a Pod -with a container that consumes the downward API exposing the container's resources. - -```shell -$ kubectl create -f docs/user-guide/downward-api/dapi-container-resources.yaml -``` - -### Examine the logs - -Grep through the pod logs to see that the pod was injected with the correct values: - -```shell -$ kubectl logs dapi-test-pod | grep MY_ -MY_MEM_LIMIT=67108864 -MY_CPU_LIMIT=1 -MY_MEM_REQUEST=33554432 -MY_CPU_REQUEST=1 -``` diff --git a/docs/user-guide/liveness/image/README.md b/docs/user-guide/liveness/image/README.md deleted file mode 100644 index 3b316fee590ba..0000000000000 --- a/docs/user-guide/liveness/image/README.md +++ /dev/null @@ -1 +0,0 @@ -This image has moved to https://github.com/kubernetes/kubernetes/tree/master/test/images/liveness \ No newline at end of file diff --git a/docs/user-guide/pods/_viewing-a-pod.md b/docs/user-guide/pods/_viewing-a-pod.md deleted file mode 100644 index d4383c3e10b9e..0000000000000 --- a/docs/user-guide/pods/_viewing-a-pod.md +++ /dev/null @@ -1,58 +0,0 @@ -To view a specific pod, use the `kubectl get` command: - -```shell -$ kubectl get pod NAME -NAME READY STATUS RESTARTS AGE -example-1934187764-scau1 1/1 Running 0 2d -``` - -To return the name of the node on which the pod is scheduled, use the `-o wide` -option: - -```shell -$ kubectl get pod NAME -o wide -NAME READY STATUS RESTARTS AGE NODE -example-1934187764-scau1 1/1 Running 0 2d gke-example-c6a38-node-xij3 -``` - -For more details about a pod, including events, use `describe` in place of -`get`: - -```shell -$ kubectl describe pod NAME -Name: example-1934187764-scau1 -Namespace: default -Image(s): kubernetes/example-php-redis:v2 -Node: gke-example-c6a38461-node-xij3/10.240.34.183 -Labels: name=frontend -Status: Running -Reason: -Message: -IP: 10.188.2.10 -Replication Controllers: example (5/5 replicas created) -Containers: - php-redis: - Image: kubernetes/example-php-redis:v2 - Limits: - cpu: 100m - State: Running - Started: Tue, 04 Aug 2015 09:02:46 -0700 - Ready: True - Restart Count: 0 -Conditions: - Type Status - Ready True -Events: - FirstSeen LastSeen Coun From SubobjectPath Reason Message - Thu, 06 Aug 2015 11:49:44 -0700 Thu, 06 Aug 2015 11:49:44 -0700 1 {kubelet gke-example-c6a38461-node-xij3} spec.containers{example} started Started with docker id 5705bffa65e2 -``` - -To list all pods running on a cluster: - -```shell -$ kubectl get pods - -NAME READY STATUS RESTARTS AGE -example-1934187764-scau1 1/1 Running 0 1m -frontend-7kdod 1/1 Running 0 1d -``` \ No newline at end of file diff --git a/docs/user-guide/simple-yaml.md b/docs/user-guide/simple-yaml.md deleted file mode 100644 index c8f30b2746047..0000000000000 --- a/docs/user-guide/simple-yaml.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -approvers: -- mikedanese -- thockin - ---- -### This document has been subsumed by [deploying-applications.md](/docs/user-guide/deploying-applications/) diff --git a/docs/user-guide/update-demo/images/kitten/README.md b/docs/user-guide/update-demo/images/kitten/README.md deleted file mode 100644 index bc5f072bbcf81..0000000000000 --- a/docs/user-guide/update-demo/images/kitten/README.md +++ /dev/null @@ -1 +0,0 @@ -This image has moved to https://github.com/kubernetes/kubernetes/tree/master/test/images/kitten \ No newline at end of file diff --git a/docs/user-guide/update-demo/images/nautilus/README.md b/docs/user-guide/update-demo/images/nautilus/README.md deleted file mode 100644 index 4b2ddc9a60169..0000000000000 --- a/docs/user-guide/update-demo/images/nautilus/README.md +++ /dev/null @@ -1 +0,0 @@ -This image has moved to https://github.com/kubernetes/kubernetes/tree/master/test/images/nautilus \ No newline at end of file