Dynamic federator remotes

changelog.d/0-release-notes/pr-3260

@@ -0,0 +1 @@
+Federation only: from this release on, remote connections should be configured via an internal REST API; the config files will be honored for a transition period, but will be ignored starting in a future release.  YOU NEED TO UPDATE YOUR BRIG HELM CHART BEFORE DEPLOYING THIS RELEASE.  [Details in the docs.](http://docs.wire.com/understand/configure-federation.html#if-your-instance-has-been-federating-before)

charts/brig/templates/configmap.yaml

@@ -247,7 +247,16 @@ data:
       setPropertyMaxValueLen: {{ .setPropertyMaxValueLen }}
       setDeleteThrottleMillis: {{ .setDeleteThrottleMillis }}
       setFederationDomain: {{ .setFederationDomain }}
+      {{- if .setFederationStrategy }}
+      setFederationStrategy: {{ toYaml .setFederationStrategy | nindent 8 }}
+      {{- end }}
+      {{- if .setFederationDomainConfigsUpdateFreq }}
+      setFederationDomainConfigsUpdateFreq: {{ toYaml .setFederationDomainConfigsUpdateFreq | nindent 8 }}
+      {{- end }}
       {{- if .setFederationDomainConfigs }}
+      # 'setFederationDomainConfigs' is deprecated as of https://github.com/wireapp/wire-server/pull/3260.  See
+      # https://docs.wire.com/understand/federation/backend-communication.html#configuring-remote-connections
+      # for details.
       setFederationDomainConfigs: {{ toYaml .setFederationDomainConfigs | nindent 8 }}
       {{- end }}
       {{- if .setSearchSameTeamOnly }}

charts/cannon/templates/configmap.yaml

@@ -14,6 +14,10 @@ data:
       host: gundeck
       port: 8080
 
+    brig:
+      host: brig
+      port: 8080
+
     drainOpts:
       gracePeriodSeconds: {{ .Values.config.drainOpts.gracePeriodSeconds }}
       millisecondsBetweenBatches: {{ .Values.config.drainOpts.millisecondsBetweenBatches }}

charts/federator/templates/configmap.yaml

@@ -51,18 +51,5 @@ data:
       clientCertificate: "/etc/wire/federator/secrets/tls.crt"
       clientPrivateKey: "/etc/wire/federator/secrets/tls.key"
       useSystemCAStore: {{ .useSystemCAStore }}
-      federationStrategy:
-        {{- if .federationStrategy.allowAll }}
-        allowAll:
-        {{- else if .federationStrategy.allowedDomains }}
-        allowedDomains:
-        {{- range $domain := .federationStrategy.allowedDomains }}
-          - {{ $domain | quote }}
-        {{- end }}
-        {{- else }}
-        # In gotemplate there is no way to distinguish between empty list and no
-        # list, we assume empty list when there is no list
-        allowedDomains: []
-        {{- end}}
     {{- end }}
     {{- end }}

charts/federator/values.yaml

@@ -41,5 +41,3 @@ config:
     # A client certificate and corresponding private key can be specified
     # similarly to a custom CA store.
     useSystemCAStore: true
-    federationStrategy:
-      allowedDomains: []

docs/src/developer/developer/federation-design-aspects.md

@@ -0,0 +1,29 @@
+# Federation Design Aspects
+
+(configuring-remote-connections-dev-perspective)=
+
+## Keeping track of federator remotes
+
+**Since [PR#3260](https://github.com/wireapp/wire-server/pull/3260).**
+
+Federation can start and end.  These events need handlers to be called
+(like remove remote users from local conv), plus it is not convenient
+to edit and re-deploy config files every time that happens.  Hence
+remotes are stored in cassandra in brig, and every pod of every
+service keeps a cache in an `IORef` in its `Env` (this information is
+needed in many end-points, so it has to remain as fast as read access
+to `Env`).
+
+See {ref}`configure-federation-strategy-in-brig` for the
+administrator's point of view.  If you haven't done so, go read that
+section now!
+
+The state is persisted in cassandra table `brig.federation_remotes`.
+brig provides the contents via an internal CRUD API (see
+{ref}`configure-federation-strategy-in-brig` for the links).  In the
+future, we may decide that brig needs to cache the table itself, but
+for now (`GET` is only used for the internal end-point to share it
+with other services) we hope to get away with the simple solution and
+always read from cassandra directly.
+
+(More details to be added?)

docs/src/developer/reference/config-options.md

@@ -393,43 +393,7 @@ settings:
 
 ### Federation allow list
 
-As of 2021-07, federation (whatever is implemented by the time you read this) is turned off by default by means of having an empty allow list:
-
-```yaml
-# federator.yaml
-optSettings:
-  federationStrategy:
-    allowedDomains: []
-```
-
-You can choose to federate with a specific list of allowed servers:
-
-
-```yaml
-# federator.yaml
-optSettings:
-  federationStrategy:
-    allowedDomains:
-      - server1.example.com
-      - server2.example.com
-```
-
-or, you can federate with everyone:
-
-```yaml
-# federator.yaml
-optSettings:
-  federationStrategy:
-    # note the 'empty' value after 'allowAll'
-    allowAll:
-
-# when configuring helm charts, this becomes (note 'true' after 'allowAll')
-# inside helm_vars/wire-server:
-federator:
-  optSettings:
-    federationStrategy:
-      allowAll: true
-```
+See {ref}`configure-federation-strategy-in-brig` (since [PR#3260](https://github.com/wireapp/wire-server/pull/3260)).
 
 ### Federation TLS Config
 
@@ -611,24 +575,11 @@ any key package whose expiry date is set further than 15 days after upload time
 
 
 ### Federated domain specific configuration settings
-#### Restrict user search
 
-The lookup and search of users on a wire instance can be configured. This can be done per federated domain.
-
-```yaml
-# [brig.yaml]
-optSettings:
-  setFederationDomainConfigs:
-    - domain: example.com
-      search_policy: no_search
-```
+#### Restrict user search
 
-Valid values for `search_policy` are:
-- `no_search`: No users are returned by federated searches.
-- `exact_handle_search`: Only users where the handle exactly matches are returned.
-- `full_search`: Additionally to `exact_handle_search`, users are found by a freetext search on handle and display name.
+See {ref}`configure-federation-strategy-in-brig` (since [PR#3260](https://github.com/wireapp/wire-server/pull/3260)).
 
-If there is no configuration for a domain, it's defaulted to `no_search`.
 
 ### API Versioning