Skip to content

Commit c0ecd56

Browse files
committed
Add back the internal database configuration docs
At some point the internal database configuration appears to have been lost from the docs. Move the external database instructions to the configuration-db include so that the instructions show up on all of the installation guides.
1 parent bbeebb4 commit c0ecd56

File tree

2 files changed

+59
-56
lines changed

2 files changed

+59
-56
lines changed

_includes/configuration-db.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,3 +89,60 @@ 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.

_includes/configuration.md

Lines changed: 2 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -39,64 +39,10 @@ environment. Before using {{ site.data.product.title_short }}, configure the dat
3939
options for it; {{ site.data.product.title_short }} provides the following two
4040
options for database configuration:
4141

42+
- Configure the appliance to use an internal PostgreSQL database
4243
- Configure the appliance to use an external PostgreSQL database
4344

44-
#### Configuring an External Database
45-
46-
Based on your setup, you will choose to configure the appliance to use
47-
an external PostgreSQL database. For example, we can only have one
48-
database in a single region. However, a region can be segmented into
49-
multiple zones, such as database zone, user interface zone, and
50-
reporting zone, where each zone provides a specific function. The
51-
appliances in these zones must be configured to use an external
52-
database.
53-
54-
The `postgresql.conf` file used with {{ site.data.product.title_short }} databases requires
55-
specific settings for correct operation. For example, it must correctly
56-
reclaim table space, control session timeouts, and format the PostgreSQL
57-
server log for improved system support. It is recommended that external databases use a
58-
`postgresql.conf` file based on the standard file used by the
59-
{{ site.data.product.title_short }} appliance.
60-
61-
Ensure you configure the settings in the `postgresql.conf` to suit your
62-
system. For example, customize the `shared_buffers` setting according to
63-
the amount of real storage available in the external system hosting the
64-
PostgreSQL instance. In addition, depending on the aggregate number of
65-
appliances expected to connect to the PostgreSQL instance, it may be
66-
necessary to alter the `max_connections` setting.
67-
68-
**Note:**
69-
70-
- {{ site.data.product.title_short }} requires PostgreSQL version 10.
71-
72-
- Because the `postgresql.conf` file controls the operation of all
73-
databases managed by a single instance of PostgreSQL, do not mix
74-
{{ site.data.product.title_short }} databases with other types of databases in a single
75-
PostgreSQL instance.
76-
77-
1. Start the appliance and open a terminal console.
78-
79-
2. Enter the `appliance_console` command. The {{ site.data.product.title_short }} appliance
80-
summary screen displays.
81-
82-
3. Press **Enter** to manually configure settings.
83-
84-
4. Select **Configure Application** from the menu.
85-
86-
5. Choose **Create Region in External Database** for the database location.
87-
88-
6. Enter the database hostname or IP address when prompted.
89-
90-
7. Enter the database name or leave blank for the default
91-
(`vmdb_production`).
92-
93-
8. Enter the database username or leave blank for the default (`root`).
94-
95-
9. Enter the chosen database user’s password.
96-
97-
10. Confirm the configuration if prompted.
98-
99-
{{ site.data.product.title_short }} will then configure the external database.
45+
{% include configuration-db.md %}
10046

10147
### Configure Messaging
10248

0 commit comments

Comments
 (0)