You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/docs/cloudnative-pg.v1.md
+67Lines changed: 67 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -429,6 +429,24 @@ _Appears in:_
429
429
|`secret`_[LocalObjectReference](https://pkg.go.dev/github.com/cloudnative-pg/machinery/pkg/api#LocalObjectReference)_| Name of the secret containing the initial credentials for the<br />owner of the user database. If empty a new secret will be<br />created from scratch ||||
430
430
431
431
432
+
#### CatalogComponentImage
433
+
434
+
435
+
436
+
CatalogComponentImage is a named image entry for a non-PostgreSQL component.
|`key`_string_| Key is the unique identifier for this image within the catalog. | True || MaxLength: 63 <br />Pattern: `^[a-z0-9]([-a-z0-9]*[a-z0-9])?$` <br /> |
447
+
|`image`_string_| Image is the container image reference. | True |||
448
+
449
+
432
450
#### CatalogImage
433
451
434
452
@@ -1150,6 +1168,27 @@ ImageCatalog is the Schema for the imagecatalogs API
1150
1168
|`spec`_[ImageCatalogSpec](#imagecatalogspec)_| Specification of the desired behavior of the ImageCatalog.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status| True |||
1151
1169
1152
1170
1171
+
#### ImageCatalogComponentRef
1172
+
1173
+
1174
+
1175
+
ImageCatalogComponentRef identifies a named image within the componentImages list of an
|`apiGroup`_string_| APIGroup is the group for the resource being referenced.<br />If APIGroup is not specified, the specified Kind must be in the core API group.<br />For any other third-party types, APIGroup is required. ||||
1187
+
|`kind`_string_| Kind is the type of resource being referenced | True |||
1188
+
|`name`_string_| Name is the name of resource being referenced | True |||
1189
+
|`key`_string_| Key identifies the entry within the catalog's componentImages list. | True || MaxLength: 63 <br />Pattern: `^[a-z0-9]([-a-z0-9]*[a-z0-9])?$` <br /> |
|`images`_[CatalogImage](#catalogimage) array_| List of CatalogImages available in the catalog | True || MaxItems: 8 <br />MinItems: 1 <br /> |
1228
+
|`componentImages`_[CatalogComponentImage](#catalogcomponentimage) array_| ComponentImages is a list of named images for components other than PostgreSQL<br />(e.g. pgbouncer). Keys must be unique within a catalog. ||| MaxItems: 32 <br /> |
1189
1229
1190
1230
1191
1231
#### ImageInfo
@@ -1697,6 +1737,8 @@ _Appears in:_
1697
1737
|`parameters`_object (keys:string, values:string)_| Additional parameters to be passed to PgBouncer - please check<br />the CNPG documentation for a list of options you can configure ||||
1698
1738
|`pg_hba`_string array_| PostgreSQL Host Based Authentication rules (lines to be appended<br />to the pg_hba.conf file) ||||
1699
1739
|`paused`_boolean_| When set to `true`, PgBouncer will disconnect from the PostgreSQL<br />server, first waiting for all queries to complete, and pause all new<br />client connections until this value is set to `false` (default). Internally,<br />the operator calls PgBouncer's `PAUSE` and `RESUME` commands. || false ||
1740
+
|`image`_string_| Image is the pgbouncer container image to use. When set, it takes<br />precedence over ImageCatalogRef and the operator default, but is<br />overridden by an explicit image set in the pod template. ||||
1741
+
|`imageCatalogRef`_[ImageCatalogComponentRef](#imagecatalogcomponentref)_| ImageCatalogRef points to an entry in an ImageCatalog or ClusterImageCatalog.<br />Mutually exclusive with Image. ||||
1700
1742
1701
1743
1702
1744
#### PluginConfiguration
@@ -1933,6 +1975,28 @@ _Appears in:_
1933
1975
|`enabled`_boolean_| Enable TLS for the monitoring endpoint.<br />Changing this option will force a rollout of all instances. || false ||
1934
1976
1935
1977
1978
+
#### PoolerPhase
1979
+
1980
+
_Underlying type:__string_
1981
+
1982
+
PoolerPhase represents the lifecycle phase of a Pooler.
1983
+
1984
+
_Validation:_
1985
+
1986
+
- Enum: [active paused inactive failed]
1987
+
1988
+
_Appears in:_
1989
+
1990
+
-[PoolerStatus](#poolerstatus)
1991
+
1992
+
| Field | Description |
1993
+
| --- | --- |
1994
+
|`active`| PoolerPhaseActive means the pooler is running normally and serving traffic.<br /> |
1995
+
|`paused`| PoolerPhasePaused means PgBouncer is up and running but holding new client<br />connections in the queue because spec.pgbouncer.paused is true. The Deployment<br />keeps reconciling; lifting the pause transitions back to Active.<br /> |
1996
+
|`inactive`| PoolerPhaseInactive means the pooler cannot make progress because a<br />prerequisite resource is missing (cluster, secret, certificate). The<br />controller retries periodically until the prerequisite shows up. Check<br />status.phaseReason for the specific cause.<br /> |
1997
+
|`failed`| PoolerPhaseFailed means the pooler cannot be reconciled due to a<br />configuration error. Check status.phaseReason for details.<br /> |
1998
+
1999
+
1936
2000
#### PoolerSecrets
1937
2001
1938
2002
@@ -1995,6 +2059,9 @@ _Appears in:_
1995
2059
| --- | --- | --- | --- | --- |
1996
2060
|`secrets`_[PoolerSecrets](#poolersecrets)_| The resource version of the config object ||||
1997
2061
|`instances`_integer_| The number of pods trying to be scheduled ||||
2062
+
|`phase`_[PoolerPhase](#poolerphase)_| Phase summarizes the overall lifecycle state of the Pooler. ||| Enum: [active paused inactive failed] <br /> |
2063
+
|`phaseReason`_string_| PhaseReason is a human-readable explanation of the current Phase. ||||
2064
+
|`image`_string_| Image is the resolved pgbouncer container image that the operator is<br />using for this Pooler, including any override coming from spec.template.<br />While Phase is Active or Paused this field reflects what the Deployment<br />actually runs; while Phase is Inactive or Failed it may carry the last<br />successfully resolved value (or be empty if the Pooler has never reconciled<br />successfully). ||||
0 commit comments