Skip to content

Conversation

@guowenatk
Copy link
Contributor

@guowenatk guowenatk commented Nov 4, 2025

Content Description

Add documentation of importing existing vcluster to platform through helm values

Preview Link

https://deploy-preview-1338--vcluster-docs-site.netlify.app/docs/platform/next/use-platform/virtual-clusters/add-virtual-clusters#post-deployment-platform-registration

Internal Reference

Closes DOC-311

@netlify /docs

@guowenatk guowenatk requested a review from a team as a code owner November 4, 2025 09:40
@netlify
Copy link

netlify bot commented Nov 4, 2025

Deploy Preview for vcluster-docs-site ready!

Name Link
🔨 Latest commit b2292df
🔍 Latest deploy log https://app.netlify.com/projects/vcluster-docs-site/deploys/690b3e1158299c0008031243
😎 Deploy Preview https://deploy-preview-1338--vcluster-docs-site.netlify.app/docs
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025

Copy link
Contributor

@Piotr1215 Piotr1215 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should focus more on the command flags, show sample vcluster.yaml and in an admonition mention that api key is needed. Also the apikey url does not resolve correctly on the preview environment.

@guowenatk
Copy link
Contributor Author

guowenatk commented Nov 5, 2025

This should focus more on the command flags, show sample vcluster.yaml and in an admonition mention that api key is needed. Also the apikey url does not resolve correctly on the preview environment.

I am not sure as I think that the way of using helm values to register the vcluster is described quite thoroughly in the apikey url https://www.vcluster.com/docs/vcluster/configure/vcluster-yaml/external/platform/api-key. If the helm example is needed like this

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.
      createRBAC: true  # Defaults to true. Automatically creates the necessary RBAC roles and role bindings to locate the secret.

then maybe I should also include how to get the secret and create the roles, which is already included in the apikey url.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants