Skip to content

Commit 478e506

Browse files
committed
Improve database model and docs
1 parent fcb080f commit 478e506

6 files changed

Lines changed: 14 additions & 3 deletions

File tree

docs/applications/databases.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,8 @@ harness
9494

9595
`initialdb` is the default database used
9696

97+
`args`: Optional list of additional command-line arguments passed to the PostgreSQL server process (e.g. `["-c", "max_connections=200"]`).
98+
9799
`operator`: When set to `true`, uses the [CloudNative-PG operator](https://github.com/cloudnative-pg/cloudnative-pg) instead of a plain Kubernetes Deployment. This provides advanced features like automated failover and cluster management. **Backups are not configured by default by this chart; you must define CNPG backup resources (for example, `Backup` and/or `ScheduledBackup` objects) or use another backup mechanism separately.** **Requires the CNPG operator to be pre-installed in the cluster.**
98100

99101
To install the CNPG operator:

docs/model/DatabaseConfig.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
1313
**instances** | **int** | Number of PostgreSQL instances managed by the CNPG operator (only used when operator is true) | [optional]
1414
**api_server_cidr** | **List[str]** | CIDR(s) allowed for CNPG pods to reach the Kubernetes API server (port 443). Override with your cluster API-server or service CIDR. | [optional]
1515
**initialdb** | **str** | Initial database name (postgres only) | [optional]
16+
**args** | **List[str]** | Additional command-line arguments passed to the database server process (postgres only) | [optional]
1617

1718
## Example
1819

libraries/models/api/openapi.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -965,6 +965,11 @@ components:
965965
initialdb:
966966
description: 'Initial database name (postgres only)'
967967
type: string
968+
args:
969+
description: 'Additional command-line arguments passed to the database server process (postgres only)'
970+
type: array
971+
items:
972+
type: string
968973
additionalProperties: true
969974
NetworkConfig:
970975
title: Root Type for NetworkConfig

libraries/models/cloudharness_model/models/database_config.py

Lines changed: 4 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

libraries/models/docs/DatabaseConfig.md

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

libraries/models/docs/ExtraContainerConfig.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)