Skip to content

fix (platform): add importing existing vcluster to platform through helm values #1338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Nov 7, 2025
Merged

fix (platform): add importing existing vcluster to platform through helm values #1338

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
31cfdab
add multi agent replicas info
guowenatk Oct 30, 2025
2600e64
make the content more precise
guowenatk Nov 4, 2025
69bb178
add import via helm
guowenatk Nov 4, 2025
3c7176c
restore config.mdx
guowenatk Nov 4, 2025
2143cf9
update the link
guowenatk Nov 5, 2025
9750cc2
fix broken link
guowenatk Nov 5, 2025
b2292df
fix link
guowenatk Nov 5, 2025
d751047
add yaml example
guowenatk Nov 7, 2025
ab5f62a
update content
guowenatk Nov 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion platform/use-platform/virtual-clusters/add-virtual-clusters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,14 @@ Organizations often have existing deployment pipelines using tools like Helm, Ar

### Post-deployment platform registration

After deploying your vCluster using your existing tools, add it to <GlossaryTerm term="platform">the Platform</GlossaryTerm> and enable full management:
After deploying your vCluster using your existing tools, add it to <GlossaryTerm term="platform">the Platform</GlossaryTerm> and enable full management.

First, login with the platform [access key](../../../api/authentication):
```bash
vcluster platform login [domain] --access-key=[ACCESS_KEY]
```

Then, add the virtual cluster to the platform by running:
<InterpolatedCodeBlock
code={`# Assuming you have already deployed a vCluster using Helm, Argo CD, or another tool

Expand All @@ -127,6 +133,17 @@ vcluster platform add vcluster [[VAR:VCLUSTER_NAME:vc-name]] \\
language="bash"
/>

You can also use Helm values by updating the `vcluster.yaml` to include the access key of the platform as follows and then upgrade or restart
the virtual cluster.
```yaml
external:
platform:
apiKey:
secretName: vcluster-platform-api-key # Defaults to vcluster-platform-api-key if undefined
namespace: vcluster-namespace # Namespace to search for the secret. If undefined, it searches the vCluster namespace. If different, vCluster needs access to the target namespace.
```
The platform access key can only be provided as a Kubernetes Secret. You can find more information of how to create such Secret at the [`apiKey` configuration section of vCluster.](../../../../vcluster/configure/vcluster-yaml/external/platform/api-key).

### Helm wrapper for VirtualClusterInstance

Create a Helm chart that deploys the VirtualClusterInstance directly, allowing the Platform to manage the vCluster from creation. This approach is ideal when you want Helm to deploy the CRD but let the Platform handle the actual vCluster.
Expand Down
Loading