diff --git a/product_docs/docs/postgres_distributed_for_kubernetes/1/api_reference.md.in b/product_docs/docs/postgres_distributed_for_kubernetes/1/api_reference.md.in deleted file mode 100644 index 7998937baf2..00000000000 --- a/product_docs/docs/postgres_distributed_for_kubernetes/1/api_reference.md.in +++ /dev/null @@ -1,30 +0,0 @@ -# API reference - -EDB Postgres Distributed for Kubernetes extends the Kubernetes API by defining the -custom resources that follow. - -All the resources are defined in the `pgd.k8s.enterprisedb.io/v1beta1` -API. - - - -{{ range $ -}} -- [{{ .Name -}}](#{{ .Name -}}) -{{ end }} - -{{ range $ -}} -{{ .Anchor }} - -## {{ .Name }} - -{{ .Doc -}} -{{ if .Items }} - -{{ .TableFieldName }} | {{ .TableFieldDoc }} | {{ .TableFieldRawType }} -{{ .TableFieldNameDashSize }} | {{ .TableFieldDocDashSize }} | {{ .TableFieldRawTypeDashSize }} -{{ end }} -{{- range .Items -}} -`{{ .Name }}` | {{ .Doc }}{{ if .Mandatory }} - *mandatory* {{ end }} | {{ .RawType }} -{{ end }} -{{ end -}} - diff --git a/product_docs/docs/postgres_distributed_for_kubernetes/1/connectivity.mdx b/product_docs/docs/postgres_distributed_for_kubernetes/1/connectivity.mdx index 0c112a9338e..47ad4138964 100644 --- a/product_docs/docs/postgres_distributed_for_kubernetes/1/connectivity.mdx +++ b/product_docs/docs/postgres_distributed_for_kubernetes/1/connectivity.mdx @@ -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: diff --git a/product_docs/docs/postgres_distributed_for_kubernetes/1/installation_upgrade.mdx b/product_docs/docs/postgres_distributed_for_kubernetes/1/installation_upgrade.mdx index 6b34d067b3c..a9cb2dcfc5d 100644 --- a/product_docs/docs/postgres_distributed_for_kubernetes/1/installation_upgrade.mdx +++ b/product_docs/docs/postgres_distributed_for_kubernetes/1/installation_upgrade.mdx @@ -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 diff --git a/product_docs/docs/postgres_distributed_for_kubernetes/1/pg4k-pgd.v1beta1.mdx b/product_docs/docs/postgres_distributed_for_kubernetes/1/pg4k-pgd.v1beta1.mdx index 81afa47181b..3808aeef9e6 100644 --- a/product_docs/docs/postgres_distributed_for_kubernetes/1/pg4k-pgd.v1beta1.mdx +++ b/product_docs/docs/postgres_distributed_for_kubernetes/1/pg4k-pgd.v1beta1.mdx @@ -634,7 +634,7 @@ required.
configuration
[Required]The CNP configuration to be used for backup. ServerName value is reserved by the operator.
@@ -859,14 +859,14 @@ Make sure you reserve enough time for the operator to request a fast shutdown ofstorage
[Required]Configuration of the storage of the instances
walStorage
[Required]Configuration of the WAL storage for the instances
@@ -881,7 +881,7 @@ successfully start up (default 300)affinity
Affinity/Anti-affinity rules for Pods
@@ -897,14 +897,14 @@ for more information.postgresql
Configuration of the PostgreSQL server
monitoring
[Required]The configuration of the monitoring infrastructure of this cluster
@@ -918,7 +918,7 @@ for more information.serviceAccountTemplate
[Required]The service account template to be passed to CNP
@@ -965,7 +965,7 @@ Defaults to:RuntimeDefault
managed
[Required]The configuration that is used by the portions of PostgreSQL that are managed by the CNP instance manager
@@ -1002,7 +1002,7 @@ Disabled by default.superuserSecret
The secret containing the superuser password. @@ -1263,6 +1263,34 @@ More info: http://kubernetes.io/docs/user-guide/annotations
NodeCertificateStatus encapsulate the status of the server certificate +of a CNP node
+ +Field | Description |
---|---|
ReplicationCertificateStatus +ReplicationCertificateStatus + |
+(Members of ReplicationCertificateStatus are embedded into this type.)
+ No description provided. |
+
nodeName [Required]+string + |
+
+ NodeName is the name of the CNP cluster using this certificate + |
+
caBundleSecretRef
[Required]CABundleSecretRef is a reference to a secret field containing the CA bundle @@ -1390,7 +1418,7 @@ to verify the openTelemetry server certificate
clientCertSecret
[Required]ClientCertSecret is the name of the secret containing the client certificate used to connect
@@ -2246,7 +2274,7 @@ by applications. Defaults to the value of the database
key.
ownerCredentialsSecret
[Required]Name of the secret containing the initial credentials for the @@ -2286,6 +2314,71 @@ case the proxies will be created in the parent group
PreProvisionedCertificate contains the data needed to supply a pre-generated certificate
+ +Field | Description |
---|---|
secretRef [Required]+string + |
+
+ SecretRef a name pointing to a secret that contains a tls.crt and tls.key + |
+
ReplicationCertificateStatus encapsulate the certificate status
+ +Field | Description |
---|---|
name [Required]+string + |
+
+ Name is the name of the certificate + |
+
hash [Required]+string + |
+
+ Hash is the hash of the configuration for which it has been generated + |
+
isReady [Required]+bool + |
+
+ Ready is true when the certificate is ready + |
+
preProvisioned [Required]+bool + |
+
+ PreProvisioned is true if the certificate is preProvisioned + |
+
barmanObjectStore
[Required]The configuration for the barman-cloud tool suite
recoveryTarget
[Required]By default, the recovery process applies all the available @@ -2479,7 +2572,7 @@ see https://pkg.go.dev/github.com/robfig/cron#hdr-CRON_Expression_Format
target
[Required]The policy to decide which instance should perform this backup. If empty,