Architecture

The Multi-Tenant Operator (MTO) is a comprehensive system designed to manage multi-tenancy in Kubernetes environments. Following is the architecture of the MTO:

MTO consists of multiple controllers and components that work together to provide the functionality of the system. The following is a list of the components that make up the MTO system:

Name	Type	Description
Tenant Controller	Deployment	The Tenant Controller is responsible for managing the creation, deletion, and updating of tenants in the cluster via Tenant CRD.
Namespace Controller	Deployment	The Namespace Controller is responsible for managing the creation, deletion, and updating of namespaces in the cluster.
Resource Supervisor Deployment	Deployment	The Resource Supervisor Controller is responsible for managing sleep and hibernation of namespaces in the cluster via ResourceSupervisor CRD.
Extensions Controller	Deployment	The Extensions Controller enhances MTO's functionality by allowing integration with external services,Currently supports integration with ArgoCD, enabling you to synchronize your repositories and configure AppProjects directly through MTO. It manages extensions via Extension CRD.
Template Quota Integration Config Controller	Deployment	The Template Quota Integration Config Controller manages 3 different CRDs in one controller, Template CRD, Quota CRD, and IntegrationConfig CRD.
TemplateInstance Controller	Deployment	The TemplateInstance Controller is responsible for managing the creation, deletion, and updating of TemplateInstances in the cluster via TemplateInstance CRD.
TemplateGroupInstance Controller	Deployment	The TemplateGroupInstance Controller is responsible for managing the creation, deletion, and updating of TemplateGroupInstances in the cluster via TemplateGroupInstance CRD.
Webhook	Deployment	The Webhook is responsible for managing webhook requests from MTO's resources.
Pilot Controller	Deployment	The Pilot Controller is responsible provisioning and managing the lifecycle of MTO-Console and it's dependencies.
Keycloak	Deployment	Keycloak is an open-source identity and access management solution that provides authentication and authorization services for the MTO Console that can be provisioned via Pilot Controller or can be deployed and managed externally following this guide External Keycloak.
Postgresql	StatefulSet	Postgresql is an open-source relational database that acts as a caching layer and stores the data for the MTO Console. It is also provisioned via Pilot Controller and is managed internally.
Opencost-Gateway	Deployment	Opencost is an open-source cost management solution that provides cost tracking and reporting for the resources deployed on the cluster. It is also provisioned via Pilot Controller and is managed internally.
Prometheus-Server	Deployment	Prometheus is an open-source monitoring and alerting solution that provides metrics and monitoring for the resources deployed on the cluster. It is also provisioned via Pilot Controller and is managed internally.
Kube-State-Metrics	Deployment	Kube-State-Metrics is a service that listens to the Kubernetes API server and generates metrics about the state of the objects in the cluster. It is also provisioned via Pilot Controller and is managed internally.
Showback	Cronjob	The Showback Cronjob is responsible for generating showback reports based on the resources present on the cluster by querying the Opencost-Gateway and storing the reports in the Postgresql database that can be viewed in the MTO Console on the Showback page.
MTO-Gateway	Deployment	The MTO-Gateway is the backend service that provides the REST API for the MTO-Console.
MTO-Console	Deployment	The MTO-Console is the user interface for the MTO system that provides a web-based interface for managing tenants, namespaces, sleep, and more. Details about the MTO-Console can be found here.