Skip to content

Commit

Permalink
Merge pull request #1805 from qahmed1998/QA-minor-changes-gcp
Browse files Browse the repository at this point in the history
Minor updates to Installing on Google Compute Engine topic

(cherry picked from commit c64feef)
  • Loading branch information
agrare authored and Fryguy committed Aug 22, 2024
1 parent 3f023dc commit 4eb94c9
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 41 deletions.
18 changes: 9 additions & 9 deletions _includes/configuration-db-external.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#### Configuring an External Database

Based on your setup, you will choose to configure the appliance to use
an external PostgreSQL database. For example, we can only have one
Based on your setup, you need to configure the appliance to use
an external PostgreSQL database. For example, you can only have one
database in a single region. However, a region can be segmented into
multiple zones, such as database zone, user interface zone, and
reporting zone, where each zone provides a specific function. The
Expand All @@ -19,20 +19,20 @@ Ensure you configure the settings in the `postgresql.conf` to suit your
system. For example, customize the `shared_buffers` setting according to
the amount of real storage available in the external system hosting the
PostgreSQL instance. In addition, depending on the aggregate number of
appliances expected to connect to the PostgreSQL instance, it may be
appliances that are expected to connect to the PostgreSQL instance, it might be
necessary to alter the `max_connections` setting.

**Note:**

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

- `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.
- `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.

Use the following steps to configure an external PostgreSQL database:

1. Start the appliance and open a terminal console.

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

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

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

10. Confirm the configuration if prompted.

{{ site.data.product.title_short }} will then configure the external database.
{{ site.data.product.title_short }} configures an external database.
7 changes: 1 addition & 6 deletions _includes/configuration-db-internal.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ recommends adding the disk before starting the appliance.
{{ site.data.product.title_short }} only supports installing of an internal VMDB on blank
disks; installation will fail if the disks are not blank.

</div>

1. Start the appliance and open a terminal console.

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

**Note:**

All {{ site.data.product.title_short }} appliances in a multi-region
deployment must use the same key.
**Note**: All {{ site.data.product.title_short }} appliances in a multi-region deployment must use the same key.

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

Expand Down
31 changes: 13 additions & 18 deletions _includes/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,41 +20,39 @@ Configure the appliance by using the internal appliance console.

3. Press `Enter` to manually configure settings.

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

5. Follow the prompts to make the changes.

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

**Note:**

The {{ site.data.product.title_short }} appliance console automatically logs out
after five minutes of inactivity.
**Note**: The {{ site.data.product.title_short }} appliance console automatically logs out after five minutes of inactivity.

### Configuring a Database

{% include configuration-db.md %}

### Configure Messaging

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

**Note:** You can only have one kafka broker per region
**Note:** You can only have one Kafka broker per region.

1. You can either configure the current appliance as a kafka broker, or point the
appliance to an existing external kafka broker.
1. You can either configure the current appliance as a Kafka broker, or point the
appliance to an existing external Kafka broker.

Select the appropriate option either
**Configure this appliance as a messaging server** or
**Connect to an external messaging system**
to connect to an external kafka broker. You will be asked to fill in the
required **Message Client Parameters** like IP address and username/password.
to connect to an external Kafka broker. Fill in the
required **Message Client Parameters**, such as IP address, username and password.

2. Select **Proceed**. `appliance_console` applies the configuration that you requested.

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

**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`
**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`.

### Configuring a Worker Appliance

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

**Note:**

All {{ site.data.product.title_short }} appliances in a multi-region deployment
must use the same key.
**Note**: All {{ site.data.product.title_short }} appliances in a multi-region deployment must use the same key.

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

Expand Down
3 changes: 1 addition & 2 deletions _includes/initial-login-changepw.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
Change your password to ensure more private and secure access to
{{ site.data.product.title_short }}.

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

2. Click **Update Password** beneath the **Username** and **Password**
text fields.
Expand Down
10 changes: 4 additions & 6 deletions _includes/initial-login.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
Once {{ site.data.product.title_short }} is installed, you can log in and perform
administration tasks.

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

1. Browse to the URL for the login screen. (<https://xx.xx.xx.xx> on
the virtual machine instance)

2. Enter the default credentials (Username: **admin** | Password:
**smartvm**) for the initial login.
2. Enter the default credentials as listed for the initial login.
- **Username**: **admin**
- **Password**: **smartvm**

3. Click **Login**.

0 comments on commit 4eb94c9

Please sign in to comment.