-
Notifications
You must be signed in to change notification settings - Fork 1.9k
OSDOCS-16945# CQA work Stor1 -- vol resize #106419
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,22 +7,23 @@ | |
| [id="add-volume-expansion_{context}"] | ||
| = Enabling volume expansion support | ||
|
|
||
| Before you can expand persistent volumes, the `StorageClass` object must | ||
| have the `allowVolumeExpansion` field set to `true`. | ||
| [role="_abstract"] | ||
| Before you can expand persistent volumes, the `StorageClass` object must have the `allowVolumeExpansion` field set to `true`. | ||
|
|
||
| .Procedure | ||
|
|
||
| * Edit the `StorageClass` object and add the `allowVolumeExpansion` attribute by running the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc edit storageclass <storage_class_name> <1> | ||
| $ oc edit storageclass <storage_class_name> | ||
| ---- | ||
| <1> Specifies the name of the storage class. | ||
| + | ||
| The following example demonstrates adding this line at the bottom | ||
| of the storage class configuration. | ||
| Enter the name of storage class in `<storage_class_name>`. | ||
| + | ||
| The following example shows adding this line at the bottom of the storage class configuration. | ||
| + | ||
| .Example storage class YAML file with `allowVolumeExpansion` field set to `true` | ||
| [source,yaml] | ||
| ---- | ||
| apiVersion: storage.k8s.io/v1 | ||
|
|
@@ -31,7 +32,7 @@ kind: StorageClass | |
| parameters: | ||
| type: gp2 | ||
| reclaimPolicy: Delete | ||
| allowVolumeExpansion: true <1> | ||
| allowVolumeExpansion: true | ||
| ---- | ||
| <1> Setting this attribute to `true` allows PVCs to be | ||
| expanded after creation. | ||
| + | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| * `parameters.allowVolumeExpansion`: Setting this field to `true` allows persistent volume claims (PVCs) to be expanded after creation. | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -3,25 +3,30 @@ | |||||
| // * storage/expanding-persistent-volumes.adoc | ||||||
| //* microshift_storage/expanding-persistent-volumes-microshift.adoc | ||||||
|
|
||||||
|
|
||||||
| :_mod-docs-content-type: PROCEDURE | ||||||
| [id="expanding-csi-volumes_{context}"] | ||||||
| = Expanding CSI volumes | ||||||
|
|
||||||
| [role="_abstract"] | ||||||
| You can use the Container Storage Interface (CSI) to expand storage volumes after they have already been created. | ||||||
|
|
||||||
| Shrinking persistent volumes (PVs) is _not_ supported. | ||||||
|
|
||||||
| .Prerequisites | ||||||
|
|
||||||
| * The underlying CSI driver supports resize. See "CSI drivers supported by {product-title}" in the "Additional resources" section. | ||||||
| * The underlying CSI driver supports resize. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider keeping "For information..." line on the same line as the prereq. |
||||||
| + | ||||||
| For information about which CSI drivers support resizing, see under the _Additional resources_ section "CSI drivers supported by {product-title}". | ||||||
|
|
||||||
| * Dynamic provisioning is used. | ||||||
|
|
||||||
| * The controlling `StorageClass` object has `allowVolumeExpansion` set to `true`. For more information, see "Enabling volume expansion support." | ||||||
| * The controlling `StorageClass` object has `allowVolumeExpansion` set to `true`. | ||||||
| + | ||||||
| For more information, see section _Enabling volume expansion support_. | ||||||
|
|
||||||
| .Procedure | ||||||
|
|
||||||
| . For the persistent volume claim (PVC), set `.spec.resources.requests.storage` to the desired new size. | ||||||
| * For the persistent volume claim (PVC), set `.spec.resources.requests.storage` to the desired new size. | ||||||
|
|
||||||
| . Watch the `status.conditions` field of the PVC to see if the resize has completed. {product-title} adds the `Resizing` condition to the PVC during expansion, which is removed after expansion completes. | ||||||
| .Verification | ||||||
| To confirm that the resize is finished, look at the `status.conditions` field of the PVC . {product-title} adds the `Resizing` condition to the PVC during expansion, which is removed after expansion completes. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,28 +7,32 @@ | |
| [id="expanding-pvc-filesystem_{context}"] | ||
| = Expanding persistent volume claims (PVCs) with a file system | ||
|
|
||
| [role="_abstract"] | ||
| ifndef::microshift,openshift-rosa,openshift-rosa-hcp[] | ||
| Expanding PVCs based on volume types that need file system resizing, such as GCE, EBS, and Cinder, is a two-step process. First, expand the volume objects in the cloud provider. Second, expand the file system on the node. | ||
| Expanding PVCs based on volume types that need file system resizing, such as Google Cloud Platform (GCP) persistent disk (PD), AWS Elastic Block Storage (EBS), and Cinder, is a two-step process. First, expand the volume objects in the cloud provider. Second, expand the file system on the node. | ||
| endif::microshift,openshift-rosa,openshift-rosa-hcp[] | ||
|
|
||
| ifdef::microshift[] | ||
| Expanding PVCs based on volume types that need file system resizing, such as GCE Persistent Disk volumes (gcePD), AWS Elastic Block Store EBS (EBS), and Cinder, is a two-step process. First, expand the volume objects in the cloud provider. Second, expand the file system on the node. | ||
| Expanding PVCs based on volume types that need file system resizing, such as Google Cloud Platform (GCP) persistent disk (PD), AWS Elastic Block Store EBS (EBS), and Cinder, is a two-step process. First, expand the volume objects in the cloud provider. Second, expand the file system on the node. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| endif::microshift[] | ||
|
|
||
| ifdef::openshift-rosa,openshift-rosa-hcp[] | ||
| Expanding PVCs based on volume types that need file system resizing, such as AWS Elastic Block Store EBS (EBS) is a two-step process. First, expand the volume objects in the cloud provider. Second, expand the file system on the node. | ||
| Expanding PVCs based on volume types that need file system resizing, such as AWS Elastic Block Store (EBS) is a two-step process. First, expand the volume objects in the cloud provider. Second, expand the file system on the node. | ||
| endif::openshift-rosa,openshift-rosa-hcp[] | ||
|
|
||
| Expanding the file system on the node only happens when a new pod is started with the volume. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * The controlling `StorageClass` object must have `allowVolumeExpansion` set to `true`. | ||
| * The controlling storage class has the `allowVolumeExpansion` field set to `true`. | ||
| + | ||
| For more information, see section _Enabling volume expansion support_. | ||
|
|
||
| .Procedure | ||
|
|
||
| . Edit the PVC and request a new size by editing `spec.resources.requests`. For example, the following expands the `ebs` PVC to 8 Gi: | ||
| * Edit the PVC and request a new size by editing `spec.resources.requests`. For example, the following expands the `ebs` PVC to 8 Gi: | ||
| + | ||
| .Example PVC YAML file | ||
| [source,yaml] | ||
| ---- | ||
| kind: PersistentVolumeClaim | ||
|
|
@@ -41,16 +45,23 @@ spec: | |
| - ReadWriteOnce | ||
| resources: | ||
| requests: | ||
| storage: 8Gi <1> | ||
| storage: 8Gi | ||
| ---- | ||
| [.small] | ||
| <1> Updating `spec.resources.requests` to a larger amount expands the PVC. | ||
| + | ||
| * `spec.resources.requests`: Updating this field to a larger amount expands the PVC. | ||
|
|
||
| . After the cloud provider object has finished resizing, the PVC is set to `FileSystemResizePending`. Check the condition by entering the following command: | ||
| .Verification | ||
| After the cloud provider object has finished resizing, the PVC is set to `FileSystemResizePending`. | ||
|
|
||
| * Check the condition by running the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc describe pvc <pvc_name> | ||
| ---- | ||
|
|
||
| . When the cloud provider object has finished resizing, the `PersistentVolume` object reflects the newly requested size in `PersistentVolume.Spec.Capacity`. At this point, you can create or recreate a new pod from the PVC to finish the file system resizing. Once the pod is running, the newly requested size is available and the `FileSystemResizePending` condition is removed from the PVC. | ||
| .Next steps | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Usually the Vale check fails for next steps. If so, perhaps a new step could be added. |
||
| When the cloud provider object has finished resizing, the `PersistentVolume` object reflects the newly requested size in `PersistentVolume.Spec.Capacity`. | ||
|
|
||
| You can now create or recreate a new pod from the PVC to finish the file system resizing. After the pod is running, the newly requested size is available and the `FileSystemResizePending` condition is removed from the PVC. | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -3,11 +3,11 @@ | |||||
| // * storage/expanding-persistent-volumes.adoc | ||||||
| //* microshift_storage/expanding-persistent-volumes-microshift.adoc | ||||||
|
|
||||||
|
|
||||||
| :_mod-docs-content-type: PROCEDURE | ||||||
| [id="expanding-local-volumes_{context}"] | ||||||
| = Expanding local volumes | ||||||
|
|
||||||
| [role="_abstract"] | ||||||
| You can manually expand persistent volumes (PVs) and persistent volume claims (PVCs) created by using the local storage operator (LSO). | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| .Procedure | ||||||
|
|
||||||


There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "why" is missing for some of these abstracts. I use this NotebookLM to help with writing short descriptions,especially for ideas on how to capture the "how" and "why" of a short description.