Skip to content

Commit 9ffda7b

Browse files
committed
fix(vcluster): shared/dedicated access naming
1 parent 44b8207 commit 9ffda7b

File tree

1 file changed

+28
-28
lines changed
  • vcluster/configure/vcluster-yaml/external/platform

1 file changed

+28
-28
lines changed

vcluster/configure/vcluster-yaml/external/platform/api-key.mdx

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -19,42 +19,42 @@ import TabItem from '@theme/TabItem';
1919

2020
<!--vale off-->
2121

22-
Enable secure communication between your virtual cluster and the vCluster Platform.
22+
Enable secure communication between your virtual cluster and the vCluster Platform.
2323
You can configure the platform to manage and authenticate virtual cluster connections consistently across different environments.
2424

25-
## Connect virtual clusters to the vCluster Platform
25+
## Connect virtual clusters to the vCluster Platform
2626

2727
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:
2828

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.
3030

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.
3232

3333

3434
<br />
3535

3636
<Tabs>
37-
<TabItem value="shared" label="Shared access" default>
38-
37+
<TabItem value="shared" label="Shared access key" default>
38+
3939
### Connect a virtual cluster to the platform using a shared access key
4040

4141
Use a shared access key to authenticate and connect your virtual cluster to the platform.
42-
42+
4343
### Prerequisites
4444

45-
Before you begin, ensure you have:
45+
Before you begin, ensure you have:
4646

4747
- A vCluster Platform instance set up and accessible.
4848
- Permissions to create and configure an access key in the platform.
4949
- Access to create Kubernetes Secrets on the host Kubernetes cluster (where the virtual cluster runs).
50-
50+
5151
### Configure shared access for a virtual cluster
5252

5353
<Flow>
5454
<Step title="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+
5858
</Step>
5959

6060
<Step title="Assign the vCluster role">
@@ -79,13 +79,13 @@ Assigning the `vcluster` role is required. Without it, the vCluster cannot authe
7979

8080
</Step>
8181
<Step title="Create the Secret">
82-
82+
8383
Create the Secret in a namespace on the host cluster. This defaults to `vcluster-platform-api-key` if undefined.
84-
84+
8585
:::note
8686
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.
8787
:::
88-
88+
8989
Run the create command, ensuring you replace the placeholders with your specific values:
9090

9191
- 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
110110
<!-- vale on -->
111111

112112
</Step>
113-
113+
114114
<Step title="Reference the Secret in vcluster.yaml">
115-
115+
116116
In your `vcluster.yaml` file, define the following parameters to reference the Secret and configure access control:
117117

118118
- `secretName`: Specifies the name of the Secret containing the API key. Defaults to `vcluster-platform-api-key` if undefined.
119119
- `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.
120120
- `createRBAC`: When set to `true`, vCluster automatically creates the necessary `Role` and `RoleBinding` resources to allow access to the Secret. Defaults to true.
121121

122122
<br />
123-
123+
124124
<!-- vale off -->
125125
<InterpolatedCodeBlock
126126
code={
@@ -132,25 +132,25 @@ You can create the Secret in the `vcluster-platform` namespace by default to ens
132132
createRBAC: [[VAR:CREATE RBAC:true]]
133133
`}
134134
language="yaml"
135-
/>
135+
/>
136136
</Step>
137137
</Flow>
138138
</TabItem>
139-
140-
<TabItem value="dedicated" label="Dedicated access">
139+
140+
<TabItem value="dedicated" label="Dedicated access key">
141141
142142
### Connect a virtual cluster to the platform with a dedicated access key
143143
144144
Authenticate a virtual cluster with the platform using a dedicated access key.
145145
146146
### Prerequisites
147147
148-
Before you begin, ensure you have:
148+
Before you begin, ensure you have:
149149
150150
- Access to the vCluster Platform.
151151
- The [vCluster CLI installed](/platform/install/quick-start-guide) installed on your local machine.
152152
- The ability for each user to generate their own access key from the platform console.
153-
153+
154154
### Connect a virtual cluster to the platform using dedicated access
155155
156156
<Flow>
@@ -236,9 +236,9 @@ To view your generated access keys, navigate to **Users** > **Access Keys**.
236236
## Example
237237

238238
<Tabs>
239-
<TabItem value="shared" label="Shared access" default>
240-
241-
```yaml title="Shared access example"
239+
<TabItem value="shared" label=" Shared access key" default>
240+
241+
```yaml title=" Shared access key example"
242242
external:
243243
platform:
244244
apiKey:
@@ -248,9 +248,9 @@ To view your generated access keys, navigate to **Users** > **Access Keys**.
248248
```
249249
</TabItem>
250250

251-
<TabItem value="dedicated" label="Dedicated access">
251+
<TabItem value="dedicated" label="Dedicated access key">
252252

253-
```yaml title="Dedicated access example"
253+
```yaml title="Dedicated access key example"
254254
external:
255255
platform:
256256
```

0 commit comments

Comments
 (0)