Cosmo Tech tenant

install Cosmo Tech API and all its dependencies in a dedicated namespace

Requirements

• working Kubernetes cluster deployed from Cosmo Tech terraform-provider (like terraform-azure for example)
• terraform

  If using Windows, Terraform must be accessible from PATH

• situational
  • Azure: azure-cli
  • AWS: aws-cli

How to

• clone & open the repository

  git clone https://github.com/Cosmo-Tech/terraform-tenant.git --branch <tag>
  cd terraform-tenant
  

• deploy
  • fill terraform.tfvars variables according to your needs
  • run pre-configured script
    • plan

      get an execution plan to preview the changes without applying

      • Linux

        ./_run-terraform.sh
        

      • Windows

        ./_run-terraform.ps1
        

    • apply

      executes the operations proposed in the plan

      • Linux

        ./_run-terraform.sh --apply
        

      • Windows

        ./_run-terraform.ps1 --apply
        

Known errors

• Error: Provider configuration not present

  The tenant has been deleted or exists in an other cluster, but the state file still exists. Chose another tenant name or delete the state file if tenant doesn't exist anymore.

• Error: [POST /datasources][409] addDataSourceConflict {"message":"data source with the same name already exists"} [..] with module.config_grafana_dashboard.grafana_data_source.redis-datasource

  The state file could not be found (it has probably been deleted, but the deployed resources remains) Go to https://<cluster_url>/monitoring (credentials are stored on Kubernetes secret monitoring/kube-prometheus-stack-grafana) -> Connections -> Data sources -> Delete both tenant--postgresql and tenant--redis

• Error: failed to create folder: [POST /folders][409] createFolderConflict {"message":"a folder with the same name already exists in the current location"} [..] with module.config_grafana_dashboard.grafana_folder.folder

  The state file could not be found (it has probably been deleted, but the deployed resources remains) Go to https://<cluster_url>/monitoring (credentials are stored on Kubernetes secret monitoring/kube-prometheus-stack-grafana) -> Dashboards -> Delete tenant-

• Error: error sending POST request to /keycloak//admin/realms: 409 Conflict. Response body: {"errorMessage":"Conflict detected. See logs for details"} [..] with with module.config_keycloak_realm.keycloak_realm.realm

  The state file could not be found (it has probably been deleted, but the deployed resources remains) Go to https://<cluster_url>/keycloak (credentials are stored on Kubernetes secret keycloak/keycloak-config) -> Select the realm "tenant-" -> Realm settings > Action > Delete

Developpers

• modules
  • terraform-tenant
    • chart_argo = install Argo Workflows
    • chart_cosmotech_api = install Cosmo Tech API
    • chart_postgresql = install PostgreSQL (and configure it for Cosmo Tech API, SeaweedFS & Argo Workflows)
    • chart_redis = install Redis
    • chart_seaweedfs = install SeaweedFS
    • config_grafana_dashboard = create tenant configuration on existing Grafana instance (add custom dashboards)
    • config_harbor_project = create tenant configuration on existing Harbor instance (add dedicated project+user to host the tenant simulators)
    • config_keycloak_realm = create tenant configuration on existing Keycloak instance (create a dedicated tenant realm, and differents clients for the tenant)
    • config_superset_oauth_provider = create tenant configuration on existing Superset instance (add authentication from Keycloak)
    • kube_namespace = create tenant namespace
    • storage = [temporary] dynamically create persistence storage for charts requiring it
• Terraform state
  • The state is stored beside the cluster Terraform state, in the current cloud s3/blob storage service (generally called csmstates<id> or cosmotech-states, depending on what the cloud provider allows in naming convention)
• Scripts _run-terraform.*
  • Automatically detect hosting target (cloud provider name, on-premise...), and adapt the Terraform module to work with it
  • Terraform modules can work without the scripts, but will require some additional manual steps.
• File target.tf
  • Allow to have multi-cloud compatibility with Terraform
  • This file is dynamically created at each run of _run-terraform
  • It instanciates the needed Terraform configuration based on the variable cloud_provider from terraform.tfvars

    $TEMPLATE_ variables in files stored in targets/ are automatically replaced with values from terraform.tfvars

  • This file is a workaround to avoid having unwanted variables related to cloud providers not targetted in current deployment
• File variables_defaults
  • contains all the defaults configurations of the module
  • all artefacts versions are tagged in this file
  • everything is this file can be customized from TF_VAR_variable, CLI arguments or terraform.tfvars

Made with ❤️ by Cosmo Tech DevOps team