Requirements

When installing Witboost, the customer should provide:

• A Kubernetes cluster where all the product's containers will be deployed
  • Version: 1.22.0 or later; can be self-hosted or provided by a cloud provider (e.g. AKS / EKS). OpenShift 4.0.0 or later is also supported.
  • Image registry: if the cluster cannot reach our image registry, an alternative one must be provided where the images will be rehosted.
  • Endpoints: Witboost exposes a Web UI that needs to be reachable by the users. As such, DNS domains and TLS certificates must be available. Witboost is able to handle them through external-dns and cert-manager, or they can be provided. TLS may also be handled externally from the Kubernetes cluster if needed (eg, through a gateway).
  • Secrets: a secret manager compatible with external-secrets is preferred.
  • Namespaces: a dedicated namespace is required.
  • Helm: Witboost is installed with a chart, so Helm is required.
• A Postgres DBMS for storage of internal metadata
  • Version: 14, 15, and 16 are supported. Other versions could work as well, but they are not officially supported.
  • The preferred way is to integrate with a managed instance, so the customer can configure it with their policies (retention, accesses, backups, etc).
  • Extensions: pgcrypto must be available
  • Privileges: users for the needed databases must have owner permissions for automatic migrations to work.
• A technical integration with the company organization's structure, like Microsoft Entra ID or LDAP. This is needed to get users' and groups' details, so Witboost can correctly identify the logged user. You can check the Authentication section for more details.
• A versioning system like GitLab/Bitbucket/Azure DevOps. The integration with such systems is performed through a technical user which will only perform read operations, while end users will integrate with it using their credentials by setting their token in the platform.