Skip to content

Commit d5c925a

Browse files
EricPonvelleEricPonvelle
authored
Merge pull request #95142 from AedinC/OSDOCS-14933
OSDOCS-14933:Feedback from SME reviewer for HCP Storage book.
2 parents 7319718 + 315ca83 commit d5c925a

17 files changed

+104
-34
lines changed

‎microshift_install_get_ready/microshift-install-get-ready.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ For most installation types, you must also take the following steps:
7979

8080
* Decide whether you need to configure storage for the application and tasks you are using in your {microshift-short} cluster, or disable the {microshift-short} storage plug-in completely.
8181
** For more information about creating volume groups and persistent volumes on {op-system-base}, see link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/overview-of-logical-volume-management_configuring-and-managing-logical-volumes[Overview of logical volume management].
82-
** For more information about the {microshift-short} plug-in, see xref:../microshift_storage/microshift-storage-plugin-overview.adoc#microshift-storage-plugin-overview[Dynamic storage using the LVMS plugin].
82+
** For more information about the {microshift-short} plug-in, see xref:../microshift_storage/microshift-storage-plugin-overview.adoc#[Dynamic storage using the LVMS plugin].
8383

8484
* Configure networking settings according to the access needs you plan for your {microshift-short} cluster and applications. Consider whether you want to use single or dual-stack networks, configure a firewall, or configure routes.
8585
** For more information about {microshift-short} networking options, see xref:../microshift_networking/microshift-networking-settings.adoc#microshift-networking[Understanding networking settings].

‎microshift_storage/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Stateful applications deployed in containers require persistent storage. {micros
2626
[id="microshift-dynamic-provisioning-overview"]
2727
=== Dynamic storage provisioning
2828

29-
Using dynamic provisioning allows you to create storage volumes on-demand, eliminating the need for pre-provisioned storage. For more information about how dynamic provisioning works in {product-title}, read xref:../microshift_storage/microshift-storage-plugin-overview.adoc#microshift-storage-plugin-overview[Dynamic provisioning].
29+
Using dynamic provisioning allows you to create storage volumes on-demand, eliminating the need for pre-provisioned storage. For more information about how dynamic provisioning works in {product-title}, read xref:../microshift_storage/microshift-storage-plugin-overview.adoc#[Dynamic provisioning using the LVMS plugin].
3030

3131
//[id="microshift-container-storage-interface"]
3232
//== Container Storage Interface (CSI)

‎modules/dynamic-provisioning-available-plugins.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2828
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2929

3030
|Amazon Elastic Block Store (Amazon EBS)
31-
|`kubernetes.io/aws-ebs`
31+
|`ebs.csi.aws.com`
3232
|For dynamic provisioning when using multiple clusters in different zones,
3333
tag each node with `Key=kubernetes.io/cluster/<cluster_name>,Value=<cluster_id>`
3434
where `<cluster_name>` and `<cluster_id>` are unique per cluster.

‎modules/dynamic-provisioning-aws-definition.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ kind: StorageClass
1212
apiVersion: storage.k8s.io/v1
1313
metadata:
1414
name: <storage-class-name> <1>
15-
provisioner: kubernetes.io/aws-ebs
15+
provisioner: ebs.csi.aws.com
1616
parameters:
1717
type: io1 <2>
1818
iopsPerGB: "10" <3>

‎modules/dynamic-provisioning-change-default-class.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ $ oc get storageclass
2929
[source,terminal]
3030
----
3131
NAME TYPE
32-
gp3 (default) kubernetes.io/aws-ebs <1>
33-
standard kubernetes.io/aws-ebs
32+
gp3 (default) ebs.csi.aws.com <1>
33+
standard ebs.csi.aws.com
3434
----
3535
<1> `(default)` indicates the default storage class.
3636

@@ -72,6 +72,6 @@ $ oc get storageclass
7272
[source,terminal]
7373
----
7474
NAME TYPE
75-
gp3 kubernetes.io/aws-ebs
76-
standard (default) kubernetes.io/aws-ebs
75+
gp3 ebs.csi.aws.com
76+
standard (default) ebs.csi.aws.com
7777
----

‎modules/dynamic-provisioning-storage-class-definition.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ The following resource shows the parameters and default values that you
1111
use to configure a storage class. This example uses the AWS
1212
ElasticBlockStore (EBS) object definition.
1313

14+
ifndef::openshift-rosa,openshift-rosa-hcp[]
1415
.Sample `StorageClass` definition
1516
[source,yaml]
1617
----
@@ -32,3 +33,28 @@ parameters: <6>
3233
<4> (optional) Annotations for the storage class.
3334
<5> (required) The type of provisioner associated with this storage class.
3435
<6> (optional) The parameters required for the specific provisioner, this will change from plug-in to plug-in.
36+
endif::openshift-rosa,openshift-rosa-hcp[]
37+
38+
ifdef::openshift-rosa,openshift-rosa-hcp[]
39+
.Sample `StorageClass` definition
40+
[source,yaml]
41+
----
42+
kind: StorageClass <1>
43+
apiVersion: storage.k8s.io/v1 <2>
44+
metadata:
45+
name: <storage-class-name> <3>
46+
annotations: <4>
47+
storageclass.kubernetes.io/is-default-class: 'true'
48+
...
49+
provisioner: ebs.csi.aws.com <5>
50+
parameters: <6>
51+
type: gp3-csi
52+
...
53+
----
54+
<1> (required) The API object type.
55+
<2> (required) The current apiVersion.
56+
<3> (required) The name of the storage class.
57+
<4> (optional) Annotations for the storage class.
58+
<5> (required) The type of provisioner associated with this storage class.
59+
<6> (optional) The parameters required for the specific provisioner, this will change from plug-in to plug-in.
60+
endif::openshift-rosa,openshift-rosa-hcp[]

‎modules/persistent-storage-csi-drivers-supported.adoc

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,19 @@ ifndef::openshift-rosa,openshift-rosa-hcp[]
1515
The AWS EFS and GCP Filestore CSI drivers are not installed by default, and must be installed manually. For instructions on installing the AWS EFS CSI driver, see link:https://access.redhat.com/documentation/en-us/openshift_dedicated/4/html/storage/using-container-storage-interface-csi#osd-persistent-storage-aws-efs-csi[Setting up AWS Elastic File Service CSI Driver Operator]. For instructions on installing the GCP Filestore CSI driver, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html/storage/using-container-storage-interface-csi#persistent-storage-csi-google-cloud-file-overview[Google Compute Platform Filestore CSI Driver Operator].
1616
====
1717
endif::openshift-rosa,openshift-rosa-hcp[]
18+
19+
ifdef::openshift-rosa,openshift-rosa-hcp[]
20+
[IMPORTANT]
21+
====
22+
The AWS EFS driver is not installed by default, and must be installed manually. For instructions about installing the AWS EFS CSI driver, see "AWS Elastic File Service CSI Driver Operator" in the _Additional resources_ section.
23+
====
24+
endif::openshift-rosa,openshift-rosa-hcp[]
25+
1826
The following table describes the CSI drivers that are
1927
ifndef::openshift-dedicated[]
20-
installed with {product-title}
28+
installed with {product-title},
2129
endif::openshift-dedicated[]
22-
ifndef::openshift-rosa,openshift-rosa-hcp[]
23-
supported by {product-title}
24-
endif::openshift-rosa,openshift-rosa-hcp[]
25-
and which CSI features they support, such as volume snapshots and resize.
30+
supported by {product-title}, and which CSI features they support, such as volume snapshots and resize.
2631

2732
ifndef::openshift-rosa,openshift-rosa-hcp[]
2833
[IMPORTANT]

‎modules/persistent-storage-csi-efs-cross-account.adoc

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,14 @@
77
[id="persistent-storage-csi-efs-cross-account_{context}"]
88
= AWS EFS CSI cross account support
99

10-
Cross account support allows you to have an {product-title} cluster in one AWS account and mount your file system in another AWS account by using the AWS Elastic File System (EFS) Container Storage Interface (CSI) driver.
10+
Cross account support allows you to have
11+
ifdef::openshift-rosa,openshift-rosa-hcp[]
12+
a {product-title} cluster
13+
endif::openshift-rosa,openshift-rosa-hcp[]
14+
ifndef::openshift-rosa,openshift-rosa-hcp[]
15+
an {product-title} cluster
16+
endif::openshift-rosa,openshift-rosa-hcp[]
17+
in one AWS account and mount your file system in another AWS account by using the AWS Elastic File System (EFS) Container Storage Interface (CSI) driver.
1118

1219
[NOTE]
1320
====
@@ -16,7 +23,13 @@ Both the {product-title} cluster and EFS file system must be in the same region.
1623

1724
.Prerequisites
1825

19-
* Access to an {product-title} cluster with administrator rights
26+
* Access to
27+
ifdef::openshift-rosa,openshift-rosa-hcp[]
28+
a {product-title} cluster
29+
endif::openshift-rosa,openshift-rosa-hcp[]
30+
ifndef::openshift-rosa,openshift-rosa-hcp[]
31+
an {product-title} cluster
32+
endif::openshift-rosa,openshift-rosa-hcp[] cluster with administrator rights
2033
2134
* Two valid AWS accounts
2235

‎modules/persistent-storage-csi-mysql-example.adoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ changes to the template.
3737
# oc get pvc
3838
----
3939
+
40+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4041
.Example output
4142
[source,terminal]
4243
----
@@ -45,3 +46,16 @@ ACCESS MODES STORAGECLASS AGE
4546
mysql Bound kubernetes-dynamic-pv-3271ffcb4e1811e8 1Gi
4647
RWO cinder 3s
4748
----
49+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
50+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
51+
.Example output
52+
[source,terminal]
53+
----
54+
NAME STATUS VOLUME CAPACITY
55+
mysql Bound kubernetes-dynamic-pv-3271ffcb4e1811e8 1Gi
56+
57+
ACCESS MODES STORAGECLASS AGE
58+
RWO gp3-csi 3s
59+
----
60+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
61+

‎modules/storage-ephemeral-storage-manage.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ For example, the following quantities all represent approximately the same value
2222

2323
[IMPORTANT]
2424
====
25-
The suffixes for each byte quantity are case-sensitive. Be sure to use the correct case. Use the case-sensitive "M", such as used in "400M" to set the request at 400 megabytes. Use the case-sensitive "400Mi" to request 400 mebibytes. If you specify "400m" of ephemeral storage, the storage requests is only 0.4 bytes.
25+
The suffixes for each byte quantity are case-sensitive. Be sure to use the correct case. Use the case-sensitive "M", such as used in "400M", to set the request at 400 megabytes. Use the case-sensitive "400Mi" to request 400 mebibytes. If you specify "400m" of ephemeral storage, the storage request is only 0.4 bytes.
2626
====
2727

2828
[id=storage-ephemeral-storage-requests-limits_{context}]

0 commit comments

Comments
 (0)