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: README.md
+1-37Lines changed: 1 addition & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -102,11 +102,7 @@ Defines a continuously-refreshed replica of a PostgreSQL database restored from
102
102
| `readOnly` | `bool` | No | `true` | Set the restored database to read-only mode. |
103
103
| `postgresExtraConfig` | `string` | No | — | Extra lines appended to `postgresql.conf` (e.g. `shared_preload_libraries`). |
104
104
| `notifications` | `[]NotificationConfig` | No | `[]` | Notification targets called on restore events. |
105
-
| `overlayDatabase` | `OverlayDatabaseConfig` | No | — | Optional overlay database configuration (persistent database via CNPG). Mutually exclusive with `persistentSchemas`. |
106
-
| `persistentSchemas` | `[]string` | No | — | List of schema names to migrate from the old restore to the new restore on each switchover. Mutually exclusive with `overlayDatabase`. |
107
-
108
-
Using the `overlayDatabase` requires the CloudNative-PG operator to be installed and configured.
109
-
Installing the CNPG cluster-level catalogs is optional but recommended.
105
+
| `persistentSchemas` | `[]string` | No | — | List of schema names to migrate from the previous restore to the new restore on each switchover. |
110
106
111
107
The cron expression is parsed using the [cronexpr](https://docs.rs/cronexpr) crate.
112
108
It has two interesting features:
@@ -151,34 +147,6 @@ Additional fields for `target: graphQL`:
| `strategy` | `"fdw"` \| `"copy"` | No | `"fdw"` | Strategy for populating the overlay from the restore. `fdw` creates foreign tables (restore must stay alive). `copy` uses `pg_dump \| psql` to copy data (tolerates version differences, restore can be discarded). |
164
-
| `postgresVersion` | `uint32` | No | Resolved from image catalog, or `18` | PostgreSQL major version for the CNPG cluster. |
165
-
| `imageCatalog` | `ImageCatalogRef` | No | ClusterImageCatalog | CNPG image catalog for PG version discovery and image resolution. |
166
-
| `storageSizeOverride` | `Quantity` | No | Auto-sized | Override for the overlay PVC size. Auto-sizing: `5Gi + ceil(snapshotSize / 10)`, ratchets up only. |
167
-
| `storageClass` | `string` | No | — | Storage class for the overlay database PVC. |
168
-
| `resources` | `ResourceRequirements` | No | — | Resource requirements for the overlay database pods. |
169
-
| `affinity` | `Affinity` | No | — | Pod affinity rules for the overlay database. |
170
-
| `tolerations` | `[]Toleration` | No | `[]` | Tolerations for the overlay database pods. |
171
-
| `serviceAnnotations` | `map[string]string` | No | — | Annotations for the overlay database's `-rw` Service. |
172
-
| `importGenerated` | `bool` | No | `false` | Include `GENERATED` column expressions when importing foreign schemas (FDW only). Ignored for `copy` strategy. |
173
-
| `retainRestore` | `bool` | No | `true` | When `false` and strategy is `copy`, delete the restore Deployment and PVC after a successful copy. The restore CR is kept for bookkeeping. Ignored for `fdw` strategy. |
174
-
175
-
#### ImageCatalogRef
176
-
177
-
| Field | Type | Required | Default | Description |
| `name` | `string` | Yes | — | Name of the image catalog resource. |
180
-
| `kind` | `string` | No | `"ClusterImageCatalog"` | Kind of the image catalog (`ClusterImageCatalog` or `ImageCatalog`). |
181
-
182
150
#### Status
183
151
184
152
| Field | Type | Description |
@@ -194,10 +162,6 @@ This can be used to persistently write data in other schemas in the overlay with
194
162
| `queuePosition` | `uint32` | Position in the global restore queue. |
195
163
| `notifications` | `[]NotificationStatus` | Status of each configured notification target. |
196
164
| `conditions` | `[]Condition` | Standard Kubernetes conditions. |
197
-
| `overlayClusterName` | `string` | Name of the CNPG Cluster CR for the overlay database. |
198
-
| `overlayRestore` | `string` | Name of the restore whose schemas are currently imported into the overlay. |
199
-
| `overlayStorageSize` | `Quantity` | Current (possibly ratcheted) storage size of the overlay PVC. |
200
-
| `overlayPostgresVersion` | `uint32` | Resolved PG major version used for the overlay cluster. |
201
165
| `schemaMigrationJob` | `string` | Name of the active schema migration Job (set while migration is in progress). |
202
166
| `schemaMigrationPhase` | `string` | Phase of the schema migration (`active`, `complete`, or `failed: <reason>`). |
203
167
| `persistentSchemaDataSize` | `Quantity` | Measured size of persistent schema data from the last successful migration. Used to size the next restore PVC. |
0 commit comments