Skip to content

Use mutable instead of immutable in the docs #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ThoSap merged 12 commits into from
Feb 26, 2026
Merged

Use mutable instead of immutable in the docs #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
31860e8
update to Quarkus 3.32.1 and update dependencies to latest versions
ThoSap Feb 25, 2026
841b02d
validate K8s resource references against the RFC 1123 hostname format…
ThoSap Feb 26, 2026
ba04f01
refactor SecretRef and ClusterReference to one common ResourceRef type
ThoSap Feb 26, 2026
638359c
fix the test by having a own SchemaCustomizer for Kubernetes names
ThoSap Feb 26, 2026
acddd5a
do not short-circuit the PostgreSQLInstanceReadinessCheck check once …
ThoSap Feb 26, 2026
a0f9e2b
let the PostgreSQLContextFactory exception bubble up
ThoSap Feb 26, 2026
b4444ea
Merge branch 'validate-k8s-resource-references-against-rfc1123' into …
ThoSap Feb 26, 2026
c95e06f
reformat code
ThoSap Feb 26, 2026
4f0adcc
fix compile issue
ThoSap Feb 26, 2026
f41c60c
the namespace should come always first
ThoSap Feb 26, 2026
dff124d
use mutable instead of immutable in the docs
ThoSap Feb 26, 2026
15c9aca
Merge branch 'main' into use-mutable-instead-of-immutable-in-the-docs
ThoSap Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/cluster-connection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Other Custom Resources (like `Database`, `Role`, `Schema`, `Grant`, `DefaultPriv

## Spec

| Field | Type | Description | Required |
|------------------|---------------------|-----------------------------------------------------------------------|----------|
| `host` | `string` | The hostname of the PostgreSQL instance. | Yes |
| `port` | `integer` | The port of the PostgreSQL instance (1-65535). | Yes |
| `database` | `string` | The database to connect to (usually `postgres` for admin operations). | Yes |
| `adminSecretRef` | `ResourceRef` | Reference to the Kubernetes Secret containing the admin credentials. | Yes |
| `parameters` | `map[string]string` | Additional connection parameters. | No |
| Field | Type | Description | Required | Mutable |
|------------------|---------------------|-----------------------------------------------------------------------|----------|---------|
| `host` | `string` | The hostname of the PostgreSQL instance. | Yes | Yes |
| `port` | `integer` | The port of the PostgreSQL instance (1-65535). | Yes | Yes |
| `database` | `string` | The database to connect to (usually `postgres` for admin operations). | Yes | Yes |
| `adminSecretRef` | `ResourceRef` | Reference to the Kubernetes Secret containing the admin credentials. | Yes | Yes |
| `parameters` | `map[string]string` | Additional connection parameters. | No | Yes |

### ResourceRef (`adminSecretRef`)

Expand Down
12 changes: 6 additions & 6 deletions docs/database.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ The `Database` Custom Resource Definition (CRD) is responsible for managing Post

## Spec

| Field | Type | Description | Required | Immutable |
|-----------------|---------------|------------------------------------------------------------------------------------------------------|----------|-----------|
| `clusterRef` | `ResourceRef` | Reference to the `ClusterConnection` to use. | Yes | No |
| `name` | `string` | The name of the database to create. | Yes | Yes |
| `owner` | `string` | The owner of the database. | No | No |
| `reclaimPolicy` | `string` | The policy for reclaiming the database when the CR is deleted. Values: `Retain` (Default), `Delete`. | No | No |
| Field | Type | Description | Required | Mutable |
|-----------------|---------------|------------------------------------------------------------------------------------------------------|----------|---------|
| `clusterRef` | `ResourceRef` | Reference to the `ClusterConnection` to use. | Yes | Yes |
| `name` | `string` | The name of the database to create. | Yes | No |
| `owner` | `string` | The owner of the database. | No | Yes |
| `reclaimPolicy` | `string` | The policy for reclaiming the database when the CR is deleted. Values: `Retain` (Default), `Delete`. | No | Yes |

### ResourceRef (`clusterRef`)

Expand Down
18 changes: 9 additions & 9 deletions docs/default-privilege.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ The `DefaultPrivilege` Custom Resource Definition (CRD) manages default privileg

## Spec

| Field | Type | Description | Required | Immutable |
|--------------|-----------------|---------------------------------------------------------------------------------------------------------|-------------|-----------|
| `clusterRef` | `ResourceRef` | Reference to the `ClusterConnection` to use. | Yes | No |
| `database` | `string` | The database where default privileges apply. | Yes | Yes |
| `role` | `string` | The role to which default privileges are granted. | Yes | Yes |
| `owner` | `string` | The role that owns the objects (the creator). Default privileges apply to objects created by this role. | Yes | Yes |
| `schema` | `string` | The schema where default privileges apply. Required, unless `objectType` is `schema`. | Conditional | Yes |
| `objectType` | `string` | The type of object. | Yes | Yes |
| `privileges` | `array[string]` | List of privileges to grant. | Yes | No |
| Field | Type | Description | Required | Mutable |
|--------------|-----------------|---------------------------------------------------------------------------------------------------------|-------------|---------|
| `clusterRef` | `ResourceRef` | Reference to the `ClusterConnection` to use. | Yes | Yes |
| `database` | `string` | The database where default privileges apply. | Yes | No |
| `role` | `string` | The role to which default privileges are granted. | Yes | No |
| `owner` | `string` | The role that owns the objects (the creator). Default privileges apply to objects created by this role. | Yes | No |
| `schema` | `string` | The schema where default privileges apply. Required, unless `objectType` is `schema`. | Conditional | No |
| `objectType` | `string` | The type of object. | Yes | No |
| `privileges` | `array[string]` | List of privileges to grant. | Yes | Yes |

### Object Types

Expand Down
18 changes: 9 additions & 9 deletions docs/grant.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ The `Grant` Custom Resource Definition (CRD) is responsible for managing privile

## Spec

| Field | Type | Description | Required | Immutable |
|--------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------|-------------|-----------|
| `clusterRef` | `ResourceRef` | Reference to the `ClusterConnection` to use. | Yes | No |
| `database` | `string` | The database containing the objects. | Yes | Yes |
| `role` | `string` | The role to which privileges are granted. | Yes | Yes |
| `schema` | `string` | The schema containing the objects. Required, unless `objectType` is `database`. | Conditional | Yes |
| `objectType` | `string` | The type of object. | Yes | Yes |
| `objects` | `array[string]` | List of object names. If empty, all objects of this `objectType` will be granted. Required, unless `objectType` is `database` or `schema`. | Conditional | No |
| `privileges` | `array[string]` | List of privileges to grant. | Yes | No |
| Field | Type | Description | Required | Mutable |
|--------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------|
| `clusterRef` | `ResourceRef` | Reference to the `ClusterConnection` to use. | Yes | Yes |
| `database` | `string` | The database containing the objects. | Yes | No |
| `role` | `string` | The role to which privileges are granted. | Yes | No |
| `schema` | `string` | The schema containing the objects. Required, unless `objectType` is `database`. | Conditional | No |
| `objectType` | `string` | The type of object. | Yes | No |
| `objects` | `array[string]` | List of object names. If empty, all objects of this `objectType` will be granted. Required, unless `objectType` is `database` or `schema`. | Conditional | Yes |
| `privileges` | `array[string]` | List of privileges to grant. | Yes | Yes |

### Object Types

Expand Down
14 changes: 7 additions & 7 deletions docs/role.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ The `Role` Custom Resource Definition (CRD) manages PostgreSQL roles (users).

## Spec

| Field | Type | Description | Required | Immutable |
|---------------------|---------------|-------------------------------------------------------------------------------------|----------|-----------|
| `clusterRef` | `ResourceRef` | Reference to the `ClusterConnection` to use. | Yes | No |
| `name` | `string` | The name of the role to create in the database. | Yes | Yes |
| `comment` | `string` | A comment to add to the role. | No | No |
| `passwordSecretRef` | `ResourceRef` | Reference to a secret containing the password for the role to make it a LOGIN role. | No | No |
| `flags` | `RoleFlags` | Flags and attributes for the role. | No | No |
| Field | Type | Description | Required | Mutable |
|---------------------|---------------|-------------------------------------------------------------------------------------|----------|---------|
| `clusterRef` | `ResourceRef` | Reference to the `ClusterConnection` to use. | Yes | Yes |
| `name` | `string` | The name of the role to create in the database. | Yes | No |
| `comment` | `string` | A comment to add to the role. | No | Yes |
| `passwordSecretRef` | `ResourceRef` | Reference to a secret containing the password for the role to make it a LOGIN role. | No | Yes |
| `flags` | `RoleFlags` | Flags and attributes for the role. | No | Yes |

### ResourceRef (`clusterRef` and `passwordSecretRef`)

Expand Down
14 changes: 7 additions & 7 deletions docs/schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ The `Schema` Custom Resource Definition (CRD) is responsible for managing Postgr

## Spec

| Field | Type | Description | Required | Immutable |
|-----------------|---------------|----------------------------------------------------------------------------------------------------|----------|-----------|
| `clusterRef` | `ResourceRef` | Reference to the `ClusterConnection` to use. | Yes | No |
| `database` | `string` | The name of the database in which the schema is created. | Yes | Yes |
| `name` | `string` | The name of the schema to create. | Yes | Yes |
| `owner` | `string` | The owner of the schema. | No | No |
| `reclaimPolicy` | `string` | The policy for reclaiming the schema when the CR is deleted. Values: `Retain` (Default), `Delete`. | No | No |
| Field | Type | Description | Required | Mutable |
|-----------------|---------------|----------------------------------------------------------------------------------------------------|----------|---------|
| `clusterRef` | `ResourceRef` | Reference to the `ClusterConnection` to use. | Yes | Yes |
| `database` | `string` | The name of the database in which the schema is created. | Yes | No |
| `name` | `string` | The name of the schema to create. | Yes | No |
| `owner` | `string` | The owner of the schema. | No | Yes |
| `reclaimPolicy` | `string` | The policy for reclaiming the schema when the CR is deleted. Values: `Retain` (Default), `Delete`. | No | Yes |

### ResourceRef (`clusterRef`)

Expand Down