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

Merge pull request #21829 from Arhell/upd-style

Browse Source 
update to right styling for VolumeSnapshotClass concept
This commit is contained in:
Kubernetes Prow Robot
2020-06-17 01:14:41 -07:00
committed by GitHub
parent 859b1723c6 f8c1f91d97
commit 1265a06e68
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/en/docs/concepts/storage/volume-snapshot-classes.md
+11 -11
View File
@@ -13,7 +13,7 @@ weight: 30
<!-- overview --> <!-- overview -->
This document describes the concept of `VolumeSnapshotClass` in Kubernetes. Familiarity This document describes the concept of VolumeSnapshotClass in Kubernetes. Familiarity
with [volume snapshots](/docs/concepts/storage/volume-snapshots/) and with [volume snapshots](/docs/concepts/storage/volume-snapshots/) and
[storage classes](/docs/concepts/storage/storage-classes) is suggested. [storage classes](/docs/concepts/storage/storage-classes) is suggested.
@@ -24,22 +24,22 @@ with [volume snapshots](/docs/concepts/storage/volume-snapshots/) and
## Introduction ## Introduction
Just like `StorageClass` provides a way for administrators to describe the "classes" Just like StorageClass provides a way for administrators to describe the "classes"
of storage they offer when provisioning a volume, `VolumeSnapshotClass` provides a of storage they offer when provisioning a volume, VolumeSnapshotClass provides a
way to describe the "classes" of storage when provisioning a volume snapshot. way to describe the "classes" of storage when provisioning a volume snapshot.
## The VolumeSnapshotClass Resource ## The VolumeSnapshotClass Resource
Each `VolumeSnapshotClass` contains the fields `driver`, `deletionPolicy`, and `parameters`, Each VolumeSnapshotClass contains the fields `driver`, `deletionPolicy`, and `parameters`,
which are used when a `VolumeSnapshot` belonging to the class needs to be which are used when a VolumeSnapshot belonging to the class needs to be
dynamically provisioned. dynamically provisioned.
The name of a `VolumeSnapshotClass` object is significant, and is how users can The name of a VolumeSnapshotClass object is significant, and is how users can
request a particular class. Administrators set the name and other parameters request a particular class. Administrators set the name and other parameters
of a class when first creating `VolumeSnapshotClass` objects, and the objects cannot of a class when first creating VolumeSnapshotClass objects, and the objects cannot
be updated once they are created. be updated once they are created.
Administrators can specify a default `VolumeSnapshotClass` just for VolumeSnapshots Administrators can specify a default VolumeSnapshotClass just for VolumeSnapshots
that don't request any particular class to bind to. that don't request any particular class to bind to.
```yaml ```yaml
@@ -47,7 +47,7 @@ apiVersion: snapshot.storage.k8s.io/v1beta1
kind: VolumeSnapshotClass kind: VolumeSnapshotClass
metadata: metadata:
name: csi-hostpath-snapclass name: csi-hostpath-snapclass
driver: hostpath.csi.k8s.io driver: hostpath.csi.k8s.io
deletionPolicy: Delete deletionPolicy: Delete
parameters: parameters:
``` ```
@@ -59,9 +59,9 @@ used for provisioning VolumeSnapshots. This field must be specified.
### DeletionPolicy ### DeletionPolicy
Volume snapshot classes have a deletionPolicy. It enables you to configure what happens to a `VolumeSnapshotContent` when the `VolumeSnapshot` object it is bound to is to be deleted. The deletionPolicy of a volume snapshot can either be `Retain` or `Delete`. This field must be specified. Volume snapshot classes have a deletionPolicy. It enables you to configure what happens to a VolumeSnapshotContent when the VolumeSnapshot object it is bound to is to be deleted. The deletionPolicy of a volume snapshot can either be `Retain` or `Delete`. This field must be specified.
If the deletionPolicy is `Delete`, then the underlying storage snapshot will be deleted along with the `VolumeSnapshotContent` object. If the deletionPolicy is `Retain`, then both the underlying snapshot and `VolumeSnapshotContent` remain. If the deletionPolicy is `Delete`, then the underlying storage snapshot will be deleted along with the VolumeSnapshotContent object. If the deletionPolicy is `Retain`, then both the underlying snapshot and VolumeSnapshotContent remain.
## Parameters ## Parameters