Skip to content

Commit fef37fe

Browse files
committed
Add external database requirements documentation
1 parent e1ce6ae commit fef37fe

File tree

5 files changed

+56
-6
lines changed

5 files changed

+56
-6
lines changed

installing/acs-default-requirements.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,10 @@ include::modules/acs-requirements.adoc[leveloffset=+1]
1111
include::modules/default-requirements-central-services.adoc[leveloffset=+1]
1212

1313
include::modules/default-requirements-secured-cluster-services.adoc[leveloffset=+1]
14+
15+
include::modules/default-requirements-external-db.adoc[leveloffset=+1]
16+
17+
[role="_additional-resources"]
18+
.Additional resources
19+
20+
* xref:../installing/installing-rhacs-on-red-hat-openshift#provision-postgresql-database_install-central-ocp[Provisioning a database in your PostgreSQL instance]

installing/installing_ocp/install-central-ocp.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ include::modules/install-central-operator-external-db.adoc[leveloffset=+2]
4242
[role="_additional-resources"]
4343
.Additional resources
4444

45+
* xref:../../installing/acs-default-requirements.adoc#default-requirements-central-services_acs-default-requirements[Requirements for using an external database]
4546
* xref:../installing_ocp/install-central-config-options-ocp.adoc#install-central-config-options-ocp[Central configuration options]
4647
* xref:https://www.postgresql.org/docs/15/libpq-connect.html#LIBPQ-CONNSTRING[PostgreSQL Connection String Docs]
4748

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/acs-default-requirements.adoc
4+
:_mod-docs-content-type: CONCEPT
5+
[id="external-db-req_{context}"]
6+
= Requirements for using an external database
7+
8+
[role="_abstract"]
9+
You can configure {product-title} Central services to use an external PostgreSQL-compatible database for data persistence instead of deploying its own database pod.
10+
11+
[IMPORTANT]
12+
====
13+
When you use an external database, note the following guidance:
14+
15+
* The database infrastructure manages persistent storage for Central DB. Therefore, do not configure persistence settings for the Central DB within the {product-title-short} installation configuration.
16+
* Red Hat supports the configuration and operation of {product-title-short} Central connected to that database. However, support for database-specific operations such as backup and restore, performance diagnosis and potential tuning, software and version upgrades, and high availability/disaster recovery operation falls under third-party support. Manually upgrading or customizing your database outside of a full platform upgrade also limits supportability.
17+
====
18+
19+
If you select an external database, your database instance and the user connecting to it must meet the requirements listed in the following sections.
20+
21+
[discrete]
22+
== Database type and version
23+
The database must be a PostgreSQL-compatible database that supports PostgreSQL 13 or later.
24+
25+
[discrete]
26+
== User permissions
27+
The user account that Central uses to connect to the database must be a `superuser` account with connection rights to the database and the following permissions:
28+
29+
* `Usage` and `Create` permissions on the schema.
30+
* `Select`, `Insert`, `Update`, and `Delete` permissions on all tables in the schema.
31+
* `Usage` permissions on all sequences in the schema.
32+
* The ability to create and delete databases as a `superuser`.
33+
34+
[discrete]
35+
== Connection string
36+
Central connects to the external database by using a connection string, which must be in `keyword=value` format. The connection string should specify details such as the host, port, database name, user, and SSL/TLS mode. For example, `host=<host> port=5432 database=stackrox user=stackrox sslmode=verify-ca`.
37+
38+
[NOTE]
39+
====
40+
Connections through *PgBouncer* are not supported.
41+
====
42+
43+
[discrete]
44+
== CA certificates
45+
If your external database uses a certificate issued by a private or untrusted Certificate Authority (CA), you might need to specify the CA certificate so that Central trusts the database certificate. You can add this by using a TLS block in the Central custom resource configuration.

modules/install-central-operator-external-db.adoc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,12 @@ For more information about {product-title-short} databases, see the link:https:/
1818

1919
.Prerequisites
2020
* You must be using {ocp} {ocp-supported-version} or later. For more information about supported {ocp} versions, see the link:https://access.redhat.com/articles/7045053[Red Hat Advanced Cluster Security for Kubernetes Support Matrix].
21-
* You must have a database in your database instance that supports PostgreSQL 13 or 15 and a user with the following permissions:
22-
** Connection rights to the database.
23-
** `Usage` and `Create` on the schema.
24-
** `Select`, `Insert`, `Update`, and `Delete` on all tables in the schema.
25-
** `Usage` on all sequences in the schema.
2621
+
2722
[NOTE]
2823
====
2924
Postgres 15 is the recommended and supported version. Red{nbsp}Hat has deprecated the support for Postgres 13 and will remove it in the newer versions of {product-title-short}.
3025
====
26+
* For detailed requirements, see "Requirements for using an external database" in the additional resources section.
3127

3228
.Procedure
3329
. On the {ocp} web console, go to the *Operators* -> *Installed Operators* page.

upgrading/upgrade-operator.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ To roll back an Operator upgrade, you must perform the steps described in one of
4040

4141
[NOTE]
4242
====
43-
If you are rolling back from {product-title-short} 4.0, you can only rollback to the latest patch release version of {product-title-short} 3.74.
43+
* If you are rolling back from {product-title-short} 4.0, you can only roll back to the latest patch release version of {product-title-short} 3.74.
44+
* If you are rolling back from {product-title-short} 4.8 or newer, you can only roll back to the latest patch release version of {product-title-short} 4.8.
4445
====
4546

4647
include::modules/rollback-operator-upgrades-cli.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)