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
+119-2Lines changed: 119 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,8 @@ Package v1 contains API Schema definitions for the postgresql v1 API group
19
19
-[Cluster](#cluster)
20
20
-[ClusterImageCatalog](#clusterimagecatalog)
21
21
-[Database](#database)
22
+
-[DatabaseRole](#databaserole)
23
+
-[DatabaseRoleList](#databaserolelist)
22
24
-[FailoverQuorum](#failoverquorum)
23
25
-[ImageCatalog](#imagecatalog)
24
26
-[Pooler](#pooler)
@@ -848,6 +850,65 @@ _Appears in:_
848
850
|`retain`| DatabaseReclaimRetain means the database will be left in its current phase for manual<br />reclamation by the administrator. The default policy is Retain.<br /> |
849
851
850
852
853
+
#### DatabaseRole
854
+
855
+
856
+
857
+
DatabaseRole is the Schema for the databaseroles API
|`metadata`_[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#objectmeta-v1-meta)_| Refer to Kubernetes API documentation for fields of `metadata`. | True |||
870
+
|`spec`_[DatabaseRoleSpec](#databaserolespec)_| Specification of the desired DatabaseRole.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status| True |||
871
+
|`status`_[DatabaseRoleStatus](#databaserolestatus)_| Most recently observed status of the DatabaseRole. This data may not be up<br />to date. Populated by the system. Read-only.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status||||
|`metadata`_[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#listmeta-v1-meta)_| Refer to Kubernetes API documentation for fields of `metadata`. | True |||
DatabaseRoleReclaimPolicy describes a policy for end-of-life maintenance of Roles.
899
+
900
+
901
+
902
+
_Appears in:_
903
+
904
+
-[DatabaseRoleSpec](#databaserolespec)
905
+
906
+
| Field | Description |
907
+
| --- | --- |
908
+
|`delete`| DatabaseRoleReclaimDelete means the Role will be deleted from Kubernetes on release<br />from its claim.<br /> |
909
+
|`retain`| DatabaseRoleReclaimRetain means the Role will be left in its current phase for manual<br />reclamation by the administrator. The default policy is Retain.<br /> |
|`ensure`_[EnsureOption](#ensureoption)_| Ensure the role is `present` or `absent` - defaults to "present" || present | Enum: [present absent] <br /> |
946
+
|`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. ||||
947
+
|`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 ||
948
+
|`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). ||||
949
+
|`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.<br />Changes to the list are applied to an existing role through<br />`GRANT` and `REVOKE` statements, not only at role creation. ||||
950
+
|`inherit`_boolean_| Whether a role "inherits" the privileges of roles it is a member of.<br />Default is `true`. || true ||
951
+
|`disablePassword`_boolean_| DisablePassword indicates that a role's password should be set to NULL in Postgres ||||
952
+
|`superuser`_boolean_| Whether the role is a `superuser` who can override all access<br />restrictions within the database - superuser status is dangerous and<br />should be used only when really needed. You must yourself be a<br />superuser to create a new superuser. Defaults is `false`. ||||
953
+
|`createdb`_boolean_| When set to `true`, the role being defined will be allowed to create<br />new databases. Specifying `false` (default) will deny a role the<br />ability to create databases. ||||
954
+
|`createrole`_boolean_| Whether the role will be permitted to create, alter, drop, comment<br />on, change the security label for, and grant or revoke membership in<br />other roles. Default is `false`. ||||
955
+
|`login`_boolean_| Whether the role is allowed to log in. A role having the `login`<br />attribute can be thought of as a user. Roles without this attribute<br />are useful for managing database privileges, but are not users in<br />the usual sense of the word. Default is `false`. ||||
956
+
|`replication`_boolean_| Whether a role is a replication role. A role must have this<br />attribute (or be a superuser) in order to be able to connect to the<br />server in replication mode (physical or logical replication) and in<br />order to be able to create or drop replication slots. A role having<br />the `replication` attribute is a very highly privileged role, and<br />should only be used on roles actually used for replication. Default<br />is `false`. ||||
957
+
|`bypassrls`_boolean_| Whether a role bypasses every row-level security (RLS) policy.<br />Default is `false`. ||||
958
+
|`cluster`_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core)_| The corresponding cluster | True |||
959
+
|`databaseRoleReclaimPolicy`_[DatabaseRoleReclaimPolicy](#databaserolereclaimpolicy)_| The policy for end-of-life maintenance of this role || retain | Enum: [delete retain] <br /> |
960
+
961
+
962
+
#### DatabaseRoleStatus
963
+
964
+
965
+
966
+
DatabaseRoleStatus defines the observed state of a DatabaseRole
|`observedGeneration`_integer_| A sequence number representing the latest<br />desired state that was synchronized ||||
977
+
|`applied`_boolean_| Applied is true if the role was reconciled correctly ||||
978
+
|`message`_string_| Message is the reconciliation error message ||||
979
+
|`secretResourceVersion`_string_| SecretResourceVersion is the resource version of the password secret<br />last applied to the role; a change to it triggers reconciliation. ||||
980
+
|`conditions`_[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#condition-v1-meta) array_| Conditions for the DatabaseRole object ||||
981
+
982
+
868
983
#### DatabaseSpec
869
984
870
985
@@ -959,6 +1074,7 @@ a Role in a PostgreSQL instance
|`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. ||||
2489
2606
|`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 ||
2490
2607
|`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). ||||
2491
-
|`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. ||||
2492
-
|`inherit`_boolean_| Whether a role "inherits" the privileges of roles it is a member of.<br />Defaults is `true`. || true ||
2608
+
|`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.<br />Changes to the list are applied to an existing role through<br />`GRANT` and `REVOKE` statements, not only at role creation.||||
2609
+
|`inherit`_boolean_| Whether a role "inherits" the privileges of roles it is a member of.<br />Default is `true`. || true ||
2493
2610
|`disablePassword`_boolean_| DisablePassword indicates that a role's password should be set to NULL in Postgres ||||
2494
2611
|`superuser`_boolean_| Whether the role is a `superuser` who can override all access<br />restrictions within the database - superuser status is dangerous and<br />should be used only when really needed. You must yourself be a<br />superuser to create a new superuser. Defaults is `false`. ||||
2495
2612
|`createdb`_boolean_| When set to `true`, the role being defined will be allowed to create<br />new databases. Specifying `false` (default) will deny a role the<br />ability to create databases. ||||
0 commit comments