Skip to content

Commit 6642621

Browse files
committed
Update doc
1 parent 5579648 commit 6642621

File tree

2 files changed

+30
-8
lines changed

2 files changed

+30
-8
lines changed

offline/docs_ubuntu_22.04.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ The following artifacts are provided:
146146

147147
## Editing the inventory
148148

149-
Copy `ansible/inventory/offline/99-static` to `ansible/inventory/offline/hosts.ini`, and remove the original.
149+
Copy `ansible/inventory/offline/99-static` to `ansible/inventory/offline/hosts.ini`, and remove the original.
150150

151151
```
152152
cp ansible/inventory/offline/99-static ansible/inventory/offline/hosts.ini
@@ -248,7 +248,7 @@ Do this for all of the instances.
248248
### Setting up Database network interfaces.
249249
* Make sure that `assethost` is present in the inventory file with the correct `ansible_host` (and `ip` values if required)
250250
* Make sure that `cassandra_network_interface` is set to the name of the network interface on which the kubenodes should talk to cassandra and on which the cassandra nodes
251-
should communicate among each other. Run `ip addr` on one of the cassandra nodes to determine the network interface names, and which networks they correspond to. In Ubuntu 22.04 for example, interface names are predictable and individualized, eg. `enp41s0`.
251+
should communicate among each other. Run `ip addr` on one of the cassandra nodes to determine the network interface names, and which networks they correspond to. In Ubuntu 22.04 for example, interface names are predictable and individualized, eg. `enp41s0`.
252252
* Similarly `elasticsearch_network_interface` and `minio_network_interface` should be set to the network interface names you want elasticsearch and minio to communicate with kubernetes with, as well.
253253

254254

@@ -295,7 +295,7 @@ ansible_user = demo
295295
cassandra_network_interface = enp1s0
296296
cassandra_backup_enabled = False
297297
cassandra_incremental_backup_enabled = False
298-
# cassandra_backup_s3_bucket =
298+
# cassandra_backup_s3_bucket =
299299
300300
[elasticsearch:vars]
301301
elasticsearch_network_interface = enp1s0
@@ -364,8 +364,8 @@ Minio and coturn services have shared secrets with the `wire-server` helm chart.
364364
./bin/offline-secrets.sh
365365
```
366366

367-
This should generate two secret files.
368-
- `./ansible/inventory/group_vars/all/secrets.yaml`
367+
This should generate two secret files.
368+
- `./ansible/inventory/group_vars/all/secrets.yaml`
369369
- `values/wire-server/secrets.yaml`
370370

371371

@@ -554,14 +554,33 @@ sed -i 's/example.com/<your-domain>/g' ./values/wire-server/values.yaml
554554
```
555555

556556
#### [Optional] Using Kubernetes managed Cassandra (K8ssandra)
557-
You can deploy K8ssandra by following these docs -
557+
You can deploy K8ssandra by following these docs -
558558
[offline/k8ssandra_setup.md](./k8ssandra_setup.md)
559559

560560
Once K8ssandra is deployed, change the host address in `values/wire-server/values.yaml` to the K8ssandra service address, i.e.
561561
```
562562
sed -i 's/cassandra-external/k8ssandra-cluster-datacenter-1-service.database/g' ./values/wire-server/values.yaml
563563
```
564564
565+
#### Update postgresql secret
566+
567+
If postgresql is part of the deployment, you need to update the postgresql credential in the `values/wire-server/secrets.yaml` file like following as the secrets are stored in the k8s environment.
568+
569+
```bash
570+
For manual deployments or troubleshooting, use the generic sync script:
571+
572+
```bash
573+
d bash
574+
# Sync PostgreSQL password from K8s secret to secrets.yaml
575+
./bin/sync-k8s-secret-to-wire-secrets.sh \
576+
wire-postgresql-external-secret \
577+
password \
578+
values/wire-server/secrets.yaml \
579+
.brig.secrets.pgPassword \
580+
.galley.secrets.pgPassword
581+
```
582+
583+
Check the details in the [Postgresql Cluster setup documentation](postgresql-cluster.md#manual-password-synchronization)
565584

566585
#### Deploying Wire-Server
567586

@@ -851,7 +870,7 @@ d kubectl uncordon kubenode1
851870
Then run:
852871

853872
```
854-
d helm upgrade --install nginx-ingress-services charts/nginx-ingress-services -f values/nginx-ingress-services/values.yaml
873+
d helm upgrade --install nginx-ingress-services charts/nginx-ingress-services -f values/nginx-ingress-services/values.yaml
855874
```
856875

857876
In order to acquire SSL certificates from letsencrypt, outgoing traffic needs from VMs needs to be enabled temporarily.
@@ -895,7 +914,7 @@ For full docs with details and explanations please see https://github.com/wireap
895914
First, make sure you have a certificate for `sftd.<yourdomain>`, or you are using letsencrypt certificate.
896915
for bring-your-own-certificate, this could be the same wildcard or SAN certificate you used at previous steps.
897916

898-
Next, copy `values/sftd/prod-values.example.yaml` to `values/sftd/values.yaml`, and change the contents accordingly.
917+
Next, copy `values/sftd/prod-values.example.yaml` to `values/sftd/values.yaml`, and change the contents accordingly.
899918

900919
* If your turn servers can be reached on their public IP by the SFT service, Wire recommends you enable cooperation between turn and SFT. add a line reading `turnDiscoveryEnabled: true` to `values/sftd/values.yaml`.
901920

offline/postgresql-cluster.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -443,6 +443,8 @@ sudo -u postgres repmgr -f /etc/repmgr/17-main/repmgr.conf node rejoin -d repmgr
443443

444444
### 🆕 Manual Standby Clone and Registration (New Node Setup)
445445

446+
Note: You can always run the ansible playbook for a clean HA postgresql cluster setup. It won't remove the existing Postgresql Wire database. It will reset the repmgr to make sure a HA postgresql cluster is available.
447+
446448
When you need to manually clone and register a standby from scratch (corrupted data, new node, or complete rebuild):
447449

448450
**Step 1: Prepare the Node**
@@ -821,6 +823,7 @@ For manual deployments or troubleshooting, use the generic sync script within th
821823
For manual deployments or troubleshooting, use the generic sync script:
822824
823825
```bash
826+
d bash
824827
# Sync PostgreSQL password from K8s secret to secrets.yaml
825828
./bin/sync-k8s-secret-to-wire-secrets.sh \
826829
wire-postgresql-external-secret \

0 commit comments

Comments
 (0)