Skip to content

Commit c64feef

Browse files
authored
Merge pull request #1805 from qahmed1998/QA-minor-changes-gcp
Minor updates to Installing on Google Compute Engine topic
2 parents 64a4d6d + 41a0b02 commit c64feef

File tree

5 files changed

+28
-41
lines changed

5 files changed

+28
-41
lines changed

_includes/configuration-db-external.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#### Configuring an External Database
22

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
3+
Based on your setup, you need to configure the appliance to use
4+
an external PostgreSQL database. For example, you can only have one
55
database in a single region. However, a region can be segmented into
66
multiple zones, such as database zone, user interface zone, and
77
reporting zone, where each zone provides a specific function. The
@@ -19,20 +19,20 @@ Ensure you configure the settings in the `postgresql.conf` to suit your
1919
system. For example, customize the `shared_buffers` setting according to
2020
the amount of real storage available in the external system hosting the
2121
PostgreSQL instance. In addition, depending on the aggregate number of
22-
appliances expected to connect to the PostgreSQL instance, it may be
22+
appliances that are expected to connect to the PostgreSQL instance, it might be
2323
necessary to alter the `max_connections` setting.
2424

2525
**Note:**
2626

27-
- {{ site.data.product.title_short }} requires PostgreSQL version 13.
27+
- {{ site.data.product.title_short }} requires PostgreSQL version 13.
2828

29-
- `postgresql.conf` controls the operation of all databases managed by the
30-
PostgreSQL instance, therefore it is not recommended to run other databases
31-
on this PostgreSQL instance.
29+
- `postgresql.conf` controls the operation of all databases managed by the PostgreSQL instance, therefore it is not recommended to run other databases on this PostgreSQL instance.
30+
31+
Use the following steps to configure an external PostgreSQL database:
3232

3333
1. Start the appliance and open a terminal console.
3434

35-
2. Enter the `appliance_console` command. The appliance console summary screen will be displayed.
35+
2. Enter the `appliance_console` command. The appliance console summary screen is displayed.
3636

3737
3. Press **Enter** to manually configure settings.
3838

@@ -51,4 +51,4 @@ necessary to alter the `max_connections` setting.
5151

5252
10. Confirm the configuration if prompted.
5353

54-
{{ site.data.product.title_short }} will then configure the external database.
54+
{{ site.data.product.title_short }} configures an external database.

_includes/configuration-db-internal.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ recommends adding the disk before starting the appliance.
88
{{ site.data.product.title_short }} only supports installing of an internal VMDB on blank
99
disks; installation will fail if the disks are not blank.
1010

11-
</div>
12-
1311
1. Start the appliance and open a terminal console.
1412

1513
2. Enter the `appliance_console` command. The {{ site.data.product.title_short }} appliance
@@ -29,10 +27,7 @@ disks; installation will fail if the disks are not blank.
2927
first appliance. For worker and multi-region setups, use this
3028
option to copy key from another appliance.
3129

32-
**Note:**
33-
34-
All {{ site.data.product.title_short }} appliances in a multi-region
35-
deployment must use the same key.
30+
**Note**: All {{ site.data.product.title_short }} appliances in a multi-region deployment must use the same key.
3631

3732
6. Choose **Create Internal Database** for the database location.
3833

_includes/configuration.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -20,41 +20,39 @@ Configure the appliance by using the internal appliance console.
2020

2121
3. Press `Enter` to manually configure settings.
2222

23-
4. Press the number for the item you want to change, and press `Enter`.
23+
4. Press the number for the item that you want to change, and press `Enter`.
2424
The options for your selection are displayed.
2525

2626
5. Follow the prompts to make the changes.
2727

2828
6. Press `Enter` to accept a setting where applicable.
2929

30-
**Note:**
31-
32-
The {{ site.data.product.title_short }} appliance console automatically logs out
33-
after five minutes of inactivity.
30+
**Note**: The {{ site.data.product.title_short }} appliance console automatically logs out after five minutes of inactivity.
3431

3532
### Configuring a Database
3633

3734
{% include configuration-db.md %}
3835

3936
### Configure Messaging
4037

41-
Configuring messaging is required for appliance setup. It is recommended to configure the broker on the same appliance where your database is configured
38+
Configuring messaging is required for the appliance setup. It is recommended to configure the broker on the same appliance where your database is configured
4239

43-
**Note:** You can only have one kafka broker per region
40+
**Note:** You can only have one Kafka broker per region.
4441

45-
1. You can either configure the current appliance as a kafka broker, or point the
46-
appliance to an existing external kafka broker.
42+
1. You can either configure the current appliance as a Kafka broker, or point the
43+
appliance to an existing external Kafka broker.
4744

4845
Select the appropriate option either
4946
**Configure this appliance as a messaging server** or
5047
**Connect to an external messaging system**
51-
to connect to an external kafka broker. You will be asked to fill in the
52-
required **Message Client Parameters** like IP address and username/password.
48+
to connect to an external Kafka broker. Fill in the
49+
required **Message Client Parameters**, such as IP address, username and password.
50+
51+
2. Select **Proceed**. `appliance_console` applies the configuration that you requested.
5352

54-
2. Select **Proceed** and appliance_console will apply the configuration that you have
55-
requested then restart evmserverd to pick up the changes.
53+
3. Restart `evmserverd` to pick up the changes.
5654

57-
**Note:** It is recommended to use your Fully Qualified Domain Name (FQDN) as the messaging hostname rather than `localhost`, ensure that a resolvable and reachable non-localhost name entry is present in `/etc/hosts`
55+
**Note:** Use your Fully Qualified Domain Name (FQDN) as the messaging hostname rather than `localhost`, ensure that a resolvable and reachable non-localhost name entry is present in `/etc/hosts`.
5856

5957
### Configuring a Worker Appliance
6058

@@ -80,10 +78,7 @@ has a region configured with a database and messaging.
8078
remote machine**. For worker and multi-region setups, use this
8179
option to copy the security key from another appliance.
8280

83-
**Note:**
84-
85-
All {{ site.data.product.title_short }} appliances in a multi-region deployment
86-
must use the same key.
81+
**Note**: All {{ site.data.product.title_short }} appliances in a multi-region deployment must use the same key.
8782

8883
6. Choose **Join Region in External Database** for the database location.
8984

_includes/initial-login-changepw.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
Change your password to ensure more private and secure access to
22
{{ site.data.product.title_short }}.
33

4-
1. Browse to the URL for the login screen. (<https://xx.xx.xx.xx> on
5-
the virtual machine instance)
4+
1. Browse to the URL for the login screen. For example, URL should be `https://xx.xx.xx.xx`.
65

76
2. Click **Update Password** beneath the **Username** and **Password**
87
text fields.

_includes/initial-login.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
Once {{ site.data.product.title_short }} is installed, you can log in and perform
22
administration tasks.
33

4-
Log in to {{ site.data.product.title_short }} for the first time after installing by:
4+
1. Browse to the URL for the login screen. For example, URL should be `https://xx.xx.xx.xx`
55

6-
1. Browse to the URL for the login screen. (<https://xx.xx.xx.xx> on
7-
the virtual machine instance)
8-
9-
2. Enter the default credentials (Username: **admin** | Password:
10-
**smartvm**) for the initial login.
6+
2. Enter the default credentials as listed for the initial login.
7+
- **Username**: **admin**
8+
- **Password**: **smartvm**
119

1210
3. Click **Login**.

0 commit comments

Comments
 (0)