Skip to content

Commit a33ba71

Browse files
committed
docs: import CloudNativePG main
1 parent dac9dc1 commit a33ba71

2 files changed

Lines changed: 59 additions & 4 deletions

File tree

website/docs/cloudnative-pg.v1.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1909,9 +1909,28 @@ _Appears in:_
19091909

19101910
| Field | Description | Required | Default | Validation |
19111911
| --- | --- | --- | --- | --- |
1912-
| `enablePodMonitor` _boolean_ | Enable or disable the `PodMonitor` | | false | |
1913-
| `podMonitorMetricRelabelings` _[RelabelConfig](https://pkg.go.dev/github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1#RelabelConfig) array_ | The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion. | | | |
1914-
| `podMonitorRelabelings` _[RelabelConfig](https://pkg.go.dev/github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1#RelabelConfig) array_ | The list of relabelings for the `PodMonitor`. Applied to samples before scraping. | | | |
1912+
| `enablePodMonitor` _boolean_ | Enable or disable the `PodMonitor`<br />Deprecated: This feature will be removed in an upcoming release. If<br />you need this functionality, you can create a PodMonitor manually. | | false | |
1913+
| `podMonitorMetricRelabelings` _[RelabelConfig](https://pkg.go.dev/github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1#RelabelConfig) array_ | The list of metric relabelings for the `PodMonitor`. Applied to samples before ingestion.<br />Deprecated: This feature will be removed in an upcoming release. If<br />you need this functionality, you can create a PodMonitor manually. | | | |
1914+
| `podMonitorRelabelings` _[RelabelConfig](https://pkg.go.dev/github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1#RelabelConfig) array_ | The list of relabelings for the `PodMonitor`. Applied to samples before scraping.<br />Deprecated: This feature will be removed in an upcoming release. If<br />you need this functionality, you can create a PodMonitor manually. | | | |
1915+
| `tls` _[PoolerMonitoringTLSConfiguration](#poolermonitoringtlsconfiguration)_ | Configure TLS communication for the metrics endpoint.<br />Changing tls.enabled option will force a rollout of all instances. | | | |
1916+
1917+
1918+
#### PoolerMonitoringTLSConfiguration
1919+
1920+
1921+
1922+
PoolerMonitoringTLSConfiguration is the type containing the TLS configuration
1923+
for the pooler monitoring
1924+
1925+
1926+
1927+
_Appears in:_
1928+
1929+
- [PoolerMonitoringConfiguration](#poolermonitoringconfiguration)
1930+
1931+
| Field | Description | Required | Default | Validation |
1932+
| --- | --- | --- | --- | --- |
1933+
| `enabled` _boolean_ | Enable TLS for the monitoring endpoint.<br />Changing this option will force a rollout of all instances. | | false | |
19151934

19161935

19171936
#### PoolerSecrets
@@ -1955,7 +1974,7 @@ _Appears in:_
19551974
| `template` _[PodTemplateSpec](#podtemplatespec)_ | The template of the Pod to be created | | | |
19561975
| `pgbouncer` _[PgBouncerSpec](#pgbouncerspec)_ | The PgBouncer configuration | True | | |
19571976
| `deploymentStrategy` _[DeploymentStrategy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#deploymentstrategy-v1-apps)_ | The deployment strategy to use for pgbouncer to replace existing pods with new ones | | | |
1958-
| `monitoring` _[PoolerMonitoringConfiguration](#poolermonitoringconfiguration)_ | The configuration of the monitoring infrastructure of this pooler.<br />Deprecated: This feature will be removed in an upcoming release. If<br />you need this functionality, you can create a PodMonitor manually. | | | |
1977+
| `monitoring` _[PoolerMonitoringConfiguration](#poolermonitoringconfiguration)_ | The configuration of the monitoring infrastructure of this pooler. | | | |
19591978
| `serviceTemplate` _[ServiceTemplateSpec](#servicetemplatespec)_ | Template for the Service to be created | | | |
19601979
| `serviceAccountName` _string_ | Name of an existing ServiceAccount in the same namespace to use for the pooler.<br />When specified, the operator will not create a new ServiceAccount<br />but will use the provided one. This is useful for sharing a single<br />ServiceAccount across multiple poolers (e.g., for cloud IAM configurations).<br />If not specified, a ServiceAccount will be created with the pooler name. | | | MaxLength: 253 <br />Pattern: `^[a-z0-9]([-a-z0-9]*[a-z0-9])?$` <br /> |
19611980

website/docs/connection_pooling.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -668,6 +668,42 @@ spec:
668668
- port: metrics
669669
```
670670

671+
### TLS for the Metrics Endpoint
672+
673+
Set `.spec.monitoring.tls.enabled: true` to serve the metrics endpoint over
674+
HTTPS. By default, the cluster's server certificate is being used.
675+
The certificate is reloaded on every TLS handshake, so rotations are
676+
picked up without restarting the pod.
677+
678+
```yaml
679+
spec:
680+
monitoring:
681+
tls:
682+
enabled: true
683+
```
684+
685+
When `.spec.pgbouncer.clientTLSSecret` is set, the metrics server presents
686+
that certificate instead.
687+
688+
```yaml
689+
spec:
690+
pgbouncer:
691+
clientTLSSecret:
692+
name: <CLIENT_TLS_SECRET>
693+
monitoring:
694+
tls:
695+
enabled: true
696+
```
697+
698+
The generated `PodMonitor` scrapes with `insecureSkipVerify=true` because
699+
Prometheus scrapes pods by IP and the certificate's SANs do not generally
700+
cover the pod IP.
701+
702+
If you need strict verification, set `.spec.monitoring.enablePodMonitor: false`
703+
and manage the `PodMonitor` yourself: the operator-generated one is hardcoded
704+
to `insecureSkipVerify=true` and overwrites its spec on every reconcile, so a
705+
manual patch on the generated `PodMonitor` would not survive.
706+
671707
### Deprecation of Automatic `PodMonitor` Creation
672708

673709
:::warning[Feature Deprecation Notice]

0 commit comments

Comments
 (0)