Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/run_nightly_tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ on:

jobs:
Nightly-Pgskipper-Pipeline:
uses: Netcracker/qubership-test-pipelines/.github/workflows/pgskipper.yaml@c46738acd2481dcea8b4cd0bee83e3f4f4539f2c #v1.11.0
uses: Netcracker/qubership-test-pipelines/.github/workflows/pgskipper.yaml@3e4193378da5730d7b96d3a625d22a158d5e8372 #v1.12.0

with:
repository_name: ${{ github.repository }}
service_branch: '${{ github.head_ref || github.ref_name }}'
pipeline_branch: 'c46738acd2481dcea8b4cd0bee83e3f4f4539f2c' #this value must match the value after '@' in 'uses'
pipeline_branch: '3e4193378da5730d7b96d3a625d22a158d5e8372' #this value must match the value after '@' in 'uses'
runner_type: 'ubuntu-latest'
scope: 'nightly'
secrets:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/run_tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ jobs:
Pgskipper-Pipeline:
if: ${{ github.actor != 'dependabot[bot]' && github.event.pull_request.user.login != 'dependabot[bot]' }}
needs: Wait-for-images
uses: Netcracker/qubership-test-pipelines/.github/workflows/pgskipper.yaml@c46738acd2481dcea8b4cd0bee83e3f4f4539f2c #v1.11.0
uses: Netcracker/qubership-test-pipelines/.github/workflows/pgskipper.yaml@3e4193378da5730d7b96d3a625d22a158d5e8372 #v1.12.0
with:
repository_name: ${{ github.repository }}
service_branch: '${{ github.head_ref || github.ref_name }}'
pipeline_branch: 'c46738acd2481dcea8b4cd0bee83e3f4f4539f2c' #this value must match the value after '@' in 'uses'
pipeline_branch: '3e4193378da5730d7b96d3a625d22a158d5e8372' #this value must match the value after '@' in 'uses'
secrets:
AWS_S3_ACCESS_KEY_ID: ${{secrets.AWS_S3_ACCESS_KEY_ID}}
AWS_S3_ACCESS_KEY_SECRET: ${{secrets.AWS_S3_ACCESS_KEY_SECRET}}
Expand Down
8 changes: 4 additions & 4 deletions docs/public/features/cis-hardening.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ The following table describes the custom values for such parameters:
|3.1.4 Ensure the log file destination directory is set correctly. | `log` | `/proc/1/fd` | In case of deployment to Kubernetes or OpenShift, we should forward all the logs to `1` process. So the `fluentd` agent should be able to forward logs to Graylog. |
|3.1.5 Ensure the filename pattern for log files is set correctly. | `postgresql-%a.log` | `1` | In case of deployment to Kubernetes or OpenShift, we should forward all the logs to `stdout` of `1` process. So the `fluentd` agent should be able to forward logs to Graylog. |
|3.1.8 Ensure the maximum log file lifetime is set correctly. | `1d` | `0` | In case of deployment to Kubernetes or OpenShift, we should forward all the logs to Graylog. The logs' rotation policy is configured system-wide for Kubernetes or OpenShift and for Graylog. |
|3.1.18 Ensure 'log_connections' is enabled. | `on` | `off` | By default, we are not enabling this parameter, but it is possible to enable it. For more information, see the [Configuring PostgreSQL Parameters](/docs/public/features/cis-hardening.md#configuring-postgresql-parameters) section. |
|3.1.18 Ensure 'log_disconnections' is enabled. | `on` | `off` | By default, we are not enabling this parameter, but it is possible to enable it. For more information, see the [Configuring PostgreSQL Parameters](/docs/public/features/cis-hardening.md#configuring-postgresql-parameters) section. |
|3.1.18 Ensure 'log_connections' is enabled. | `on` | `off` | By default, we are not enabling this parameter, but it is possible to enable it. For more information, see the [Configuring PostgreSQL Parameters](#configuring-postgresql-parameters) section. |
|3.1.18 Ensure 'log_disconnections' is enabled. | `on` | `off` | By default, we are not enabling this parameter, but it is possible to enable it. For more information, see the [Configuring PostgreSQL Parameters](#configuring-postgresql-parameters) section. |
|3.1.22 Ensure 'log_line_prefix' is set correctly. | `%m` | `[%m][source=postgresql]` | In case of deployment to Kubernetes or OpenShift, we should forward all the logs to Graylog. Such `log_line_prefix` allows to filter all the PostgreSQL logs through the `source=postgresql` prefix. |
|3.1.23 Ensure 'log_hostname' is set correctly | `off` | `on` | Enabling the log_hostname setting causes the hostname of the connecting host to be logged in addition to the host's IP address for connection log messages. |
|3.1.24 Ensure 'log_timezone' is set correctly. | `us/eastern` | `UTC` | We are setting `UTC` timezone for our PostgreSQL deployment. But it is possible to change this value. |
|3.2 Ensure the PostgreSQL Audit Extension (pgAudit) is enabled - pgaudit installed. | `pgaudit` | `pg_stat_statements, pg_hint_plan, pg_cron, pgaudit, set_user` | By default, we are not enabling this parameter, but it is possible to enable it. For more information, see the [Configuring PostgreSQL Parameters](/docs/public/features/cis-hardening.md#configuring-postgresql-parameters) section. |
|4.7 Ensure the set_user extension is installed. | `set_user` | `pg_stat_statements, pg_hint_plan, pg_cron, pgaudit, set_user` | By default, we are not enabling this parameter, but it is possible to enable it. For more information, see the [Configuring PostgreSQL Parameters](/docs/public/features/cis-hardening.md#configuring-postgresql-parameters) section. |
|3.2 Ensure the PostgreSQL Audit Extension (pgAudit) is enabled - pgaudit installed. | `pgaudit` | `pg_stat_statements, pg_hint_plan, pg_cron, pgaudit, set_user` | By default, we are not enabling this parameter, but it is possible to enable it. For more information, see the [Configuring PostgreSQL Parameters](#configuring-postgresql-parameters) section. |
|4.7 Ensure the set_user extension is installed. | `set_user` | `pg_stat_statements, pg_hint_plan, pg_cron, pgaudit, set_user` | By default, we are not enabling this parameter, but it is possible to enable it. For more information, see the [Configuring PostgreSQL Parameters](#configuring-postgresql-parameters) section. |
|6.8 Ensure SSL is enabled and configured correctly. | `on` | `off` | PostgreSQL is not exposed outside of OpenShift or Kubernetes, so enabling of SSL is needless. If necessary, it is better to configure SSL on the PaaS Level (OpenShift or Kubernetes). |
|6.9 Ensure that pgcrypto extension is installed and configured correctly. | `"pgcrypto", regex:".*", regex:".*", regex:".*"` | `"pgcrypto", "1.3", NULL, "cryptographic functions"` | Pgcrypto extension is installed in PostgreSQL Docker images by default, but the extension should be activated on Logical Database level by applications. |

Expand Down
6 changes: 3 additions & 3 deletions docs/public/features/disaster-recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ This chapter describes how to deploy and use PostgreSQL in Disaster Recovery sch

Postgres Service can be deployed in the Disaster Recovery (DR) scheme with clusters in `active` and `standby` modes using the configuration described in the section Active-Standby PostgreSQL Cluster Deployment Scheme in the _Postgres Operator Maintenance_ chapter.

For more information about the DR scheme, refer to the [PostgreSQL Service Installation Procedure](/docs/public/installation.md#active-standby-deployment-in-two-kubernetes-clusters-prerequisites).
For more information about the DR scheme, refer to the [PostgreSQL Service Installation Procedure](../installation.md#active-standby-deployment-in-two-kubernetes-clusters-prerequisites).

![Postgres Service DR Scheme](/docs/public/images/arch/pg-arch-on-prem-dr.png)
![Postgres Service DR Scheme](../images/arch/pg-arch-on-prem-dr.png)

In case of maintenance, switchover, or failover, promote the standby cluster to active by changing the configuration.

Expand All @@ -21,7 +21,7 @@ Previously, this action was fully manual. Now there is a high level Site Manager
# Prerequisites

* In case of two separate Postgres services already installed on two Kubernetes or OpenShift clusters (also can be deployed on different namespaces of the one cloud)
* Configuration below can be considered as additional part for [Installation Guide](/docs/public/installation.md)
* Configuration below can be considered as additional part for [Installation Guide](../installation.md)
* **Openshift 4.X** Postgres Operator limits should be set to `limits.cpu=100m` and `limits.memory=100Mi`.
* In case if `siteManager.httpAuth.enabled` is set to `true`, TokenReview rights should be granted to `postgres-sa` ServiceAccount in PostgreSQL Operator namespace.
* `siteManager.httpAuth.smNamespace` should be specified if custom name for site-manager NS is used.
Expand Down
2 changes: 1 addition & 1 deletion docs/public/features/ldap_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ It is widely used in enterprise environments for authentication, authorization,

# Input Parameters

The required parameters to integrate LDAP with postgres is described in the [LDAP Configuration section](/docs/public/installation.md#ldap).
The required parameters to integrate LDAP with postgres is described in the [LDAP Configuration section](../installation.md#ldap).

# AD/LDAP side configuration
We have created below 2 user’s i.e.
Expand Down
2 changes: 1 addition & 1 deletion docs/public/features/pgBackRest.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ About pgBackRest [Official docs](https://pgbackrest.org/).

In our case pgBackRest included into `Sidecar` container with web server onboard and provides REST API.

![pgbackrest](/docs/public/images/features/pgbackrest.png)
![pgbackrest](../images/features/pgbackrest.png)

# How to deploy

Expand Down
8 changes: 4 additions & 4 deletions docs/public/features/query-exporter.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ However for managed databases these extensions must be enabled for database inst

## Migration from postgres-exporter

Please check [new queries format](/charts/patroni-services/query-exporter/query-exporter-queries.yaml) for query-exporter.
Please check [new queries format](../../../operator/charts/patroni-services/query-exporter/query-exporter-queries.yaml) for query-exporter.
For custom queries two sections must be used in config: `metrics` and `queries`.

Queries section includes map of queries. Each query now include next mandatory fields:
Expand Down Expand Up @@ -58,7 +58,7 @@ This feature is used for dynamically update of queries for Query Exporter by con

## How to enable this feature

Custom queries' watcher for Query Exporter should be enabled in [deployment parameters](/docs/public/installation.md#query-exporter).
Custom queries' watcher for Query Exporter should be enabled in [deployment parameters](../installation.md#query-exporter).
Namespaces list also should be defined in the deployment parameters.

There are several ways of configure necessary roles:
Expand Down Expand Up @@ -174,7 +174,7 @@ In this case query `pg_example` will be executed for all databases matching at l

In postgres-operator new watchers are created for namespaces, listed in deployment parameters.
These watchers react to Create, Update, Delete events for config maps with labels from `queryExporter.customQueries.labels` parameter and mandatory label
```query-exporter: custom-queries```. Config maps should contain metrics with custom queries for Query Exporter. Metrics must correspond to the [query exporter format](/charts/patroni-services/query-exporter/query-exporter-queries.yaml) and must meet [metric naming rules](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels)).
```query-exporter: custom-queries```. Config maps should contain metrics with custom queries for Query Exporter. Metrics must correspond to the [query exporter format](../../../operator/charts/patroni-services/query-exporter/query-exporter-queries.yaml) and must meet [metric naming rules](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels)).
After the Create event, changes from created config map will be appended to `query-exporter-queries` config map.
After the Modify event, changes from config map will be replaced in `query-exporter-queries` config map.
After the Delete event, changes from config map will be deleted from `query-exporter-queries` config map.
Expand Down Expand Up @@ -202,7 +202,7 @@ queryExporter:
- "pg_lock_tree_query"
- "connection_by_role_with_limit_query"
```
Names of the queries can be found in [query-exporter-queries](/charts/patroni-services/query-exporter/query-exporter-queries.yaml) configmap. All metrics for excluded query will be automatically excluded.
Names of the queries can be found in [query-exporter-queries](../../../operator/charts/patroni-services/query-exporter/query-exporter-queries.yaml) configmap. All metrics for excluded query will be automatically excluded.


# Self monitoring
Expand Down
Loading
Loading