Skip to content

Commit c5b5f49

Browse files
Add more clarification on the multi-tenancy docs (#459)
This is not immediately clear from the yaml, add some comments to tie it together
1 parent a74ef87 commit c5b5f49

1 file changed

Lines changed: 6 additions & 8 deletions

File tree

  • pages/plural-features/projects-and-multi-tenancy

pages/plural-features/projects-and-multi-tenancy/index.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,40 +26,38 @@ The core of how tenancy is managed at scale is via Projects. An example of how
2626
apiVersion: v1
2727
kind: Namespace
2828
metadata:
29-
name: gke-fleet
29+
name: gke-fleet # this will be the namespace all Plural CRDS for `gke-fleet` live in for your management cluster
3030
---
3131
apiVersion: deployments.plural.sh/v1alpha1
3232
kind: ServiceAccount
3333
metadata:
3434
name: gke-fleet
3535
spec:
36-
email: gke-fleet-fleet@plural.sh
36+
email: gke-fleet-fleet@plural.sh # the Plural service account user that will be admin for that Project
3737
tokenSecretRef:
38-
name: gke-fleet-sa-token
38+
name: gke-fleet-sa-token # a secret that its access token will be dumped to
3939
namespace: gke-fleet
4040
---
4141
apiVersion: deployments.plural.sh/v1alpha1
4242
kind: Project
4343
metadata:
4444
name: gke-fleet
45-
annotations:
46-
config.kubernetes.io/depends-on: deployments.plural.sh/ServiceAccount/gke-fleet
4745
spec:
4846
name: gke-fleet
4947
description: resources for managing the gke-fleet fleet
5048
bindings:
5149
write:
52-
- userEmail: gke-fleet-fleet@plural.sh
50+
- userEmail: gke-fleet-fleet@plural.sh # adds the user as a writer for the project (by email)
5351
---
5452
apiVersion: deployments.plural.sh/v1alpha1
5553
kind: NamespaceCredentials
5654
metadata:
5755
name: gke-fleet
5856
spec:
5957
namespaces:
60-
- gke-fleet
58+
- gke-fleet # the namespace we want gke-fleet crs to live in
6159
secretRef:
62-
name: gke-fleet-sa-token
60+
name: gke-fleet-sa-token # the token the operator will use in that namespace, ensuring permissions are only scoped to the project
6361
namespace: gke-fleet
6462
```
6563

0 commit comments

Comments
 (0)