Update docs

DataDog · Jan 9, 2025 · da4ab24 · da4ab24
1 parent 7d40ddb
commit da4ab24
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 10 deletions.
diff --git a/api/datadoghq/v2alpha1/datadogagent_types.go b/api/datadoghq/v2alpha1/datadogagent_types.go
@@ -508,7 +508,7 @@ type GPUMonitoringFeatureConfig struct {
 	Enabled *bool `json:"enabled,omitempty"`
 
 	// PodRuntimeClassName specifies the runtime class name required for the GPU monitoring feature.
-	// If left empty, the runtime class will not be set.
+	// If left empty, the runtime class is not set.
 	// Default: nvidia
 	// +optional
 	PodRuntimeClassName *string `json:"requiredRuntimeClassName"`

diff --git a/config/crd/bases/v1/datadoghq.com_datadogagents.yaml b/config/crd/bases/v1/datadoghq.com_datadogagents.yaml
@@ -1030,7 +1030,7 @@ spec:
                         requiredRuntimeClassName:
                           description: |-
                             PodRuntimeClassName specifies the runtime class name required for the GPU monitoring feature.
-                            If left empty, the runtime class will not be set.
+                            If left empty, the runtime class is not set.
                             Default: nvidia
                           type: string
                       type: object
@@ -7909,7 +7909,7 @@ spec:
                             requiredRuntimeClassName:
                               description: |-
                                 PodRuntimeClassName specifies the runtime class name required for the GPU monitoring feature.
-                                If left empty, the runtime class will not be set.
+                                If left empty, the runtime class is not set.
                                 Default: nvidia
                               type: string
                           type: object

diff --git a/config/crd/bases/v1/datadoghq.com_datadogagents_v2alpha1.json b/config/crd/bases/v1/datadoghq.com_datadogagents_v2alpha1.json
@@ -1074,7 +1074,7 @@
                   "type": "boolean"
                 },
                 "requiredRuntimeClassName": {
-                  "description": "PodRuntimeClassName specifies the runtime class name required for the GPU monitoring feature.\nIf left empty, the runtime class will not be set.\nDefault: nvidia",
+                  "description": "PodRuntimeClassName specifies the runtime class name required for the GPU monitoring feature.\nIf left empty, the runtime class is not set.\nDefault: nvidia",
                   "type": "string"
                 }
               },
@@ -7895,7 +7895,7 @@
                       "type": "boolean"
                     },
                     "requiredRuntimeClassName": {
-                      "description": "PodRuntimeClassName specifies the runtime class name required for the GPU monitoring feature.\nIf left empty, the runtime class will not be set.\nDefault: nvidia",
+                      "description": "PodRuntimeClassName specifies the runtime class name required for the GPU monitoring feature.\nIf left empty, the runtime class is not set.\nDefault: nvidia",
                       "type": "string"
                     }
                   },

diff --git a/docs/configuration.v2alpha1.md b/docs/configuration.v2alpha1.md
@@ -112,7 +112,7 @@ spec:
 | features.externalMetricsServer.useDatadogMetrics | UseDatadogMetrics enables usage of the DatadogMetrics CRD (allowing one to scale on arbitrary Datadog metric queries). Default: true |
 | features.externalMetricsServer.wpaController | WPAController enables the informer and controller of the Watermark Pod Autoscaler. NOTE: The Watermark Pod Autoscaler controller needs to be installed. See also: https://github.com/DataDog/watermarkpodautoscaler. Default: false |
 | features.gpu.enabled | Enables GPU monitoring. Default: false |
-| features.gpu.requiredRuntimeClassName | PodRuntimeClassName specifies the runtime class name required for the GPU monitoring feature. If left empty, the runtime class will not be set. Default: nvidia |
+| features.gpu.requiredRuntimeClassName | PodRuntimeClassName specifies the runtime class name required for the GPU monitoring feature. If left empty, the runtime class is not set. Default: nvidia |
 | features.helmCheck.collectEvents | CollectEvents set to `true` enables event collection in the Helm check (Requires Agent 7.36.0+ and Cluster Agent 1.20.0+) Default: false |
 | features.helmCheck.enabled | Enables the Helm check. Default: false |
 | features.helmCheck.valuesAsTags | ValuesAsTags collects Helm values from a release and uses them as tags (Requires Agent and Cluster Agent 7.40.0+). Default: {} |

diff --git a/internal/controller/datadogagent/feature/gpu/feature_test.go b/internal/controller/datadogagent/feature/gpu/feature_test.go
@@ -155,20 +155,26 @@ func Test_GPUMonitoringFeature_Configure(t *testing.T) {
 			Name:          "gpu monitoring enabled",
 			DDA:           ddaGPUMonitoringEnabled,
 			WantConfigure: true,
-			Agent:         test.NewDefaultComponentTest().WithWantFunc(func(t testing.TB, mgrInterface feature.PodTemplateManagers) { GPUMonitoringAgentNodeWantFunc(t, mgrInterface, v2alpha1.DefaultGPUMonitoringRuntimeClass) }),
+			Agent: test.NewDefaultComponentTest().WithWantFunc(func(t testing.TB, mgrInterface feature.PodTemplateManagers) {
+				GPUMonitoringAgentNodeWantFunc(t, mgrInterface, v2alpha1.DefaultGPUMonitoringRuntimeClass)
+			}),
 		},
 		{
 			Name:          "gpu monitoring enabled, alternative runtime class",
 			DDA:           ddaGPUMonitoringEnabledAlternativeRuntimeClass,
 			WantConfigure: true,
-			Agent:         test.NewDefaultComponentTest().WithWantFunc(func(t testing.TB, mgrInterface feature.PodTemplateManagers) { GPUMonitoringAgentNodeWantFunc(t, mgrInterface, alternativeRuntimeClass) }),
+			Agent: test.NewDefaultComponentTest().WithWantFunc(func(t testing.TB, mgrInterface feature.PodTemplateManagers) {
+				GPUMonitoringAgentNodeWantFunc(t, mgrInterface, alternativeRuntimeClass)
+			}),
 		},
 
 		{
 			Name:          "gpu monitoring enabled, no runtime class",
 			DDA:           ddaGPUMonitoringEnabledANoRuntimeClass,
 			WantConfigure: true,
-			Agent:         test.NewDefaultComponentTest().WithWantFunc(func(t testing.TB, mgrInterface feature.PodTemplateManagers) { GPUMonitoringAgentNodeWantFunc(t, mgrInterface, "") }),
+			Agent: test.NewDefaultComponentTest().WithWantFunc(func(t testing.TB, mgrInterface feature.PodTemplateManagers) {
+				GPUMonitoringAgentNodeWantFunc(t, mgrInterface, "")
+			}),
 		},
 	}
 

diff --git a/pkg/testutils/builder.go b/pkg/testutils/builder.go
@@ -950,7 +950,6 @@ func (builder *DatadogAgentBuilder) WithFIPS(fipsConfig v2alpha1.FIPSConfig) *Da
 	return builder
 }
 
-
 // GPU
 
 func (builder *DatadogAgentBuilder) initGPUMonitoring() {
-Original file line number
+Diff line change
@@ Expand Up @@
     	return builder
     }
     // GPU
     func (builder *DatadogAgentBuilder) initGPUMonitoring() {
@@ Expand Down @@