Skip to content

Commit

Permalink
Documentation: Remove experimental tag from sharding option in Promet…
Browse files Browse the repository at this point in the history
…heus CRD (prometheus-operator#6409)

This commit changes the docs so that future prometheus operator users know the option is out of experimental. The sharding option is used for many years by multiple contributers.

Co-authored-by: Gijs Entius <in648ent@Gijss-MacBook-Pro.local>
  • Loading branch information
gijsentius and Gijs Entius committed Mar 21, 2024
1 parent 56ffd97 commit 06d6a03
Show file tree
Hide file tree
Showing 9 changed files with 50 additions and 50 deletions.
10 changes: 5 additions & 5 deletions Documentation/api.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 14 additions & 14 deletions bundle.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion jsonnet/prometheus-operator/prometheusagents-crd.json
Original file line number Diff line number Diff line change
Expand Up @@ -5330,7 +5330,7 @@
"x-kubernetes-map-type": "atomic"
},
"shards": {
"description": "EXPERIMENTAL: Number of shards to distribute targets onto. `spec.replicas` multiplied by `spec.shards` is the total number of Pods created. \n Note that scaling down shards will not reshard data onto remaining instances, it must be manually moved. Increasing shards will not reshard data either but it will continue to be available from the same instances. To query globally, use Thanos sidecar and Thanos querier or remote write data to a central location. \n Sharding is performed on the content of the `__address__` target meta-label for PodMonitors and ServiceMonitors and `__param_target__` for Probes. \n Default: 1",
"description": "Number of shards to distribute targets onto. `spec.replicas` multiplied by `spec.shards` is the total number of Pods created. \n Note that scaling down shards will not reshard data onto remaining instances, it must be manually moved. Increasing shards will not reshard data either but it will continue to be available from the same instances. To query globally, use Thanos sidecar and Thanos querier or remote write data to a central location. \n Sharding is performed on the content of the `__address__` target meta-label for PodMonitors and ServiceMonitors and `__param_target__` for Probes. \n Default: 1",
"format": "int32",
"type": "integer"
},
Expand Down
2 changes: 1 addition & 1 deletion jsonnet/prometheus-operator/prometheuses-crd.json
Original file line number Diff line number Diff line change
Expand Up @@ -6344,7 +6344,7 @@
"type": "string"
},
"shards": {
"description": "EXPERIMENTAL: Number of shards to distribute targets onto. `spec.replicas` multiplied by `spec.shards` is the total number of Pods created. \n Note that scaling down shards will not reshard data onto remaining instances, it must be manually moved. Increasing shards will not reshard data either but it will continue to be available from the same instances. To query globally, use Thanos sidecar and Thanos querier or remote write data to a central location. \n Sharding is performed on the content of the `__address__` target meta-label for PodMonitors and ServiceMonitors and `__param_target__` for Probes. \n Default: 1",
"description": "Number of shards to distribute targets onto. `spec.replicas` multiplied by `spec.shards` is the total number of Pods created. \n Note that scaling down shards will not reshard data onto remaining instances, it must be manually moved. Increasing shards will not reshard data either but it will continue to be available from the same instances. To query globally, use Thanos sidecar and Thanos querier or remote write data to a central location. \n Sharding is performed on the content of the `__address__` target meta-label for PodMonitors and ServiceMonitors and `__param_target__` for Probes. \n Default: 1",
"format": "int32",
"type": "integer"
},
Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/monitoring/v1/prometheus_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ type CommonPrometheusFields struct {
// Default: 1
// +optional
Replicas *int32 `json:"replicas,omitempty"`
// EXPERIMENTAL: Number of shards to distribute targets onto. `spec.replicas`
// Number of shards to distribute targets onto. `spec.replicas`
// multiplied by `spec.shards` is the total number of Pods created.
//
// Note that scaling down shards will not reshard data onto remaining
Expand Down

0 comments on commit 06d6a03

Please sign in to comment.