loft-sh / vcluster-sdk

Provides a toolset to create custom vcluster syncers
Apache License 2.0
25 stars 20 forks source link


WebsiteDocumentationBlogTwitterSlack

This project holds the official vCluster SDK, which can be used to develop plugins for vCluster. Plugins are a feature to extend the capabilities of vCluster. They allow you to add custom functionality, such as:

  1. Syncing specific resources from or to the virtual clusters including cluster scoped resources like cluster roles.
  2. Syncing custom resources from or to the virtual cluster.
  3. Deploying resources on virtual cluster startup, such as CRDs, applications etc.
  4. Manage resources and applications inside the host or virtual cluster.
  5. Enforcing certain restrictions on synced resources or extending the existing syncers of vCluster.
  6. Any other operator use case that could benefit from having access to the virtual cluster as well the host cluster at the same time.

To learn more about plugins, please take a look at the vCluster documentation or our plugin examples.