Skip to content

Commit

Permalink
Merge pull request #1390 from mpetason/docs-generic-syncer-link-update
Browse files Browse the repository at this point in the history
  • Loading branch information
Thomas Kosiewski authored Dec 3, 2023
2 parents 41aee5d + 1a97949 commit 950228e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/pages/syncer/other_resources/generic_sync.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Generic Sync
sidebar_label: Generic Sync
---

Besides the plugins, vCluster provides a way to define additional resources that should be synced in a generic and declarative way with just a few lines of a YAML configuration. This feature is a successor to the [vcluster-generic-crd-sync-plugin](https://github.com/loft-sh/vcluster-generic-crd-sync-plugin) project and is included since v0.14.0 release. The full range of the generic sync features is available only in the vCluster created in the "multi-namespace mode", see the ["Multi-namespace mode" chapter](#multi-namespace-mode) for details.
Besides the plugins, vCluster provides a way to define additional resources that should be synced in a generic and declarative way with just a few lines of YAML. This feature is a successor to the [vcluster-generic-crd-sync-plugin](https://github.com/loft-sh/vcluster-generic-crd-sync-plugin) project and is included since v0.14.0 release. The full range of the generic sync features is available only in the vCluster created in the "multi-namespace mode", see the ["Multi-namespace Mode" chapter](./multi_namespace_mode.mdx) for details.

You will need to declare which CRD Kinds you would like to sync from the virtual cluster to the host cluster, or vice versa, and the vCluster will automatically copy the CRD definition from the host cluster into vCluster at the start. Then it will take care of watching the resources of the predefined Kinds and execute the synchronization logic based on the configuration provided to it. The vCluster may automatically transform the resource metadata(such as name, namespace, labels, etc.) as is common for resources synced by vCluster. In addition to the implicit metadata transformations, you can configure transformations that will be performed on other fields of the resource, and these will depend on the meaning of those fields. You may also declare which fields will be copied in the opposite direction, from the synced resource to the original one.
Many controllers create Kubernetes resources as a result of custom resources, for example, cert-manager creates Secrets based on Certificate custom resources, and this feature will allow you to sync these resources from the host cluster into the virtual one. The following chapters describe the configuration options in more detail.
Expand Down

0 comments on commit 950228e

Please sign in to comment.