Files
capsule/docs/operator/use-cases/taint-namespaces.md
Adriano Pezzuto 6e24aad094 Improve documentation (#146)
* move docs in a separate folder
* review of readme and add faq
* rewrite use cases
* more use cases
* add new project logo
* minor improvements
2020-12-15 00:03:07 +01:00

1.5 KiB
Raw Blame History

Taint namespaces

With Capsule, Bill can "taint" the namespaces created by Alice with an additional labels and/or annotations. There is no specific semantic assigned to these labels and annotations: they just will be assigned to the namespaces in the tenant as they are created by Alice. This can help the cluster admin to implement specific use cases. As for example, it can be used to implement backup as a service for namespaces in the tenant.

Bill assigns an additional label to the oil tenant to force the backup system to take care of Alice's namespaces:

apiVersion: capsule.clastix.io/v1alpha1
kind: Tenant
metadata:
  name: oil
spec:
  owner:
    name: alice
    kind: User
  namespacesMetadata:
    additionalLabels:
      capsule.clastix.io/backup: "true"

or by annotations:

apiVersion: capsule.clastix.io/v1alpha1
kind: Tenant
metadata:
  name: oil
spec:
  owner:
    name: alice
    kind: User
  namespacesMetadata:
    additionalAnnotations:
      capsule.clastix.io/do_stuff: backup

When Alice creates a namespace, this will inherit the given label and/or annotation:

kind: Namespace
apiVersion: v1
metadata:
  name: oil-production
  labels:
    capsule.clastix.io/backup: "true"    # here the additional label
    capsule.clastix.io/tenant: oil
  annotations:
    capsule.clastix.io/do_stuff: backup  # here the additional annotation

Whats next

See how Bill, the cluster admin, can assign multiple tenants to Alice. Assign multiple tenants to an owner.