Skip to content

Commit

Permalink
various link fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
josh-heyer committed Nov 8, 2023
1 parent 5ac9bd1 commit 625f415
Show file tree
Hide file tree
Showing 17 changed files with 24 additions and 24 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ function requires `TRIGGER` privilege on the `relation` and `EXECUTE`
privilege on the function. This applies with a
`bdr.backwards_compatibility` of 30619 or above. Additional
security rules apply in PGD to all triggers including conflict
triggers. See [Security and roles](../../security#triggers).
triggers. See [Security and roles](../../security/access-control#triggers).

## `bdr.create_transform_trigger`

Expand Down Expand Up @@ -92,7 +92,7 @@ Similarly to normal PostgreSQL triggers, the `bdr.create_transform_trigger`
function requires the `TRIGGER` privilege on the `relation` and `EXECUTE`
privilege on the function. Additional security rules apply in PGD to all
triggers including transform triggers. See
[Security and roles](../../security#triggers).
[Security and roles](../../security/access-control#triggers).

## `bdr.drop_trigger`

Expand Down
2 changes: 1 addition & 1 deletion product_docs/docs/pgd/5/security/access-control.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ to exclude the `public` schema from the search_path without problems.

Administrators must not grant explicit privileges on catalog
objects such as tables, views, and functions. Manage access to those objects
by granting one of the roles described in [PGD default roles](#pgd-defaultpredefined-roles).
by granting one of the roles described in [PGD default roles](pgd-predefined-roles).

This requirement is a consequence of the flexibility that allows
joining a node group even if the nodes on either side of the join don't
Expand Down
4 changes: 2 additions & 2 deletions product_docs/docs/postgres_for_kubernetes/1/backup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ Scheduled backups are the recommended way to configure your backup strategy in
EDB Postgres for Kubernetes. They are managed by the `ScheduledBackup` resource.

!!! Info
Please refer to [`ScheduledBackupSpec`](cloudnative-pg.v1.md#postgresql-k8s-enterprisedb-io-v1-ScheduledBackupSpec)
Please refer to [`ScheduledBackupSpec`](pg4k.v1.md#postgresql-k8s-enterprisedb-io-v1-ScheduledBackupSpec)
in the API reference for a full list of options.

The `schedule` field allows you to define a *six-term cron schedule* specification,
Expand Down Expand Up @@ -235,7 +235,7 @@ you can set `.spec.immediate: true`.
## On-demand backups

!!! Info
Please refer to [`BackupSpec`](cloudnative-pg.v1.md#postgresql-k8s-enterprisedb-io-v1-BackupSpec)
Please refer to [`BackupSpec`](pg4k.v1.md#postgresql-k8s-enterprisedb-io-v1-BackupSpec)
in the API reference for a full list of options.

To request a new backup, you need to create a new `Backup` resource
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ as it is composed of a community PostgreSQL image and the latest

A backup is performed from a primary or a designated primary instance in a
`Cluster` (please refer to
[replica clusters](replica_cluster.md)
[replica clusters](replica_cluster.mdx)
for more information about designated primary instances), or alternatively
on a [standby](#backup-from-a-standby).
on a [standby](backup.md#backup-from-a-standby).

## Common object stores

Expand Down Expand Up @@ -99,8 +99,8 @@ algorithms via `barman-cloud-backup` (for backups) and
- snappy

The compression settings for backups and WALs are independent. See the
[DataBackupConfiguration](cloudnative-pg.v1.md#postgresql-k8s-enterprisedb-io-v1-DataBackupConfiguration) and
[WALBackupConfiguration](cloudnative-pg.v1.md#postgresql-k8s-enterprisedb-io-v1-WalBackupConfiguration) sections in
[DataBackupConfiguration](pg4k.v1.md#postgresql-k8s-enterprisedb-io-v1-DataBackupConfiguration) and
[WALBackupConfiguration](pg4k.v1.md#postgresql-k8s-enterprisedb-io-v1-WalBackupConfiguration) sections in
the API reference.

It is important to note that archival time, restore time, and size change
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ EDB Postgres for Kubernetes allows you to configure a given Postgres cluster for
Snapshot backups through the `backup.volumeSnapshot` stanza.

!!! Info
Please refer to [`VolumeSnapshotConfiguration`](cloudnative-pg.v1.md#postgresql-k8s-enterprisedb-io-v1-VolumeSnapshotConfiguration)
Please refer to [`VolumeSnapshotConfiguration`](pg4k.v1.md#postgresql-k8s-enterprisedb-io-v1-VolumeSnapshotConfiguration)
in the API reference for a full list of options.

A generic example with volume snapshots (assuming that PGDATA and WALs share
Expand Down
4 changes: 2 additions & 2 deletions product_docs/docs/postgres_for_kubernetes/1/bootstrap.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ storage that the EDB Postgres for Kubernetes operator provides, please refer to
["Recovery" section](recovery.md) for guidance on each method.

!!! Seealso "API reference"
Please refer to the ["API reference for the `bootstrap` section](cloudnative-pg.v1.md#postgresql-k8s-enterprisedb-io-v1-BootstrapConfiguration)
Please refer to the ["API reference for the `bootstrap` section](pg4k.v1.md#postgresql-k8s-enterprisedb-io-v1-BootstrapConfiguration)
for more information.

## The `externalClusters` section
Expand Down Expand Up @@ -108,7 +108,7 @@ continuously fed from the source, either via streaming, via WAL shipping
through the PostgreSQL's `restore_command`, or any of the two.

!!! Seealso "API reference"
Please refer to the ["API reference for the `externalClusters` section](cloudnative-pg.v1.md#postgresql-k8s-enterprisedb-io-v1-ExternalCluster)
Please refer to the ["API reference for the `externalClusters` section](pg4k.v1.md#postgresql-k8s-enterprisedb-io-v1-ExternalCluster)
for more information.

## Bootstrap an empty cluster (`initdb`)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ EDB Postgres for Kubernetes also creates a secret with the same name as the pool
the configuration files used with PgBouncer.

!!! Seealso "API reference"
For details, see [`PgBouncerSpec`](cloudnative-pg.v1.md#postgresql-k8s-enterprisedb-io-v1-PgBouncerSpec)
For details, see [`PgBouncerSpec`](pg4k.v1.md#postgresql-k8s-enterprisedb-io-v1-PgBouncerSpec)
in the API reference.

## Pooler resource lifecycle
Expand Down Expand Up @@ -178,7 +178,7 @@ GRANT EXECUTE ON FUNCTION user_search(text)

You can take advantage of pod templates specification in the `template`
section of a `Pooler` resource. For details, see
[`PoolerSpec`](cloudnative-pg.v1.md#postgresql-k8s-enterprisedb-io-v1-PoolerSpec) in the API reference.
[`PoolerSpec`](pg4k.v1.md#postgresql-k8s-enterprisedb-io-v1-PoolerSpec) in the API reference.

Using templates, you can configure pods as you like, including fine control
over affinity and anti-affinity rules for pods and nodes. By default,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ spec:
The role specification in `spec.managed.roles` adheres to the
[PostgreSQL structure and naming conventions](https://www.postgresql.org/docs/current/sql-createrole.html).
Please refer to the [API reference](cloudnative-pg.v1.md#postgresql-k8s-enterprisedb-io-v1-RoleConfiguration) for
Please refer to the [API reference](pg4k.v1.md#postgresql-k8s-enterprisedb-io-v1-RoleConfiguration) for
the full list of attributes you can define for each role.

A few points are worth noting:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ EOF

!!! Note "There's more"
For more detailed information about the available options, please refer
to the ["API Reference" section](cloudnative-pg.v1.md).
to the ["API Reference" section](pg4k.v1.md).

In order to create the 3-node PostgreSQL cluster, you need to run the following command:

Expand Down
2 changes: 1 addition & 1 deletion product_docs/docs/postgres_for_kubernetes/1/openshift.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -865,7 +865,7 @@ that runs with the `quay.io/enterprisedb/pgbouncer` image.

!!! Note "There's more"
For more details about pod customization for the pooler, please refer to
the ["Pod templates"](connection_pooling.md#podtemplates) section in the
the ["Pod templates"](connection_pooling.md#pod-templates) section in the
connection pooling documentation.

You can change the image name from the advanced interface, specifically by
Expand Down
2 changes: 1 addition & 1 deletion product_docs/docs/postgres_for_kubernetes/1/postgis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ both the template database and the application database, ready for use.

!!! Info
Take some time and look at the available options in `.spec.bootstrap.initdb`
from the [API reference](cloudnative-pg.v1.md#postgresql-k8s-enterprisedb-io-v1-BootstrapInitDB), such as
from the [API reference](pg4k.v1.md#postgresql-k8s-enterprisedb-io-v1-BootstrapInitDB), such as
`postInitApplicationSQL`.

You can easily verify the available version of PostGIS that is in the
Expand Down
2 changes: 1 addition & 1 deletion product_docs/docs/postgres_for_kubernetes/1/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ spec:
!!! Note "There's more"
For more detailed information about the available options, please refer
to the ["API Reference" section](cloudnative-pg.v1.md).
to the ["API Reference" section](pg4k.v1.md).
In order to create the 3-node PostgreSQL cluster, you need to run the following command:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ In EDB Postgres for Kubernetes, we use the terms:

This feature, introduced in EDB Postgres for Kubernetes 1.18, is now enabled by default and
can be disabled via configuration. For details, please refer to the
["replicationSlots" section in the API reference](cloudnative-pg.v1.md#postgresql-k8s-enterprisedb-io-v1-ReplicationSlotsConfiguration).
["replicationSlots" section in the API reference](pg4k.v1.md#postgresql-k8s-enterprisedb-io-v1-ReplicationSlotsConfiguration).
Here follows a brief description of the main options:

`.spec.replicationSlots.highAvailability.enabled`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ while creating a cluster:
in a VM or physical machine scenario - see below).
- Set up database server pods on a dedicated node using nodeSelector.
See the "nodeSelector" and "tolerations" fields of the
[β€œaffinityconfiguration"](cloudnative-pg.v1.md#postgresql-k8s-enterprisedb-io-v1-AffinityConfiguration) resource on the API reference page.
[β€œaffinityconfiguration"](pg4k.v1.md#postgresql-k8s-enterprisedb-io-v1-AffinityConfiguration) resource on the API reference page.

You can refer to the following example manifest:

Expand Down
2 changes: 1 addition & 1 deletion product_docs/docs/postgres_for_kubernetes/1/samples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,4 @@ Cluster with TDE enabled
an EPAS 15 cluster with TDE. Note that you will need access credentials
to download the image used.

For a list of available options, please refer to the ["API Reference" page](cloudnative-pg.v1.md).
For a list of available options, please refer to the ["API Reference" page](pg4k.v1.md).
2 changes: 1 addition & 1 deletion product_docs/docs/postgres_for_kubernetes/1/scheduling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ the best node possible, based on several criteria.
anti-affinity, node selectors, and so on.

You can control how the EDB Postgres for Kubernetes cluster's instances should be
scheduled through the [`affinity`](cloudnative-pg.v1.md#postgresql-k8s-enterprisedb-io-v1-AffinityConfiguration)
scheduled through the [`affinity`](pg4k.v1.md#postgresql-k8s-enterprisedb-io-v1-AffinityConfiguration)
section in the definition of the cluster, which supports:

- pod affinity/anti-affinity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ the ["Backup on object stores" section](backup_barmanobjectstore.md) to set up
the WAL archive.

!!! Info
Please refer to [`BarmanObjectStoreConfiguration`](cloudnative-pg.v1.md#postgresql-k8s-enterprisedb-io-v1-barmanobjectstoreconfiguration)
Please refer to [`BarmanObjectStoreConfiguration`](pg4k.v1.md#postgresql-k8s-enterprisedb-io-v1-barmanobjectstoreconfiguration)
in the API reference for a full list of options.

If required, you can choose to compress WAL files as soon as they
Expand Down

2 comments on commit 625f415

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

πŸŽ‰ Published on https://edb-docs.netlify.app as production
πŸš€ Deployed on https://654bfdf76e1db14d799bc3fc--edb-docs.netlify.app

Please sign in to comment.