diff --git a/docs/cluster-connection.md b/docs/cluster-connection.md index 0b88e39..139fcfb 100644 --- a/docs/cluster-connection.md +++ b/docs/cluster-connection.md @@ -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`) diff --git a/docs/database.md b/docs/database.md index d1c7df4..1bc7be4 100644 --- a/docs/database.md +++ b/docs/database.md @@ -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`) diff --git a/docs/default-privilege.md b/docs/default-privilege.md index 19d24ae..5a20264 100644 --- a/docs/default-privilege.md +++ b/docs/default-privilege.md @@ -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 diff --git a/docs/grant.md b/docs/grant.md index 7c24d9f..9f9fbfc 100644 --- a/docs/grant.md +++ b/docs/grant.md @@ -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 diff --git a/docs/role.md b/docs/role.md index dddeb59..cdea41b 100644 --- a/docs/role.md +++ b/docs/role.md @@ -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`) diff --git a/docs/schema.md b/docs/schema.md index edd70a4..9a042a0 100644 --- a/docs/schema.md +++ b/docs/schema.md @@ -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`)