-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1460577
commit 03a5321
Showing
3 changed files
with
55 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Multi-Tenancy | ||
|
||
CAPL can manage multi-tenant workload clusters across Linode accounts. Custom resources may reference an optional Secret | ||
containing their Linode credentials (i.e. API token) to be used for the deployment of Linode resources (e.g. Linodes, | ||
VPCs, NodeBalancers, etc.) associated with the cluster. | ||
|
||
The following example shows a basic credentials Secret: | ||
|
||
```yaml | ||
apiVersion: v1 | ||
kind: Secret | ||
metadata: | ||
name: linode-credentials | ||
stringData: | ||
apiToken: <LINODE_TOKEN> | ||
``` | ||
```admonish warning | ||
The Linode API token data must be put in a key named `apiToken`! | ||
``` | ||
|
||
Which may be optionally consumed by one or more custom resource objects: | ||
|
||
```yaml | ||
# Example: LinodeCluster | ||
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha1 | ||
kind: LinodeCluster | ||
metadata: | ||
name: test-cluster | ||
spec: | ||
credentialsRef: | ||
name: linode-credentials | ||
... | ||
--- | ||
# Example: LinodeVPC | ||
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha1 | ||
kind: LinodeVPC | ||
metadata: | ||
name: test-vpc | ||
spec: | ||
credentialsRef: | ||
name: linode-credentials | ||
... | ||
``` | ||
|
||
Secrets from other namespaces by additionally specifying an optional | ||
`.spec.credentialsRef.namespace` value. | ||
|
||
```admonish warning | ||
If `.spec.credentialsRef` is set for a LinodeCluster, it should also be set for adjacent resources (e.g. LinodeVPC). | ||
``` |