Installation requirements
OKDP Sandbox is a quick-start installation of an OKDP cluster. By following the README.md, you should have access the to all current OKDP services.
The following installation guide explains the mandatory dependencies that OKDP v1 needs in order to have a working cluster.
KuboCD objects
Section titled “KuboCD objects”Kubocd is an overlayer of Flux for managing helmRelease object linked to Helm charts. Flux must be installed prior to the KuboCD CRD for the latter to work.
KuboCD release
Section titled “KuboCD release”A KuboCD release contains one or several Helm charts with a dependency order between them if necessary and dynamically overwrites their values.yaml with variables set in a context and /or a clusterContract object.
Context
Section titled “Context”A context is a Kubernetes object belonging to the KuboCD environment. It is basically a set of defined variables for KuboCD releases to have access to. The purpose is to centralize variables that are used through several releases and define the OKDP environment, like the ingress suffix, proxy HTTP/HTTPS address,.etc. The context also contains the service catalog.
Cluster contract
Section titled “Cluster contract”A cluster contract (clusterContract with the kubectl command) is also a Kubernetes object belonging to the KuboCD environment, defining variables that are, in contrast to the context, specific for a service or a component.
Main mandatory dependencies
Section titled “Main mandatory dependencies”Storage
Section titled “Storage”OKDP does not provide storage, and an S3-compatible storage provider like SeaweedFS or Ceph is required beforehand for the platform. OKDP communicates through the S3 API to the storage provider. Any S3 storage provider that also performs STS, since it is being used by Polaris for securing its catalogs, should be compatible with OKDP; here, for the demonstration purposes, SeaweedFS is being used.
A database server controller like CloudNativePG must be provided too. A database server controller is a Kubernetes operator enabling you to manage a database cluster to handle the lifecycle of database objects in a Kubernetes native way.
Once the storage provider and the database-server controller are present, OKDP communicates with them through connections explained in Connections and external secrets management.
How to create a view of the storage provider’s user interface is shown in the user guide.
The storage provider as well as the database server controller must be provided through a kubocd package with storage or database-server marked in their metadata. Otherwise, some services depending on them are undeployable.
Ingress controller
Section titled “Ingress controller”An Ingress controller must be installed to access the user interfaces of all services and the OKDP control plane itself. For the v1 of OKDP, Nginx is being used, knowing that it is deprecated; however, migration to other ingress controllers will be applied later on.
Identity provider
Section titled “Identity provider”OKDP currently works and has been tested with Keycloak and KubeAuth for OIDC authentication. Please refer to their documentation for any further information.
Other dependencies
Section titled “Other dependencies”The OKDP sandbox currently depends on other components such as a DNS server, a cert manager, and other tools, which you can see on the stack page.