The Common Gateway repository provides a quick Kubernetes wrapper for the Common Gateway Symfony Bundle. In other words, it doesn't aim to be its own code base but simply contains the files needed to create Kubernetes images and Helm installers for the core bundle.
If you are looking for the Common Gateway code base, please refer to the Core Bundle repository instead, as that's where you will find all the appropriate documentation.
Warning The most recent documentation for setting up your common gateway is maintained in this document. The documentation in this document might or might not be up to date with this documentation.
Dependencies
- To clone the codebase to your locale machine you will need Git
- To run the gateway on your local machine, you will need Docker Desktop.
You can start up the Common Gateway locally by cloning the repository to your machine
$ git clone https://github.com/ConductionNL/commonground-gateway
After that, you need to spin up your local Docker setup
$ docker compose up --build
(the --build flag can be ignored the next time you want to run the application)
Dependencies
- For installations on Kubernetes, you will need to install Helm on your local machine.
- If you need to install LetsEncrypt, you will also need to install
kubectl, but if you previously installed Docker Desktop thenkubectlis already present on your machine (so no installation needed).
If you are installing the Common Gateway on a Haven environment, you can just run the provided Helm installer. Before installing the Common Gateway, you need to add it to your Helm repositories.
$ helm repo add common-gateway https://raw.githubusercontent.com/ConductionNL/commonground-gateway/main/api/helm/
After that, you can simply install the Gateway to your cluster using the Helm installer. If you are using a kubeconfig file to authenticate yourself, you need to add that as a --kubeconfig flag. However, if you are using another authentication method, you can omit the flag. When installing an application to Helm, always choose a name that helps you identify the application and put that in place of [my-installation].
$ helm install [my-gateway] common-gateway/commonground-gateway --kubeconfig=[path-to-your-kubeconfig] --namespace [namespace]
This will install the Gateway in a bare-bones and production setup on the latest version (you can lock versions through the version flag e.g. --version 2.2). To further configure the Gateway, we need to set some environmental values. A full option list can be found here. Let's for now assume that you want to switch your Gateway from prod to dev-mode, enable cron-runners for asynchronous resource handling, add a domain name to make the Gateway publicly accessible, and last but not least, use LetsEncrypt to provide an SSL/HTTPS connection. In Helm, we use the --set flag to set values. So the total upgrade command would look like:
$ helm upgrade [my-gateway] --kubeconfig=[path-to-your-kubeconfig] --set gateway.enabled=true, pwa.apiUrl=https://[your-domain]/api, pwa.meUrl=https://[your-domain]/me, pwa.baseUrl=https://[your-domain], pwa.frontendUrl=https://[your-domain], pwa.adminUrl=https://[your-domain], ingress.enabled=true, global.domain=[your-domain], ingress.hostname=[your-domain], ingress.annotations.cert-manager\.io/cluster-manager=letsencrypt-prod, ingress.tls.0.hosts.0=[your-domain], ingress.tls.0.secretName=[your-domain but replace . with -]-tls, gateway.cronrunner.enabled=true
Or for the headless version
$ helm upgrade [my-gateway] common-gateway/commonground-gateway --kubeconfig=[path-to-your-kubeconfig] --set cronrunner.enabled=true,php.tag=dev,nginx.tag=dev,ingress.enabled=true,global.domain=[my-domain.com]
The helm install and upgrade commandos can also be put together:
$ helm upgrade [my-gateway] common-gateway/commonground-gateway --kubeconfig=[path-to-your-kubeconfig] --set cronrunner.enabled=true,php.tag=dev,nginx.tag=dev,ingress.enabled=true,global.domain=[my-domain.com] --namespace [namespace] --install
Alternatively, you can use the Kubernetes dashboard to change the Helm values file.
For more information on installing the application through Helm, read the Helm documentation.
If however, your environment is not compliant with the Haven standard (and we suggest that you follow it), then keep in mind that you need the following dependencies on your Kubernetes clusters:
MUST have
Should have
- Cert manager (add
--set installCRDs=trueto the command if using Helm, you will need them for LetsEncrypt) - LetsEncrypt (see details below)
- Prometheus
- Loki
If you want your cluster to be able to set up its own certificates for SSL/HTTPS (and save yourself the hassle of manually loading certificates), you can install LetsEncrypt. Keep in mind that this will provide low-level certificates. If you need higher-level certificates, you will still need to manually obtain them.
Note: Make sure to install Cert Manager before LetsEncrypt
$ kubectl apply -f letsencrypt-ci.yaml --kubeconfig=[path-to-your-kubeconfig]
The common gateway relies on a number of software dependencies the helm chart installs alongside the common gateway. If you want however to connect to existing versions of these dependencies, you can disable them.
The common gateway is dependent on a SQL database for internal operations. We recommend to use PostgreSQL as the database type the common gateway was designed with. However we also support MySQL, MariaDB and Microsoft SQL Server, although the latter defers from newer standards and henceforth can cause some issues and therefore is not recommended.
To disable PostgreSQL: set the setting postgresql.enabled to false, and enter a SQL url (pgsql://, psql:// for postgres, mysqli:// for MySQL and MariaDB or pdo_sqlsrv://) in the field postgresql.url. Also, if the database is a Microsoft SQL Server database, don't forget to change the field databaseType to mssql.
The PostgreSQL database that is installed if postgresql.enabled is set to true is installed with this chart. This chart contains default resource requests that are not overwritten.
In case the resource requests and/or limits have to be overridden this can be done using the following parameters:
postgresql:
primary:
resources:
limits: {}
requests: {}The default requests are 256Mi memory and 200m vCPU.
For serving content quickly the common gateway relies on a document cache which is run in MongoDB. MongoDB is also used to store the logs of the common gateway.
To disable MongoDB: set the setting mongodb.enabled to false, and enter a SQL url (mongodb://) in the field mongodb.url.
The MongoDB database that is installed if mongodb.enabled is set to true is installed with this chart. This chart does not contain default resource requests, therefore the gateway chart overrides these requests with the following values:
mongodb:
resources:
requests:
cpu: 1
memory: 6GiThese limits are set to high limits to accommodate for large databases, and can be tweaked to lower values if the size of the database is not expected to exceed a couple of Gigabytes.
To run events from the event-driven architecture asynchronously, the common gateway uses a message queue on RabbitMQ.
The RabbitMQ dependency can be disabled by setting rabbitmq.enabled to false. However, it is not possible at this time to connect to an external instance of rabbitmq, this means that events cannot be run asynchronously, and that the workers have to be disabled by setting consumer.replicaCount to 0.
The RabbitMQ message queue that is installed if rabbitmq.enabled is set to true is installed with this chart. This chart does not contain default resource requests, therefore the gateway chart overrides these requests with the following values:
rabbitmq:
resources:
requests:
cpu: 200m
memory: 256MiThese are values that are not observed to be exceeded on busy environments with large numbers of asynchronous events.
For session storage and key value caching, a redis cache is in place.
The Redis dependency can be disabled by setting redis.enabled to false. However, it is not possible at this time to connect to an external instance of redis. This means that in order to have consistent session storage the common gateway can only be run on one container by setting the replicaCount parameter to 1.
The Redis cache that is in stalled if redis.enabled is set to true is installed with this chart. This chart does not contain default resource requests, therefore the gateway chart overrides these requests with the following values:
In case the resource requests and/or limits have to be overridden this can be done using the following parameters:
redis:
master:
resources:
requests:
cpu: 20m
memory: 128MiThe common gateway also offers its own User Interface for admin.
This user interface is installed with this chart.
The resource requests for these containers are set to:
gateway-ui:
resources:
requests:
cpu: 10m
memory: 128Mi