From 5a721e9ceb8acfe67b4bc0b58d21c52667afafef Mon Sep 17 00:00:00 2001 From: XsWack Date: Fri, 18 Aug 2017 14:29:16 +0800 Subject: [PATCH 01/17] Update configure-pdb.md There will be 404 status in the jump process and fix the url --- docs/tasks/run-application/configure-pdb.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tasks/run-application/configure-pdb.md b/docs/tasks/run-application/configure-pdb.md index fc42343274..9a0c3365aa 100644 --- a/docs/tasks/run-application/configure-pdb.md +++ b/docs/tasks/run-application/configure-pdb.md @@ -14,8 +14,8 @@ nodes. {% capture prerequisites %} * You are the owner of an application running on a Kubernetes cluster that requires high availability. -* You should know how to deploy [Replicated Stateless Applications](/docs/tasks/run-application/run-stateless-application-deployment.md) - and/or [Replicated Stateful Applications](/docs/tasks/run-application/run-replicated-stateful-application.md). +* You should know how to deploy [Replicated Stateless Applications](/docs/tasks/run-application/run-stateless-application-deployment/) + and/or [Replicated Stateful Applications](/docs/tasks/run-application/run-replicated-stateful-application/). * You should have read about [Pod Disruptions](/docs/concepts/workloads/pods/disruptions/). * You should confirm with your cluster owner or service provider that they respect Pod Disruption Budgets. From 08083aeb20eee6f2fbdcddd5f146877cd24a925f Mon Sep 17 00:00:00 2001 From: Stewart-YU Date: Fri, 18 Aug 2017 08:08:21 +0800 Subject: [PATCH 02/17] Update kubectl-overview.md Fix the format of web page. --- docs/user-guide/kubectl-overview.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/user-guide/kubectl-overview.md b/docs/user-guide/kubectl-overview.md index 10fd5131f7..ba735d7fee 100644 --- a/docs/user-guide/kubectl-overview.md +++ b/docs/user-guide/kubectl-overview.md @@ -26,12 +26,16 @@ where `command`, `TYPE`, `NAME`, and `flags` are: * `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.
From b22ca98b83f24d77308195813457e915ae93d33e Mon Sep 17 00:00:00 2001 From: lemon-tree Date: Fri, 18 Aug 2017 09:32:28 +0800 Subject: [PATCH 03/17] Update kubectl-cheatsheet.md I think ":" is better than ".", so I changed the "." to ":". --- docs/user-guide/kubectl-cheatsheet.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/kubectl-cheatsheet.md b/docs/user-guide/kubectl-cheatsheet.md index 111f3d942e..ddba577c75 100644 --- a/docs/user-guide/kubectl-cheatsheet.md +++ b/docs/user-guide/kubectl-cheatsheet.md @@ -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 -------------------- | -------------------- From d629ec4a1cd47b7fc38ac5f33253995ea54f9028 Mon Sep 17 00:00:00 2001 From: Anthony Date: Fri, 18 Aug 2017 14:49:39 +0800 Subject: [PATCH 04/17] Update cluster.md modify "Configmap" to "ConfigMap" --- docs/tasks/administer-federation/cluster.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tasks/administer-federation/cluster.md b/docs/tasks/administer-federation/cluster.md index 09d4076ea2..8392d625f2 100644 --- a/docs/tasks/administer-federation/cluster.md +++ b/docs/tasks/administer-federation/cluster.md @@ -78,7 +78,7 @@ kubectl --context=rivendell label cluster gondor key1=value1 key2=value2 Starting in Kubernetes 1.7, there is alpha support for directing objects across the federated clusters with the annotation `federation.alpha.kubernetes.io/cluster-selector`. The *ClusterSelector* is conceptually similar to `nodeSelector`, but instead of selecting against labels on nodes, it selects against labels on federated clusters. -The annotation value must be json formatted and must be parsable into the [ClusterSelector API type](/docs/reference/federation/v1beta1/definitions/#_v1beta1_clusterselector). For example: `[{"key": "load", "operator": "Lt", "values": ["10"]}]`. Content that doesn't parse correctly will throw an error and prevent distribution of the object to any federated clusters. Objects of type Configmap, Secret, Daemonset, Service and Ingress are included in the alpha implementation. +The annotation value must be JSON formatted and must be parsable into the [ClusterSelector API type](/docs/reference/federation/v1beta1/definitions/#_v1beta1_clusterselector). For example: `[{"key": "load", "operator": "Lt", "values": ["10"]}]`. Content that doesn't parse correctly will throw an error and prevent distribution of the object to any federated clusters. Objects of type ConfigMap, Secret, Daemonset, Service and Ingress are included in the alpha implementation. Here is an example ClusterSelector annotation, which will only select clusters WITH the label `pci=true` and WITHOUT the label `environment=test`: From 8ec5b4469673ff82c1376c8c30044a87cb6b86cc Mon Sep 17 00:00:00 2001 From: Stewart-YU Date: Fri, 18 Aug 2017 17:12:16 +0800 Subject: [PATCH 05/17] Update audit.md Missing a symbol. --- docs/tasks/debug-application-cluster/audit.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tasks/debug-application-cluster/audit.md b/docs/tasks/debug-application-cluster/audit.md index dab1c2e970..67a7197415 100644 --- a/docs/tasks/debug-application-cluster/audit.md +++ b/docs/tasks/debug-application-cluster/audit.md @@ -107,7 +107,7 @@ The policy file holds rules that determine the level of an event. Known audit le - `Request` - log event metadata and request body but not response body. - `RequestResponse` - log event metadata, request and response bodies. -When an event is processed it's compared against the list of rules in order. +When an event is processed, it's compared against the list of rules in order. The first matching rule sets the audit level of the event. The audit policy is defined by the [`audit.k8s.io` API group][audit-api]. From 49b911e7d1fc59ec282ee0b9e5048ed957ce9387 Mon Sep 17 00:00:00 2001 From: Anthony Date: Fri, 18 Aug 2017 08:44:50 +0800 Subject: [PATCH 06/17] Update running-cloud-controller.md --- docs/tasks/administer-cluster/running-cloud-controller.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tasks/administer-cluster/running-cloud-controller.md b/docs/tasks/administer-cluster/running-cloud-controller.md index 9902b0ae40..ba76170525 100644 --- a/docs/tasks/administer-cluster/running-cloud-controller.md +++ b/docs/tasks/administer-cluster/running-cloud-controller.md @@ -16,8 +16,8 @@ In future Kubernetes releases, cloud vendors should link code that satisfies the To build cloud-controller-manager for your cloud, follow these steps: -* Write a cloudprovider that satisfies the [cloudprovider.Interface](https://git.k8s.io/kubernetes/pkg/cloudprovider/cloud.go). -* Link the cloudprovider to cloud-controller-manager. +1. Write a cloudprovider that satisfies the [cloudprovider.Interface](https://git.k8s.io/kubernetes/pkg/cloudprovider/cloud.go). +1. Link the cloudprovider to cloud-controller-manager. The methods in [cloudprovider.Interface](https://git.k8s.io/kubernetes/pkg/cloudprovider/cloud.go) are self-explanatory. All of the [existing providers](https://git.k8s.io/kubernetes/pkg/cloudprovider/providers) satisfy this interface. If your cloud is already a part From 573442c182e0b393e447be29b71b4ad63657b254 Mon Sep 17 00:00:00 2001 From: Anthony Date: Thu, 17 Aug 2017 12:20:54 +0800 Subject: [PATCH 07/17] Update running-cloud-controller.md add "." to the sentence --- docs/tasks/administer-cluster/running-cloud-controller.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tasks/administer-cluster/running-cloud-controller.md b/docs/tasks/administer-cluster/running-cloud-controller.md index c56df35f05..9902b0ae40 100644 --- a/docs/tasks/administer-cluster/running-cloud-controller.md +++ b/docs/tasks/administer-cluster/running-cloud-controller.md @@ -17,7 +17,7 @@ In future Kubernetes releases, cloud vendors should link code that satisfies the To build cloud-controller-manager for your cloud, follow these steps: * Write a cloudprovider that satisfies the [cloudprovider.Interface](https://git.k8s.io/kubernetes/pkg/cloudprovider/cloud.go). -* Link the cloudprovider to cloud-controller-manager +* Link the cloudprovider to cloud-controller-manager. The methods in [cloudprovider.Interface](https://git.k8s.io/kubernetes/pkg/cloudprovider/cloud.go) are self-explanatory. All of the [existing providers](https://git.k8s.io/kubernetes/pkg/cloudprovider/providers) satisfy this interface. If your cloud is already a part From 08a5d4d7289c5257f630d65b12c5ce8b87b95427 Mon Sep 17 00:00:00 2001 From: Anthony Date: Fri, 18 Aug 2017 08:57:24 +0800 Subject: [PATCH 08/17] Update running-cloud-controller.md --- docs/tasks/administer-cluster/running-cloud-controller.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tasks/administer-cluster/running-cloud-controller.md b/docs/tasks/administer-cluster/running-cloud-controller.md index ba76170525..0c45ade1c4 100644 --- a/docs/tasks/administer-cluster/running-cloud-controller.md +++ b/docs/tasks/administer-cluster/running-cloud-controller.md @@ -17,7 +17,7 @@ In future Kubernetes releases, cloud vendors should link code that satisfies the To build cloud-controller-manager for your cloud, follow these steps: 1. Write a cloudprovider that satisfies the [cloudprovider.Interface](https://git.k8s.io/kubernetes/pkg/cloudprovider/cloud.go). -1. Link the cloudprovider to cloud-controller-manager. +2. Link the cloudprovider to cloud-controller-manager. The methods in [cloudprovider.Interface](https://git.k8s.io/kubernetes/pkg/cloudprovider/cloud.go) are self-explanatory. All of the [existing providers](https://git.k8s.io/kubernetes/pkg/cloudprovider/providers) satisfy this interface. If your cloud is already a part From 8a1a91eb54304e4d35034310c09a92621c09c207 Mon Sep 17 00:00:00 2001 From: Anthony Date: Fri, 18 Aug 2017 08:44:50 +0800 Subject: [PATCH 09/17] Update running-cloud-controller.md (+1 squashed commit) Squashed commits: [49b911e] Update running-cloud-controller.md --- docs/tasks/administer-cluster/running-cloud-controller.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tasks/administer-cluster/running-cloud-controller.md b/docs/tasks/administer-cluster/running-cloud-controller.md index 9902b0ae40..0c45ade1c4 100644 --- a/docs/tasks/administer-cluster/running-cloud-controller.md +++ b/docs/tasks/administer-cluster/running-cloud-controller.md @@ -16,8 +16,8 @@ In future Kubernetes releases, cloud vendors should link code that satisfies the To build cloud-controller-manager for your cloud, follow these steps: -* Write a cloudprovider that satisfies the [cloudprovider.Interface](https://git.k8s.io/kubernetes/pkg/cloudprovider/cloud.go). -* Link the cloudprovider to cloud-controller-manager. +1. Write a cloudprovider that satisfies the [cloudprovider.Interface](https://git.k8s.io/kubernetes/pkg/cloudprovider/cloud.go). +2. Link the cloudprovider to cloud-controller-manager. The methods in [cloudprovider.Interface](https://git.k8s.io/kubernetes/pkg/cloudprovider/cloud.go) are self-explanatory. All of the [existing providers](https://git.k8s.io/kubernetes/pkg/cloudprovider/providers) satisfy this interface. If your cloud is already a part From 98b0d1fde6f7d3603c2eed8bd1a5dd4e98306f28 Mon Sep 17 00:00:00 2001 From: Stewart-YU Date: Fri, 18 Aug 2017 08:27:40 +0800 Subject: [PATCH 10/17] Update deployment.md Missing a signal. --- docs/concepts/workloads/controllers/deployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/concepts/workloads/controllers/deployment.md b/docs/concepts/workloads/controllers/deployment.md index d80149c01b..f70b21b96c 100644 --- a/docs/concepts/workloads/controllers/deployment.md +++ b/docs/concepts/workloads/controllers/deployment.md @@ -476,7 +476,7 @@ $ kubectl set image deploy/nginx-deployment nginx=nginx:sometag deployment "nginx-deployment" image updated ``` -The image update starts a new rollout with ReplicaSet nginx-deployment-1989198191 but it's blocked due to the +The image update starts a new rollout with ReplicaSet nginx-deployment-1989198191, but it's blocked due to the maxUnavailable requirement that we mentioned above. ```shell From 818fa9b3a1984711f555b5ef777cd3fbed42fe66 Mon Sep 17 00:00:00 2001 From: Weibin Lin Date: Fri, 18 Aug 2017 08:31:07 +0800 Subject: [PATCH 11/17] Update configure-liveness-readiness-probes.md fix typo --- .../configure-liveness-readiness-probes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md b/docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md index 66dd333b18..a842c449cd 100644 --- a/docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md +++ b/docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md @@ -180,7 +180,7 @@ can’t it is considered a failure. {% include code.html language="yaml" file="tcp-liveness-readiness.yaml" ghlink="/docs/tasks/configure-pod-container/tcp-liveness-readiness.yaml" %} -As you can see, configuration for a TCP check is quite similar to a HTTP check. +As you can see, configuration for a TCP check is quite similar to an HTTP check. This example uses both readiness and liveness probes. The kubelet will send the first readiness probe 5 seconds after the container starts. This will attempt to connect to the `goproxy` container on port 8080. If the probe succeeds, the pod From eee656902feba4ff89336c65f7d4ecf43cfa57d8 Mon Sep 17 00:00:00 2001 From: Weibin Lin Date: Fri, 18 Aug 2017 08:36:08 +0800 Subject: [PATCH 12/17] Update audit.md --- docs/tasks/debug-application-cluster/audit.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tasks/debug-application-cluster/audit.md b/docs/tasks/debug-application-cluster/audit.md index 67a7197415..185f9a1cc1 100644 --- a/docs/tasks/debug-application-cluster/audit.md +++ b/docs/tasks/debug-application-cluster/audit.md @@ -48,7 +48,7 @@ for configuring where and how audit logs are handled: - `audit-log-path` - enables the audit log pointing to a file where the requests are being logged to, '-' means standard out. - `audit-log-maxage` - specifies maximum number of days to retain old audit log files based on the timestamp encoded in their filename. - `audit-log-maxbackup` - specifies maximum number of old audit log files to retain. -- `audit-log-maxsize` - specifies maximum size in megabytes of the audit log file before it gets rotated. Defaults to 100MB +- `audit-log-maxsize` - specifies maximum size in megabytes of the audit log file before it gets rotated. Defaults to 100MB. If an audit log file already exists, Kubernetes appends new audit logs to that file. Otherwise, Kubernetes creates an audit log file at the location you specified in @@ -80,7 +80,7 @@ webhooks. The structure of audit events changes when enabling the `AdvancedAuditing` feature flag. This includes some cleanups, such as the `method` reflecting the verb evaluated by the [authorization layer](/docs/admin/authorization/) instead of the [HTTP verb](/docs/admin/authorization/#determine-the-request-verb). -Also, instead of always generating two events per request, events are recorded with an associated "stage." +Also, instead of always generating two events per request, events are recorded with an associated "stage". The known stages are: - `RequestReceived` - The stage for events generated as soon as the audit handler receives the request. From d3823d47348c42a4e607c6373c1986c49eabffd8 Mon Sep 17 00:00:00 2001 From: lemon-tree Date: Fri, 18 Aug 2017 08:56:00 +0800 Subject: [PATCH 13/17] Update docker-cli-to-kubectl.md Added the lost "." and ":". --- docs/user-guide/docker-cli-to-kubectl.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) 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 From 1fdaa2baa4c2930a23946ec270ad057e1f584677 Mon Sep 17 00:00:00 2001 From: XsWack Date: Fri, 18 Aug 2017 09:21:59 +0800 Subject: [PATCH 14/17] Update define-environment-variable-container.md format the command line --- .../define-environment-variable-container.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tasks/inject-data-application/define-environment-variable-container.md b/docs/tasks/inject-data-application/define-environment-variable-container.md index 11f46f69d3..adb159a5c3 100644 --- a/docs/tasks/inject-data-application/define-environment-variable-container.md +++ b/docs/tasks/inject-data-application/define-environment-variable-container.md @@ -51,7 +51,7 @@ Pod: 1. In your shell, run the `printenv` command to list the environment variables. - root@envar-demo:/# printenv + root@envar-demo:/# printenv The output is similar to this: From 25091ef09f5e7fc02984b4a6b0018ff3e796b901 Mon Sep 17 00:00:00 2001 From: XsWack Date: Fri, 18 Aug 2017 10:20:19 +0800 Subject: [PATCH 15/17] Update scratch.md fix bad url --- docs/getting-started-guides/scratch.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started-guides/scratch.md b/docs/getting-started-guides/scratch.md index 8e450bbaf6..5894732059 100644 --- a/docs/getting-started-guides/scratch.md +++ b/docs/getting-started-guides/scratch.md @@ -889,7 +889,7 @@ At this point you should be able to run through one of the basic examples, such ### Running the Conformance Test -You may want to try to run the [Conformance test](http://releases.k8s.io/{{page.githubbranch}}/hack/conformance-test.sh). Any failures may give a hint as to areas that need more attention. +You may want to try to run the [Conformance test](http://releases.k8s.io/{{page.githubbranch}}/test/e2e_node/conformance/run_test.sh). Any failures may give a hint as to areas that need more attention. ### Networking From c549dffaaf50e6a94699ed0c110101967dad0fe6 Mon Sep 17 00:00:00 2001 From: lemon-tree Date: Fri, 18 Aug 2017 11:58:32 +0800 Subject: [PATCH 16/17] Update kubefed_init.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit “Init” is redundant. --- docs/admin/kubefed_init.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin/kubefed_init.md b/docs/admin/kubefed_init.md index 8910568b5c..656cdde6ee 100644 --- a/docs/admin/kubefed_init.md +++ b/docs/admin/kubefed_init.md @@ -5,7 +5,7 @@ Initialize a federation control plane ### Synopsis -Init initializes a federation control plane. +Initialize a federation control plane. Federation control plane is hosted inside a Kubernetes cluster. The host cluster must be specified using the From 8b2485c4411df2b3924224c36839cf9faf5a77be Mon Sep 17 00:00:00 2001 From: Anthony Date: Fri, 18 Aug 2017 18:23:10 +0800 Subject: [PATCH 17/17] Update scheduling-gpus.md modify "nvidia drivers" to "Nvidia drivers" --- docs/tasks/manage-gpus/scheduling-gpus.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tasks/manage-gpus/scheduling-gpus.md b/docs/tasks/manage-gpus/scheduling-gpus.md index 20b5d9aec4..8981bc5a31 100644 --- a/docs/tasks/manage-gpus/scheduling-gpus.md +++ b/docs/tasks/manage-gpus/scheduling-gpus.md @@ -13,7 +13,7 @@ This page describes how users can consume GPUs and the current limitations. {% capture prerequisites %} -1. Kubernetes nodes have to be pre-installed with Nvidia drivers. Kubelet will not detect Nvidia GPUs otherwise. Try to re-install nvidia drivers if kubelet fails to expose Nvidia GPUs as part of Node Capacity. After installing the driver, run `nvidia-docker-plugin` to confirm that all drivers have been loaded. +1. Kubernetes nodes have to be pre-installed with Nvidia drivers. Kubelet will not detect Nvidia GPUs otherwise. Try to re-install Nvidia drivers if kubelet fails to expose Nvidia GPUs as part of Node Capacity. After installing the driver, run `nvidia-docker-plugin` to confirm that all drivers have been loaded. 2. A special **alpha** feature gate `Accelerators` has to be set to true across the system: `--feature-gates="Accelerators=true"`. 3. Nodes must be using `docker engine` as the container runtime.