Skip to content

Commit 1eb5c3a

Browse files
committed
Split up internal and external db docs
1 parent c0ecd56 commit 1eb5c3a

File tree

4 files changed

+61
-60
lines changed

4 files changed

+61
-60
lines changed

_includes/configuration.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ options for database configuration:
4242
- Configure the appliance to use an internal PostgreSQL database
4343
- Configure the appliance to use an external PostgreSQL database
4444

45-
{% include configuration-db.md %}
45+
{% include internal-configuration-db.md %}
46+
{% include external-configuration-db.md %}
4647

4748
### Configure Messaging
4849

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
#### Configuring an External Database
2+
3+
Based on your setup, you will choose to configure the appliance to use
4+
an external PostgreSQL database. For example, we can only have one
5+
database in a single region. However, a region can be segmented into
6+
multiple zones, such as database zone, user interface zone, and
7+
reporting zone, where each zone provides a specific function. The
8+
appliances in these zones must be configured to use an external
9+
database.
10+
11+
The `postgresql.conf` file used with {{ site.data.product.title_short }} databases requires
12+
specific settings for correct operation. For example, it must correctly
13+
reclaim table space, control session timeouts, and format the PostgreSQL
14+
server log for improved system support. It is recommended that external databases use a
15+
`postgresql.conf` file based on the standard file used by the
16+
{{ site.data.product.title_short }} appliance.
17+
18+
Ensure you configure the settings in the `postgresql.conf` to suit your
19+
system. For example, customize the `shared_buffers` setting according to
20+
the amount of real storage available in the external system hosting the
21+
PostgreSQL instance. In addition, depending on the aggregate number of
22+
appliances expected to connect to the PostgreSQL instance, it may be
23+
necessary to alter the `max_connections` setting.
24+
25+
**Note:**
26+
27+
- {{ site.data.product.title_short }} requires PostgreSQL version 10.
28+
29+
- Because the `postgresql.conf` file controls the operation of all
30+
databases managed by a single instance of PostgreSQL, do not mix
31+
{{ site.data.product.title_short }} databases with other types of databases in a single
32+
PostgreSQL instance.
33+
34+
1. Start the appliance and open a terminal console.
35+
36+
2. Enter the `appliance_console` command. The {{ site.data.product.title_short }} appliance
37+
summary screen displays.
38+
39+
3. Press **Enter** to manually configure settings.
40+
41+
4. Select **Configure Application** from the menu.
42+
43+
5. Choose **Create Region in External Database** for the database location.
44+
45+
6. Enter the database hostname or IP address when prompted.
46+
47+
7. Enter the database name or leave blank for the default
48+
(`vmdb_production`).
49+
50+
8. Enter the database username or leave blank for the default (`root`).
51+
52+
9. Enter the chosen database user’s password.
53+
54+
10. Confirm the configuration if prompted.
55+
56+
{{ site.data.product.title_short }} will then configure the external database.

_includes/configuration-db.md renamed to _includes/internal-configuration-db.md

Lines changed: 1 addition & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ disks; installation will fail if the disks are not blank.
3434
All {{ site.data.product.title_short }} appliances in a multi-region
3535
deployment must use the same key.
3636

37-
6. Choose **Create Internal Database** for the database location.
37+
6. Choose **Create Internal Database** for the database location.
3838

3939
In the **Configure Messaging** menu, select **Make No messaging changes**. If you see ```Configuration failed: Internal database require a volume mounted at /var/lib/pgsql. Please add an unpartitioned disk and try again.``` message, then ensure to add a second disk for the database per instructions as defined above.
4040

@@ -89,60 +89,3 @@ disks; installation will fail if the disks are not blank.
8989
{{ site.data.product.title_short }} then configures the internal database. This takes a few
9090
minutes. After the database is created and initialized, you can log in
9191
to {{ site.data.product.title_short }}.
92-
93-
#### Configuring an External Database
94-
95-
Based on your setup, you will choose to configure the appliance to use
96-
an external PostgreSQL database. For example, we can only have one
97-
database in a single region. However, a region can be segmented into
98-
multiple zones, such as database zone, user interface zone, and
99-
reporting zone, where each zone provides a specific function. The
100-
appliances in these zones must be configured to use an external
101-
database.
102-
103-
The `postgresql.conf` file used with {{ site.data.product.title_short }} databases requires
104-
specific settings for correct operation. For example, it must correctly
105-
reclaim table space, control session timeouts, and format the PostgreSQL
106-
server log for improved system support. It is recommended that external databases use a
107-
`postgresql.conf` file based on the standard file used by the
108-
{{ site.data.product.title_short }} appliance.
109-
110-
Ensure you configure the settings in the `postgresql.conf` to suit your
111-
system. For example, customize the `shared_buffers` setting according to
112-
the amount of real storage available in the external system hosting the
113-
PostgreSQL instance. In addition, depending on the aggregate number of
114-
appliances expected to connect to the PostgreSQL instance, it may be
115-
necessary to alter the `max_connections` setting.
116-
117-
**Note:**
118-
119-
- {{ site.data.product.title_short }} requires PostgreSQL version 10.
120-
121-
- Because the `postgresql.conf` file controls the operation of all
122-
databases managed by a single instance of PostgreSQL, do not mix
123-
{{ site.data.product.title_short }} databases with other types of databases in a single
124-
PostgreSQL instance.
125-
126-
1. Start the appliance and open a terminal console.
127-
128-
2. Enter the `appliance_console` command. The {{ site.data.product.title_short }} appliance
129-
summary screen displays.
130-
131-
3. Press **Enter** to manually configure settings.
132-
133-
4. Select **Configure Application** from the menu.
134-
135-
5. Choose **Create Region in External Database** for the database location.
136-
137-
6. Enter the database hostname or IP address when prompted.
138-
139-
7. Enter the database name or leave blank for the default
140-
(`vmdb_production`).
141-
142-
8. Enter the database username or leave blank for the default (`root`).
143-
144-
9. Enter the chosen database user’s password.
145-
146-
10. Confirm the configuration if prompted.
147-
148-
{{ site.data.product.title_short }} will then configure the external database.

quickstart_openstack_provider_guide/_topics/configuration-quick.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ database. For instructions on how to configure an external database
3131
instead, see [Configuring an External
3232
Database](https://access.redhat.com/documentation/en/red-hat-cloudforms/4.1/single/installing-red-hat-cloudforms-on-red-hat-enterprise-linux-openstack-platform#configuring_an_external_database).
3333

34-
{% include configuration-db.md %}
34+
{% include internal-configuration-db.md %}
35+
{% include external-configuration-db.md %}
3536

3637
### Configuring General {{ site.data.product.title_short }} Settings
3738

0 commit comments

Comments
 (0)