Skip to content

Drop hpack #2596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 9, 2022
Merged

Drop hpack #2596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ea39731
rm */**/package.yaml
fisx Aug 5, 2022
f55c436
cleanup
fisx Aug 5, 2022
bd9546e
changelog
fisx Aug 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions cabal.project.freeze
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1153,8 +1153,6 @@ constraints: any.AC-Angle ==1.0,
any.hourglass ==0.2.12,
any.hourglass-orphans ==0.1.0.0,
any.hp2pretty ==0.10,
any.hpack ==0.34.5,
any.hpack-dhall ==0.5.3,
any.hpc-codecov ==0.3.0.0,
any.hpc-lcov ==1.0.1,
any.hprotoc ==2.4.17,
Expand Down
1 change: 1 addition & 0 deletions changelog.d/5-internal/drop-hpack
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
No more package.yaml / hpack, and stick with cabal files as the single (and only) source of truth
23 changes: 9 additions & 14 deletions docs/src/understand/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ Backend components startup

The Wire server backend is designed to run on a kubernetes cluster. From a high level perspective the startup sequence from machine power-on to the Wire server being ready to receive requests is as follow:

1. *Kubernetes node power on*. Systemd starts the kubelet service which makes the worker node available to kubernetes. For more details about kubernetes startup refer to `the official kubernetes documentation <https://kubernetes.io/docs/reference/setup-tools/kubeadm/implementation-details/>`__. For details about the installation and configuration of kubernetes and worker nodes for Wire server see :ref:`Installing kubernetes and databases on VMs with ansible <ansible_vms>`
1. *Kubernetes node power on*. Systemd starts the kubelet service which makes the worker node available to kubernetes. For more details about kubernetes startup refer to `the official kubernetes documentation <https://kubernetes.io/docs/reference/setup-tools/kubeadm/implementation-details/>`__. For details about the installation and configuration of kubernetes and worker nodes for Wire server see :ref:`Installing kubernetes and databases on VMs with ansible <ansible_vms>`
2. *Kubernetes workload startup*. Kubernetes will ensure that Wire server workloads installed via helm are scheduled on available worker nodes. For more details about workload scheduling refer to `the official kubernetes documentation <https://kubernetes.io/docs/concepts/scheduling-eviction/kube-scheduler/>`__. For details about how to install Wire server with helm refer to :ref:`Installing wire-server (production) components using Helm <helm_prod>`.
3. *Stateful workload startup*. Systemd starts the stateful services (cassandra, elasticsearch and minio). See for instance `ansible-cassandra role <https://github.com/wireapp/ansible-cassandra/blob/master/tasks/systemd.yml#L10>`__ and other database installation instructions in :ref:`Installing kubernetes and databases on VMs with ansible <ansible_vms>`
3. *Stateful workload startup*. Systemd starts the stateful services (cassandra, elasticsearch and minio). See for instance `ansible-cassandra role <https://github.com/wireapp/ansible-cassandra/blob/master/tasks/systemd.yml#L10>`__ and other database installation instructions in :ref:`Installing kubernetes and databases on VMs with ansible <ansible_vms>`
4. *Other services*. Systemd starts the restund docker container. See `ansible-restund role <https://github.com/wireapp/ansible-restund/blob/9807313a7c72ffa40e74f69d239404fd87db65ab/templates/restund.service.j2#L12-L19>`__. For details about docker container startup `consult the official documentation <https://docs.docker.com/get-started/overview/#docker-architecture>`__

.. note::
Expand All @@ -60,7 +60,7 @@ The Wire server backend is designed to run on a kubernetes cluster. From a high
Focus on pods
~~~~~~~~~~~~~

The Wire backend runs in `a kubernetes cluster <https://kubernetes.io/>`__, with different components running in different `pods <https://kubernetes.io/docs/concepts/workloads/pods/>`__.
The Wire backend runs in `a kubernetes cluster <https://kubernetes.io/>`__, with different components running in different `pods <https://kubernetes.io/docs/concepts/workloads/pods/>`__.

This is a list of those pods as found in a typical installation.

Expand All @@ -78,7 +78,7 @@ Frontend pods:
Pods with an HTTP API:

* ``brig``: `The user management API service <https://github.com/wireapp/wire-server/tree/develop/services/brig>`__. Connects to ``cassandra`` and ``elastisearch`` for user data storage, sends emails and SMS for account validation.
* ``cannon``: `WebSockets API Service <https://github.com/wireapp/wire-server/blob/develop/services/cannon/package.yaml#L6>`__. Holds WebSocket connections.
* ``cannon``: `WebSockets API Service <https://github.com/wireapp/wire-server/blob/develop/services/cannon/>`__. Holds WebSocket connections.
* ``cargohold``: `Asset Storage API Service <https://docs.wire.com/how-to/install/aws-prod.html>`__. Amazon-AWS-S3-style services are used by ``cargohold`` to store encrypted files that users are sharing amongst each other, such as images, files, and other static content, which we call assets. All assets except profile pictures are symmetrically encrypted before storage (and the keys are only known to the participants of the conversation in which an assets was shared - servers have no knowledge of the keys).
* ``galley``: `Conversations and Teams API Service <https://docs.wire.com/understand/api-client-perspective/index.html>`__. Data is stored in cassandra. Uses ``gundeck`` to send notifications to users.
* ``nginz``: Public API Reverse Proxy (Nginx with custom libzauth module). A modified copy of nginx, compiled with a specific set of upstream extra modules, and one important additional module zauth_nginx_module. Responsible for user authentication validation. Forwards traffic to all other API services (except federator)
Expand All @@ -88,16 +88,16 @@ Pods with an HTTP API:

Supporting pods and data storage:

* ``cassandra-ephemeral`` (or ``cassandra-external``): `NoSQL Database management system <https://github.com/wireapp/wire-server/tree/develop/charts/cassandra-ephemeral>`__ (https://en.wikipedia.org/wiki/Apache_Cassandra). Everything stateful in wire-server (cassandra is used by ``brig``, ``galley``, ``gundeck`` and ``spar``) is stored in cassandra.
* ``cassandra-ephemeral`` is for test clusters where persisting the data (i.e. loose users, conversations,...) does not matter, but this shouldn't be used in production environments.
* ``cassandra-ephemeral`` (or ``cassandra-external``): `NoSQL Database management system <https://github.com/wireapp/wire-server/tree/develop/charts/cassandra-ephemeral>`__ (https://en.wikipedia.org/wiki/Apache_Cassandra). Everything stateful in wire-server (cassandra is used by ``brig``, ``galley``, ``gundeck`` and ``spar``) is stored in cassandra.
* ``cassandra-ephemeral`` is for test clusters where persisting the data (i.e. loose users, conversations,...) does not matter, but this shouldn't be used in production environments.
* ``cassandra-external`` is used to point to an external cassandra cluster which is installed outside of Kubernetes.
* ``demo-smtp``: In "demo" installations, used to replace a proper external SMTP server for the sending of emails (for example verification codes). In production environments, an actual SMTP server is used directly instead of this pod. (https://github.com/namshi/docker-smtp)
* ``fluent-bit``: A log processor and forwarder, allowing collection of data such as metrics and logs from different sources. Not typically deployed. (https://fluentbit.io/)
* ``elastisearch-ephemeral`` (or ``elastisearch-external``): `Distributed search and analytics engines, stores some user information (name, handle, userid, teamid) <https://github.com/wireapp/wire-server/tree/develop/charts/elastisearch-external>`__. Information is duplicated here from cassandra to allow searching for users. Information here can be re-populated from data in cassandra (albeit with some downtime for search functionality) (https://www.elastic.co/what-is/elasticsearch).
* ``elastisearch-ephemeral`` is for test clusters where persisting the data doesn't matter.
* ``elastisearch-ephemeral`` (or ``elastisearch-external``): `Distributed search and analytics engines, stores some user information (name, handle, userid, teamid) <https://github.com/wireapp/wire-server/tree/develop/charts/elastisearch-external>`__. Information is duplicated here from cassandra to allow searching for users. Information here can be re-populated from data in cassandra (albeit with some downtime for search functionality) (https://www.elastic.co/what-is/elasticsearch).
* ``elastisearch-ephemeral`` is for test clusters where persisting the data doesn't matter.
* ``elastisearch-external`` refers to elasticsearch IPs located outside kubernetes by specifying IPs manually.
* ``fake-aws-s3``: Amazon-AWS-S3-compatible object storage using MinIO (https://min.io/), used by cargohold to store (encrypted) assets such as files, posted images, profile pics, etc.
* ``fake-aws-s3-reaper``: Creates the default S3 bucket inside fake-aws-s3.
* ``fake-aws-s3-reaper``: Creates the default S3 bucket inside fake-aws-s3.
* ``fake-aws-sns``. `Amazon Simple Notification Service (Amazon SNS) <https://docs.aws.amazon.com/AmazonS3/latest/userguide/NotificationHowTo.html>`__, used to push messages to mobile devices or distributed services. SNS can publish a message once, and deliver it one or more times.
* ``fake-aws-sqs``: `Amazon Simple Queue Service (Amazon SQS) queue <https://docs.aws.amazon.com/AmazonS3/latest/userguide/NotificationHowTo.html>`__, used to transmit any volume of data without requiring other services to be always available.
* ``redis-ephemeral``: Stores websocket connection assignments (part of the ``gundeck`` / ``cannon`` architecture).
Expand Down Expand Up @@ -146,8 +146,3 @@ As an example, this is the result of running the ``kubectl get pods --namespace
.. note::

This list is not exhaustive, and your installation may have additional pods running depending on your configuration.





5 changes: 0 additions & 5 deletions libs/api-bot/api-bot.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
cabal-version: 1.12

-- This file has been generated from package.yaml by hpack version 0.34.4.
--
-- see: https://github.com/sol/hpack
--
-- hash: 4010a19af0b65ce213a7afb528aa57a5ae3dba5fd870c09d28781afae11d2c4b

name: api-bot
version: 0.4.2
Expand Down
51 changes: 0 additions & 51 deletions libs/api-bot/package.yaml
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions libs/api-client/api-client.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
cabal-version: 1.12

-- This file has been generated from package.yaml by hpack version 0.34.4.
--
-- see: https://github.com/sol/hpack
--
-- hash: 7e6aaa6730e46316c0dc70278f66a66b36707f4eee741ee3c89b736543e36d07

name: api-client
version: 0.4.2
Expand Down
40 changes: 0 additions & 40 deletions libs/api-client/package.yaml
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions libs/bilge/bilge.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
cabal-version: 1.12

-- This file has been generated from package.yaml by hpack version 0.34.4.
--
-- see: https://github.com/sol/hpack
--
-- hash: 02dbb0433605f5282d44accf8028da425b93c7e326c70ac8d2a092abab8db504

name: bilge
version: 0.22.0
Expand Down
39 changes: 0 additions & 39 deletions libs/bilge/package.yaml
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions libs/brig-types/brig-types.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
cabal-version: 1.12

-- This file has been generated from package.yaml by hpack version 0.34.4.
--
-- see: https://github.com/sol/hpack
--
-- hash: 208f0e0b617d4b77a178515ad4feb886ef0dcef8997be2174e4ae72b78dccd7e

name: brig-types
version: 1.35.0
Expand Down
48 changes: 0 additions & 48 deletions libs/brig-types/package.yaml
View file
Open in desktop

This file was deleted.

3 changes: 0 additions & 3 deletions libs/cargohold-types/cargohold-types.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
cabal-version: 1.12

-- This file has been generated from package.yaml by hpack version 0.34.4.
--
-- see: https://github.com/sol/hpack

name: cargohold-types
version: 1.5.0
Expand Down
18 changes: 0 additions & 18 deletions libs/cargohold-types/package.yaml
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions libs/cassandra-util/cassandra-util.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
cabal-version: 1.12

-- This file has been generated from package.yaml by hpack version 0.34.4.
--
-- see: https://github.com/sol/hpack
--
-- hash: 23fae7c145e7caafdaf90ad2186c54ceffc973065e99ac6032b0241e9cb8c243

name: cassandra-util
version: 0.16.5
Expand Down
32 changes: 0 additions & 32 deletions libs/cassandra-util/package.yaml
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions libs/deriving-swagger2/deriving-swagger2.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
cabal-version: 1.12

-- This file has been generated from package.yaml by hpack version 0.34.4.
--
-- see: https://github.com/sol/hpack
--
-- hash: f47dc031ff87a0941f316c2a34d49f1bc02319b7f3928c827e02b3bece3b819c

name: deriving-swagger2
version: 0.1.0
Expand Down
Loading