Skip to content

Commit

Permalink
DOCS-192: link fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
josh-heyer committed Mar 20, 2024
1 parent 85e21e8 commit ce00c0f
Show file tree
Hide file tree
Showing 4 changed files with 110 additions and 47 deletions.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Each service is generated from a customizable template in the `.spec.connectivit
section of the manifest.

All services must be reachable using their FQDN
from all the PGD nodes in all the Kubernetes clusters. See [Domain names resolution](#domain-names-resolutions).
from all the PGD nodes in all the Kubernetes clusters. See [Domain names resolution](#domain-names-resolution).

EDB Postgres Distributed for Kubernetes provides a service templating framework that gives you the
availability to easily customize services at the following three levels:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ kubectl apply -f \

With the operators and a self-signed cert issuer deployed, you can start
creating PGD clusters. See the
[Quick start](quickstart.md#part-3-deploy-a-pgd-cluster) for an example.
[Quick start](quickstart.md#part-3---deploy-a-pgd-cluster) for an example.


## Red Hat OpenShift
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -634,7 +634,7 @@ required.</p>
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>configuration</code> <b>[Required]</b><br/>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/api_reference#backupconfiguration"><i>BackupConfiguration</i></a>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/pg4k-pgd.v1beta1#backupconfiguration"><i>BackupConfiguration</i></a>
</td>
<td>
<p>The CNP configuration to be used for backup. ServerName value is reserved by the operator.</p>
Expand Down Expand Up @@ -859,14 +859,14 @@ Make sure you reserve enough time for the operator to request a fast shutdown of
</td>
</tr>
<tr><td><code>storage</code> <b>[Required]</b><br/>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/api_reference#storageconfiguration"><i>StorageConfiguration</i></a>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/pg4k-pgd.v1beta1#storageconfiguration"><i>StorageConfiguration</i></a>
</td>
<td>
<p>Configuration of the storage of the instances</p>
</td>
</tr>
<tr><td><code>walStorage</code> <b>[Required]</b><br/>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/api_reference#storageconfiguration"><i>StorageConfiguration</i></a>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/pg4k-pgd.v1beta1#storageconfiguration"><i>StorageConfiguration</i></a>
</td>
<td>
<p>Configuration of the WAL storage for the instances</p>
Expand All @@ -881,7 +881,7 @@ successfully start up (default 300)</p>
</td>
</tr>
<tr><td><code>affinity</code><br/>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/api_reference#affinityconfiguration"><i>AffinityConfiguration</i></a>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/pg4k-pgd.v1beta1#affinityconfiguration"><i>AffinityConfiguration</i></a>
</td>
<td>
<p>Affinity/Anti-affinity rules for Pods</p>
Expand All @@ -897,14 +897,14 @@ for more information.</p>
</td>
</tr>
<tr><td><code>postgresql</code><br/>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/api_reference#postgresconfiguration"><i>PostgresConfiguration</i></a>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/pg4k-pgd.v1beta1#postgresconfiguration"><i>PostgresConfiguration</i></a>
</td>
<td>
<p>Configuration of the PostgreSQL server</p>
</td>
</tr>
<tr><td><code>monitoring</code> <b>[Required]</b><br/>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/api_reference#monitoringconfiguration"><i>MonitoringConfiguration</i></a>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/pg4k-pgd.v1beta1#monitoringconfiguration"><i>MonitoringConfiguration</i></a>
</td>
<td>
<p>The configuration of the monitoring infrastructure of this cluster</p>
Expand All @@ -918,7 +918,7 @@ for more information.</p>
</td>
</tr>
<tr><td><code>serviceAccountTemplate</code> <b>[Required]</b><br/>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/api_reference#serviceaccounttemplate"><i>ServiceAccountTemplate</i></a>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/pg4k-pgd.v1beta1#serviceaccounttemplate"><i>ServiceAccountTemplate</i></a>
</td>
<td>
<p>The service account template to be passed to CNP</p>
Expand Down Expand Up @@ -965,7 +965,7 @@ Defaults to: <code>RuntimeDefault</code></p>
</td>
</tr>
<tr><td><code>managed</code> <b>[Required]</b><br/>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/api_reference#managedconfiguration"><i>ManagedConfiguration</i></a>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/pg4k-pgd.v1beta1#managedconfiguration"><i>ManagedConfiguration</i></a>
</td>
<td>
<p>The configuration that is used by the portions of PostgreSQL that are managed by the CNP instance manager</p>
Expand Down Expand Up @@ -1002,7 +1002,7 @@ Disabled by default.</p>
</td>
</tr>
<tr><td><code>superuserSecret</code><br/>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/api_reference#localobjectreference"><i>LocalObjectReference</i></a>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/pg4k-pgd.v1beta1#localobjectreference"><i>LocalObjectReference</i></a>
</td>
<td>
<p>The secret containing the superuser password.
Expand Down Expand Up @@ -1263,6 +1263,34 @@ More info: http://kubernetes.io/docs/user-guide/annotations</p>
</tbody>
</table>

<h2 id='pgd-k8s-enterprisedb-io-v1beta1-NodeCertificateStatus'>NodeCertificateStatus</h2>

**Appears in:**

- [ConnectivityStatus](#pgd-k8s-enterprisedb-io-v1beta1-ConnectivityStatus)

<p>NodeCertificateStatus encapsulate the status of the server certificate
of a CNP node</p>

<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ReplicationCertificateStatus</code><br/>
<a href="#pgd-k8s-enterprisedb-io-v1beta1-ReplicationCertificateStatus"><i>ReplicationCertificateStatus</i></a>
</td>
<td>(Members of <code>ReplicationCertificateStatus</code> are embedded into this type.)
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>nodeName</code> <b>[Required]</b><br/>
<i>string</i>
</td>
<td>
<p>NodeName is the name of the CNP cluster using this certificate</p>
</td>
</tr>
</tbody>
</table>

<h2 id='pgd-k8s-enterprisedb-io-v1beta1-NodeKindName'>NodeKindName</h2>

(Alias of `string`)
Expand Down Expand Up @@ -1382,15 +1410,15 @@ More info: http://kubernetes.io/docs/user-guide/annotations</p>
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>caBundleSecretRef</code> <b>[Required]</b><br/>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/api_reference#secretkeyselector"><i>SecretKeySelector</i></a>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/pg4k-pgd.v1beta1#secretkeyselector"><i>SecretKeySelector</i></a>
</td>
<td>
<p>CABundleSecretRef is a reference to a secret field containing the CA bundle
to verify the openTelemetry server certificate</p>
</td>
</tr>
<tr><td><code>clientCertSecret</code> <b>[Required]</b><br/>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/api_reference#localobjectreference"><i>LocalObjectReference</i></a>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/pg4k-pgd.v1beta1#localobjectreference"><i>LocalObjectReference</i></a>
</td>
<td>
<p>ClientCertSecret is the name of the secret containing the client certificate used to connect
Expand Down Expand Up @@ -2246,7 +2274,7 @@ by applications. Defaults to the value of the <code>database</code> key.</p>
</td>
</tr>
<tr><td><code>ownerCredentialsSecret</code> <b>[Required]</b><br/>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/api_reference#localobjectreference"><i>LocalObjectReference</i></a>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/pg4k-pgd.v1beta1#localobjectreference"><i>LocalObjectReference</i></a>
</td>
<td>
<p>Name of the secret containing the initial credentials for the
Expand Down Expand Up @@ -2286,6 +2314,71 @@ case the proxies will be created in the parent group</p>
</tbody>
</table>

<h2 id='pgd-k8s-enterprisedb-io-v1beta1-PreProvisionedCertificate'>PreProvisionedCertificate</h2>

**Appears in:**

- [ClientPreProvisionedCertificates](#pgd-k8s-enterprisedb-io-v1beta1-ClientPreProvisionedCertificates)

<p>PreProvisionedCertificate contains the data needed to supply a pre-generated certificate</p>

<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>secretRef</code> <b>[Required]</b><br/>
<i>string</i>
</td>
<td>
<p>SecretRef a name pointing to a secret that contains a tls.crt and tls.key</p>
</td>
</tr>
</tbody>
</table>

<h2 id='pgd-k8s-enterprisedb-io-v1beta1-ReplicationCertificateStatus'>ReplicationCertificateStatus</h2>

**Appears in:**

- [ConnectivityStatus](#pgd-k8s-enterprisedb-io-v1beta1-ConnectivityStatus)

- [NodeCertificateStatus](#pgd-k8s-enterprisedb-io-v1beta1-NodeCertificateStatus)

<p>ReplicationCertificateStatus encapsulate the certificate status</p>

<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>name</code> <b>[Required]</b><br/>
<i>string</i>
</td>
<td>
<p>Name is the name of the certificate</p>
</td>
</tr>
<tr><td><code>hash</code> <b>[Required]</b><br/>
<i>string</i>
</td>
<td>
<p>Hash is the hash of the configuration for which it has been generated</p>
</td>
</tr>
<tr><td><code>isReady</code> <b>[Required]</b><br/>
<i>bool</i>
</td>
<td>
<p>Ready is true when the certificate is ready</p>
</td>
</tr>
<tr><td><code>preProvisioned</code> <b>[Required]</b><br/>
<i>bool</i>
</td>
<td>
<p>PreProvisioned is true if the certificate is preProvisioned</p>
</td>
</tr>
</tbody>
</table>

<h2 id='pgd-k8s-enterprisedb-io-v1beta1-Restore'>Restore</h2>

**Appears in:**
Expand All @@ -2298,14 +2391,14 @@ case the proxies will be created in the parent group</p>
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>barmanObjectStore</code> <b>[Required]</b><br/>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/api_reference#barmanobjectstoreconfiguration"><i>BarmanObjectStoreConfiguration</i></a>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/pg4k-pgd.v1beta1#barmanobjectstoreconfiguration"><i>BarmanObjectStoreConfiguration</i></a>
</td>
<td>
<p>The configuration for the barman-cloud tool suite</p>
</td>
</tr>
<tr><td><code>recoveryTarget</code> <b>[Required]</b><br/>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/api_reference#recoverytarget"><i>RecoveryTarget</i></a>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/pg4k-pgd.v1beta1#recoverytarget"><i>RecoveryTarget</i></a>
</td>
<td>
<p>By default, the recovery process applies all the available
Expand Down Expand Up @@ -2479,7 +2572,7 @@ see https://pkg.go.dev/github.com/robfig/cron#hdr-CRON_Expression_Format</p>
</td>
</tr>
<tr><td><code>target</code> <b>[Required]</b><br/>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/api_reference#backuptarget"><i>BackupTarget</i></a>
<a href="https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/pg4k-pgd.v1beta1#backuptarget"><i>BackupTarget</i></a>
</td>
<td>
<p>The policy to decide which instance should perform this backup. If empty,
Expand Down

0 comments on commit ce00c0f

Please sign in to comment.