docs: Fix MetricPipeline input docs (kyma-project#1540)

Co-authored-by: Andreas Thaler <[email protected]>
TeodorSAP · Oct 22, 2024 · f0bf09d · f0bf09d
1 parent 7c90c5f
commit f0bf09d
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 12 deletions.
diff --git a/apis/telemetry/v1alpha1/metricpipeline_types.go b/apis/telemetry/v1alpha1/metricpipeline_types.go
@@ -82,7 +82,7 @@ type MetricPipelineInput struct {
 
 // MetricPipelinePrometheusInput defines the Prometheus scraping section.
 type MetricPipelinePrometheusInput struct {
-	// If enabled, Pods marked with `prometheus.io/scrape=true` annotation are scraped. The default is `false`.
+	// If enabled, Services and Pods marked with `prometheus.io/scrape=true` annotation are scraped. The default is `false`.
 	Enabled bool `json:"enabled,omitempty"`
 	// Describes whether Prometheus metrics from specific namespaces are selected. System namespaces are disabled by default.
 	// +optional
@@ -145,7 +145,7 @@ type MetricPipelineRuntimeInputResourceDisabledByDefault struct {
 
 // MetricPipelineIstioInput defines the Istio scraping section.
 type MetricPipelineIstioInput struct {
-	// If enabled, metrics for istio-proxy containers are scraped from Pods that have had the istio-proxy sidecar injected. The default is `false`.
+	// If enabled, istio-proxy metrics are scraped from Pods that have the istio-proxy sidecar injected. The default is `false`.
 	Enabled bool `json:"enabled,omitempty"`
 	// Describes whether istio-proxy metrics from specific namespaces are selected. System namespaces are enabled by default.
 	// +optional

diff --git a/config/crd/bases/telemetry.kyma-project.io_metricpipelines.yaml b/config/crd/bases/telemetry.kyma-project.io_metricpipelines.yaml
@@ -74,9 +74,9 @@ spec:
                             type: boolean
                         type: object
                       enabled:
-                        description: If enabled, metrics for istio-proxy containers
-                          are scraped from Pods that have had the istio-proxy sidecar
-                          injected. The default is `false`.
+                        description: If enabled, istio-proxy metrics are scraped from
+                          Pods that have the istio-proxy sidecar injected. The default
+                          is `false`.
                         type: boolean
                       namespaces:
                         description: Describes whether istio-proxy metrics from specific
@@ -146,7 +146,7 @@ spec:
                             type: boolean
                         type: object
                       enabled:
-                        description: If enabled, Pods marked with `prometheus.io/scrape=true`
+                        description: If enabled, Services and Pods marked with `prometheus.io/scrape=true`
                           annotation are scraped. The default is `false`.
                         type: boolean
                       namespaces:

diff --git a/config/development/crd/bases/telemetry.kyma-project.io_metricpipelines.yaml b/config/development/crd/bases/telemetry.kyma-project.io_metricpipelines.yaml
@@ -74,9 +74,9 @@ spec:
                             type: boolean
                         type: object
                       enabled:
-                        description: If enabled, metrics for istio-proxy containers
-                          are scraped from Pods that have had the istio-proxy sidecar
-                          injected. The default is `false`.
+                        description: If enabled, istio-proxy metrics are scraped from
+                          Pods that have the istio-proxy sidecar injected. The default
+                          is `false`.
                         type: boolean
                       namespaces:
                         description: Describes whether istio-proxy metrics from specific
@@ -146,7 +146,7 @@ spec:
                             type: boolean
                         type: object
                       enabled:
-                        description: If enabled, Pods marked with `prometheus.io/scrape=true`
+                        description: If enabled, Services and Pods marked with `prometheus.io/scrape=true`
                           annotation are scraped. The default is `false`.
                         type: boolean
                       namespaces:

diff --git a/docs/user/resources/05-metricpipeline.md b/docs/user/resources/05-metricpipeline.md
@@ -72,7 +72,7 @@ For details, see the [MetricPipeline specification file](https://github.com/kyma
 | **input.&#x200b;istio**  | object | Configures istio-proxy metrics scraping. |
 | **input.&#x200b;istio.&#x200b;diagnosticMetrics**  | object | Configures diagnostic metrics scraping |
 | **input.&#x200b;istio.&#x200b;diagnosticMetrics.&#x200b;enabled**  | boolean | If enabled, diagnostic metrics are scraped. The default is `false`. |
-| **input.&#x200b;istio.&#x200b;enabled**  | boolean | If enabled, metrics for istio-proxy containers are scraped from Pods that have had the istio-proxy sidecar injected. The default is `false`. |
+| **input.&#x200b;istio.&#x200b;enabled**  | boolean | If enabled, istio-proxy metrics are scraped from Pods that have the istio-proxy sidecar injected. The default is `false`. |
 | **input.&#x200b;istio.&#x200b;namespaces**  | object | Describes whether istio-proxy metrics from specific namespaces are selected. System namespaces are enabled by default. |
 | **input.&#x200b;istio.&#x200b;namespaces.&#x200b;exclude**  | \[\]string | Exclude metrics from the specified Namespace names only. |
 | **input.&#x200b;istio.&#x200b;namespaces.&#x200b;include**  | \[\]string | Include metrics from the specified Namespace names only. |
@@ -84,7 +84,7 @@ For details, see the [MetricPipeline specification file](https://github.com/kyma
 | **input.&#x200b;prometheus**  | object | Configures Prometheus scraping. |
 | **input.&#x200b;prometheus.&#x200b;diagnosticMetrics**  | object | Configures diagnostic metrics scraping |
 | **input.&#x200b;prometheus.&#x200b;diagnosticMetrics.&#x200b;enabled**  | boolean | If enabled, diagnostic metrics are scraped. The default is `false`. |
-| **input.&#x200b;prometheus.&#x200b;enabled**  | boolean | If enabled, Pods marked with `prometheus.io/scrape=true` annotation are scraped. The default is `false`. |
+| **input.&#x200b;prometheus.&#x200b;enabled**  | boolean | If enabled, Services and Pods marked with `prometheus.io/scrape=true` annotation are scraped. The default is `false`. |
 | **input.&#x200b;prometheus.&#x200b;namespaces**  | object | Describes whether Prometheus metrics from specific namespaces are selected. System namespaces are disabled by default. |
 | **input.&#x200b;prometheus.&#x200b;namespaces.&#x200b;exclude**  | \[\]string | Exclude metrics from the specified Namespace names only. |
 | **input.&#x200b;prometheus.&#x200b;namespaces.&#x200b;include**  | \[\]string | Include metrics from the specified Namespace names only. |