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/versioned_docs/version-1.29/cloudnative-pg.v1.md
+24-3Lines changed: 24 additions & 3 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
@@ -638,6 +656,7 @@ _Appears in:_
638
656
| --- | --- | --- | --- | --- |
639
657
|`instances`_integer_| The total number of PVC Groups detected in the cluster. It may differ from the number of existing instance pods. ||||
640
658
|`readyInstances`_integer_| The total number of ready instances in the cluster. It is equal to the number of ready instance pods. ||||
659
+
|`selector`_string_| Selector is the serialized form of the label selector that identifies<br />the pods managed by this cluster. Populated by the operator and exposed<br />through the scale sub-resource so an autoscaler (such as HPA or VPA)<br />can discover the managed instance pods. ||||
641
660
|`instancesStatus`_object (keys:[PodStatus](#podstatus), values:string array)_| InstancesStatus indicates in which status the instances are ||||
642
661
|`instancesReportedState`_object (keys:[PodName](#podname), values:[InstanceReportedState](#instancereportedstate))_| The reported state of the instances during the last reconciliation loop ||||
643
662
|`managedRolesStatus`_[ManagedRoles](#managedroles)_| ManagedRolesStatus reports the state of the managed roles in the cluster ||||
@@ -680,6 +699,7 @@ _Appears in:_
680
699
|`onlineUpdateEnabled`_boolean_| OnlineUpdateEnabled shows if the online upgrade is enabled inside the cluster ||||
681
700
|`image`_string_| Image contains the image name used by the pods ||||
682
701
|`pgDataImageInfo`_[ImageInfo](#imageinfo)_| PGDataImageInfo contains the details of the latest image that has run on the current data directory. ||||
702
+
|`targetPgDataImageInfo`_[ImageInfo](#imageinfo)_| TargetPGDataImageInfo contains the details of the target image for an<br />in-progress major upgrade. It is set before the upgrade Job is created,<br />and cleared on successful completion or when the upgrade is rolled back. ||||
683
703
|`pluginStatus`_[PluginStatus](#pluginstatus) array_| PluginStatus is the status of the loaded plugins ||||
684
704
|`switchReplicaClusterStatus`_[SwitchReplicaClusterStatus](#switchreplicaclusterstatus)_| SwitchReplicaClusterStatus is the status of the switch to replica cluster ||||
685
705
|`demotionToken`_string_| DemotionToken is a JSON token containing the information<br />from pg_controldata such as Database system identifier, Latest checkpoint's<br />TimeLineID, Latest checkpoint's REDO location, Latest checkpoint's REDO<br />WAL file, and Time of latest checkpoint ||||
|`name`_string_| The name of the extension, required| True || MinLength: 1 <br />Pattern: `^[a-z0-9]([-a-z0-9_]*[a-z0-9])?$` <br /> |
1013
+
|`name`_string_| The name of the extension, required. The limit of 59 characters<br />leaves room for the prefix the operator adds when deriving the<br />extension's Kubernetes Volume name (capped at 63 characters). | True ||MaxLength: 59 <br />MinLength: 1 <br />Pattern: `^[a-z0-9]([-a-z0-9_]*[a-z0-9])?$` <br /> |
994
1014
|`image`_[ImageVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#imagevolumesource-v1-core)_| The image containing the extension. ||||
995
1015
|`extension_control_path`_string array_| The list of directories inside the image which should be added to extension_control_path.<br />If not defined, defaults to "/share". ||||
996
1016
|`dynamic_library_path`_string array_| The list of directories inside the image which should be added to dynamic_library_path.<br />If not defined, defaults to "/lib". ||||
|`images`_[CatalogImage](#catalogimage) array_| List of CatalogImages available in the catalog | True || MaxItems: 8 <br />MinItems: 1 <br /> |
1209
+
|`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 /> |
|`byStatus`_object (keys:[RoleStatus](#rolestatus), values:string array)_| ByStatus gives the list of roles in each state ||||
1454
-
|`cannotReconcile`_object (keys:string, values:string array)_| CannotReconcile lists roles that cannot be reconciledin PostgreSQL,<br />with an explanation of the cause||||
1475
+
|`cannotReconcile`_object (keys:string, values:string array)_| CannotReconcile lists roles that cannot be reconciled, with an<br />explanation of the cause. Failures may originate in PostgreSQL<br />(e.g. dropping a role that owns objects) or in Kubernetes (e.g.<br />the referenced password Secret cannot be fetched).||||
1455
1476
|`passwordStatus`_object (keys:string, values:[PasswordState](#passwordstate))_| PasswordStatus gives the last transaction id and password secret version for each managed role ||||
1456
1477
1457
1478
@@ -2398,7 +2419,7 @@ _Appears in:_
2398
2419
|`name`_string_| Name of the role | True |||
2399
2420
|`comment`_string_| Description of the role ||||
2400
2421
|`ensure`_[EnsureOption](#ensureoption)_| Ensure the role is `present` or `absent` - defaults to "present" || present | Enum: [present absent] <br /> |
2401
-
|`passwordSecret`_[LocalObjectReference](https://pkg.go.dev/github.com/cloudnative-pg/machinery/pkg/api#LocalObjectReference)_| Secret containing the password of the role (if present)<br />If null, the password will be ignored unless DisablePassword is set ||||
2422
+
|`passwordSecret`_[LocalObjectReference](https://pkg.go.dev/github.com/cloudnative-pg/machinery/pkg/api#LocalObjectReference)_| Secret containing the password of the role (if present).<br />If null, the password will be ignored unless DisablePassword is set.<br />When set, the secret must follow the `kubernetes.io/basic-auth` format<br />and contain both a `username` and a `password` field.||||
2402
2423
|`connectionLimit`_integer_| If the role can log in, this specifies how many concurrent<br />connections the role can make. `-1` (the default) means no limit. || -1 ||
2403
2424
|`validUntil`_[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#time-v1-meta)_| Date and time after which the role's password is no longer valid.<br />When omitted, the password will never expire (default). ||||
2404
2425
|`inRoles`_string array_| List of one or more existing roles to which this role will be<br />immediately added as a new member. Default empty. ||||
0 commit comments