whentimeslows/website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add admonition type to shortcode (#9482)

Browse Source 
* Change existing admon blocks

* Fix includes issue
This commit is contained in:
Luc Perkins
2018-11-06 11:33:04 -08:00
committed by k8s-ci-robot
parent e839031292
commit d65e1790ff
192 changed files with 673 additions and 543 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/en/docs/concepts/storage/persistent-volumes.md
+8 -8
View File
@@ -85,7 +85,7 @@ Once a user has a claim and that claim is bound, the bound PV belongs to the use
The purpose of the Storage Object in Use Protection feature is to ensure that Persistent Volume Claims (PVCs) in active use by a pod and Persistent Volume (PVs) that are bound to PVCs are not removed from the system as this may result in data loss.
{{< note >}}
**Note:** PVC is in active use by a pod when the pod status is `Pending` and the pod is assigned to a node or the pod status is `Running`.
PVC is in active use by a pod when the pod status is `Pending` and the pod is assigned to a node or the pod status is `Running`.
{{< /note >}}
When the [Storage Object in Use Protection feature](/docs/tasks/administer-cluster/storage-object-in-use-protection/) is enabled, if a user deletes a PVC in active use by a pod, the PVC is not removed immediately. PVC removal is postponed until the PVC is no longer actively used by any pods, and also if admin deletes a PV that is bound to a PVC, the PV is not removed immediately. PV removal is postponed until the PV is not bound to a PVC any more.
@@ -147,7 +147,7 @@ For volume plugins that support the `Delete` reclaim policy, deletion removes bo
#### Recycle
{{< warning >}}
**Warning:** The `Recycle` reclaim policy is deprecated. Instead, the recommended approach is to use dynamic provisioning.
The `Recycle` reclaim policy is deprecated. Instead, the recommended approach is to use dynamic provisioning.
{{< /warning >}}
If supported by the underlying volume plugin, the `Recycle` reclaim policy performs a basic scrub (`rm -rf /thevolume/*`) on the volume and makes it available again for a new claim.
@@ -238,7 +238,7 @@ This feature has no effect on PVCs that are not in use by a Pod or deployment. Y
uses the PVC before the expansion can complete.
{{< note >}}
**Note:** Expanding EBS volumes is a time consuming operation. Also, there is a per-volume quota of one modification every 6 hours.
Expanding EBS volumes is a time consuming operation. Also, there is a per-volume quota of one modification every 6 hours.
{{< /note >}}
@@ -377,7 +377,7 @@ Currently, only NFS and HostPath support recycling. AWS EBS, GCE PD, Azure Disk,
A Kubernetes administrator can specify additional mount options for when a Persistent Volume is mounted on a node.
{{< note >}}
**Note:** Not all Persistent volume types support mount options.
Not all Persistent volume types support mount options.
{{< /note >}}
The following volume types support mount options:
@@ -495,7 +495,7 @@ the requirements are ANDed together: only a PV of the requested class and with
the requested labels may be bound to the PVC.
{{< note >}}
**Note:** Currently, a PVC with a non-empty `selector` can't have a PV dynamically provisioned for it.
Currently, a PVC with a non-empty `selector` can't have a PV dynamically provisioned for it.
{{< /note >}}
In the past, the annotation `volume.beta.kubernetes.io/storage-class` was used instead
@@ -547,7 +547,7 @@ applicable.
* RBD (Ceph Block Device)
{{< note >}}
**Note**: Only FC and iSCSI volumes supported raw block volumes in Kubernetes 1.9.
Only FC and iSCSI volumes supported raw block volumes in Kubernetes 1.9.
Support for the additional plugins was added in 1.10.
{{< /note >}}
@@ -605,7 +605,7 @@ spec:
```
{{< note >}}
**Note:** When adding a raw block device for a Pod, we specify the device path in the container instead of a mount path.
When adding a raw block device for a Pod, we specify the device path in the container instead of a mount path.
{{< /note >}}
### Binding Block Volumes
@@ -627,7 +627,7 @@ Volume binding matrix for statically provisioned volumes:
| Filesystem | unspecified | BIND |
{{< note >}}
**Note:** Only statically provisioned volumes are supported for alpha release. Administrators should take care to consider these values when working with raw block devices.
Only statically provisioned volumes are supported for alpha release. Administrators should take care to consider these values when working with raw block devices.
{{< /note >}}
## Volume Snapshot and Restore Volume from Snapshot Support
content/en/docs/concepts/storage/storage-classes.md
+12 -4
View File
@@ -123,8 +123,10 @@ the class or PV, so mount of the PV will simply fail if one is invalid.
{{< feature-state for_k8s_version="v1.12" state="beta" >}}
**Note:** This feature requires the `VolumeScheduling` feature gate to be
{{< note >}}
This feature requires the `VolumeScheduling` feature gate to be
enabled.
{{< /note >}}
The `volumeBindingMode` field controls when [volume binding and dynamic
provisioning](/docs/concepts/storage/persistent-volumes/#provisioning) should occur.
@@ -159,8 +161,10 @@ The following plugins support `WaitForFirstConsumer` with pre-created Persistent
### Allowed Topologies
{{< feature-state for_k8s_version="v1.12" state="beta" >}}
**Note:** This feature requires the `VolumeScheduling` feature gate to be
{{< note >}}
This feature requires the `VolumeScheduling` feature gate to be
enabled.
{{< /note >}}
When a cluster operactor specifies the `WaitForFirstConsumer` volume binding mode, it is no longer necessary
to restrict provisioning to specific topologies in most situations. However,
@@ -232,8 +236,10 @@ parameters:
encrypting the volume. If none is supplied but `encrypted` is true, a key is
generated by AWS. See AWS docs for valid ARN value.
**Note:** `zone` and `zones` parameters are deprecated and replaced with
{{< note >}}
`zone` and `zones` parameters are deprecated and replaced with
[allowedTopologies](#allowed-topologies)
{{< /note >}}
### GCE PD
@@ -269,8 +275,10 @@ specified, Kubernetes will arbitrarily choose among the specified zones. If the
`zones` parameter is omitted, Kubernetes will arbitrarily choose among zones
managed by the cluster.
**Note:** `zone` and `zones` parameters are deprecated and replaced with
{{< note >}}
`zone` and `zones` parameters are deprecated and replaced with
[allowedTopologies](#allowed-topologies)
{{< /note >}}
### Glusterfs
content/en/docs/concepts/storage/volumes.md
+26 -26
View File
@@ -105,7 +105,7 @@ EBS volume can be pre-populated with data, and that data can be "handed off"
between Pods.
{{< caution >}}
**Important:** You must create an EBS volume using `aws ec2 create-volume` or the AWS API before you can use it.
You must create an EBS volume using `aws ec2 create-volume` or the AWS API before you can use it.
{{< /caution >}}
There are some restrictions when using an `awsElasticBlockStore` volume:
@@ -170,7 +170,7 @@ that data can be "handed off" between Pods. CephFS can be mounted by multiple
writers simultaneously.
{{< caution >}}
**Important:** You must have your own Ceph server running with the share exported before you can use it.
You must have your own Ceph server running with the share exported before you can use it.
{{< /caution >}}
See the [CephFS example](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/volumes/cephfs/) for more details.
@@ -215,11 +215,11 @@ Note that this path is derived from the volume's `mountPath` and the `path`
keyed with `log_level`.
{{< caution >}}
**Important:** You must create a [ConfigMap](/docs/tasks/configure-pod-container/configure-pod-configmap/) before you can use it.
You must create a [ConfigMap](/docs/tasks/configure-pod-container/configure-pod-configmap/) before you can use it.
{{< /caution >}}
{{< note >}}
**Note:** A Container using a ConfigMap as a [subPath](#using-subpath) volume mount will not
A Container using a ConfigMap as a [subPath](#using-subpath) volume mount will not
receive ConfigMap updates.
{{< /note >}}
@@ -229,7 +229,7 @@ A `downwardAPI` volume is used to make downward API data available to applicatio
It mounts a directory and writes the requested data in plain text files.
{{< note >}}
**Note:** A Container using Downward API as a [subPath](#using-subpath) volume mount will not
A Container using Downward API as a [subPath](#using-subpath) volume mount will not
receive Downward API updates.
{{< /note >}}
@@ -245,7 +245,7 @@ or different paths in each Container. When a Pod is removed from a node for
any reason, the data in the `emptyDir` is deleted forever.
{{< note >}}
**Note:** A Container crashing does *NOT* remove a Pod from a node, so the data in an `emptyDir` volume is safe across Container crashes.
A Container crashing does *NOT* remove a Pod from a node, so the data in an `emptyDir` volume is safe across Container crashes.
{{< /note >}}
Some uses for an `emptyDir` are:
@@ -290,7 +290,7 @@ You can specify single or multiple target World Wide Names using the parameter
targetWWNs expect that those WWNs are from multi-path connections.
{{< caution >}}
**Important:** You must configure FC SAN Zoning to allocate and mask those LUNs (volumes) to the target WWNs beforehand so that Kubernetes hosts can access them.
You must configure FC SAN Zoning to allocate and mask those LUNs (volumes) to the target WWNs beforehand so that Kubernetes hosts can access them.
{{< /caution >}}
See the [FC example](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/volumes/fibre_channel) for more details.
@@ -307,7 +307,7 @@ reattached by Flocker to the node that the Pod is scheduled. This means data
can be "handed off" between Pods as required.
{{< caution >}}
**Important:** You must have your own Flocker installation running before you can use it.
You must have your own Flocker installation running before you can use it.
{{< /caution >}}
See the [Flocker example](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/volumes/flocker) for more details.
@@ -321,7 +321,7 @@ preserved and the volume is merely unmounted. This means that a PD can be
pre-populated with data, and that data can be "handed off" between Pods.
{{< caution >}}
**Important:** You must create a PD using `gcloud` or the GCE API or UI before you can use it.
You must create a PD using `gcloud` or the GCE API or UI before you can use it.
{{< /caution >}}
There are some restrictions when using a `gcePersistentDisk`:
@@ -403,7 +403,7 @@ spec:
### gitRepo (deprecated) {#gitrepo}
{{< warning >}}
**Warning:** The gitRepo volume type is deprecated. To provision a container with a git repo, mount an [EmptyDir](#emptydir) into an InitContainer that clones the repo using git, then mount the [EmptyDir](#emptydir) into the Pod's container.
The gitRepo volume type is deprecated. To provision a container with a git repo, mount an [EmptyDir](#emptydir) into an InitContainer that clones the repo using git, then mount the [EmptyDir](#emptydir) into the Pod's container.
{{< /warning >}}
A `gitRepo` volume is an example of what can be done as a volume plugin. It
@@ -443,7 +443,7 @@ be "handed off" between Pods. GlusterFS can be mounted by multiple writers
simultaneously.
{{< caution >}}
**Important:** You must have your own GlusterFS installation running before you can use it.
You must have your own GlusterFS installation running before you can use it.
{{< /caution >}}
See the [GlusterFS example](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/volumes/glusterfs) for more details.
@@ -521,7 +521,7 @@ unmounted. This means that an iscsi volume can be pre-populated with data, and
that data can be "handed off" between Pods.
{{< caution >}}
**Important:** You must have your own iSCSI server running with the volume created before you can use it.
You must have your own iSCSI server running with the volume created before you can use it.
{{< /caution >}}
A feature of iSCSI is that it can be mounted as read-only by multiple consumers
@@ -537,7 +537,7 @@ See the [iSCSI example](https://github.com/kubernetes/examples/tree/{{< param "g
{{< feature-state for_k8s_version="v1.10" state="beta" >}}
{{< note >}}
**Note:** The alpha PersistentVolume NodeAffinity annotation has been deprecated
The alpha PersistentVolume NodeAffinity annotation has been deprecated
and will be removed in a future release. Existing PersistentVolumes using this
annotation must be updated by the user to use the new PersistentVolume
`NodeAffinity` field.
@@ -610,7 +610,7 @@ provisioning yet. For an example on how to run an external local provisioner,
see the [local volume provisioner user guide](https://github.com/kubernetes-incubator/external-storage/tree/master/local-volume).
{{< note >}}
**Note:** The local PersistentVolume requires manual cleanup and deletion by the
The local PersistentVolume requires manual cleanup and deletion by the
user if the external static provisioner is not used to manage the volume
lifecycle.
{{< /note >}}
@@ -625,7 +625,7 @@ that data can be "handed off" between Pods. NFS can be mounted by multiple
writers simultaneously.
{{< caution >}}
**Important:** You must have your own NFS server running with the share exported before you can use it.
You must have your own NFS server running with the share exported before you can use it.
{{< /caution >}}
See the [NFS example](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/volumes/nfs) for more details.
@@ -782,7 +782,7 @@ option for the API server. The `path` field specifies a relative path to the mou
of the projected volume.
{{< note >}}
**Note:** A Container using a projected volume source as a [subPath](#using-subpath) volume mount will not
A Container using a projected volume source as a [subPath](#using-subpath) volume mount will not
receive updates for those volume sources.
{{< /note >}}
@@ -818,7 +818,7 @@ spec:
```
{{< caution >}}
**Important:** Make sure you have an existing PortworxVolume with name `pxvol`
Make sure you have an existing PortworxVolume with name `pxvol`
before using it in the Pod.
{{< /caution >}}
@@ -830,7 +830,7 @@ A `quobyte` volume allows an existing [Quobyte](http://www.quobyte.com) volume t
be mounted into your Pod.
{{< caution >}}
**Important:** You must have your own Quobyte setup running with the volumes
You must have your own Quobyte setup running with the volumes
created before you can use it.
{{< /caution >}}
@@ -846,7 +846,7 @@ means that a RBD volume can be pre-populated with data, and that data can
be "handed off" between Pods.
{{< caution >}}
**Important:** You must have your own Ceph installation running before you can use RBD.
You must have your own Ceph installation running before you can use RBD.
{{< /caution >}}
A feature of RBD is that it can be mounted as read-only by multiple consumers
@@ -866,7 +866,7 @@ volumes (or it can dynamically provision new volumes for persistent volume claim
[ScaleIO Persistent Volumes](/docs/concepts/storage/persistent-volumes/#scaleio)).
{{< caution >}}
**Important:** You must have an existing ScaleIO cluster already setup and
You must have an existing ScaleIO cluster already setup and
running with the volumes created before you can use them.
{{< /caution >}}
@@ -908,11 +908,11 @@ backed by tmpfs (a RAM-backed filesystem) so they are never written to
non-volatile storage.
{{< caution >}}
**Important:** You must create a secret in the Kubernetes API before you can use it.
You must create a secret in the Kubernetes API before you can use it.
{{< /caution >}}
{{< note >}}
**Note:** A Container using a Secret as a [subPath](#using-subpath) volume mount will not
A Container using a Secret as a [subPath](#using-subpath) volume mount will not
receive Secret updates.
{{< /note >}}
@@ -934,7 +934,7 @@ The StorageOS Container requires 64-bit Linux and has no additional dependencies
A free developer license is available.
{{< caution >}}
**Important:** You must run the StorageOS Container on each node that wants to
You must run the StorageOS Container on each node that wants to
access StorageOS volumes or that will contribute storage capacity to the pool.
For installation instructions, consult the
[StorageOS documentation](https://docs.storageos.com).
@@ -974,7 +974,7 @@ For more information including Dynamic Provisioning and Persistent Volume Claims
### vsphereVolume {#vspherevolume}
{{< note >}}
**Prerequisite:** Kubernetes with vSphere Cloud Provider configured. For cloudprovider
Prerequisite: Kubernetes with vSphere Cloud Provider configured. For cloudprovider
configuration please refer [vSphere getting started guide](https://vmware.github.io/vsphere-storage-for-kubernetes/documentation/).
{{< /note >}}
@@ -982,7 +982,7 @@ A `vsphereVolume` is used to mount a vSphere VMDK Volume into your Pod. The con
of a volume are preserved when it is unmounted. It supports both VMFS and VSAN datastore.
{{< caution >}}
**Important:** You must create VMDK using one of the following method before using with Pod.
You must create VMDK using one of the following method before using with Pod.
{{< /caution >}}
#### Creating a VMDK volume
@@ -1274,7 +1274,7 @@ Its values are:
[Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt)
{{< caution >}}
**Caution:** `Bidirectional` mount propagation can be dangerous. It can damage
`Bidirectional` mount propagation can be dangerous. It can damage
the host operating system and therefore it is allowed only in privileged
Containers. Familiarity with Linux kernel behavior is strongly recommended.
In addition, any volume mounts created by Containers in Pods must be destroyed