You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: vcluster/configure/vcluster-yaml/external/platform/api-key.mdx
+28-28Lines changed: 28 additions & 28 deletions
Original file line number
Diff line number
Diff line change
@@ -19,42 +19,42 @@ import TabItem from '@theme/TabItem';
19
19
20
20
<!--valeoff-->
21
21
22
-
Enable secure communication between your virtual cluster and the vCluster Platform.
22
+
Enable secure communication between your virtual cluster and the vCluster Platform.
23
23
You can configure the platform to manage and authenticate virtual cluster connections consistently across different environments.
24
24
25
-
## Connect virtual clusters to the vCluster Platform
25
+
## Connect virtual clusters to the vCluster Platform
26
26
27
27
To connect a virtual cluster to the vCluster Platform, you can use an API key—referred to as an [access key](/platform/next/api/authentication) in the platform's console. There are two authentication methods:
28
28
29
-
-**Shared access** (_Recommended_): Create a single Kubernetes Secret containing the access key, and reference it in multiple virtual clusters, even if they are deployed in different namespaces. This approach simplifies management, reduces overhead, and eases credential rotation, making it suitable for most users and production environments. For most scenarios, using a shared access key is the preferred approach due to its simplicity and ease of maintenance.
29
+
-**Shared access key** (_Recommended_): Create a single Kubernetes Secret containing the access key, and reference it in multiple virtual clusters, even if they are deployed in different namespaces. This approach simplifies management, reduces overhead, and eases credential rotation, making it suitable for most users and production environments. For most scenarios, using a shared access key is the preferred approach due to its simplicity and ease of maintenance.
30
30
31
-
-**Dedicated access**: Create separate Kubernetes Secrets, each with a unique access key, for every virtual cluster. This method provides granular access control and allows revocation of access to individual clusters.
31
+
-**Dedicated access key**: Create separate Kubernetes Secrets, each with a unique access key, for every virtual cluster. This method provides granular access control and allows revocation of access to individual clusters.
### Connect a virtual cluster to the platform using a shared access key
40
40
41
41
Use a shared access key to authenticate and connect your virtual cluster to the platform.
42
-
42
+
43
43
### Prerequisites
44
44
45
-
Before you begin, ensure you have:
45
+
Before you begin, ensure you have:
46
46
47
47
- A vCluster Platform instance set up and accessible.
48
48
- Permissions to create and configure an access key in the platform.
49
49
- Access to create Kubernetes Secrets on the host Kubernetes cluster (where the virtual cluster runs).
50
-
50
+
51
51
### Configure shared access for a virtual cluster
52
52
53
53
<Flow>
54
54
<Steptitle="Create the access key">
55
-
56
-
Log in to vCluster Platform and create an [access key](/platform/next/api/authentication).
57
-
55
+
56
+
Log in to vCluster Platform and create an [access key](/platform/next/api/authentication).
57
+
58
58
</Step>
59
59
60
60
<Steptitle="Assign the vCluster role">
@@ -79,13 +79,13 @@ Assigning the `vcluster` role is required. Without it, the vCluster cannot authe
79
79
80
80
</Step>
81
81
<Step title="Create the Secret">
82
-
82
+
83
83
Create the Secret in a namespace on the host cluster. This defaults to `vcluster-platform-api-key` if undefined.
84
-
84
+
85
85
:::note
86
86
This namespace does **not** need to match the target namespace used by the virtual cluster, but it must exist on the host where the vCluster is deployed.
87
87
:::
88
-
88
+
89
89
Run the create command, ensuring you replace the placeholders with your specific values:
90
90
91
91
- Replace `ACCESS_KEY` with your API key (also referred to as an access key).
@@ -110,17 +110,17 @@ You can create the Secret in the `vcluster-platform` namespace by default to ens
110
110
<!-- vale on -->
111
111
112
112
</Step>
113
-
113
+
114
114
<Step title="Reference the Secret in vcluster.yaml">
115
-
115
+
116
116
In your `vcluster.yaml` file, define the following parameters to reference the Secret and configure access control:
117
117
118
118
- `secretName`: Specifies the name of the Secret containing the API key. Defaults to `vcluster-platform-api-key` if undefined.
119
119
- `namespace`: Specifies the namespace where the Secret is located. If different from the virtual cluster's namespace, ensure that the virtual cluster has access to this namespace.
120
120
- `createRBAC`: When set to `true`, vCluster automatically creates the necessary `Role` and `RoleBinding` resources to allow access to the Secret. Defaults to true.
121
121
122
122
<br />
123
-
123
+
124
124
<!-- vale off -->
125
125
<InterpolatedCodeBlock
126
126
code={
@@ -132,25 +132,25 @@ You can create the Secret in the `vcluster-platform` namespace by default to ens
0 commit comments