Dynamic federator remotes

cassandra-schema.cql

@@ -1292,31 +1292,6 @@ CREATE TABLE brig_test.service_team (
     AND read_repair_chance = 0.0
     AND speculative_retry = '99PERCENTILE';
 
-CREATE TABLE brig_test.invitation (
-    inviter uuid,
-    id uuid,
-    code ascii,
-    created_at timestamp,
-    email text,
-    name text,
-    phone text,
-    PRIMARY KEY (inviter, id)
-) WITH CLUSTERING ORDER BY (id ASC)
-    AND bloom_filter_fp_chance = 0.01
-    AND caching = {'keys': 'ALL', 'rows_per_partition': 'NONE'}
-    AND comment = ''
-    AND compaction = {'class': 'org.apache.cassandra.db.compaction.SizeTieredCompactionStrategy', 'max_threshold': '32', 'min_threshold': '4'}
-    AND compression = {'chunk_length_in_kb': '64', 'class': 'org.apache.cassandra.io.compress.LZ4Compressor'}
-    AND crc_check_chance = 1.0
-    AND dclocal_read_repair_chance = 0.1
-    AND default_time_to_live = 0
-    AND gc_grace_seconds = 864000
-    AND max_index_interval = 2048
-    AND memtable_flush_period_in_ms = 0
-    AND min_index_interval = 128
-    AND read_repair_chance = 0.0
-    AND speculative_retry = '99PERCENTILE';
-
 CREATE TABLE brig_test.blacklist (
     key text PRIMARY KEY
 ) WITH bloom_filter_fp_chance = 0.1
@@ -1667,6 +1642,49 @@ CREATE TABLE brig_test.password_reset (
     AND read_repair_chance = 0.0
     AND speculative_retry = '99PERCENTILE';
 
+CREATE TABLE brig_test.federation_remotes (
+    domain text PRIMARY KEY,
+    search_policy int
+) WITH bloom_filter_fp_chance = 0.01
+    AND caching = {'keys': 'ALL', 'rows_per_partition': 'NONE'}
+    AND comment = ''
+    AND compaction = {'class': 'org.apache.cassandra.db.compaction.SizeTieredCompactionStrategy', 'max_threshold': '32', 'min_threshold': '4'}
+    AND compression = {'chunk_length_in_kb': '64', 'class': 'org.apache.cassandra.io.compress.LZ4Compressor'}
+    AND crc_check_chance = 1.0
+    AND dclocal_read_repair_chance = 0.1
+    AND default_time_to_live = 0
+    AND gc_grace_seconds = 864000
+    AND max_index_interval = 2048
+    AND memtable_flush_period_in_ms = 0
+    AND min_index_interval = 128
+    AND read_repair_chance = 0.0
+    AND speculative_retry = '99PERCENTILE';
+
+CREATE TABLE brig_test.invitation (
+    inviter uuid,
+    id uuid,
+    code ascii,
+    created_at timestamp,
+    email text,
+    name text,
+    phone text,
+    PRIMARY KEY (inviter, id)
+) WITH CLUSTERING ORDER BY (id ASC)
+    AND bloom_filter_fp_chance = 0.01
+    AND caching = {'keys': 'ALL', 'rows_per_partition': 'NONE'}
+    AND comment = ''
+    AND compaction = {'class': 'org.apache.cassandra.db.compaction.SizeTieredCompactionStrategy', 'max_threshold': '32', 'min_threshold': '4'}
+    AND compression = {'chunk_length_in_kb': '64', 'class': 'org.apache.cassandra.io.compress.LZ4Compressor'}
+    AND crc_check_chance = 1.0
+    AND dclocal_read_repair_chance = 0.1
+    AND default_time_to_live = 0
+    AND gc_grace_seconds = 864000
+    AND max_index_interval = 2048
+    AND memtable_flush_period_in_ms = 0
+    AND min_index_interval = 128
+    AND read_repair_chance = 0.0
+    AND speculative_retry = '99PERCENTILE';
+
 CREATE TABLE brig_test.activation_keys (
     key ascii PRIMARY KEY,
     challenge ascii,

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.](https://docs.wire.com/understand/federation/backend-communication.html#configuring-remote-connections)

charts/brig/templates/configmap.yaml

@@ -248,6 +248,9 @@ data:
       setDeleteThrottleMillis: {{ .setDeleteThrottleMillis }}
       setFederationDomain: {{ .setFederationDomain }}
       {{- 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 }}

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

@@ -0,0 +1,28 @@
+# Federation Design Aspects
+
+(configuring-remote-connections-dev-perspective)=
+
+## keeping track of federator remotes
+
+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`).
+
+This section elaborates on the implementation.  See
+{ref}`configuring-remote-connections` 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}`configuring-remote-connections` 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.
+
+Introduced in
+[PR#3260](https://github.com/wireapp/wire-server/pull/3260).

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

@@ -391,46 +391,32 @@ settings:
   federationDomain: example.com
 ```
 
-### Federation allow list
+### Federation strategy: whom to federate with?
 
-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:
+As of the release containing [PR#3260](https://github.com/wireapp/wire-server/pull/3260), federator gets its configuration from brig (which has a cassandra instance and is thus better equipped to handle persistent dynamic data).  See {ref}`configuring-remote-connections` for the whole story.
 
+Federation is turned off by default.  You can also turn it off
+explicitly by setting federation strategy "allowedDomains", and making
+sure that `brig.federation_remotes` (the response of the
+[`GET`](https://staging-nginz-https.zinfra.io/api-internal/swagger-ui/brig/#/brig/get_i_federation_remotes)
+request is empty).
 
 ```yaml
-# federator.yaml
+# brig.yaml
 optSettings:
-  federationStrategy:
-    allowedDomains:
-      - server1.example.com
-      - server2.example.com
+  federationStrategy: allowedDomains
 ```
 
-or, you can federate with everyone:
+If you want to federate with all domains that ask, change this to:
 
 ```yaml
-# federator.yaml
+# brig.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
+  federationStrategy: allowAll
 ```
 
+If you want to federate selectively with a list of known peers, consult {ref}`configuring-remote-connections`.
+
 ### Federation TLS Config
 
 When a federator connects with another federator, it does so over HTTPS. There
@@ -611,24 +597,15 @@ 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.
+You can configure search policies on a peer-by-peer basis, but using
+the config file for that is not supported any more since the release
+containing
+[PR#3260](https://github.com/wireapp/wire-server/pull/3260).  See
+{ref}`configuring-remote-connections` for how to do this now.
 
-If there is no configuration for a domain, it's defaulted to `no_search`.
 
 ### API Versioning