Flux TMC Multi-tenant

This repo serves as a starting point for managing multi-tenant clusters using Flux and TMC.In this case what we mean by multi-tenant is that different teams can share a K8s cluster and have access to self service namespaces in that cluster but not be able to interfere with other teams namespaces in the same cluster. This does not get into network policy for locking down namespace networking, that is out of scope. The overall goal of this repo is to give an base template an example of a real world flux multiteant use case with TMC. The structure of this repo accounts for multiple environments and clusters and is meant to be able to represent an enterprise environment.

Associated repos

Here are the repos for the tenants that are mentioned throughout this doc.

iris-green bootstrap repo

iris-green app repo

iris-blue bootstrap repo

iris-blue app repo

iris-red bootstrap repo

iris-red app repo

Roles

Platform Admin

Has admin access to TMC
Has admin access to all k8s clusters
Manages the "infra-ops" cluster
Manages cluster wide resources
Onboards the tenant’s main GitRepository and Kustomization

Tenant

Has self service namespace creation
Has admin access to the namespaces they create
Manages GitRepositories, Kustomizations, HelmRepositories and HelmReleases in their namespaces
has editor access into thier TMC workspace

How it works

TMC has the concept of a workspace which can group multiple namespaces across clusters under a single space. Using this concept we can create a tenancy model around namespaces in a cluster. This workspace concept is core to the multitenancy in this repo. The way this tenancy model works is this:

tenants get their own workspace and using TMC permissions we can ensure they are not able to access namespaces outside of their workspace as a logged in user
A flux bootstrap namespace and service account is created for each tenant, this namespace is where the initial kustomization for flux is deployed by the platform admin.
The bootstrap namespace service account is given permissions in TMC to the workspace. *** This is a key piece in that TMC handles propogating the permissions on the service account to access the tenants other namespaces. without TMC doing this another tool is needed to handle this, it's not native to k8s. ***
A TMC custom OPA policy is used to enforce that the tenants kustomizations and other flux reosurces use a service account. this prevents the flux controller from operating as cluster admin. This si cirtical in limiting the tenants access.
Enforcing namespace creation through flux allows for the platform admins to overwrite the critical fields to make sure namespaces are created in the right workspace.

Clustergroup bootstrapping

One key element to this setup is how every cluster gets bootstrapped with the right flux config and paths. The approach used here is to only enable the TMC CD components at the clustergroup level. The typical challenge with this approach is that setting a kustomization at the clustergroup level means you cannot override the path per cluster and means everything needs to be the same in each cluster. This is not the case in most situations so in order for this to work we need every cluster to be able to override clustergroup configuration. This is done by using a combination of carvel tooling, tmc provided information and flux variables injection. Here is a breakdown of the process.

when a clustergroup kustomization is created it will point to the folder clustergroups/<groupname>
from there two other kustomizations are created clustergroup-gitops and group-apps
group-apps points to apps/clustergroups/<groupname> which defines any group level apps that need to be installed. most importantly it installs the apps/base/cluster-name-secret
the cluster-name-secret app in this case is using carvel secretgen to create a secret containing the cluster name from the tmc provided configmap stack-config and then using a secretExport and secretImport to copy that secret into the tanzu-continous-delivery-resources namespace.
clustergroup-gitops depends on group-apps and points to clustergroups/common/per-cluster where it creates a kustomization called cluster-gitops also it uses the flux substituteFrom capability to inject the cluster name from the previosuly created secret as a variable for use.
cluster-gitops creates a path dynamically using the cluster name to point to clusters/<clustername> which allows for cluster specific flux configuration.

Using this structure we can now set a single kustomization at the clustergroup level and have it dynamically create cluster specific kustomizations

Multi Tenant Architecture

This architecture is simplified and does not show all of the details but it highlights a few key components which are the tenancy with workspaces, the infra-ops cluster, and the use of different repos and flux.

Platform admin repo structure

The platform admin repo has the following directories

clustergroups

this contains directories with Flux config for each group. This is where the base bootstrap config lives. This is used when initially configuring a cluster group's Kustomization in TMC. Everything is initiated from here.

clustergroups
│   ├── common
│   │   └── per-cluster
│   │       └── base.yaml
│   └── <clustergroup-name>
│       ├── base.yml
│       └── kustomization.yaml

subdirectories:

common - used for any common config between all cluster groups.
common/per-cluster - this holds the kustomization that is dynamically created for each cluster that is mentioned in the clustergroup boostrapping section.
clustergroup-name - folder per cluster group with configs for that clustergroup.

clusters

This contains directories with Flux config for each cluster. This is what will hold each clusters base configuration that gets boostrapped from the cluster group.

clusters
│   └── <cluster-name>
│       ├── apps.yml
│       ├── infrastructure.yml
│       └── tenants.yml

subdirectories/files:

cluster-name> - each cluster will have it's own directory that contains any cluster specific configuration. apps.yml - sets up the cluster specific kustomization pointing to the clusters directory in the apps folder. infrastructure.yml - sets up the cluster specifc kustomization ponting to the clusters directory infrastructure directory. tenants.yml - this is a single kustomization with a patch that defines each tenant into the helm chart values. This is used for bootstrapping tenants on a cluster

infrastructure

Contains config to install common infra tools per environment. This idea here is that infrastructure is used for installing tools that are more infra focused (ex. external secrets operator) per environment and the apps directory is used for more general apps/config per cluster.

infrastructure
│   ├── base
│   │   ├── <some-app>
│   │   │   ├── kustomization.yml
│   │   │   └── install.yml  
│   │   └── kustomization.yml
│   ├── env
│   │   ├── <environment>
│   │   │   ├── <some-app>
│   │   │   │   └── install.yml
│   │   │   └── kustomization.yml

subdirectories/files:

base - contains folders for each infra app to be installed in the cluster.
env - contains folders for every environment.
env/<environment> - holds the configuration for which apps to install in that environment.
env/<environment>/<some-app> - holds any environment specific overrides for that app.

apps

Contains all of the app configs that will be installed per cluster or clustergroup. Also allows for environment specific overrides if necessary.

apps
│   ├── base
│   │   ├── <some-app>
│   │   │   ├── install.yml
│   │   │   └── kustomization.yaml
│   ├── clustergroups
│   │   ├── <clustergroup-name>
│   │   │   └── kustomization.yaml
│   ├── clusters
│   │   └── <cluster-name>
│   │       └── kustomization.yaml
│   └── env
│       └── <environment>
│           └── <some-app>
│               ├── kustomization.yaml
│               └── override.yml

subdirectories/files:

base - contains folders for each app to be installed in the clusters.
clustergroups - contains folders for each clustergroup. This allows for adding config to install certain apps and overrides per cluster group.
clusters - contains folders for each cluster. This allows for adding config to install certain apps and overrides per cluster.
env - contains folders for every environment.
env/<environment>/<some-app> - holds any environment specific overrides for that app.

examples:

some good examples of different ways to override settings can be found in the following directories.

apps/clusters/iris-dev - this shows how to use an env override with the components directive for external-secrets. It also shows how to do an override specific to the cluster using the inline patches to add an override values file for contour.

tmc

Contains any yaml needed for creating TMC objects with the CLI.

Tenant repo structure

The tenant repo has the following directories

clusters

this has a directory for each cluster. this will be the reference point for the tenants configured in the platform admin repo. This is used as a bootstrap for the tenant to configure their own kustomizations.

clusters
    └── <cluster-name>
        ├── kustomization.yml
        ├── namespaces
        │   ├── kustomization.yml
        │   └── namespaces.yml

subdirectories/files:

<cluster-name> - one for each cluster to deploy on
<cluster-name>/namespaces - hold files(s) that define the TMCNamespace objects for namespace self service. also contains the kustomization.yml that adds the unique suffic to the TMCNamespace objects

Initial Setup

These steps walk through a somewhat opinionated way of organzing things. This is not the only way of doing it and is just an example. Also for any infrastructure created it's advised that this be automated rather than being done by hand, in this example we will use the cli for everything we can. If you already have existing infra, it's not necessary to create new clusters etc. just use those. Also for the purpose of this setup we will assume that we have a platform team and 3 tenants. Those tenants are all within the same product group but are different app teams. our product group name is Iris, so we will have a setup where each team gets a workspace in TMC and k8s clusters will be grouped by environment into cluster groups, each product group in this case will have a cluster(s) per environment. Our three dev teams will be called iris-green, iris-red, iris-blue.

Explaining the Infra-Ops cluster

In the next few sections it will refer to an "infra-ops" cluster. This cluster is not something that tenants will deploy onto. This cluster is used by platform admins to run thier workloads for mgmt purposes. Specifically in this case it is used to run the tmc-controller this is a metacontroller that is used for creating TMC namespaces. This allows for self service management of namespaces in TMC with gitops.

Create initial cluster groups

For this setup we will have the following cluster groups. Since we are implementing multitenancy we will also assume that there will be multiple dev teams using a single cluster separated by namespace.

infra-ops - used by platform admins
dev - tenants will exist here to deploy dev code
test - tenants will exist here to deploy tes code

Create these cluster groups in TMC:

tanzu tmc clustergroup create -f tmc/clustergroups/infra-ops.yaml
tanzu tmc clustergroup create -f tmc/clustergroups/dev.yaml
tanzu tmc clustergroup create -f tmc/clustergroups/test.yaml

Create initial clusters

This will not walk through creating the clusters needed since it's out of scope, but create the following cluster's on your favorite flavor of k8s and put them in the respective cluster groups.

clusters:

infra-ops
iris-dev
iris-test

Create initial workspaces for each team

Each team gets their own workspace in which all of their namespaces will be created

tanzu tmc workspace create -f tmc/workspaces/iris-green.yaml
tanzu tmc workspace create -f tmc/workspaces/iris-blue.yaml

Setup secrets management

Some type of secrets management will be needed when using gitops. There are a few different approaches, but in this exmaple we will be using Azure Key Vault. This will allow us to use one bootstrap secret that can then be used by external secrets that will handle all other secrets.

This will not go thorugh the entire process of setting up AKV but it will include installing external secrets with AKV.

Additionally when setting this up we will use a bootstrap credential in the clusters, however if you have workload identity setup to work with azure this could be done using a role instead of a SP.

Other options:

SOPS Sealed Secrets

Secret tenancy

Since this is a multitenant setup we need multitenant secrets.

Option 1

This option is the we have implemented for this repo.

There will be one ClusterSecretStore that is managed by the platform admins. We will create one AKV per environment. The secrets in AKV will be based on a naming convention, this will allow for policy based access to secrets. The naming will be something along the lines of $tenant-$secretname this would then mean that per workspace(tenant) a policy will enforce what they can access. You can read more about the inspiration for this in Dodd Pfeffer's detailed blog post here

This approach still leaves the option open for developers to create their own namespace bound secretStores but it is up to them to botstrap the credentials for those. If desired, the cluster secret store could even be used as a way to inject the namespace based secretstore boostrap creds into the clusters.

Pros:

optional self service for tenants
centralized vault so tenants don't need to worry about managing vaults
works well in a managed platform environment Cons:
bootstrap secrets required
some custom automation may be required to enable secret creation.

As a Platform admin:

Create centralized keyvault in azure per environment. for this setup create the following
1. ss-env - this is the shared service environment vault(mostly used for platform stuff)
2. dev-env - dev env vault
3. test-env - test env vault
Create a Azure SP that has read access to the keyvault
bootstrap the cluster with the Azure SP credentials created above. We can make this easy using TMC. TMC has the ability to create opaque secrets at the cluster group level. This will make it so that every cluster in the cluster group automatically gets the bootstrap secret. This remove the need for running a script to bootstrap clusters. before running the below commands make sure to update the files with your client-id and client secret

tanzu tmc secret create -f tmc/secrets/azure-sp-bootstrap-dev.yaml -s clustergroup
tanzu tmc secret create -f tmc/secrets/azure-sp-bootstrap-test.yaml -s clustergroup
tanzu tmc secret create -f tmc/secrets/azure-sp-bootstrap-infra-ops.yaml -s clustergroup

create a policy in TMC using gatekeeper to prevent tenants from accessing eachothers secrets and apply it to the two cluster groups. This policy will make sure that the naming convention matches the tenant workspace label on the namepsace. becuase of the access given to tenants they will not be able to modify this label so it is a good identifier to match on. The policy will match any namespace with the tmc.cloud.vmware.com/workspace label, this can be changed to meet your needs. For example you could have a list of workspaces to apply this to using the same label but with a list of values to match.

tanzu tmc policy policy-template create --object-file tmc/policy/enforce-es-naming-template.yaml --data-inventory "/v1/Namespace"
tanzu tmc policy create -f tmc/policy/enforce-es-naming-dev.yaml -s clustergroup
tanzu tmc policy create -f tmc/policy/enforce-es-naming-test.yaml -s clustergroup

Update the ClusterSecretStore details in the git repo. Under apps/env/<env-name>/external-secrets-crd there is an override yaml. update this with your tenant id and vault url for each environment.
create secrets in the key vault for the tenants. This document does not cover the automation, but this could be done with a process that allows tenants to manage their own creential entries.

As a tenant:

create an external secret object that references the secret you want in your namespace. An example of this can be found here, notice the naming convention being used iris-green-example-secret

Option 2

This option works well for teams that manage their own AKV instances and also if your clusters are federated with Azure(AKS or using workload-identity) and can use workload identities. In this setup tenants will manage their own secretStores in their namespaces. This does not require any setup from the platform admin team outside of installing the operator which this repo already handles.

Pros:

self service for tenants
no secrets invovled to bootstrap
works well in an environment with more advanced tenants Cons:
no centralized control of vault so more effort for tenants(less platform like)
advanced setup of identities outside of AKS

This repo does not cover the scope of setting up workload identity for Azure, but the quickstart here does a nice job of explaining. Once this is complete the below process can be used by tenants or admins to access their vaults.

As a tenant:

create a k8s service account in my namespace and assign it a workload identity that has permissions to the vault. docs here.
create a secretStore in my namespace and set the service account ref field to use the previosuly created account. docs here.
start using externalSecrets to consume secrets.

Install the operator

Since we are using gitops, this will be installed automatically though this repo. there is nothing else to do here. In the following steps the kustomizations will be created that deploy this.

Setup Automated DNS

If you would like automated DNS through external-dns follow these steps. if you would like to manually setup DNS you can remove the external dns setup from the cluster kustomizations in apps/clusters/<clustername>/kustomization.yaml.

External DNS supports many providers, for this example we will use AWS route 53. You can change this to meet your needs based on the external dns documentation.

Create a hosted zone or use existing

we need a zone to use to create dns entries. In this example we will create a single hosted zone and then have external-dns manage creating subdomains per cluster. If you already have an existing zone Skip ahead.

aws route53 create-hosted-zone --name <yourdomain> --caller-reference <randomstring>

#ex.  aws route53 create-hosted-zone --name fluxtmc.aws.warroyo.com --caller-reference 123y3hjdhajkdh

be sure to add your upstream ns records if needed so that the domain resolves.

Setup the IAM Policy and credentials

Just like with secrets management this could be skipped and instead you can use an identity on the pods. For simplicity in this example we will use the IAM user approach instead of a pod identity.

aws iam create-policy --policy-name tmc-flux-external-dns --policy-document \
'{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "route53:ChangeResourceRecordSets"
      ],
      "Resource": [
        "arn:aws:route53:::hostedzone/*"
      ]
    },
    {
      "Effect": "Allow",
      "Action": [
        "route53:ListHostedZones",
        "route53:ListResourceRecordSets"
      ],
      "Resource": [
        "*"
      ]
    }
  ]
}'

create a IAM user and add the policy

aws iam create-user --user-name external-dns-fluxtmc
aws iam create-access-key --user-name external-dns-fluxtmc
aws iam attach-user-policy --policy-arn <arn-from-above> --user-name external-dns-fluxtmc

Add the AWS credentials to AKV

Since we are using AKV for secrets management we will add the created credentials to the key vault for the environments. In this case the user is the same for both environments but if it's not be sure to repeat these steps for each environment.

#dev env
az keyvault secret set --vault-name "dev-env" --name "external-dns-access-key" --value "<access-key>"
az keyvault secret set --vault-name "dev-env" --name "external-dns-secret-key" --value "<secret-key>"

# test env
az keyvault secret set --vault-name "test-env" --name "external-dns-access-key" --value "<access-key>"
az keyvault secret set --vault-name "test-env" --name "external-dns-secret-key" --value "<secret-key>"

Deploy the operator

This is all done through gitops, so at this point everything is prepared and will be handled by flux.

Enable CD components on the cluster groups for TMC

This will enable the flux kustomize and helm controllers in all of the clusters that are added to the cluster groups.

tanzu tmc continuousdelivery enable -g infra-ops -s clustergroup
tanzu tmc continuousdelivery enable -g dev -s clustergroup
tanzu tmc continuousdelivery enable -g test -s clustergroup

tanzu tmc helm enable -g infra-ops -s clustergroup
tanzu tmc helm enable -g dev -s clustergroup
tanzu tmc helm enable -g test -s clustergroup

Create the custom TMC policy to enforce service account usage

We need to create an Gatekeeper constraint template that will allow us to enforce service account usage on the flux CRDs. This prevents tenants from being able to use admin level creds with flux.

tanzu tmc policy policy-template create --object-file tmc/policy/enforce-sa-template.yaml

Apply that template to the two cluster groups that tenants clusters will be in. We will also exclude the namespaces that we don't want it enforce on.

tanzu tmc policy create -f tmc/policy/enforce-sa-dev.yaml -s clustergroup
tanzu tmc policy create -f tmc/policy/enforce-sa-test.yaml -s clustergroup

Create the TMC IAM roles needed

The first role needed is the role that will be equivalent to cluster admin and bound to the bootsrap namespace's service account called tenant-flux-reconciler. this is required becuase currently the built in TMC roles at the workspace level do not have enough permisisons for CRDs.

tanzu tmc iam role create -f tmc/iam/cluster-admin-equiv-iam.yaml

The next role is the one that will allow the flux tenant service account in the infra-ops cluster the ability to create TMC namespaces. this enables namespace self service.

tanzu tmc iam role create -f tmc/iam/tmcnamespaces-iam.yaml

Bind the roles to the service account with TMC IAM policy

This role binding is going to bind the tenants service account to the cluster admin equivalent role in the tenants workspace. This will mean that anytime a new namespace is created the service account flux is using will immediately have the correct permissions on the namespace. This is very useful, without this workspace level binding we would need to use some type of controller to handle this dynamically for us.

tanzu tmc iam update-policy -s workspace -n iris-blue -f tmc/iam/sa-rb-workspace-blue.yaml
tanzu tmc iam update-policy -s workspace -n iris-green -f tmc/iam/sa-rb-workspace-green.yaml

Create the base Gitrepos for each cluster group

Each cluster group will need a gitrepo added as the base git repo to bootstrap the cluster. In this case that repo is this one. This could be any git repo though as long as the structure is setup properly.

tanzu tmc continuousdelivery gitrepository create -f tmc/continousdelivery/test-gitrepo.yaml -s clustergroup
tanzu tmc continuousdelivery gitrepository create -f tmc/continousdelivery/dev-gitrepo.yaml -s clustergroup
tanzu tmc continuousdelivery gitrepository create -f tmc/continousdelivery/infra-ops-gitrepo.yaml -s clustergroup

Setup the Infra-Ops Cluster

The infra ops cluster should be a one time setup since there is not one per tenant. This cluster will host our TMC Controller that enables the self service of namespaces.

Create the TMC credential

The infra-ops cluster needs to be able to communicate with the TMC API. Create a credential in the ss-env AKV for the TMC API token.

create a TMC API token
create the AKV entries.

for the tmc-host value enter this as the TMC hostname without https://. it should juts be the fqdn.

az keyvault secret set --vault-name "ss-env" --name "tmc-csp-token" --value "<tmc-api-token>"
az keyvault secret set --vault-name "ss-env" --name "tmc-host" --value "<tmc-hostname>"

Setup the bootstrap Kustomization

By enabling this bootstrap kustomization it will start the process of installing all of the required tools on the infra-ops clusters.

rename the folder clusters/eks.eks-warroyo2.us-west-2.infra-ops to match your TMC cluster name.
enable the kustomization

tanzu tmc continuousdelivery kustomization create -f tmc/continousdelivery/infra-ops.yaml -s clustergroup

Here is a breakdown on what gets installed and how. This does not cover the initial bootstrap process in detail which is covered in detail in the above section

The kustomization created above points to this path clustergroups/infra-ops in this repo.
From that folder two more kustomizations are created group-apps and clustergroup-gitops
group-apps points at /apps/clustergroups/infra-ops. This installs the metacontroller and the tmc controller from the apps/base directory. these are kustomizations that point at other git repos.
clustergroup-gitops bootstraps the cluster specific kustomization called cluster-gitops
cluster-gitops points at /clusters/eks.eks-warroyo2.us-west-2.infra-ops which creates a few more kustomizations infrastructure, apps, infra-pre-reqs and the tenant specific kustomizations. Read more about the standard repo stucture above for details on what each kustomization's purpose is.
infrastructure sets up external secrets operator and cert-manager.
apps - sets up the clusterSecretStore pointing at our ss-env AKV using the boostrap credential.
infra-pre-reqs - installs any pre-reqs for infra apps. this can be used to install any dependencies since infrastructure kustomization depends on it.
tenants specific kustomizations, this sets up a tenant namespace and service account, as well as the kustomization that points at the tenants bootstrap repo and path to namespaces. It also creates an initial TMCNamespace object for the bootstrap ns in the downstream cluster(s). This is what configures namespace self service. the kustomization also overrides fields in the TMCNamespace objects to ensure they are not creating things outside of their workspace.

Summary of initial setup

At this point all of the one time setup has been complete. This means that we can now onboard tenants and/or new clusters.

Here is a summary of what was created:

clusters for each env
infra-ops cluster with TMC controller
workspaces for each team
cluster groups for each environment
policies for enforcing tenancy
IAM policy for enforcing tenancy
enabling base flux components at the cluster group level
secrets management setup with AKV

Add a tenant to a cluster

For this step we will walk through adding a tenant to a clustergroup. This will use pre-existing configuration from this repo. In another section we will cover creating a tenant from scratch.

Setup the bootstrap Kustomizations

Each cluster group will have an initial kustomization that points to a specific path in the git repo to bootstrap. This will create other Kustomizations that will be specific to each cluster.

rename the folder clusters/eks.eks-warroyo2.us-west-2.iris-dev and clusters/eks.eks-warroyo2.us-west-2.iris-dev to match your TMC cluster names.
this creates the kustomizations for the dev and test cluster groups.

tanzu tmc continuousdelivery kustomization create -f tmc/continousdelivery/dev.yaml -s clustergroup
tanzu tmc continuousdelivery kustomization create -f tmc/continousdelivery/test.yaml -s clustergroup

Here is a breakdown of what is happening after creating these. This breakdown is for the dev clustergroup and iris-dev cluster but this same process happens for any cluster added.

The kustomization created above points to this path clustergroups/dev in this repo.
From that folder two more kustomizations are created group-apps and clustergroup-gitops
group-apps points at /apps/clustergroups/dev. currently the only thing installed here is the secret imports and exports to make the next step work.
clustergroup-gitops bootstraps the cluster specific kustomization called cluster-gitops
cluster-gitops points at /clusters/eks.eks-warroyo2.us-west-2.iris-dev which creates a few more kustomizations infrastructure, apps, infra-pre-reqs and the tenant specific kustomizations. Read more about the standard repo stucture above for details on what each kustomization's purpose is.
infrastructure sets up external secrets operator and cert-manager.
apps - sets up the clusterSecretStore pointing at our dev-env AKV using the boostrap credential. Also installs the contour package.
infra-pre-reqs - installs any pre-reqs for infra apps. this can be used to install any dependencies since infrastructure kustomization depends on it.
tenants specific kustomizations, this sets up a service account in the tenant bootstrap ns that was created through the ns automation in the infra-ops cluster. As well as the kustomization that points at the tenants bootstrap repo and path to the cluster name. Permissions for the service account are inherited by the access policy on the workspace. This is what allows the tenant to now create their own kustomizations and gitrepos to install their apps.

After the reconcile completes you should see a number of kustomizations in the cluster and everything should be deployed from the tenant bootstrap repo. It will look like this:

NAMESPACE↑                                   NAME                            READY          STATUS                                                                    AGE              │
│ iris-blue                                    iris-blue                       True           Applied revision: main/7f1800ddfe91e8546e8ee895cb463cea76ca799f           28h              │
│ iris-blue                                    iris-blue-apps                  True           Applied revision: main/0a0022ebc2735d8defaa373d511499ac64949474           12m              │
│ iris-green                                   iris-green                      True           Applied revision: main/2402dfc51ea88adab1535306741925bc6ecaeb4f           28h              │
│ iris-green                                   iris-green-apps                 True           Applied revision: main/b1d1541217c8565f37e8659391c3f152227692ed           25m              │
│ iris-red                                     iris-red                        True           Applied revision: main/a79bd9de6fbd1e3fd6f41b864873e00aa63f03ee           25h              │
│ iris-red                                     iris-red-apps                   True           Applied revision: main/3215ab378aed49d155427c1efe1c70b62bdd55ea           16s              │
│ tanzu-continuousdelivery-resources           apps                            True           Applied revision: main/177933088ded390537795fc8b1bb94a230af1239           46h              │
│ tanzu-continuousdelivery-resources           cg-base                         True           Applied revision: main/177933088ded390537795fc8b1bb94a230af1239           2d22h            │
│ tanzu-continuousdelivery-resources           cluster-gitops                  True           Applied revision: main/177933088ded390537795fc8b1bb94a230af1239           46h              │
│ tanzu-continuousdelivery-resources           clustergroup-gitops             True           Applied revision: main/177933088ded390537795fc8b1bb94a230af1239           46h              │
│ tanzu-continuousdelivery-resources           external-secrets-crds           True           Applied revision: main/59bf53e7a3cdd38dd0d742f0950b731d89cc50e6           46h              │
│ tanzu-continuousdelivery-resources           group-apps                      True           Applied revision: main/177933088ded390537795fc8b1bb94a230af1239           46h              │
│ tanzu-continuousdelivery-resources           infra-pre-reqs                  True           Applied revision: main/177933088ded390537795fc8b1bb94a230af1239           46h              │
│ tanzu-continuousdelivery-resources           infrastructure                  True           Applied revision: main/177933088ded390537795fc8b1bb94a230af1239           46h

Adding a new cluster

This will outline adding a new cluster to an existing environment, the process would be similar for adding an environment but you would just need to add more folders for the environment specific pieces.

Platform admin Tasks

create the cluster and add it to the appropriate cluster group
create a new folder in the clusters directory with the name of the cluster from TMC.
add the neccessary files, examples of what are in the files can be foudn in this directory and are explained in the repo stucture.
1. tenants.yml
2. apps.yml
3. infrastructure.yml
create a new folder in the apps/clusters directory with the name of the cluster. this must match the path given in the apps.yml
create a kustomization.yml in that directory with the references to the apps you want installed in that cluster.

Tenant tasks

These steps would only be done if the tenant was added to the new cluster. The steps are the same as the steps below for adding a new Tenant.

Adding a new tenant

These steps should be completed any time a new team is wanting to be onboarded. These steps are outlined with commands referencing this repo's setup but these could be adpated to be done generically.

using iris-red as the new tenant.

Platform admin tasks

create a new workspace in TMC for the team.

tanzu tmc workspace create -f tmc/workspaces/iris-red.yaml

bind the service account to the IAM role using a tmc access policy. this gives the service account in the bootstrap namespace permissions to any namespace in the workspace.

tanzu tmc iam update-policy -s workspace -n iris-red -f tmc/iam/sa-rb-workspace-red.yaml

add a tenant to the list of tenant in the tenant.yml in the infra-ops cluster folder. See more on the tenant automation below.
create a tenant gitops repo, this could also be handled by the tenant initially and passed to the admins. In this case our git repo name is iris-red-gitops
Add the tenant to the values in the tenant.yml for the cluster. See docs here on tenant automation.
commit these files into the git repo and wait for flux to reconcile. here is what is created
1. tenant workspace
2. tenant git repo
3. tenant ns in the cluster(s)
4. IAM rules for tenant
5. ability to do NS self service
6. intial flux config so they can start installing apps.

Tenant tasks

The tenant tasks will vary based on what the tenant wants to do but here is the minimum required to get things working.

Create folder for clusters in the tenant git repo

mkdir -p clusters/iris-dev

Create a folder for namespaces per cluster

mkdir -p clusters/iris-dev/namespaces

create the kustomization files in each directory to let flux know which files to reconcile. This will depend on how the tenant wants to structure thier repo. an example can be found here.

Automation ideas

In the steps above we used a helm chart to generate most of our tenant yaml. More automation could be done here or this could be done in another way. Here are some ideas.

TAP acelerators for tenant repos
ADO pipelines + YTT templated files
Simple bash scripts to create the files.
CLI scaffolding generator tooling

Self Service a namespace

The setup in the repo allows for tenants to self service namespaces. This is done using TMC workspaces, without a TMC workspaces this problem is someone hard to solve and requires other 3rd party tools. Additionally we want self service through gitops, to solve this problem the TMC controller was created. So what is enabled is the ability for a tenant to put TMC namespace configs into a directory in thier tenant git repo and it will create them and give them permissions to those namespaces automatically.

In the tenant git repo make sure you have the clusters/<clustername/namespaces folder created. this is what flux watches.
create a file(s) in the directory that has the namespace config. An example can be found here
make sure that the kustomization includes that file, example here. Make sure that the kustomization also includes a unique nameSuffix this will make sure that the TMCNamespace objects do not have collisions in the infra-ops cluster.

Tenant Automation

For this repo we have setup some automation around how tenants get generated. This is done using a helm chart that is embedded in this repo in the tenant-generator folder.This makes it easier to add tenants to a cluster. Rather than copy pasting a bunch of yaml it allows for simply adding some variables to an array and the helm chart will generate all of the resources and apply them to the cluster.

There are two types of cluster tenants that it supports, infra and workload. Infra is used for the infra ops cluster which manages TMC namespace objects and is slightly different than workload. Workload is used for all clusters that tenants will be deploying to and is a bit more simple than the infra setup.

The Basics

Before going into the differences between the two, let's dive into the commonalities and how it works.

The tenants.yml for each cluster contains a kustomization this points at the /apps/base/tenant-generator/ folder which defines a helmRelease that uses our prebiosuly mentioned chart. It also depends on the apps kustomization so that it runs after core software is installed. The helmRelease defines the bare minimum config needed to install the chart and then for each cluster we can override the values for the chart using a patch. The patch is where the tenants get added. this is simply passing the values to the helm chart. The helm release will then loop over each and generate the required k8s manifests.

Infra Setup

The tenants.yml file for an infra cluster it will look like this. The main thing to look at is the patches section which is all that really needs to change. This has a few key variables and an array called tenants. this is where you add new tenants.

---
apiVersion: kustomize.toolkit.fluxcd.io/v1beta2
kind: Kustomization
metadata:
  name: tenants
  namespace: tanzu-continuousdelivery-resources
spec:
  dependsOn:
  - name: apps
  interval: 10m0s
  path: ./apps/base/tenant-generator/
  prune: true
  sourceRef:
    kind: GitRepository
    namespace: tanzu-continuousdelivery-resources
    name: infra-gitops
  patches:
    - patch: |
        - op: add
          path: /spec/values
          value:
            cluster_type: infra
            infra_cluster:
              tenants:
                - name: iris-blue
                  namespace: iris-blue
                  workspace: iris-blue
                  git_repo_url: https://github.com/warroyo/iris-blue-gitops
                  clusters:
                    - name: eks.sp-eks-new.us-east-2.iris-dev
                      provisioner: eks
                      mgmt_cluster: eks
                    - name: aks.c149b7a9.my-resource-grp-sp.iris-test
                      provisioner: aks
                      mgmt_cluster: aks
                - name: iris-green
                  namespace: iris-green
                  workspace: iris-green   
                  git_repo_url: https://github.com/warroyo/iris-green-gitops
                  clusters:
                    - name: eks.sp-eks-new.us-east-2.iris-dev
                      provisioner: eks
                      mgmt_cluster: eks
                    - name: aks.c149b7a9.my-resource-grp-sp.iris-test
                      provisioner: aks
                      mgmt_cluster: aks
      target:
        kind: HelmRelease
        name: tenant-generator
        namespace: tanzu-continuousdelivery-resources

Workload Setup

The tenants.yml file for a worklaod cluster looks almost the same as the infra cluster type excppt that the values in the paches are different. see below.

---
apiVersion: kustomize.toolkit.fluxcd.io/v1beta2
kind: Kustomization
metadata:
  name: tenants
  namespace: tanzu-continuousdelivery-resources
spec:
  dependsOn:
  - name: apps
  interval: 10m0s
  path: ./apps/base/tenant-generator/
  prune: true
  sourceRef:
    kind: GitRepository
    namespace: tanzu-continuousdelivery-resources
    name: infra-gitops
  patches:
    - patch: |
        - op: add
          path: /spec/values
          value:
            cluster_type: workload
            workload_cluster:
              cluster_name: ${cluster_name} 
              tenants:
                - name: iris-blue
                  namespace: iris-blue
                  git_repo_url: https://github.com/warroyo/iris-blue-gitops
                - name: iris-green
                  namespace: iris-green   
                  git_repo_url: https://github.com/warroyo/iris-green-gitops
                - name: iris-red
                  namespace: iris-red   
                  git_repo_url: https://github.com/warroyo/iris-red-gitops
                
      target:
        kind: HelmRelease
        name: tenant-generator
        namespace: tanzu-continuousdelivery-resources

Name		Name	Last commit message	Last commit date
Latest commit History 136 Commits
apps		apps
clustergroups		clustergroups
clusters		clusters
images		images
infrastructure		infrastructure
tenant-generator		tenant-generator
tmc		tmc
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
README.md		README.md

warroyo/flux-tmc-multitenant

Folders and files

Latest commit

History

Repository files navigation

Flux TMC Multi-tenant

Associated repos

Roles

How it works

Clustergroup bootstrapping

Multi Tenant Architecture

Platform admin repo structure

clustergroups

clusters

infrastructure

apps

tmc

Tenant repo structure

clusters

Initial Setup

Explaining the Infra-Ops cluster

Create initial cluster groups

Create initial clusters

Create initial workspaces for each team

Setup secrets management

Secret tenancy

Install the operator

Setup Automated DNS

Create a hosted zone or use existing

Setup the IAM Policy and credentials

Add the AWS credentials to AKV

Deploy the operator

Enable CD components on the cluster groups for TMC

Create the custom TMC policy to enforce service account usage

Create the TMC IAM roles needed

Bind the roles to the service account with TMC IAM policy

Create the base Gitrepos for each cluster group

Setup the Infra-Ops Cluster

Create the TMC credential

Setup the bootstrap Kustomization

Summary of initial setup

Add a tenant to a cluster

Setup the bootstrap Kustomizations

Adding a new cluster

Platform admin Tasks

Tenant tasks

Adding a new tenant

Platform admin tasks

Tenant tasks

Automation ideas

Self Service a namespace

Tenant Automation

The Basics

Infra Setup

Workload Setup

About

Resources

Stars

Watchers

Forks

Releases 3

Packages 0

Languages

Packages