Skip to content

Commit 1c84e58

Browse files
committed
chore: update docs fixing anchors
Signed-off-by: Leonardo Cecchi <leonardo.cecchi@enterprisedb.com>
1 parent 06aeabb commit 1c84e58

49 files changed

Lines changed: 95 additions & 95 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/appendixes/backup_barmanobjectstore.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ segment to be archived.
106106
By default, CloudNativePG sets `archive_timeout` to `5min`, ensuring
107107
that WAL files, even in case of low workloads, are closed and archived
108108
at least every 5 minutes, providing a deterministic time-based value for
109-
your Recovery Point Objective ([RPO](../before_you_start.md#rpo)). Even though you change the value
109+
your Recovery Point Objective ([RPO](../before_you_start.md#postgresql-terminology)). Even though you change the value
110110
of the [`archive_timeout` setting in the PostgreSQL configuration](https://www.postgresql.org/docs/current/runtime-config-wal.html#GUC-ARCHIVE-TIMEOUT),
111111
our experience suggests that the default value set by the operator is
112112
suitable for most use cases.

docs/architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -375,10 +375,10 @@ only write inside a single Kubernetes cluster, at any time.
375375

376376
However, for business continuity objectives it is fundamental to:
377377

378-
- reduce global **recovery point objectives** ([RPO](before_you_start.md#rpo))
378+
- reduce global **recovery point objectives** ([RPO](before_you_start.md#postgresql-terminology))
379379
by storing PostgreSQL backup data in multiple locations, regions and possibly
380380
using different providers (Disaster Recovery)
381-
- reduce global **recovery time objectives** ([RTO](before_you_start.md#rto))
381+
- reduce global **recovery time objectives** ([RTO](before_you_start.md#postgresql-terminology))
382382
by taking advantage of PostgreSQL replication beyond the primary Kubernetes
383383
cluster (High Availability)
384384

docs/backup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ as they can simply rely on the WAL archive to synchronize across long
9090
distances, extending disaster recovery goals across different regions.
9191

9292
When you [configure a WAL archive](wal_archiving.md), CloudNativePG provides
93-
out-of-the-box an [RPO](before_you_start.md#rpo) ≤ 5 minutes for disaster
93+
out-of-the-box an [RPO](before_you_start.md#postgresql-terminology) ≤ 5 minutes for disaster
9494
recovery, even across regions.
9595

9696
:::info[Important]
@@ -169,7 +169,7 @@ Consider the following factors:
169169
- **Database size**: For very large databases (VLDBs), **volume snapshots are
170170
generally preferred** as they enable faster recovery due to copy-on-write
171171
technology—this significantly improves your
172-
[Recovery Time Objective (RTO)](before_you_start.md#rto).
172+
[Recovery Time Objective (RTO)](before_you_start.md#postgresql-terminology).
173173
- **Data mobility**: Object store–based backups may offer greater flexibility
174174
for replicating or storing backups across regions or environments.
175175
- **Operational familiarity**: Choose the method that aligns best with your
@@ -247,7 +247,7 @@ since seconds are not supported.
247247

248248
:::tip[Hint]
249249
The frequency of your backups directly impacts your **Recovery Time Objective**
250-
([RTO](before_you_start.md#rto)).
250+
([RTO](before_you_start.md#postgresql-terminology)).
251251
:::
252252

253253
To optimize your disaster recovery strategy based on continuous backup:

docs/connection_pooling.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -458,7 +458,7 @@ Go runtime (with the prefix `go_*`).
458458

459459
:::info
460460
You can inspect the exported metrics on a pod running PgBouncer. For instructions, see
461-
[How to inspect the exported metrics](monitoring.md/#how-to-inspect-the-exported-metrics).
461+
[How to inspect the exported metrics](monitoring.md#how-to-inspect-the-exported-metrics).
462462
Make sure that you use the correct IP and the `9127` port.
463463
:::
464464

@@ -731,4 +731,4 @@ is to explicitly list the options that can be configured by users.
731731
use cases. It leaves room for the future implementation of a separate
732732
operator for PgBouncer to complete the gamma with more advanced and customized
733733
scenarios.
734-
:::
734+
:::

docs/failover.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ During the time the failing primary is being shut down:
5555

5656
## RTO and RPO impact
5757

58-
Failover may result in the service being impacted ([RTO](before_you_start.md#rto))
59-
and/or data being lost ([RPO](before_you_start.md#rpo)):
58+
Failover may result in the service being impacted ([RTO](before_you_start.md#postgresql-terminology))
59+
and/or data being lost ([RPO](before_you_start.md#postgresql-terminology)):
6060

6161
1. During the time when the primary has started to fail, and before the controller
6262
starts failover procedures, queries in transit, WAL writes, checkpoints and

docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,7 @@ single cluster, namely:
459459
- storage: use dedicated storage for each worker node running Postgres
460460

461461
Use at least one standby, preferably at least two, so that you can configure
462-
synchronous replication in the cluster, introducing [RPO](before_you_start.md#rpo)=0
462+
synchronous replication in the cluster, introducing [RPO](before_you_start.md#postgresql-terminology)=0
463463
for high availability.
464464

465465
If you do not have availability zones - normally the case of on-premise

docs/imagevolume_extensions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ volume inside a running pod at a known filesystem path.
1919
If the extension requires one or more shared libraries to be pre-loaded at server
2020
start, you can add them via the [`shared_preload_libraries` option](postgresql_conf.md#shared-preload-libraries).
2121
Also, if your extension requires being created at the database level through
22-
the `CREATE EXTENSION` command, you can use the [`Database` resource’s declarative extension management](declarative_database_management.md/#managing-extensions-in-a-database)
22+
the `CREATE EXTENSION` command, you can use the [`Database` resource’s declarative extension management](declarative_database_management.md#managing-extensions-in-a-database)
2323
to ensure consistent, automated extension setup within your PostgreSQL databases.
2424

2525
## Benefits
@@ -161,7 +161,7 @@ Once mounted, CloudNativePG will automatically configure PostgreSQL by appending
161161
This ensures that the PostgreSQL container is ready to serve the `foo`
162162
extension when requested by a database, as described in the next section. The
163163
`CREATE EXTENSION foo` command, triggered automatically during the
164-
[reconciliation of the `Database` resource](declarative_database_management.md/#managing-extensions-in-a-database),
164+
[reconciliation of the `Database` resource](declarative_database_management.md#managing-extensions-in-a-database),
165165
will work without additional configuration, as PostgreSQL will locate:
166166

167167
- the extension control file at `/extensions/foo/share/extension/foo.control`

docs/instance_manager.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ seconds.
368368

369369
:::info[Important]
370370
In order to avoid any data loss in the Postgres cluster, which impacts
371-
the database [RPO](before_you_start.md#rpo), don't delete the Pod where
371+
the database [RPO](before_you_start.md#postgresql-terminology), don't delete the Pod where
372372
the primary instance is running. In this case, perform a switchover to
373373
another instance first.
374374
:::
@@ -386,8 +386,8 @@ the time given to the former primary to shut down gracefully and archive all
386386
the WAL files. By default it is set to `3600` (1 hour).
387387

388388
:::warning
389-
The `.spec.switchoverDelay` option affects the [RPO](before_you_start.md#rpo)
390-
and [RTO](before_you_start.md#rto) of your PostgreSQL database. Setting it to
389+
The `.spec.switchoverDelay` option affects the [RPO](before_you_start.md#postgresql-terminology)
390+
and [RTO](before_you_start.md#postgresql-terminology) of your PostgreSQL database. Setting it to
391391
a low value, might favor RTO over RPO but lead to data loss at cluster level
392392
and/or backup level. On the contrary, setting it to a high value, might remove
393393
the risk of data loss while leaving the cluster without an active primary for a

docs/kubectl-plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1061,7 +1061,7 @@ to request an online/hot backup or an offline/cold one: additionally, you can
10611061
also tune online backups by explicitly setting the `--immediate-checkpoint` and
10621062
`--wait-for-archive` options.
10631063

1064-
The ["Backup" section](./backup.md#backup) contains more information about
1064+
The ["Backup" section](./backup.md) contains more information about
10651065
the configuration settings.
10661066

10671067
### Launching psql

docs/operator_capability_levels.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ continuity and scalability.
358358

359359
*Disaster recovery* is a business continuity component that requires
360360
that both backup and recovery of a database work correctly. While as a
361-
starting point, the goal is to achieve [RPO](before_you_start.md#rpo) < 5
361+
starting point, the goal is to achieve [RPO](before_you_start.md#postgresql-terminology) < 5
362362
minutes, the long-term goal is to implement RPO=0 backup solutions. *High
363363
availability* is the other important component of business continuity. Through
364364
PostgreSQL native physical replication and hot standby replicas, it allows the
@@ -425,7 +425,7 @@ Both volume snapshots and CNPG-I-based backups support:
425425
### Backups from a standby
426426

427427
The operator supports offloading base backups onto a standby without impacting
428-
the [RPO](before_you_start.md#rpo) of the database. This allows resources to
428+
the [RPO](before_you_start.md#postgresql-terminology) of the database. This allows resources to
429429
be preserved on the primary, in particular I/O, for standard database
430430
operations.
431431

@@ -486,7 +486,7 @@ switchover across data centers remains necessary.)
486486

487487
Additionally, the flexibility extends to creating delayed replica clusters
488488
intentionally lagging behind the primary cluster. This intentional lag aims to
489-
minimize the Recovery Time Objective ([RTO](before_you_start.md#rto)) in the
489+
minimize the Recovery Time Objective ([RTO](before_you_start.md#postgresql-terminology)) in the
490490
event of unintended errors, such as incorrect `DELETE` or `UPDATE` SQL operations.
491491

492492
### Distributed Database Topologies

0 commit comments

Comments
 (0)