Skip to content

Commit aa381db

Browse files
mpfusterjpe442
authored andcommitted
update wem install instructions
1 parent 00219d0 commit aa381db

File tree

1 file changed

+58
-9
lines changed
  • advocacy_docs/supported-open-source/warehousepg/wem/installing

1 file changed

+58
-9
lines changed

advocacy_docs/supported-open-source/warehousepg/wem/installing/wem.mdx

Lines changed: 58 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Install the WarehousePG Enterprise Manager (WEM) package on your designated host
2323
sudo dnf install -y whpg-enterprise-manager
2424
```
2525

26-
## Configuring WEM
26+
## Configuring WEM options
2727

2828
Edit the configuration file `/etc/wem/wem.conf` and configure the following parameters:
2929

@@ -45,18 +45,53 @@ Edit the configuration file `/etc/wem/wem.conf` and configure the following para
4545
LOKI_URL="http://loki.hostname:3100"
4646
```
4747

48-
1. Configure the WEM portal details. For example:
48+
49+
1. To enable the AI Assistant for query writing and optimization, configure the `ANTHROPIC_API_KEY` parameter. Note that this requires an active Anthropic account.
50+
51+
1. To enable centralized alert handling and notifications with Alertmanager, configure the `ALERTMANAGER_URL` parameter to point to your Alertmanager endpoint.
52+
53+
1. Optionally, set the parameters `WEM_EXPORTER_LOG_LEVEL`, `WEM_EXPORTER_REMOTE_WRITE_INTERVAL`, and `WEM_EXPORTER_REMOTE_WRITE_TIMEOUT` for advanced configuration settings.
54+
55+
56+
### Configuring WEM portal access
57+
58+
Define how you access the WEM portal and establish the initial administrative credentials by configuring the following parameters in your environment file:
59+
60+
```ini
61+
WEM_HOST=wem-hostname
62+
WEM_USER=admin
63+
WEM_PORT=8080
64+
```
65+
66+
To configure the administrator password, choose one of the three following methods:
67+
68+
1. **Option 1: Interactive setup** This is the simplest method for manual installations. You do not need to modify the configuration file manually; the system will prompt you for the password and handle the internal setup.
69+
70+
Run the setup command and follow the prompt to enter your desired password:
71+
72+
```bash
73+
wem setup --interactive
74+
```
75+
76+
1. **Option 2: Static configuration** Use this method to define your administrative password directly within the configuration file.
4977

5078
```ini
51-
WEM_HOST=wem-hostname
52-
WEM_USER=admin
53-
WEM_PASSWORD=admin123
54-
WEM_PORT=8080
79+
WEM_ADMIN_PASSWORD=admin123
5580
```
5681

57-
1. To enable the AI Assistant for query writing and optimization, configure the `ANTHROPIC_API_KEY` parameter. Note that this requires an active Anthropic account.
82+
1. **Option 3: File-based configuration** For enhanced security, manage the password via an external file. This is ideal for automated deployments or keeping secrets out of main config files.
5883

59-
1. Optionally, set the parameters `WEM_EXPORTER_LOG_LEVEL`, `WEM_EXPORTER_REMOTE_WRITE_INTERVAL`, and `WEM_EXPORTER_REMOTE_WRITE_TIMEOUT` for advanced configuration settings.
84+
1. Provide a password by creating a file containing your password. Then, set the following parameter in your configuration:
85+
86+
```bash
87+
echo "your-secure-password" > /etc/wem/admin.pw
88+
```
89+
90+
Point WEM to the file:
91+
92+
```bash
93+
WEM_ADMIN_PASSWORD_FILE=/etc/wem/admin.pw
94+
```
6095

6196
## Starting the WEM service
6297

@@ -67,10 +102,24 @@ Run the following commands to enable and start the WEM service on your dedicated
67102
systemctl start wem
68103
```
69104

70-
Verify that the service is running:
105+
Verify that the service is running and active:
71106

72107
```bash
73108
sudo systemctl status wem
74109
```
75110

111+
## Verifying the installation
112+
113+
After starting the service, use these diagnostic tools to ensure all WEM components are communicating correctly and the environment is healthy:
114+
115+
- Connectivity Check: Run the verification tool to test the portal's link to the backend:
116+
117+
```bash
118+
wem setup --verify
119+
```
120+
121+
- System Health Audit: Perform a comprehensive "doctor" check to identify potential configuration errors, missing dependencies, or connectivity issues:
76122

123+
```bash
124+
wem doctor
125+
```

0 commit comments

Comments
 (0)