Merge pull request #1497 from EnterpriseDB/release/2021-06-17

Release: 2021-06-17
Former-commit-id: ddf9139

Author: josh-heyer

.github/workflows/deploy-develop.yml

@@ -7,6 +7,10 @@ jobs:
   build-deploy:
     runs-on: ubuntu-latest
     steps:
+    - name: Cleanup disk
+      uses: curoky/[email protected]
+      with:
+        retain: 'python,node'      
     - uses: actions/checkout@v2
       with:
         ref: develop

.github/workflows/deploy-main.yml

@@ -7,6 +7,10 @@ jobs:
   build-deploy:
     runs-on: ubuntu-latest
     steps:
+    - name: Cleanup disk
+      uses: curoky/[email protected]
+      with:
+        retain: 'python,node'
     - uses: actions/checkout@v2
       with:
         ref: main

.github/workflows/update-pdfs-on-develop.yml

@@ -11,6 +11,10 @@ jobs:
   build-pdfs:
     runs-on: ubuntu-20.04
     steps:
+    - name: Cleanup disk
+      uses: curoky/[email protected]
+      with:
+        retain: 'python,node'
     - uses: actions/checkout@v2
       with:
         ref: develop

README.md

@@ -4,7 +4,7 @@
 ![Deploy Develop to Netlify](https://github.com/EnterpriseDB/docs/workflows/Deploy%20Develop%20to%20Netlify/badge.svg)
 ![Update PDFs on Develop](https://github.com/EnterpriseDB/docs/workflows/Update%20PDFs%20on%20Develop/badge.svg)
 
-This repo contains the React/Gatsby application that powers the EDB Docs website. The site pulls [Markdown](https://www.markdownguide.org/) content from several repos in a process called "sourcing", and then renders it all into high-performance markup. You can install the application on your local computer for easy editing, viewing, and eventually publishing to the GitHub repo.
+This repo contains the React/Gatsby application that powers [the EDB Docs website](https://www.enterprisedb.com/docs/). The site pulls [Markdown](https://www.markdownguide.org/) content from several repos in a process called "sourcing", and then renders it all into high-performance markup. You can install the application on your local computer for easy editing, viewing, and eventually publishing to the GitHub repo.
 
 ## MacOS Installation
 
@@ -140,25 +140,24 @@ This frontmatter is an automatically generated list of redirects for Docs 1.0 to
 
 If you need to setup a redirect from Docs 1.0 to Docs 2.0 manually, this is the place to do it. If the `legacyRedirectsGenerated` frontmatter does not include the redirect you need, you should add it here.
 
-# Advocacy Docs (left over from previous README, needs attention)
 
-Advocacy doc files are in [advocacy_docs/getting-started](https://github.com/EnterpriseDB/docs/tree/master/advocacy_docs/getting-started)
+# MDX Format
 
-New docs need a `.mdx` suffix to be used by Gatsby.
+Documentation must be formatted as an [MDX file](https://www.gatsbyjs.com/docs/mdx/writing-pages/) with the `.mdx` extension. MDX is a superset of [Markdown](https://www.markdownguide.org/).
 
-## frontmatter
+## Frontmatter
 
-Each document requires a `frontmatter` section at the top with a title. This looks like this:
+Each document requires a [YAML](https://yaml.org) frontmatter section at the top with a title:
 
 ```
 ---
 title: Title of page
 ---
 ```
 
-The title can be in quotes, but they are not needed unless you want an apostrophe in there. There also needs to be a space after `title:`
+If the title contains [special characters](https://stackoverflow.com/questions/19109912/yaml-do-i-need-quotes-for-strings-in-yaml), it will need to be quoted. There also needs to be a space after `title:`
 
-In addition to `title`, there is also the option of adding `navTitle` and `description` to look like this:
+In addition to `title`, frontmatter may optionally include `navTitle` and `description`:
 
 ```
 ---
@@ -176,26 +175,66 @@ The `description` is used in cards as well.
 
 All of these files use Markdown for styling. The options for what can be done can be seen [here](https://github.com/EnterpriseDB/docs/blob/master/advocacy_docs/playground/1/01_examples/index.mdx)
 
-## Ordering of files
+## Admonitions (Notes, Warnings, etc.)
 
-The items in the left nav are sorted alphabetically by file name. This can be done with a numerical prefix. The titles of each page are used for the names in the left nav.
+If you need to draw attention to information, consider using an admonition:
+
+```
+!!! Note Optional title
+    This is text you'd like the reader to notice.
+```
 
-## Content submission
+Admonitions begin with the `!!!` signifier. Next comes a (case-insensitive) type which is one of:
 
-To add content to this site, changes must be submitted as a PR. There are two options for this:
+* important
+* tip
+* note
+* caution
+* warning
 
-Option 1: locally
+There are several [aliases](https://github.com/elviswolcott/remark-admonitions#usage):
+
+* info => important
+* success => tip
+* secondary => note
+* danger => warning
+* seealso => note
+* hint => tip
+
+Titles are optional. If you don't include one, the admonition will default to the type name ("Important", "Tip", etc.).
+
+The body of the admonition is indented 4 spaces. It should line up with the first letter of the admonition type. Alternatively, fenced admonitions that begin and end with `!!!` lines are supported:
+
+```
+!!! Tip
+Use fenced admonitions to avoid space counting.
+!!!
+```
 
-1. Clone repo
-2. Make a new branch
-3. Add commits to branch and push to github
-4. Create a new PR on github
+For examples of what you can do with admonitions, see [this demo](https://github.com/EnterpriseDB/docs/blob/main/advocacy_docs/playground/1/01_examples/admonitions.mdx).
 
-Option 2: on github
+## Ordering of files
 
-1. Edit a file on github
-2. Submit changes as a PR on a new branch
+The items in the left nav are sorted alphabetically by file name. This can be done with a numerical prefix. The titles of each page are used for the names in the left nav.
 
 ## Search
 
 Content is indexed for search when the production site builds.
+
+## Contributions
+
+[We love feedback!](https://www.enterprisedb.com/docs/community/contributing/)
+
+To contribute content to this site submit as a pull request (PR). There are two options for this:
+
+Option 1: locally
+
+1. [Clone](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) this repository.
+2. [Make a new branch.](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging)
+3. Add commits to branch and [push to GitHub](https://git-scm.com/book/en/v2/Git-Branching-Remote-Branches).
+4. Create a new PR on GitHub.
+
+Option 2: on GitHub
+
+1. Edit a file on GitHub.
+2. Submit changes as a PR on a new branch.

advocacy_docs/kubernetes/cloud_native_postgresql/api_reference.mdx

@@ -503,13 +503,13 @@ SecretsResourceVersion is the resource versions of the secrets managed by the op
 
 Name                     | Description                                                          | Type  
 ------------------------ | -------------------------------------------------------------------- | ------
-`superuserSecretVersion  ` | The resource version of the "postgres" user secret                   - *mandatory*  | string
-`replicationSecretVersion` | The resource version of the "streaming_replication" user secret      - *mandatory*  | string
-`applicationSecretVersion` | The resource version of the "app" user secret                        - *mandatory*  | string
+`superuserSecretVersion  ` | The resource version of the "postgres" user secret                   | string
+`replicationSecretVersion` | The resource version of the "streaming_replication" user secret      | string
+`applicationSecretVersion` | The resource version of the "app" user secret                        | string
 `caSecretVersion         ` | Unused. Retained for compatibility with old versions.                | string
-`clientCaSecretVersion   ` | The resource version of the PostgreSQL client-side CA secret version - *mandatory*  | string
-`serverCaSecretVersion   ` | The resource version of the PostgreSQL server-side CA secret version - *mandatory*  | string
-`serverSecretVersion     ` | The resource version of the PostgreSQL server-side secret version    - *mandatory*  | string
+`clientCaSecretVersion   ` | The resource version of the PostgreSQL client-side CA secret version | string
+`serverCaSecretVersion   ` | The resource version of the PostgreSQL server-side CA secret version | string
+`serverSecretVersion     ` | The resource version of the PostgreSQL server-side secret version    | string
 
 <a id='StorageConfiguration'></a>
 

advocacy_docs/kubernetes/cloud_native_postgresql/installation_upgrade.mdx

@@ -11,12 +11,12 @@ product: 'Cloud Native Operator'
 The operator can be installed like any other resource in Kubernetes,
 through a YAML manifest applied via `kubectl`.
 
-You can install the [latest operator manifest](https://get.enterprisedb.io/cnp/postgresql-operator-1.5.0.yaml)
+You can install the [latest operator manifest](https://get.enterprisedb.io/cnp/postgresql-operator-1.5.1.yaml)
 as follows:
 
 ```sh
 kubectl apply -f \
-  https://get.enterprisedb.io/cnp/postgresql-operator-1.5.0.yaml
+  https://get.enterprisedb.io/cnp/postgresql-operator-1.5.1.yaml
 ```
 
 Once you have run the `kubectl` command, Cloud Native PostgreSQL will be installed in your Kubernetes cluster.

advocacy_docs/kubernetes/cloud_native_postgresql/interactive_demo.mdx

@@ -65,7 +65,7 @@ You will see one node called `minikube`. If the status isn't yet "Ready", wait f
 Now that the Minikube cluster is running, you can proceed with Cloud Native PostgreSQL installation as described in the ["Installation"](installation_upgrade.md) section:
 
 ```shell
-kubectl apply -f https://get.enterprisedb.io/cnp/postgresql-operator-1.5.0.yaml
+kubectl apply -f https://get.enterprisedb.io/cnp/postgresql-operator-1.5.1.yaml
 __OUTPUT__
 namespace/postgresql-operator-system created
 customresourcedefinition.apiextensions.k8s.io/backups.postgresql.k8s.enterprisedb.io created
@@ -245,7 +245,7 @@ curl -sSfL \
   sudo sh -s -- -b /usr/local/bin
 __OUTPUT__
 EnterpriseDB/kubectl-cnp info checking GitHub for latest tag
-EnterpriseDB/kubectl-cnp info found version: 1.5.0 for v1.5.0/linux/x86_64
+EnterpriseDB/kubectl-cnp info found version: 1.5.1 for v1.5.1/linux/x86_64
 EnterpriseDB/kubectl-cnp info installed /usr/local/bin/kubectl-cnp
 ```
 

advocacy_docs/kubernetes/cloud_native_postgresql/operator_capability_levels.mdx

@@ -90,6 +90,9 @@ workload requirements, based on what the underlying Kubernetes environment
 can offer. This implies choosing a particular storage class in
 a public cloud environment or fine-tuning the generated PVC through a
 PVC template in the CR's `storage` parameter.
+The [`cnp-bench`](https://github.com/EnterpriseDB/cnp-bench) open source
+project can be used to benchmark both the storage and the database prior to
+production.
 
 ### Replica configuration
 
@@ -173,17 +176,16 @@ Kubernetes API Server and the operator itself.
 ### Cluster's certification authority
 
 The operator automatically creates a certification authority for every PostgreSQL
-cluster, which is used to issue and renew TLS certificates for the authentication
-of streaming replication standby servers and applications (instead of passwords).
-The operator will use the Certification Authority to sign every cluster
-certification authority. Certificates can be issued with the `cnp` plugin
-for `kubectl`.
+cluster, which is used to issue and renew TLS certificates for clients' authentication,
+including streaming replication standby servers (instead of passwords).
+Certificates can be issued with the `cnp` plugin for `kubectl`.
 
 ### TLS connections
 
 The operator transparently and natively supports TLS/SSL connections
 to encrypt client/server communications for increased security using the
 cluster's certification authority.
+Support for custom server certificates is available through secrets.
 
 ### Certificate authentication for streaming replication
 

advocacy_docs/kubernetes/cloud_native_postgresql/operator_conf.mdx

@@ -21,15 +21,19 @@ namespace as a Kubernetes `Deployment` called `postgresql-operator-controller-ma
 !!! Note
     In the examples below we assume the default name and namespace for the operator deployment.
 
-The behavior of the operator can be customized through a `ConfigMap` that
+The behavior of the operator can be customized through a `ConfigMap`/`Secret` that
 is located in the same namespace of the operator deployment and with
 `postgresql-operator-controller-manager-config` as the name.
 
 !!! Important
-    Any change to the config map will not be automatically detected by the operator,
+    Any change to the config's `ConfigMap`/`Secret` will not be automatically detected by the operator,
     - and as such, it needs to be reloaded (see below). Moreover, changes only
     apply to the resources created after the configuration is reloaded.
 
+!!! Important
+    The operator first processes the ConfigMap values and then the Secret’s, in this order.
+    As a result, if a parameter is defined in both places, the one in the Secret will be used.
+
 ## Available options
 
 The operator looks for the following environment variables to be defined in the config map:
@@ -65,6 +69,24 @@ data:
   EDB_LICENSE_KEY: <YOUR_EDB_LICENSE_KEY_HERE>
 ```
 
+## Defining an operator secret
+
+The example below customizes the behavior of the operator, by defining a
+default license key.
+
+```yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  name: postgresql-operator-controller-manager-config
+  namespace: postgresql-operator-system
+type: Opaque
+data:
+  EDB_LICENSE_KEY: <YOUR_BASE64_ENCODED_EDB_LICENSE_KEY_HERE>
+```
+
+## Restarting the operator to reload configs
+
 For the change to be effective, you need to recreate the operator pods to
 reload the config map. If you have installed the operator on Kubernetes
 using the manifest you can do that by issuing:

advocacy_docs/kubernetes/cloud_native_postgresql/release_notes.mdx

@@ -6,6 +6,15 @@ product: 'Cloud Native Operator'
 
 History of user-visible changes for Cloud Native PostgreSQL.
 
+## Version 1.5.1
+
+**Release date:** 17 June 2021
+
+Change: 
+
+- Fix a bug with CRD validation preventing auto-update with Operator Deployments on Red Hat OpenShift
+- Allow passing operator's configuration using a Secret.
+
 ## Version 1.5.0
 
 **Release date:** 11 June 2021

merge_sources/kubernetes/cloud_native_postgresql/interactive_demo.mdx

@@ -65,7 +65,7 @@ You will see one node called `minikube`. If the status isn't yet "Ready", wait f
 Now that the Minikube cluster is running, you can proceed with Cloud Native PostgreSQL installation as described in the ["Installation"](installation_upgrade.md) section:
 
 ```shell
-kubectl apply -f https://get.enterprisedb.io/cnp/postgresql-operator-1.5.0.yaml
+kubectl apply -f https://get.enterprisedb.io/cnp/postgresql-operator-1.5.1.yaml
 __OUTPUT__
 namespace/postgresql-operator-system created
 customresourcedefinition.apiextensions.k8s.io/backups.postgresql.k8s.enterprisedb.io created
@@ -245,7 +245,7 @@ curl -sSfL \
   sudo sh -s -- -b /usr/local/bin
 __OUTPUT__
 EnterpriseDB/kubectl-cnp info checking GitHub for latest tag
-EnterpriseDB/kubectl-cnp info found version: 1.5.0 for v1.5.0/linux/x86_64
+EnterpriseDB/kubectl-cnp info found version: 1.5.1 for v1.5.1/linux/x86_64
 EnterpriseDB/kubectl-cnp info installed /usr/local/bin/kubectl-cnp
 ```
 

product_docs/convert.sh

@@ -1,3 +1,3 @@
-#!/bin/sh
+#!/bin/zsh
 
-for i in content/**/*.rst ; do python3 scripts/pre_pandoc_script.py ${i%}; echo \"$i\" && pandoc --wrap=none $i -f rst -t gfm --atx-headers -o ${i%.*}.mdx ; done ; python3 scripts/post_pandoc_script.py
+for i in content/**/*.rst ; do python3 scripts/pre_pandoc_script.py ${i%}; echo \"$i\" && pandoc --wrap=none $i -f rst -t gfm --markdown-headings=atx -o ${i%.*}.mdx ; done ; python3 scripts/post_pandoc_script.py

product_docs/convert_pem_online_help.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+cd "${0%/*}"
+
+./convert.sh
+
+rsync -a --delete content_build/pem/ docs/pem/8.1.0/pem_online_help/
+
+rm docs/pem/8.1.0/pem_online_help/release_notes*.mdx
+
+cd ..
+
+node scripts/normalize/titleRefs.js "product_docs/docs/pem/8.1.0/pem_online_help/**/*.mdx"
+node scripts/normalize/slashEscapedLessThan.js "product_docs/docs/pem/8.1.0/pem_online_help/**/*.mdx"
+node scripts/normalize/markdown.js "product_docs/docs/**/*.mdx" "product_docs/docs/pem/8.1.0/**/*.mdx"

product_docs/docs/pem/8.0/images/sql_profiler.png

@@ -111,4 +111,5 @@ Use the following steps to enable the plugin:
     -   Select `Open trace`… to open an existing trace.
     -   Select `Delete trace(s)`… to delete one or more traces.
     -   Select `View scheduled trace(s)`… to review a list of scheduled traces.
-![Screen Shot 2021-05-06 at 4 58 23 PM](https://user-images.githubusercontent.com/5795880/117365029-b1687700-ae8c-11eb-850e-aa51c69abc54.png)
+
+    ![Server -> SQL Profiler menu](../images/sql_profiler.png)

product_docs/docs/pem/8.0/pem_sqlprofiler/01_installing_the_sql_profiler_plugin.mdx

@@ -1,6 +1,27 @@
 ---
 navTitle: Enterprise Features Guide
 title: "PEM Enterprise Features Guide"
+
+navigation:
+
+  - 01_what's_new
+  - 02_pem_query_tool
+  - 03_pem_schema_diff_tool
+  - 04_pem_erd_tool
+  - 05_performance_monitoring_and_management
+  - 15_performance_diagnostic
+  - 06_capacity_manager
+  - 07_audit_manager
+  - 08_log_manager
+  - 09_sql_profiler
+  - 10_tuning_wizard
+  - 11_postgres_expert
+  - 17_monitoring_BDR_nodes
+  - 13_monitoring_failover_manager
+  - 14_monitoring_xdb_replication_cluster
+  - 12_reports
+  - 16_reference
+  
 ---
 
 This guide will acquaint you with the tools and wizards that are built into the Postgres Enterprise Manager (PEM) web interface that make it easier for you to monitor and manage your system.