On Kubernetes#
This document contains instructions on installing, uninstalling and configuring Multi Tenant Operator on Kubernetes.
Requirements#
- A Kubernetes cluster (v1.24 or higher)
- Helm CLI
- kubectl
-
To run on Kubernetes, two certificates are needed in the operator namespace for the operator to be up and running, named
quota-template-intconfig-server-cert
pointing tomulti-tenant-operator-quota-template-intconfig-webhook-service.{{ .Release.Namespace }}.svc.cluster.local
webhook-server-cert
pointing tomulti-tenant-operator-webhook-service.{{ .Release.Namespace }}.svc.cluster.local
If you are using Cert Manager, these certificates will be handled by templates in Helm Chart
Installing via Helm CLI#
-
Public Helm Chart of MTO is available at Stakater GHCR Packages and available Helm options can be seen at MTO Helm Chart Options
-
Use
helm install
command to install MTO helm chart. Here,bypassedGroups
has the names of groups which are designated as Cluster Admins in your cluster. For this example, we will usesystem:masters
helm install tenant-operator oci://ghcr.io/stakater/public/charts/multi-tenant-operator --version 0.12.62 --namespace multi-tenant-operator --create-namespace --set bypassedGroups=system:masters'
Note
It is better to install MTO in its preferred namespace, multi-tenant-operator
Wait for the pods to be up
kubectl get pods -n multi-tenant-operator --watch
After all pods come in running state, you can follow Tutorials.
Enterprise License Configuration#
For the Enterprise version, you need to have a configmap license
created in MTO's namespace multi-tenant-operator
. You will get this configmap when purchasing the Enterprise version. It would look like this:
apiVersion: v1
kind: ConfigMap
metadata:
name: license
namespace: multi-tenant-operator
data:
payload.json: |
{
"metaData": {
"tier" : "paid",
"company": "<company name here>"
}
}
signature.base64.txt: <base64 signature here>
Uninstall via Helm CLI#
MTO can be uninstalled by Helm CLI if Helm was used to install it earlier.
- Use
helm uninstall
command to remove the earlier createdHelm Release
inmulti-tenant-operator
namespace
helm uninstall tenant-operator --namespace multi-tenant-operator
Notes#
- For details on licensing of MTO please refer Pricing.
- For more details on how to use MTO please refer Tenant tutorial.
- For details on how to extend your MTO manager ClusterRole please refer extend-default-clusterroles.