Merge branch 'main' into reformat_drawio

Author: julialongtin

CODEOWNERS

@@ -0,0 +1 @@
+*	@wireapp/backend @wireapp/platform-engineering @wireapp/customerops

build/Pipfile

@@ -13,6 +13,7 @@ mike = "2.1.3"
 mkdocs-get-deps = "0.2.0"
 mkdocs-macros-plugin = "1.3.7"
 mkdocs-material-extensions = "1.3.1"
+mkdocs-mermaid2-plugin = "1.2.1"
 
 [requires]
 python_version = "3.11"

build/Pipfile.lock

@@ -13,8 +13,7 @@ nav:
       - How to plan an installation: how-to/install/planning.md
       - Version requirements: how-to/install/version-requirements.md
       - Dependencies on operator’s machine: how-to/install/dependencies.md
-      - How to install kubernetes (Demo): how-to/install/kubernetes.md
-      - How to install wire-server using Helm (Demo): how-to/install/helm.md
+      - How to install Wire in a box (Demo): how-to/install/demo-wiab.md
       - Introduction: how-to/install/prod-intro.md
       - How to install kubernetes and databases: how-to/install/ansible-VMs.md
       - How to configure AWS services: how-to/install/aws-prod.md
@@ -144,6 +143,7 @@ theme:
 
 plugins:
   - search
+  - mermaid2
   - minify:
       minify_html: true
       minify_js: true
@@ -179,8 +179,12 @@ markdown_extensions:
   - pymdownx.snippets
   - pymdownx.tasklist:
       custom_checkbox: true
-  - pymdownx.superfences
   - pymdownx.tabbed
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
 
 extra:
   version:

mkdocs.yml

@@ -98,4 +98,8 @@
 - [Test an ingress is working from inside the cluster](manuals.md#test-an-ingress-is-working-from-inside-the-cluster)
 - [Load an image into containerd in an offline/airgapped environment](manuals.md#load-an-image-into-containerd-in-an-offlineairgapped-environment)
 
+## 12. Migration
+
+- [Migrate team features](migrate-team-features.md)
+
 <!-- TODO: .. include:: administration/redis.rst -->

src/how-to/administrate/README.md

@@ -0,0 +1,60 @@
+# Migrate to new team features
+
+Release of [wire-server-5.12](https://docs.wire.com/latest/changelog/changelog.html#2025-03-06-chart-release-5120) introduces a new data storage format for team features. To migrate to the new format, we have added a [tool](https://github.com/wireapp/helm-charts/tree/main/charts/migrate-features) called `migrate-features` to our deployment bundle, which will have to be run, after upgrading to a `wire-server` release past 5.12. Migration has to be run only once.
+If you do not perform this migration after deploying to a release past `5.12`, your team settings will be in an inconsistent state.
+
+## Configuration
+
+The values of the chart `migrate-features/values.yaml` already contains the necessary configuration options.
+
+```yaml
+job:
+  name: migrate-features
+  restartPolicy: Never
+  backoffLimit: 4
+  cassandraHost: cassandra-external # Replace with your Cassandra service name `kubectl get svc -n default`
+  cassandraPort: 9042
+  galleyKeyspace: galley
+```
+
+Most configuration values can remain as they are, but ensure the `cassandraHost` value is correct by running:
+
+```sh
+kubectl get svc -n default` # assuming the services are in the default namespace
+```
+
+If your cassandra installation differs from the standard `wire-server-deploy` setup, a hostname or an IP address of one of the cassandra nodes can be supplied here.
+
+## Run the migration job
+
+When this chart is installed, it sets up a `migrate-feature` job in the `default` namespace:
+
+```sh
+helm install default ./charts/migrate-features
+```
+
+Before running the helm command, make sure the `migrate-features` chart is available in the charts directory, if not please [download](https://github.com/wireapp/helm-charts/tree/main/charts/migrate-features) the chart or copy it from one of our latest artifact.
+
+## Troubleshoot and monitoring
+
+After the helm installation check if the job is running
+
+```sh
+kubectl get jobs -n default
+```
+
+When the job is complete, you will see a `migrate-features` job with a `COMPLETIONS` status of `1/1`. This may take some time. If the job does not complete, check the pod logs or Kubernetes events.
+
+To check the pod events run:
+
+```sh
+kubectl describe job migrate-features -n default
+```
+
+To check the logs run:
+
+```sh
+kubectl logs job/migrate-features -n default
+```
+
+While the migration tool is running, team features are going to operate in read-only mode for the team that is currently being migrated. After migration, the new storage is going to be used. No other action should be required on the part of instance operators besides running the migration tool.

src/how-to/administrate/migrate-team-features.md

@@ -13,45 +13,43 @@
 - [Dependencies on operator’s machine](dependencies.md)
   - [(Alternative) Installing dependencies using Direnv and Nix](dependencies.md#alternative-installing-dependencies-using-direnv-and-nix)
 
-## 4. Installing Kubernetes (Demo)
-- [How to install kubernetes (Demo)](kubernetes.md)
-  - [How to set up your hosts.ini file](kubernetes.md#how-to-set-up-your-hosts-ini-file)
-  - [Passwordless authentication](kubernetes.md#passwordless-authentication)
-  - [Minio setup](kubernetes.md#minio-setup)
-  - [How to install kubernetes](kubernetes.md#how-to-install-kubernetes)
-
-## 5. Installing Wire-Server using Helm (Demo)
-- [How to install wire-server using Helm (Demo)](helm.md)
-  - [Introduction](helm.md#introduction)
-  - [Prerequisites](helm.md#prerequisites)
-  - [How to start installing charts from wire](helm.md#how-to-start-installing-charts-from-wire)
-  - [Watching changes as they happen](helm.md#watching-changes-as-they-happen)
-  - [How to install in-memory databases and external components](helm.md#how-to-install-in-memory-databases-and-external-components)
-  - [How to install wire-server itself](helm.md#how-to-install-wire-server-itself)
-
-## 6. Introduction
+## 4. How to install Wire in a box (Demo)
+- [Demo Wire-in-a-Box Deployment Guide](demo-wiab.md)
+  - [Introduction](demo-wiab.md#introduction)
+  - [What will be installed?](demo-wiab.md#what-will-be-installed)
+  - [Wire Demo installation diagram](demo-wiab.md#diagram)
+  - [Installation Guide](demo-wiab.md#installation-guide)
+  - [Deployment requirements](demo-wiab.md#deployment-requirements)
+  - [Getting Started](demo-wiab.md#getting-started)
+  - [Deployment Flow](demo-wiab.md#deployment-flow)
+  - [General Tips](demo-wiab.md#general-tips)
+  - [Trying Things Out](demo-wiab.md#trying-things-out)
+  - [Troubleshooting](demo-wiab.md#troubleshooting)
+  - [Cleaning/Uninstalling Wire-in-a-Box](demo-wiab.md#cleaninguninstalling-wire-in-a-box)
+
+## 5. Introduction
 - [Introduction](prod-intro.md)
   - [What will be installed by following these parts?](prod-intro.md#what-will-be-installed-by-following-these-parts)
   - [What will not be installed?](prod-intro.md#what-will-not-be-installed)
   - [What will not be installed by default?](prod-intro.md#what-will-not-be-installed-by-default)
   - [Getting support](prod-intro.md#getting-support)
   - [Next steps for high-available production installation](prod-intro.md#next-steps-for-high-available-production-installation)
 
-## 7. Installing Kubernetes and Databases
+## 6. Installing Kubernetes and Databases
 - [How to install kubernetes and databases](ansible-VMs.md)
   - [Introduction](ansible-VMs.md#introduction)
   - [Assumptions](ansible-VMs.md#assumptions)
   - [Preparing to run ansible](ansible-VMs.md#preparing-to-run-ansible)
   - [Running ansible to install software on your machines](ansible-VMs.md#running-ansible-to-install-software-on-your-machines)
 
-## 8. Configuring AWS Services
+## 7. Configuring AWS Services
 - [How to configure AWS services](aws-prod.md)
   - [Introduction](aws-prod.md#introduction)
   - [Using real AWS services for SNS](aws-prod.md#using-real-aws-services-for-sns)
   - [Using real AWS services for SES / SQS](aws-prod.md#using-real-aws-services-for-ses-sqs)
   - [Using real AWS services for S3](aws-prod.md#using-real-aws-services-for-s3)
 
-## 9. Installing Wire-Server using Helm
+## 8. Installing Wire-Server using Helm
 - [How to install wire-server using Helm](helm-prod.md)
   - [Introduction](helm-prod.md#introduction)
   - [Prerequisites](helm-prod.md#prerequisites)
@@ -67,7 +65,7 @@
   - [How to install wire-server itself](helm-prod.md#how-to-install-wire-server-itself)
   - [DNS records](helm-prod.md#dns-records)
 
-## 10. Infrastructure Configuration
+## 9. Infrastructure Configuration
 - [Infrastructure configuration](infrastructure-configuration.md)
   - [Redirect some traffic through a http(s) proxy](infrastructure-configuration.md#redirect-some-traffic-through-a-http-s-proxy)
   - [Enable push notifications using the public appstore / playstore mobile Wire clients](infrastructure-configuration.md#enable-push-notifications-using-the-public-appstore-playstore-mobile-wire-clients)
@@ -89,11 +87,11 @@
   - [S3 Addressing Style](infrastructure-configuration.md#s3-addressing-style)
   - [I have a team larger than 500 users](infrastructure-configuration.md#i-have-a-team-larger-than-500-users)
 
-## 11. Monitoring Wire-Server
+## 10. Monitoring Wire-Server
 - [How to monitor wire-server](monitoring.md)
   - [Dashboards](monitoring.md#dashboards)
 
-## 12. Centralized Logs for Wire-Server
+## 11. Centralized Logs for Wire-Server
 - [How to see centralized logs for wire-server](logging.md)
   - [Introduction](logging.md#introduction)
   - [Status](logging.md#status)
@@ -105,28 +103,28 @@
   - [Nuking it all.](logging.md#nuking-it-all)
   - [Debugging](logging.md#debugging)
 
-## 13. Ingress-Controller (Getting Traffic In)
+## 12. Ingress-Controller (Getting Traffic In)
 - [Ingress-controller (getting traffic in)](ingress.md)
   - [Installing in a cloud-like environment](ingress.md#installing-in-a-cloud-like-environment)
   - [Installing on bare-metal without dynamic load balancer support](ingress.md#installing-on-bare-metal-without-dynamic-load-balancer-support)
 
-## 14. Web App Settings
+## 13. Web App Settings
 - [Web app settings](web-app-settings.md)
   - [Enforce desktop application only](web-app-settings.md#enforce-desktop-application-only)
   - [Enforce constant bit rate](web-app-settings.md#enforce-constant-bit-rate)
   - [Disable media plugins](web-app-settings.md#disable-media-plugins)
   - [Enable extra entropy (only on Windows)](web-app-settings.md#enable-extra-entropy-only-on-windows)
 
-## 15. Installing Conference Calling 2.0 (aka SFT)
+## 14. Installing Conference Calling 2.0 (aka SFT)
 - [Installing Conference Calling 2.0 (aka SFT)](sft.md)
   - [Background](sft.md#background)
 
-## 16. Installing Restund
+## 15. Installing Restund
 - [Installing Restund](restund.md)
   - [Background](restund.md#background)
   - [Installation instructions](restund.md#installation-instructions)
 
-## 17. Configure TLS Ciphers
+## 16. Configure TLS Ciphers
 - [Configure TLS ciphers](tls.md)
   - [Ingress Traffic (wire-server)](tls.md#ingress-traffic-wire-server)
   - [Egress Traffic (wire-server/federation)](tls.md#egress-traffic-wire-server-federation)
@@ -136,16 +134,16 @@
   - [Restund (ansible)](tls.md#restund-ansible)
   - [Restund (kubernetes)](tls.md#restund-kubernetes)
 
-## 18. Managing Authentication with Ansible
+## 17. Managing Authentication with Ansible
 - [Managing authentication with ansible](ansible-authentication.md)
   - [How to use password authentication when you ssh to a machine with ansible](ansible-authentication.md#how-to-use-password-authentication-when-you-ssh-to-a-machine-with-ansible)
   - [Configuring SSH keys](ansible-authentication.md#configuring-ssh-keys)
   - [Sudo without password](ansible-authentication.md#sudo-without-password)
 
-## 19. Using Tinc
+## 18. Using Tinc
 - [Using tinc](ansible-tinc.md)
 
-## 20. Troubleshooting During Installation
+## 19. Troubleshooting During Installation
 - [Troubleshooting during installation](troubleshooting.md)
   - [Problems with CSP on the web based applications (webapp, team-settings, account-pages)](troubleshooting.md#problems-with-csp-on-the-web-based-applications-webapp-team-settings-account-pages)
   - [Problems with ansible and python versions](troubleshooting.md#problems-with-ansible-and-python-versions)
@@ -157,7 +155,7 @@
   - [Diagnosing issues with installation steps.](troubleshooting.md#diagnosing-issues-with-installation-steps)
   - [Verifying correct deployment of DNS / DNS troubleshooting.](troubleshooting.md#verifying-correct-deployment-of-dns-dns-troubleshooting)
 
-## 21. Verifying Your Installation
+## 20. Verifying Your Installation
 - [Verifying your installation](post-install.md)
   - [NTP Checks](post-install.md#ntp-checks)
   - [Logs and Data Protection checks](post-install.md#logs-and-data-protection-checks)