Skip to content

Commit de6fcbf

Browse files
lpettyjolpettyjo
authored
Merge pull request #80371 from lpettyjo/OSDOCS-11073
OSDOCS#11073: AWS EFS usage metrics
2 parents 4825feb + d99107e commit de6fcbf

File tree

4 files changed

+120
-0
lines changed

4 files changed

+120
-0
lines changed

‎modules/persistent-storage-csi-efs-metrics-overview.adoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * storage/persistent_storage/persistent-storage-csi-aws-efs.adoc
4+
//
5+
:_mod-docs-content-type: CONCEPT
6+
[id="efs-metrics-overview_{context}"]
7+
= Usage metrics overview
8+
9+
Amazon Web Services (AWS) Elastic File Service (EFS) storage Container Storage Interface (CSI) usage metrics allow you to monitor how much space is used by either dynamically or statically provisioned EFS volumes.
10+
11+
[IMPORTANT]
12+
====
13+
This features is disabled by default, because turning on metrics can lead to performance degradation.
14+
====
15+
16+
The AWS EFS usage metrics feature collects volume metrics in the AWS EFS CSI Driver by recursively walking through the files in the volume. Because this effort can degrade performance, administrators must explicitly enable this feature.

‎modules/persistent-storage-csi-efs-metrics-procedure-cli.adoc

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * storage/persistent_storage/persistent-storage-csi-aws-efs.adoc
4+
//
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="efs-metrics-procedure-cli_{context}"]
7+
= Enabling usage metrics using the CLI
8+
9+
To enable Amazon Web Services (AWS) Elastic File Service (EFS) storage Container Storage Interface (CSI) usage metrics using the CLI:
10+
11+
. Edit ClusterCSIDriver by running the following command:
12+
+
13+
[source, terminal]
14+
----
15+
$ oc edit clustercsidriver efs.csi.aws.com
16+
----
17+
18+
. Under `spec.aws.efsVolumeMetrics.state`, set the value to `RecursiveWalk`.
19+
+
20+
`RecursiveWalk` indicates that volume metrics collection in the AWS EFS CSI Driver is performed by recursively walking through the files in the volume.
21+
+
22+
.Example ClusterCSIDriver efs.csi.aws.com YAML file
23+
[source, yaml]
24+
----
25+
spec:
26+
driverConfig:
27+
driverType: AWS
28+
aws:
29+
efsVolumeMetrics:
30+
state: RecursiveWalk
31+
recursiveWalk:
32+
refreshPeriodMinutes: 100
33+
fsRateLimit: 10
34+
----
35+
36+
. Optional: To define how the recursive walk operates, you can also set the following fields:
37+
+
38+
** `refreshPeriodMinutes`: Specifies the refresh frequency for volume metrics in minutes. If this field is left blank, a reasonable default is chosen, which is subject to change over time. The current default is 240 minutes. The valid range is 1 to 43,200 minutes.
39+
** `fsRateLimit`: Defines the rate limit for processing volume metrics in goroutines per file system. If this field is left blank, a reasonable default is chosen, which is subject to change over time. The current default is 5 goroutines. The valid range is 1 to 100 goroutines.
40+
41+
. Save the changes to the `efs.csi.aws.com` object.
42+
43+
[NOTE]
44+
====
45+
To *disable* AWS EFS CSI usage metrics, use the preceding procedure, but for `spec.aws.efsVolumeMetrics.state`, change the value from `RecursiveWalk` to `Disabled`.
46+
====

‎modules/persistent-storage-csi-efs-metrics-procedure-gui.adoc

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * storage/persistent_storage/persistent-storage-csi-aws-efs.adoc
4+
//
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="efs-metrics-procedure-gui_{context}"]
7+
= Enabling usage metrics using the web console
8+
9+
To enable Amazon Web Services (AWS) Elastic File Service (EFS) Storage Container Storage Interface (CSI) usage metrics using the web console:
10+
11+
. Click *Administration* > *CustomResourceDefinitions*.
12+
13+
. On the *CustomResourceDefinitions* page next to the *Name* dropdown box, type `clustercsidriver`.
14+
15+
. Click *CRD ClusterCSIDriver*.
16+
17+
. Click the *YAML* tab.
18+
19+
. Under `spec.aws.efsVolumeMetrics.state`, set the value to `RecursiveWalk`.
20+
+
21+
`RecursiveWalk` indicates that volume metrics collection in the AWS EFS CSI Driver is performed by recursively walking through the files in the volume.
22+
+
23+
.Example ClusterCSIDriver efs.csi.aws.com YAML file
24+
[source, yaml]
25+
----
26+
spec:
27+
driverConfig:
28+
driverType: AWS
29+
aws:
30+
efsVolumeMetrics:
31+
state: RecursiveWalk
32+
recursiveWalk:
33+
refreshPeriodMinutes: 100
34+
fsRateLimit: 10
35+
----
36+
37+
. Optional: To define how the recursive walk operates, you can also set the following fields:
38+
+
39+
** `refreshPeriodMinutes`: Specifies the refresh frequency for volume metrics in minutes. If this field is left blank, a reasonable default is chosen, which is subject to change over time. The current default is 240 minutes. The valid range is 1 to 43,200 minutes.
40+
** `fsRateLimit`: Defines the rate limit for processing volume metrics in goroutines per file system. If this field is left blank, a reasonable default is chosen, which is subject to change over time. The current default is 5 goroutines. The valid range is 1 to 100 goroutines.
41+
42+
. Click *Save*.
43+
44+
[NOTE]
45+
====
46+
To *disable* AWS EFS CSI usage metrics, use the preceding procedure, but for `spec.aws.efsVolumeMetrics.state`, change the value from `RecursiveWalk` to `Disabled`.
47+
====

‎storage/container_storage_interface/persistent-storage-csi-aws-efs.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,17 @@ If you have problems setting up static PVs, see xref:../../storage/container_sto
9292

9393
include::modules/persistent-storage-csi-efs-security.adoc[leveloffset=+1]
9494

95+
== AWS EFS storage CSI usage metrics
96+
include::modules/persistent-storage-csi-efs-metrics-overview.adoc[leveloffset=+2]
97+
98+
//:FeatureName: AWS EFS usage metrics
99+
// Commenting this out for now because we anticipate GA status.
100+
// include::snippets/technology-preview.adoc[leveloffset=+2]
101+
102+
include::modules/persistent-storage-csi-efs-metrics-procedure-gui.adoc[leveloffset=+2]
103+
104+
include::modules/persistent-storage-csi-efs-metrics-procedure-cli.adoc[leveloffset=+2]
105+
95106
include::modules/persistent-storage-csi-efs-troubleshooting.adoc[leveloffset=+1]
96107

97108
:FeatureName: AWS EFS

0 commit comments

Comments
 (0)