Backport doc changes from 1.0-SNAPSHOT not included in development-0.9
This can be shown by a:
git checkout development-0.9
git pull
git fetch
git diff origin/development doc/content
diff --git a/doc/content/en/01-introduction/04-components-of-the-stack/_index.md b/doc/content/en/01-introduction/04-components-of-the-stack/_index.md
index e6564ba1..1d02eee2 100755
--- a/doc/content/en/01-introduction/04-components-of-the-stack/_index.md
+++ b/doc/content/en/01-introduction/04-components-of-the-stack/_index.md
@@ -1,7 +1,7 @@
---
title: "Components of the Stack"
weight: 4
-url: intro/stack-components
+url: intro/stackcomponents
---
Running Postgres in production requires "a RedHat" of PostgreSQL. A curated set of open source components built,
@@ -147,7 +147,7 @@ as part of the [Helm chart]({{% relref "03-production-installation/02-installati
and you can follow the steps there to set the Helm chart needed parameters so that monitoring integration works as expected.
Please, read and review the steps and notes for a successful installation.
-Please note that Prometheus will be removed from the Helm chart at some point, so the actual instructions will change and become obsolete.
+Please note that Prometheus is to be removed from the Helm chart at some point, so the actual instructions will change and be obsolete.
### Grafana integration
diff --git a/doc/content/en/01-introduction/05-licensing/_index.md b/doc/content/en/01-introduction/05-licensing/_index.md
index b53a0391..8c80c3a8 100755
--- a/doc/content/en/01-introduction/05-licensing/_index.md
+++ b/doc/content/en/01-introduction/05-licensing/_index.md
@@ -12,5 +12,5 @@ We respect others who switch to or are directly built as source-available softwa
follow this approach. We love the concept of GitLab’s stewardship, and in the same spirit, we
promise you that StackGres will always be open source software.
-Contact us at StackGres at OnGres dot com if you want a trial or commercial license that does not
+Contact us at StackGres at OnGres doc com if you want a trial or commercial license that does not
contain the GPL clauses.
diff --git a/doc/content/en/02-demo-quickstart/03-create-your-first-cluster/_index.md b/doc/content/en/02-demo-quickstart/03-create-your-first-cluster/_index.md
index b5af2d99..bad8fc94 100755
--- a/doc/content/en/02-demo-quickstart/03-create-your-first-cluster/_index.md
+++ b/doc/content/en/02-demo-quickstart/03-create-your-first-cluster/_index.md
@@ -112,7 +112,7 @@ To clean up the resources created by the demo run:
```
helm uninstall --keep-history simple
-helm get hooks simple | kubectl delete --ignore-not-found -f -
+helm get hooks -n connectivity-5f2bb6bf connectivity | kubectl delete --ignore-not-found -n connectivity-5f2bb6bf -f -
helm uninstall simple
```
diff --git a/doc/content/en/03-production-installation/01-pre-requisites/_index.md b/doc/content/en/03-production-installation/01-pre-requisites/_index.md
index 2dad8bfb..fe35dca7 100755
--- a/doc/content/en/03-production-installation/01-pre-requisites/_index.md
+++ b/doc/content/en/03-production-installation/01-pre-requisites/_index.md
@@ -9,7 +9,7 @@ url: install/prerequisites
As explained in the [Demo section]({{% relref "02-demo-quickstart/01-setting-up-the-environment" %}}), for setting up the Operator and StackGres Cluster, you need to have an
environment on top of which it needs to request the necessary resources.
-StackGres is able to run on any Kubernetes installation from 1.11 to 1.17 version, to maintain support for some version, please follow up the open discussion at" [#666](https://gitlab.com/ongresinc/stackgres/-/issues/666).
+StackGres is able to run on any Kubernetes installation from 1.11 to 1.17 version, support for newer version, please follow up the open discussion at [#666](https://gitlab.com/ongresinc/stackgres/-/issues/666).
## Backups
@@ -19,18 +19,18 @@ In the next section, you'll be able to see how to done this [via Helm]({{% relre
### Storage
-StackGres support Backups with the following storage options:
+StackGres support Backups support the following storage options:
* AWS S3
* Google CLoud Storage
* Azure Blob Storage
-> Examples are using [MinIO](https://min.io/) service as a S3 compatible service for
+> By default, examples are using [MinIO](https://min.io/) service as a S3 compatible service for
> quick setups on local Kubernetes Cluster. Although, for production setups, StackGres Team recommends
> emphatically to pick a Storage as a Service for this purpose.
-All the related configuration for the storage, is under `configurations.backupconfig.storage` section in your [Stackgres Cluster configuration file](https://gitlab.com/ongresinc/stackgres/-/blob/development/stackgres-k8s/install/helm/stackgres-cluster/values.yaml#L100-148).
+All the related configuration for the storage, is under backupconfig/storage section in your [Stackgres Cluster configuration file](https://gitlab.com/ongresinc/stackgres/-/blob/development/stackgres-k8s/install/helm/stackgres-cluster/values.yaml#L100-148).
```yaml
configurations:
@@ -90,6 +90,8 @@ Some manual steps are required in order to achieve such integration.
**Using the UI:** Click on Grafana > Dashboard > Manage > Select Postgres exporter dashboard > Copy URL
+ Or using the value returned by the next [script]().
+
3. Create and copy/paste Grafana API token:
**Using the UI:** Grafana > Configuration > API Keys > Add API key (for viewer) > Copy key value
@@ -103,3 +105,7 @@ We recommend to disable all non production options in a production environment.
``` yaml
nonProductionOptions: {}
```
+
+The use of MinIO in production is not considered a bad practice but we recommend to install MinIO
+ separately to in order to be able to change version independently from the StackGres cluster helm
+ chart.
\ No newline at end of file
diff --git a/doc/content/en/03-production-installation/03-post-installation/_index.md b/doc/content/en/03-production-installation/03-post-installation/_index.md
index 95d7612a..fce253c7 100755
--- a/doc/content/en/03-production-installation/03-post-installation/_index.md
+++ b/doc/content/en/03-production-installation/03-post-installation/_index.md
@@ -10,6 +10,8 @@ StackGres publish a Web UI that can be accessed by pointing to port 443 with DNS
`stackgres-operator.stackgres.svc`. It is not recommended to expose this Web UI to public
internet without protecting it with some secure access bridge.
+A good fit for this purpose would be using the [ingress nginx project](https://github.com/kubernetes/ingress-nginx/) by configuring an [external OAUTH authentication](https://kubernetes.github.io/ingress-nginx/examples/auth/oauth-external-auth/).
+
You can expose the UI using the bellow command:
```
diff --git a/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/01-kubectl/_index.md b/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/01-kubectl/_index.md
index 775b5558..d182d43a 100644
--- a/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/01-kubectl/_index.md
+++ b/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/01-kubectl/_index.md
@@ -2,6 +2,4 @@
title: Connecting with Kubectl
weight: 1
url: administration/cluster/connection/kubectl
----
-
-This section is currently empty and the documentation development is in progress.
\ No newline at end of file
+---
\ No newline at end of file
diff --git a/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/02-port-forward/_index.md b/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/02-port-forward/_index.md
index 19c75b90..6159192b 100644
--- a/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/02-port-forward/_index.md
+++ b/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/02-port-forward/_index.md
@@ -1,7 +1,5 @@
---
title: Port Forward
weight: 2
-url: administration/cluster/connection/port-forward
----
-
-This section is currently empty and the documentation development is in progress.
\ No newline at end of file
+url: administration/cluster/connection/portForward
+---
\ No newline at end of file
diff --git a/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/03-load-balancer/_index.md b/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/03-load-balancer/_index.md
index 6ab9edc8..a117d6d1 100644
--- a/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/03-load-balancer/_index.md
+++ b/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/03-load-balancer/_index.md
@@ -1,7 +1,5 @@
---
title: Load Balancer
weight: 3
-url: administration/cluster/connection/load-balancer
----
-
-This section is currently empty and the documentation development is in progress.
\ No newline at end of file
+url: administration/cluster/connection/loadbalancer
+---
\ No newline at end of file
diff --git a/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/04-exposed-services/_index.md b/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/04-exposed-services/_index.md
index aefca357..4bce2a94 100644
--- a/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/04-exposed-services/_index.md
+++ b/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/04-exposed-services/_index.md
@@ -2,6 +2,4 @@
title: Exposed Services
weight: 4
url: administration/cluster/connection/services
----
-
-This section is currently empty and the documentation development is in progress.
\ No newline at end of file
+---
\ No newline at end of file
diff --git a/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/05-dns/_index.md b/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/05-dns/_index.md
index d0cffe0c..18baa2db 100644
--- a/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/05-dns/_index.md
+++ b/doc/content/en/04-administration-guide/02-connecting-to-the-cluster/05-dns/_index.md
@@ -2,6 +2,4 @@
title: DNS
weight: 5
url: administration/cluster/connection/dns
----
-
-This section is currently empty and the documentation development is in progress.
\ No newline at end of file
+---
\ No newline at end of file
diff --git a/doc/content/en/04-administration-guide/07-create-a-more-advanced-cluster/_index.md b/doc/content/en/04-administration-guide/07-create-a-more-advanced-cluster/_index.md
index ca1077bc..52d94b18 100644
--- a/doc/content/en/04-administration-guide/07-create-a-more-advanced-cluster/_index.md
+++ b/doc/content/en/04-administration-guide/07-create-a-more-advanced-cluster/_index.md
@@ -175,4 +175,4 @@ helm install --namespace stackgres stackgres-operator \
--set-string grafana.password=${grafana_admin_cred} \
--set-string adminui.service.type=LoadBalancer \
{{< download-url >}}/helm-operator.tgz
-```
\ No newline at end of file
+```
diff --git a/doc/content/en/04-administration-guide/14-distributed-log-cluster/01-Basics/_index.md b/doc/content/en/04-administration-guide/14-distributed-log-cluster/01-Basics/_index.md
index 0f7419f9..b47a8657 100644
--- a/doc/content/en/04-administration-guide/14-distributed-log-cluster/01-Basics/_index.md
+++ b/doc/content/en/04-administration-guide/14-distributed-log-cluster/01-Basics/_index.md
@@ -10,4 +10,4 @@ This section is currently empty and the documentation development is in progress
## Query Distributed Log Cluster
-This section is currently empty and the documentation development is in progress.
\ No newline at end of file
+This section is currently empty and the documentation development is in progress.
diff --git a/doc/content/en/05-crd-reference/02-backups/_index.md b/doc/content/en/05-crd-reference/02-backups/_index.md
index 4b9b6e71..901aee62 100755
--- a/doc/content/en/05-crd-reference/02-backups/_index.md
+++ b/doc/content/en/05-crd-reference/02-backups/_index.md
@@ -137,26 +137,8 @@ status:
| Property | Required | Updatable |Type | Default | Description |
|:---------------------------------------|----------|-----------|:--------|:----------|:------------|
-| [baseBackups](#base-backups) | | ✓ | object | | {{< crd-field-description SGBackup.status.sgBackupConfig.baseBackups >}} |
| [storage](#storage-configuration) | | ✓ | object | | {{< crd-field-description SGBackup.status.sgBackupConfig.storage >}} |
-## Base Backups
-
-| Property | Required | Updatable |Type | Default | Description |
-|:-----------------------------------------|----------|-----------|:--------|:----------|:------------|
-| retention | | ✓ | integer | 5 | {{< crd-field-description SGBackup.status.sgBackupConfig.baseBackups.retention >}} |
-| cronSchedule | | ✓ | string | 05:00 UTC | {{< crd-field-description SGBackup.status.sgBackupConfig.baseBackups.cronSchedule >}} |
-| compression | | ✓ | string | lz4 | {{< crd-field-description SGBackup.status.sgBackupConfig.baseBackups.compression >}} |
-| [performance](#base-backup-performance) | | ✓ | object | | {{< crd-field-description SGBackup.status.sgBackupConfig.baseBackups.performance >}} |
-
-## Base Backup Performance
-
-| Property | Required | Updatable |Type | Default | Description |
-|:---------------------------------------|----------|-----------|:--------|:----------|:------------|
-| maxDiskBandwitdh | | ✓ | integer | unlimited | {{< crd-field-description SGBackup.status.sgBackupConfig.baseBackups.performance.maxDiskBandwitdh >}} |
-| maxNetworkBandwitdh | | ✓ | integer | unlimited | {{< crd-field-description SGBackup.status.sgBackupConfig.baseBackups.performance.maxNetworkBandwitdh >}} |
-| uploadDiskConcurrency | | ✓ | integer | 1 | {{< crd-field-description SGBackup.status.sgBackupConfig.baseBackups.performance.uploadDiskConcurrency >}} |
-
## Storage Configuration
| Property | Required | Updatable | Type | Default | Description |
Edited by Matteo Melli