Add admonition type to shortcode (#9482)

* Change existing admon blocks * Fix includes issue
2018-11-06 11:33:04 -08:00
parent e839031292
commit d65e1790ff
192 changed files with 673 additions and 543 deletions
@@ -186,11 +186,13 @@ kubectl config set-credentials kubelet-bootstrap --token=${BOOTSTRAP_TOKEN} --ku

 When starting the kubelet, if the file specified by `--kubeconfig` does not exist, the bootstrap kubeconfig is used to request a client certificate from the API server. On approval of the certificate request and receipt back by the kubelet, a kubeconfig file referencing the generated key and obtained certificate is written to the path specified by `--kubeconfig`. The certificate and key file will be placed in the directory specified by `--cert-dir`.

-**Note:** The following flags are required to enable this bootstrapping when starting the kubelet:
+{{< note >}}
+The following flags are required to enable this bootstrapping when starting the kubelet:

 ```
 --bootstrap-kubeconfig="/path/to/bootstrap/kubeconfig"
 ```
+{{< /note >}}

 Additionally, in 1.7 the kubelet implements __alpha__ features for enabling rotation of both its client and/or serving certs.
 These can be enabled through the respective `RotateKubeletClientCertificate` and `RotateKubeletServerCertificate` feature
@@ -357,7 +357,7 @@ based on the Ready NodeCondition is disabled.

 {{< note >}}
 <!--
-**Note:** To maintain the existing [rate limiting](/docs/concepts/architecture/nodes/)
+To maintain the existing [rate limiting](/docs/concepts/architecture/nodes/)
 behavior of pod evictions due to node problems, the system actually adds the taints
 in a rate-limited way. This prevents massive pod evictions in scenarios such
 as the master becoming partitioned from the nodes.
@@ -14,7 +14,7 @@ A _Deployment_ controller provides declarative updates for [Pods](/docs/concepts
 You describe a _desired state_ in a Deployment object, and the Deployment controller changes the actual state to the desired state at a controlled rate. You can define Deployments to create new ReplicaSets, or to remove existing Deployments and adopt all their resources with new Deployments.

 {{< note >}}
-**Note:** You should not manage ReplicaSets owned by a Deployment. All the use cases should be covered by manipulating the Deployment object. Consider opening an issue in the main Kubernetes repository if your use case is not covered below.
+You should not manage ReplicaSets owned by a Deployment. All the use cases should be covered by manipulating the Deployment object. Consider opening an issue in the main Kubernetes repository if your use case is not covered below.
 {{< /note >}}

 {{% /capture %}}
@@ -103,7 +103,7 @@ nginx-deployment-2035384211-qqcnn   1/1       Running   0          18s       app
 The created ReplicaSet ensures that there are three nginx Pods at all times.

 {{< note >}}
-**Note:** You must specify an appropriate selector and pod template labels in a Deployment (in this case,
+You must specify an appropriate selector and pod template labels in a Deployment (in this case,
 `app = nginx`). That is, don't overlap with other controllers (including other Deployments, ReplicaSets,
 StatefulSets, etc.). Kubernetes doesn't stop you from overlapping, and if multiple
 controllers have overlapping selectors, those controllers may fight with each other and won't behave
@@ -113,7 +113,7 @@ correctly.
 ### Pod-template-hash label

 {{< note >}}
-**Note:** Do not change this label.
+Do not change this label.
 {{< /note >}}

 Note the pod-template-hash label in the example output in the pod labels above. This label is added by the
@@ -125,7 +125,7 @@ and in any existing Pods that the ReplicaSet may have.
 ## Updating a Deployment

 {{< note >}}
-**Note:** A Deployment's rollout is triggered if and only if the Deployment's pod template (that is, `.spec.template`)
+A Deployment's rollout is triggered if and only if the Deployment's pod template (that is, `.spec.template`)
 is changed, for example if the labels or container images of the template are updated. Other updates, such as scaling the Deployment, do not trigger a rollout.
 {{< /note >}}

@@ -270,7 +270,7 @@ By default, all of the Deployment's rollout history is kept in the system so tha
 (you can change that by modifying revision history limit).

 {{< note >}}
-**Note:** A Deployment's revision is created when a Deployment's rollout is triggered. This means that the
+A Deployment's revision is created when a Deployment's rollout is triggered. This means that the
 new revision is created if and only if the Deployment's pod template (`.spec.template`) is changed,
 for example if you update the labels or container images of the template. Other updates, such as scaling the Deployment,
 do not create a Deployment revision, so that we can facilitate simultaneous manual- or auto-scaling.
@@ -318,7 +318,7 @@ nginx-deployment-3066724191-eocby   0/1       ImagePullBackOff   0          6s
 ```

 {{< note >}}
-**Note:** The Deployment controller will stop the bad rollout automatically, and will stop scaling up the new
+The Deployment controller will stop the bad rollout automatically, and will stop scaling up the new
 ReplicaSet. This depends on the rollingUpdate parameters (`maxUnavailable` specifically) that you have specified.
 Kubernetes by default sets the value to 1 and spec.replicas to 1 so if you haven't cared about setting those
 parameters, your Deployment can have 100% unavailability by default! This will be fixed in Kubernetes in a future
@@ -596,7 +596,7 @@ nginx-3926361531   3         3         3         28s
 ```

 {{< note >}}
-**Note:** You cannot rollback a paused Deployment until you resume it.
+You cannot rollback a paused Deployment until you resume it.
 {{< /note >}}

 ## Deployment status
@@ -669,13 +669,13 @@ attributes to the Deployment's `status.conditions`:
 See the [Kubernetes API conventions](https://git.k8s.io/community/contributors/devel/api-conventions.md#typical-status-properties) for more information on status conditions.

 {{< note >}}
-**Note:** Kubernetes will take no action on a stalled Deployment other than to report a status condition with
+Kubernetes will take no action on a stalled Deployment other than to report a status condition with
 `Reason=ProgressDeadlineExceeded`. Higher level orchestrators can take advantage of it and act accordingly, for
 example, rollback the Deployment to its previous version.
 {{< /note >}}

 {{< note >}}
-**Note:** If you pause a Deployment, Kubernetes does not check progress against your specified deadline. You can
+If you pause a Deployment, Kubernetes does not check progress against your specified deadline. You can
 safely pause a Deployment in the middle of a rollout and resume without triggering the condition for exceeding the
 deadline.
 {{< /note >}}
@@ -780,7 +780,7 @@ this Deployment you want to retain. The rest will be garbage-collected in the ba
 all revision history will be kept. In a future version, it will default to switch to 2.

 {{< note >}}
-**Note:** Explicitly setting this field to 0, will result in cleaning up all the history of your Deployment
+Explicitly setting this field to 0, will result in cleaning up all the history of your Deployment
 thus that Deployment will not be able to roll back.
 {{< /note >}}

@@ -831,7 +831,7 @@ from `.spec.template` or if the total number of such Pods exceeds `.spec.replica
 Pods with `.spec.template` if the number of Pods is less than the desired number.

 {{< note >}}
-**Note:** You should not create other pods whose labels match this selector, either directly, by creating
+You should not create other pods whose labels match this selector, either directly, by creating
 another Deployment, or by creating another controller such as a ReplicaSet or a ReplicationController. If you
 do so, the first Deployment thinks that it created these other pods. Kubernetes does not stop you from doing this.
 {{< /note >}}
@@ -279,7 +279,7 @@ with different/greater permissions.

 {{< caution >}}
 <!--
-**Caution:** System administrators, use care when granting access to pod
+System administrators, use care when granting access to pod
 creation.  A user granted permission to create pods (or controllers that create
 pods) in the namespace can: read all secrets in the namespace; read all config
 maps in the namespace; and impersonate any service account in the namespace and
@@ -152,7 +152,7 @@ IP 地址列在 `LoadBalancer Ingress` 旁边。

 {{< note >}}
 <!--
-**Note**: If you are running your service on Minikube, you can find the assigned IP address and port with:
+If you are running your service on Minikube, you can find the assigned IP address and port with:
 -->
 **注意：** 如果您在 Minikube 上运行服务，您可以通过以下命令找到分配的 IP 地址和端口：
 {{< /note >}}
@@ -102,7 +102,7 @@ jsonpath 解释如下：

 {{< note >}}
 <!--
-**Note:** When fetching a single Pod by name, e.g. `kubectl get pod nginx`,
+When fetching a single Pod by name, e.g. `kubectl get pod nginx`,
 the `.items[*]` portion of the path should be omitted because a single
 Pod is returned instead of a list of items.
 -->
@@ -109,7 +109,7 @@ load-balanced access to an application running in a cluster.

   {{< note >}}
 <!--
-   **Note:** If you are using Minikube, you don't get an external IP address. The
+    If you are using Minikube, you don't get an external IP address. The
   external IP address remains in the pending state.
 -->
   **注意：** 如果您使用 Minikube，那么您将不会获得外部 IP 地址。外部 IP 地址将保持 pending 状态。
@@ -139,7 +139,7 @@ load-balanced access to an application running in a cluster.

   {{< note >}}
 <!--
-   **Note:** If you are using Minikube, enter these commands:
+   If you are using Minikube, enter these commands:
 -->
   **注意：** 如果您使用 Minikube，输入以下命令：
   {{< /note >}}
@@ -200,7 +200,7 @@ local workstation to debug the database that is running in the pod.

 {{< warning >}}
 <!--
-**Warning**: Due to known limitations, port forward today only works for TCP protocol.
+Due to known limitations, port forward today only works for TCP protocol.
 The support to UDP protocol is being tracked in
 [issue 47862](https://github.com/kubernetes/kubernetes/issues/47862).
 -->
@@ -54,7 +54,7 @@ Before proceeding:
 {{< caution >}}
 <!--

-**Caution:** All the containers will get restarted after the upgrade, due to container spec hash value gets changed.
+All the containers will get restarted after the upgrade, due to container spec hash value gets changed.

 --->
 **注意:** 由于容器的具体哈希值改变了，所有的容器在升级之后会重新启动。
@@ -98,7 +98,7 @@ chmod a+rx /usr/bin/kubeadm
 {{< caution >}}
 <!--

-**Caution:** Upgrading the `kubeadm` package on your system prior to upgrading the control plane causes a failed upgrade. 
+Upgrading the `kubeadm` package on your system prior to upgrading the control plane causes a failed upgrade. 
 Even though `kubeadm` ships in the Kubernetes repositories, it's important to install `kubeadm` manually. The kubeadm 
 team is working on fixing this limitation. 

@@ -103,7 +103,7 @@ The following sysctls are supported in the _safe_ set:

 {{< note >}}
 <!--
-**Note**: The example `net.ipv4.tcp_syncookies` is not namespaced on Linux kernel version 4.4 or lower.
+The example `net.ipv4.tcp_syncookies` is not namespaced on Linux kernel version 4.4 or lower.
 --->
 **注意**: 示例中的 `net.ipv4.tcp_syncookies` 在Linux 内核 4.4 或更低的版本中是无命名空间的。
 {{< /note >}}
@@ -226,7 +226,7 @@ spec:

 {{< warning >}}
 <!--
-**Warning**: Due to their nature of being _unsafe_, the use of _unsafe_ sysctls
+Due to their nature of being _unsafe_, the use of _unsafe_ sysctls
 is at-your-own-risk and can lead to severe problems like wrong behavior of
 containers, resource shortage or complete breakage of a node.
 --->
@@ -299,7 +299,7 @@ given sysctl is both allowed and forbidden.

 {{< warning >}}
 <!--
-**Warning**: If you whitelist unsafe sysctls via the `allowedUnsafeSysctls` field
+If you whitelist unsafe sysctls via the `allowedUnsafeSysctls` field
 in a PodSecurityPolicy, any pod using such a sysctl will fail to start
 if the sysctl is not whitelisted via the `--allowed-unsafe-sysctls` kubelet
 flag as well on that node.
@@ -79,7 +79,7 @@ Each request can be recorded with an associated "stage". The known stages are:

 {{< note >}}
 <!--
-**Note** The audit logging feature increases the memory consumption of the API
+The audit logging feature increases the memory consumption of the API
 server because some context required for auditing is stored for each request.
 Additionally, memory consumption depends on the audit logging configuration.
 -->
@@ -174,7 +174,7 @@ In both cases, audit events structure is defined by the API in the

 {{< note >}}
 <!--
-**Note:** In case of patches, request body is a JSON array with patch operations, not a JSON object
+In case of patches, request body is a JSON array with patch operations, not a JSON object
 with an appropriate Kubernetes API object. For example, the following request body is a valid patch
 request to `/apis/batch/v1/namespaces/some-namespace/jobs/some-job-name`.
 -->
@@ -184,7 +184,7 @@ kubectl exec -it kubernetes-downwardapi-volume-example-2 -- sh
 * Pod的注释

 {{< note >}}
-**Note:** 如果容器未指定CPU和memory limits，则Downward API默认为节点可分配值。
+如果容器未指定CPU和memory limits，则Downward API默认为节点可分配值。
 {{< /note >}}

 ## 投射密钥到指定路径并且指定文件权限