docs: overriding behavior for common labels #5699

rexagod · 2023-06-18T18:10:36Z

Description

Document common (reserved) labels in:

alertmanager
prometheus
thanos-ruler

Fixes #4549.

Type of change

CHANGE (fix or feature that would cause existing functionality to not work as expected)
FEATURE (non-breaking change which adds functionality)
BUGFIX (non-breaking change which fixes an issue)
ENHANCEMENT (non-breaking change which improves existing functionality)
NONE (if none of the other choices apply. Example, tooling, build system, CI, docs, etc.)

Changelog entry

Document overriding behavior for common (reserved) labels.

- Document overriding behavior in common (reserved) labels for `alertmanager`, `prometheus`, and `thanos-ruler.

simonpasquier

Thanks! I've got only some minor comments. I've focused on Alertmanager but if you agree with my suggestions, the same applies to Prometheus and ThanosRuler.

pkg/apis/monitoring/v1/alertmanager_types.go

simonpasquier

Just a few nits :)

simonpasquier · 2023-10-31T15:32:20Z

pkg/apis/monitoring/v1/thanos_types.go

@@ -68,7 +68,13 @@ type ThanosRulerList struct {
 type ThanosRulerSpec struct {
 	// Version of Thanos to be deployed.
 	Version string `json:"version,omitempty"`
-	// PodMetadata contains Labels and Annotations gets propagated to the thanos ruler pods.
+	// PodMetadata contains Labels and Annotations gets propagated to the ThanosRuler pods,


Suggested change

// PodMetadata contains Labels and Annotations gets propagated to the ThanosRuler pods,

// PodMetadata configures labels and annotations which are propagated to the ThanosRuler pods.

simonpasquier · 2023-10-31T15:32:41Z

pkg/apis/monitoring/v1/thanos_types.go

@@ -68,7 +68,13 @@ type ThanosRulerList struct {
 type ThanosRulerSpec struct {
 	// Version of Thanos to be deployed.
 	Version string `json:"version,omitempty"`
-	// PodMetadata contains Labels and Annotations gets propagated to the thanos ruler pods.
+	// PodMetadata contains Labels and Annotations gets propagated to the ThanosRuler pods,
+	// out of which, the following are reserved and cannot be overridden:


Suggested change

// out of which, the following are reserved and cannot be overridden:

//

// The following items are reserved and cannot be overridden:

simonpasquier · 2023-10-31T15:35:40Z

pkg/apis/monitoring/v1/prometheus_types.go

@@ -59,7 +59,16 @@ func (l *Prometheus) GetStatus() PrometheusStatus {
 // CommonPrometheusFields are the options available to both the Prometheus server and agent.
 // +k8s:deepcopy-gen=true
 type CommonPrometheusFields struct {
-	// PodMetadata configures labels and annotations which are propagated to the Prometheus pods.
+	// PodMetadata configures labels and annotations which are propagated to the Prometheus pods,


Suggested change

// PodMetadata configures labels and annotations which are propagated to the Prometheus pods,

// PodMetadata configures labels and annotations which are propagated to the Prometheus pods.

simonpasquier · 2023-10-31T15:35:59Z

pkg/apis/monitoring/v1/prometheus_types.go

@@ -59,7 +59,16 @@ func (l *Prometheus) GetStatus() PrometheusStatus {
 // CommonPrometheusFields are the options available to both the Prometheus server and agent.
 // +k8s:deepcopy-gen=true
 type CommonPrometheusFields struct {
-	// PodMetadata configures labels and annotations which are propagated to the Prometheus pods.
+	// PodMetadata configures labels and annotations which are propagated to the Prometheus pods,
+	// out of which, the following are reserved and cannot be overridden:


Suggested change

// out of which, the following are reserved and cannot be overridden:

//

// The following items are reserved and cannot be overridden:

simonpasquier · 2023-10-31T15:41:42Z

pkg/apis/monitoring/v1/alertmanager_types.go

@@ -60,7 +60,14 @@ func (l *Alertmanager) DeepCopyObject() runtime.Object {
 // https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
 // +k8s:openapi-gen=true
 type AlertmanagerSpec struct {
-	// PodMetadata configures Labels and Annotations which are propagated to the alertmanager pods.
+	// PodMetadata configures Labels and Annotations which are propagated to the Alertmanager pods,


Suggested change

// PodMetadata configures Labels and Annotations which are propagated to the Alertmanager pods,

// PodMetadata configures labels and annotations which are propagated to the Alertmanager pods.

simonpasquier · 2023-10-31T15:42:05Z

pkg/apis/monitoring/v1/alertmanager_types.go

@@ -60,7 +60,14 @@ func (l *Alertmanager) DeepCopyObject() runtime.Object {
 // https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
 // +k8s:openapi-gen=true
 type AlertmanagerSpec struct {
-	// PodMetadata configures Labels and Annotations which are propagated to the alertmanager pods.
+	// PodMetadata configures Labels and Annotations which are propagated to the Alertmanager pods,
+	// out of which, the following are reserved and cannot be overridden:


Suggested change

// out of which, the following are reserved and cannot be overridden:

//

// The following items are reserved and cannot be overridden:

Document overriding behavior for common labels in, * alertmanager, * prometheus, and, * thanos-ruler. Signed-off-by: Pranshu Srivastava <rexagod@gmail.com>

rexagod · 2023-11-01T21:44:55Z

I'm encountering errors on make --always-make format generate, I'll try getting the binary manually from source.

Downloading shellcheck
tar: shellcheck-stable/shellcheck: Not found in archive
tar: Error exit delayed from previous errors.
make: *** [/Users/rexagod/repositories/work/prometheus-operator/tmp/bin/controller-gen] Error 1

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

* docs: overriding behavior for common labels Document overriding behavior for common labels in, * alertmanager, * prometheus, and, * thanos-ruler. Signed-off-by: Pranshu Srivastava <rexagod@gmail.com> * Regenerate Documentation/api/md Signed-off-by: Simon Pasquier <spasquie@redhat.com> --------- Signed-off-by: Pranshu Srivastava <rexagod@gmail.com> Signed-off-by: Simon Pasquier <spasquie@redhat.com> Co-authored-by: Simon Pasquier <spasquie@redhat.com>

rexagod requested a review from a team as a code owner June 18, 2023 18:10

simonpasquier reviewed Jun 19, 2023

View reviewed changes

github-actions bot added the stale label Aug 19, 2023

rexagod force-pushed the 4549 branch from e465823 to 6e7c83d Compare October 12, 2023 00:01

pull-request-size bot added the size/M label Oct 12, 2023

rexagod force-pushed the 4549 branch from 6e7c83d to 5c2f0c8 Compare October 12, 2023 00:05

rexagod requested a review from simonpasquier October 12, 2023 00:06

github-actions bot removed the stale label Oct 12, 2023

rexagod force-pushed the 4549 branch from 5c2f0c8 to 046d611 Compare October 21, 2023 16:42

simonpasquier reviewed Oct 31, 2023

View reviewed changes

rexagod force-pushed the 4549 branch from 046d611 to 10fa069 Compare October 31, 2023 18:44

docs: overriding behavior for common labels

6f08877

Document overriding behavior for common labels in, * alertmanager, * prometheus, and, * thanos-ruler. Signed-off-by: Pranshu Srivastava <rexagod@gmail.com>

rexagod force-pushed the 4549 branch from 10fa069 to 6f08877 Compare November 1, 2023 15:05

Regenerate Documentation/api/md

d6c70f7

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

simonpasquier approved these changes Nov 3, 2023

View reviewed changes

simonpasquier enabled auto-merge (squash) November 3, 2023 10:20

simonpasquier merged commit 45185c8 into prometheus-operator:main Nov 3, 2023
17 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: overriding behavior for common labels #5699

docs: overriding behavior for common labels #5699

rexagod commented Jun 18, 2023 •

edited

simonpasquier left a comment

simonpasquier left a comment

simonpasquier Oct 31, 2023

simonpasquier Oct 31, 2023

simonpasquier Oct 31, 2023

simonpasquier Oct 31, 2023

simonpasquier Oct 31, 2023

simonpasquier Oct 31, 2023

rexagod commented Nov 1, 2023

	// PodMetadata contains Labels and Annotations gets propagated to the ThanosRuler pods,
	// PodMetadata configures labels and annotations which are propagated to the ThanosRuler pods.

	// out of which, the following are reserved and cannot be overridden:
	//
	// The following items are reserved and cannot be overridden:

docs: overriding behavior for common labels #5699

docs: overriding behavior for common labels #5699

Conversation

rexagod commented Jun 18, 2023 • edited

Description

Type of change

Changelog entry

simonpasquier left a comment

Choose a reason for hiding this comment

simonpasquier left a comment

Choose a reason for hiding this comment

simonpasquier Oct 31, 2023

Choose a reason for hiding this comment

simonpasquier Oct 31, 2023

Choose a reason for hiding this comment

simonpasquier Oct 31, 2023

Choose a reason for hiding this comment

simonpasquier Oct 31, 2023

Choose a reason for hiding this comment

simonpasquier Oct 31, 2023

Choose a reason for hiding this comment

simonpasquier Oct 31, 2023

Choose a reason for hiding this comment

rexagod commented Nov 1, 2023

rexagod commented Jun 18, 2023 •

edited