Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
amitsagtani97 committed Oct 10, 2024
1 parent 5c8894d commit 9b7f604
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 44 deletions.
7 changes: 0 additions & 7 deletions ansible/setup-offline-sources.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,6 @@
tags:
- containers-helm
- containers
- name: Copy other containers
unarchive:
src: ../containers-other.tar
dest: /opt/assets
tags:
- containers-other
- containers
- copy:
src: files/serve-assets.service
dest: /etc/systemd/system/serve-assets.service
Expand Down
2 changes: 1 addition & 1 deletion offline/ci.sh
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,6 @@ tar cf containers-helm.tar containers-helm

echo "docker_ubuntu_repo_repokey: '${fingerprint}'" > ansible/inventory/offline/group_vars/all/key.yml

tar czf assets.tgz debs-jammy.tar binaries.tar containers-adminhost containers-helm.tar containers-other.tar containers-system.tar ansible charts values bin
tar czf assets.tgz debs-jammy.tar binaries.tar containers-adminhost containers-helm.tar containers-system.tar ansible charts values bin

echo "Done"
66 changes: 33 additions & 33 deletions offline/coturn.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This document explains how to install Coturn on a newly deployed Wire-Server ins
This presumes you already have:

* Followed the [single Hetzner machine installation](single_hetzner_machine_installation.md) guide or otherwise have a machine ready to accept a Wire-Server deployment.
* Have followed the [Wire-Server installation](docs_ubuntu_22.04.md) guide and have Wire-Server deployed and working (with Restund as the TURN server, which is currently the default, and will be replaced by Coturn as part of this process).
* Have followed the [Wire-Server installation](docs_ubuntu_22.04.md) guide and have Wire-Server deployed and working.

## Plan.

Expand All @@ -22,8 +22,7 @@ To setup Coturn, we will:
* Configure the Coturn labels to select on which machine(s) it will run.
* Configure the SFT labels for Coturn and SFT to share a port range.
* Configure the port redirection in Nftables.
* Change the Wire-Server configuration to use Coturn instead of Restund.
* Disable Restund.
* Change the Wire-Server configuration to use Coturn.
* Install Coturn using Helm.
* Verify that Coturn is working.

Expand Down Expand Up @@ -239,7 +238,7 @@ Note: This section is only relevant if you are running Wire-Server/Coturn/SFT be

We must configure the port redirection in Nftables to allow traffic to reach Coturn and SFT.

Calling and TURN services (Coturn, Restund, SFT) require being reachable on a range of ports used to transmit the calling data.
Calling and TURN services (Coturn, SFT) require being reachable on a range of ports used to transmit the calling data.

Both SFT and Coturn both want to use the same port range, therefore predicting which node is using which port range ahead of time requires dividing/configuring port ranges in advance.

Expand Down Expand Up @@ -335,9 +334,9 @@ sudo systemctl restart nftables

```

## Change the Wire-Server configuration to use Coturn instead of Restund.
## Change the Wire-Server configuration to use Coturn.

We must change the Wire-Server configuration to use Coturn instead of Restund.
We must change the Wire-Server configuration to use Coturn.

First, we must locate what the "external" IP address of the machine is.

Expand Down Expand Up @@ -393,35 +392,10 @@ d helm upgrade --install wire-server ./charts/wire-server --timeout=15m0s --valu

```

## Disable Restund.

As we are no longer using Restund, we should now disable it entirely.

We do this by editing the `hosts.ini` file:

Edit `ansible/inventory/offline/hosts.ini`, and comment out the restund section by adding `#` at the beginning of each line :

```
[restund]
# ansnode1
# ansnode2
```

Then connect to each ansnode and do:

```bash
sudo service restund stop
```

And check it is stopped with:

```bash
sudo service restund status
```

## Install Coturn with Helm.

We have now configured our Coturn `value` and `secret` files, configured `wire-server` to use Coturn, and disabled Restund.
We have now configured our Coturn `value` and `secret` files, configured `wire-server` to use Coturn.

It is time to actually deploy Coturn.

Expand Down Expand Up @@ -499,4 +473,30 @@ These are the additional steps to ensure a smooth transition:
2. Change the `turnStatic` call configuration in the `values/wire-server/values.yaml` file to use the Coturn IPs instead of the Restund IPs.
3. Re-deploy the Wire-Server chart to apply the new configuration.
4. Wait at least 24 hours for all clients to retrieve the new configuration.
5. Once you are sure all clients have migrated to Coturn, you can disable Restund as described in this guide.
5. Once you are sure all clients have migrated to Coturn, you can disable Restund as described in this guide below.

## Disable Restund.

As we are no longer using Restund, we should now disable it entirely.

We do this by editing the `hosts.ini` file:

Edit `ansible/inventory/offline/hosts.ini`, and comment out the restund section by adding `#` at the beginning of each line :

```
[restund]
# ansnode1
# ansnode2
```

Then connect to each ansnode and do:

```bash
sudo service restund stop
```

And check it is stopped with:

```bash
sudo service restund status
```
3 changes: 0 additions & 3 deletions offline/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,6 @@ The following is a list of important artifacts which are provided:
- `containers-helm.tar`
These are the container images our charts (and charts we depend on) refer to.
Also come as tarballs, and are seeded like the system containers.
- `containers-other.tar`
These are other container images, not deployed inside k8s. Currently, only
contains Restund.
- `debs-*.tar`
This acts as a self-contained dump of all packages required to install
kubespray, as well as all other packages that are installed by ansible
Expand Down

0 comments on commit 9b7f604

Please sign in to comment.