Skip to content

Commit 87002a5

Browse files
author
github-actions
committed
docs: import CloudNativePG
1 parent 90ea03d commit 87002a5

File tree

4 files changed

+56
-24
lines changed

4 files changed

+56
-24
lines changed

docs/declarative_database_management.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -402,12 +402,8 @@ Each foreign server entry supports the following properties:
402402
- `ensure`: Indicates whether the option should be `present` or `absent`.
403403

404404
:::info[Important]
405-
:::
406-
407-
The `fdw` field must reference an existing foreign data wrapper already defined in the database.
408-
If the specified FDW does not exist, the foreign server will not be created.
409-
410-
:::info
405+
The `fdw` field must reference an existing foreign data wrapper already defined in the database.
406+
If the specified FDW does not exist, the foreign server will not be created.
411407
:::
412408

413409
CloudNativePG manages foreign servers using PostgreSQL’s native SQL commands:

docs/preview_version.md

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ testing before the community issues a new generally available (GA) release.
1212
These versions are feature-frozen, meaning no new features are added, and are
1313
intended for public testing prior to the final release.
1414

15-
:::info[Important]
16-
CloudNativePG release candidates are not intended for use in production
17-
systems.
15+
:::warning[Important]
16+
    CloudNativePG release candidates are **not intended for use in production** systems.
17+
They should only be deployed in staging or dedicated testing environments.
1818
:::
1919

2020
## Purpose of Release Candidates
@@ -24,13 +24,47 @@ the official release. While a release candidate aims to be identical to the
2424
initial release of a new minor version of CloudNativePG, additional changes may
2525
be implemented before the GA release.
2626

27-
## Community Involvement
27+
### Mitigating Critical Issues
28+
29+
The primary purpose of an RC is to catch serious defects and regressions that our
30+
automated testing and internal manual checks might miss. **Specifically, community testing
31+
is invaluable for validating real-world scenarios, such as:**
32+
33+
- **Upgrade Paths:** Testing the process of upgrading an existing CloudNativePG
34+
cluster from the previous stable minor version to the RC version. This often
35+
uncovers critical compatibility or migration issues, like those that affect PVC
36+
ownership, which can only be reliably tested with diverse existing user setups.
37+
- **Unique Configurations:** Validating compatibility with specific Kubernetes
38+
versions, storage providers, networking setups, or custom PostgreSQL
39+
extensions not covered by our standard test matrix.
40+
- **Real-world Workloads:** Running the RC with your actual application
41+
workload and traffic patterns to expose performance regressions or race
42+
conditions.
43+
44+
## Community Involvement: How to Help
2845

2946
The stability of each CloudNativePG minor release significantly depends on the
3047
community's efforts to test the upcoming version with their workloads and
3148
tools. Identifying bugs and regressions through user testing is crucial in
3249
determining when we can finalize the release.
3350

51+
### Your Call to Action
52+
53+
If a Release Candidate is available, we encourage you to perform the following tests in a
54+
non-production environment:
55+
56+
- **New Deployment Test:** Deploy a new CloudNativePG cluster using the RC version.
57+
- **Upgrade Test (Crucial):** **Upgrade an existing cluster** (from the
58+
preceding stable minor version) to the RC version, and verify all key
59+
operational aspects (scaling, failover, backup/restore) function correctly.
60+
- **Basic Operations:** Verify key features like rolling update,
61+
backup/restore, instance failover, and connection pooling function as
62+
expected.
63+
- **Report Issues:** **Immediately report any issues or unexpected behavior**
64+
by opening a GitHub issue and clearly marking it with a **`Release
65+
Candidate`** tag or label, along with the RC version number
66+
(e.g., `1.28.0-rc1`).
67+
3468
## Usage Advisory
3569

3670
The CloudNativePG Community strongly advises against using preview versions of
@@ -39,6 +73,9 @@ CloudNativePG undergoes extensive automated and manual testing, beta releases
3973
may contain serious bugs. Features in preview versions may change in ways that
4074
are not backwards compatible and could be removed entirely.
4175

76+
**By testing the Release Candidate, you are helping to prevent a potentially
77+
critical bug from affecting the entire community upon the GA release.**
78+
4279
## Current Preview Version
4380

4481
There are currently no preview versions available.

docs/release_notes/v1.28.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,10 @@ on the release branch in GitHub.
4747
- Enabled simultaneous image and configuration changes when using
4848
`primaryUpdateMethod: restart`, allowing you to update the container image
4949
(including PostgreSQL version or extensions) and PostgreSQL configuration
50-
settings in the same operation. Note that when using `primaryUpdateMethod:
51-
switchover`, image and configuration changes must still be performed
52-
separately to avoid configuration mismatches during the switchover process.
50+
settings in the same operation.
51+
Note that when using `primaryUpdateMethod: switchover`, image and
52+
configuration changes must still be performed separately to avoid configuration
53+
mismatches during the switchover process.
5354
([#8241](https://github.com/cloudnative-pg/cloudnative-pg/pull/8241))
5455

5556
- Improved network failure detection for replica instances by setting the

docs/security.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -495,18 +495,16 @@ You can assign an
495495
[AppArmor](https://kubernetes.io/docs/tutorials/security/apparmor/) profile to
496496
the `postgres`, `initdb`, `join`, `full-recovery` and `bootstrap-controller` containers inside every `Cluster` pod through the
497497
`container.apparmor.security.beta.kubernetes.io` annotation.
498+
For example:
498499

499-
:::note[Example of cluster annotations]
500-
:::
501-
502-
```
503-
kind: Cluster
504-
metadata:
505-
name: cluster-apparmor
506-
annotations:
507-
container.apparmor.security.beta.kubernetes.io/postgres: runtime/default
508-
container.apparmor.security.beta.kubernetes.io/initdb: runtime/default
509-
container.apparmor.security.beta.kubernetes.io/join: runtime/default
500+
```yaml
501+
kind: Cluster
502+
metadata:
503+
name: cluster-apparmor
504+
annotations:
505+
container.apparmor.security.beta.kubernetes.io/postgres: runtime/default
506+
container.apparmor.security.beta.kubernetes.io/initdb: runtime/default
507+
container.apparmor.security.beta.kubernetes.io/join: runtime/default
510508
```
511509

512510
:::warning

0 commit comments

Comments
 (0)