Adding docs

open-telemetry · Mar 1, 2024 · 3cc85e9 · 3cc85e9
1 parent 62db99b
commit 3cc85e9
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 5 deletions.
diff --git a/apis/v1alpha1/opentelemetrycollector_types.go b/apis/v1alpha1/opentelemetrycollector_types.go
@@ -527,7 +527,7 @@ type MetricsConfigSpec struct {
 	//
 	// +optional
 	// +kubebuilder:validation:Optional
-	// Deprecated: use Spec.Observability.Metrics.DisableAutomaticPrometheusAnnotations instead.
+	// Deprecated: use "OpenTelemetryCollector.Spec.Observability.Metrics.DisableAutomaticPrometheusAnnotations" instead.
 	DisablePrometheusAnnotations bool `json:"DisablePrometheusAnnotations,omitempty"`
 	// DisableAutomaticPrometheusAnnotations controls the automatic addition of default Prometheus annotations
 	// ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')

diff --git a/bundle/manifests/opentelemetry.io_opentelemetrycollectors.yaml b/bundle/manifests/opentelemetry.io_opentelemetrycollectors.yaml
@@ -3870,7 +3870,12 @@ spec:
                       DisablePrometheusAnnotations:
                         description: DisablePrometheusAnnotations controls the automatic
                           addition of default Prometheus annotations ('prometheus.io/scrape',
-                          'prometheus.io/port', and 'prometheus.io/path')
+                          'prometheus.io/port', and 'prometheus.
+                        type: boolean
+                      disableAutomaticPrometheusAnnotations:
+                        description: DisableAutomaticPrometheusAnnotations controls
+                          the automatic addition of default Prometheus annotations
+                          ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
                         type: boolean
                       enableMetrics:
                         description: EnableMetrics specifies if ServiceMonitor or
@@ -5214,6 +5219,11 @@ spec:
                           DisablePrometheusAnnotations:
                             description: DisablePrometheusAnnotations controls the
                               automatic addition of default Prometheus annotations
+                              ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.
+                            type: boolean
+                          disableAutomaticPrometheusAnnotations:
+                            description: DisableAutomaticPrometheusAnnotations controls
+                              the automatic addition of default Prometheus annotations
                               ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
                             type: boolean
                           enableMetrics:

diff --git a/config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml b/config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml
@@ -3867,7 +3867,12 @@ spec:
                       DisablePrometheusAnnotations:
                         description: DisablePrometheusAnnotations controls the automatic
                           addition of default Prometheus annotations ('prometheus.io/scrape',
-                          'prometheus.io/port', and 'prometheus.io/path')
+                          'prometheus.io/port', and 'prometheus.
+                        type: boolean
+                      disableAutomaticPrometheusAnnotations:
+                        description: DisableAutomaticPrometheusAnnotations controls
+                          the automatic addition of default Prometheus annotations
+                          ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
                         type: boolean
                       enableMetrics:
                         description: EnableMetrics specifies if ServiceMonitor or
@@ -5211,6 +5216,11 @@ spec:
                           DisablePrometheusAnnotations:
                             description: DisablePrometheusAnnotations controls the
                               automatic addition of default Prometheus annotations
+                              ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.
+                            type: boolean
+                          disableAutomaticPrometheusAnnotations:
+                            description: DisableAutomaticPrometheusAnnotations controls
+                              the automatic addition of default Prometheus annotations
                               ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
                             type: boolean
                           enableMetrics:

diff --git a/docs/api.md b/docs/api.md
@@ -17815,7 +17815,14 @@ Metrics defines the metrics configuration for operands.
         <td><b>DisablePrometheusAnnotations</b></td>
         <td>boolean</td>
         <td>
-          DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')<br/>
+          DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.<br/>
+        </td>
+        <td>false</td>
+      </tr><tr>
+        <td><b>disableAutomaticPrometheusAnnotations</b></td>
+        <td>boolean</td>
+        <td>
+          DisableAutomaticPrometheusAnnotations controls the automatic addition of default Prometheus annotations ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')<br/>
         </td>
         <td>false</td>
       </tr><tr>
@@ -20325,7 +20332,14 @@ Metrics defines the metrics configuration for operands.
         <td><b>DisablePrometheusAnnotations</b></td>
         <td>boolean</td>
         <td>
-          DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')<br/>
+          DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.<br/>
+        </td>
+        <td>false</td>
+      </tr><tr>
+        <td><b>disableAutomaticPrometheusAnnotations</b></td>
+        <td>boolean</td>
+        <td>
+          DisableAutomaticPrometheusAnnotations controls the automatic addition of default Prometheus annotations ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')<br/>
         </td>
         <td>false</td>
       </tr><tr>