-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: bump vcluster & import secrets
- Loading branch information
1 parent
1c31ae4
commit a161ef5
Showing
56 changed files
with
2,377 additions
and
789 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Contributing to vcluster-sdk | ||
|
|
||
| ## Build the Examples | ||
|
|
||
| Make sure you do a dual platform build for `linux/amd64` and `linux/arm64` via: | ||
|
|
||
| ``` | ||
| # Ensure docker builder with multi platform support | ||
| docker buildx create \ | ||
| --name container \ | ||
| --driver=docker-container | ||
| # Build & push image | ||
| docker buildx build --platform linux/amd64,linux/arm64 . -t ghcr.io/loft-sh/vcluster-example-hooks:v1 --builder container --push | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the Apache 2.0 License. | ||
|
|
||
| ## Copyright notice | ||
|
|
||
| It is important to state that you retain copyright for your contributions, but agree to license them for usage by the project and author(s) under the Apache 2.0 license. Git retains history of authorship, but we use a catch-all statement rather than individual names. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,234 @@ | ||
| package syncers | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| synccontext "github.com/loft-sh/vcluster/pkg/controllers/syncer/context" | ||
| "github.com/loft-sh/vcluster/pkg/controllers/syncer/translator" | ||
| synctypes "github.com/loft-sh/vcluster/pkg/types" | ||
| "github.com/loft-sh/vcluster/pkg/util/translate" | ||
| corev1 "k8s.io/api/core/v1" | ||
| "k8s.io/apimachinery/pkg/api/equality" | ||
| kerrors "k8s.io/apimachinery/pkg/api/errors" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| "k8s.io/klog/v2" | ||
| ctrl "sigs.k8s.io/controller-runtime" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| ) | ||
|
|
||
| var ( | ||
| vImportedAnnotation = "vcluster.loft.sh/imported" | ||
| pImportAnnotation = "vcluster.loft.sh/import" | ||
| ) | ||
|
|
||
| func NewImportSecrets(ctx *synccontext.RegisterContext) synctypes.Syncer { | ||
| return &importSecretSyncer{} | ||
| } | ||
|
|
||
| type importSecretSyncer struct{} | ||
|
|
||
| func (s *importSecretSyncer) Name() string { | ||
| return "import-secret-syncer" | ||
| } | ||
|
|
||
| func (s *importSecretSyncer) Resource() client.Object { | ||
| return &corev1.Secret{} | ||
| } | ||
|
|
||
| var _ synctypes.UpSyncer = &importSecretSyncer{} | ||
|
|
||
| func (s *importSecretSyncer) SyncUp(ctx *synccontext.SyncContext, pObj client.Object) (ctrl.Result, error) { | ||
| pSecret := pObj.(*corev1.Secret) | ||
|
|
||
| // ignore Secrets synced to the host by the vcluster | ||
| if pSecret.Labels != nil && pSecret.Labels[translate.MarkerLabel] != "" { | ||
| return ctrl.Result{}, nil | ||
| } | ||
|
|
||
| // try to parse import annotation | ||
| namespaceName := parseFromAnnotation(pSecret.Annotations, pImportAnnotation) | ||
| if namespaceName.Name == "" { | ||
| return ctrl.Result{}, nil | ||
| } | ||
|
|
||
| // check if namespace is there | ||
| err := ctx.VirtualClient.Get(ctx.Context, types.NamespacedName{Name: namespaceName.Namespace}, &corev1.Namespace{}) | ||
| if err != nil { | ||
| if !kerrors.IsNotFound(err) { | ||
| return ctrl.Result{}, err | ||
| } | ||
|
|
||
| // create namespace | ||
| ctx.Log.Infof("create namespace %s", namespaceName.Namespace) | ||
| err = ctx.VirtualClient.Create(ctx.Context, &corev1.Namespace{ObjectMeta: metav1.ObjectMeta{Name: namespaceName.Namespace}}) | ||
| if err != nil { | ||
| return ctrl.Result{}, fmt.Errorf("creating namespace %s: %w", namespaceName.Namespace, err) | ||
| } | ||
| } | ||
|
|
||
| // create virtual secret | ||
| vSecret := &corev1.Secret{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Namespace: namespaceName.Namespace, | ||
| Name: namespaceName.Name, | ||
| Annotations: getVirtualAnnotations(pSecret), | ||
| Labels: pSecret.Labels, | ||
| }, | ||
| Immutable: pSecret.Immutable, | ||
| Data: pSecret.Data, | ||
| Type: pSecret.Type, | ||
| } | ||
| ctx.Log.Infof("import secret %s/%s into %s/%s", pSecret.GetNamespace(), pSecret.GetName(), vSecret.Namespace, vSecret.Name) | ||
| err = ctx.VirtualClient.Create(ctx.Context, vSecret) | ||
| if err != nil { | ||
| return ctrl.Result{}, fmt.Errorf("failed to import secret %s/%s: %v", pSecret.GetNamespace(), pSecret.GetName(), err) | ||
| } | ||
|
|
||
| return ctrl.Result{}, err | ||
| } | ||
|
|
||
| func (s *importSecretSyncer) Sync(ctx *synccontext.SyncContext, pObj client.Object, vObj client.Object) (ctrl.Result, error) { | ||
| pSecret := pObj.(*corev1.Secret) | ||
| vSecret := vObj.(*corev1.Secret) | ||
|
|
||
| // check if we should delete secret | ||
| vSecretName := parseFromAnnotation(pSecret.Annotations, pImportAnnotation) | ||
| if vSecretName.Name == "" { | ||
| // delete synced secret if the physical secret is not referencing it anymore | ||
| ctx.Log.Infof("delete virtual secret %s/%s because host secret is no longer pointing to it", vObj.GetNamespace(), vObj.GetName()) | ||
| err := ctx.VirtualClient.Delete(ctx.Context, vObj) | ||
| if err != nil { | ||
| return ctrl.Result{}, fmt.Errorf("failed to delete imported secret %s/%s: %v", vObj.GetNamespace(), vObj.GetName(), err) | ||
| } | ||
|
|
||
| return ctrl.Result{}, err | ||
| } | ||
|
|
||
| // check if update is needed | ||
| updated := s.translateUpdateUp(pSecret, vSecret) | ||
| if updated == nil { | ||
| // no update is needed | ||
| return ctrl.Result{}, nil | ||
| } | ||
|
|
||
| // update secret | ||
| ctx.Log.Infof("update imported secret %s/%s", vObj.GetNamespace(), vObj.GetName()) | ||
| err := ctx.VirtualClient.Update(ctx.Context, updated) | ||
| if err == nil { | ||
| return ctrl.Result{}, fmt.Errorf("failed to update imported secret %s/%s: %v", vObj.GetNamespace(), vObj.GetName(), err) | ||
| } | ||
|
|
||
| return ctrl.Result{}, err | ||
| } | ||
|
|
||
| func (s *importSecretSyncer) SyncDown(ctx *synccontext.SyncContext, vObj client.Object) (ctrl.Result, error) { | ||
| // this is called when the secret in the host gets removed | ||
| // or if the vObj is an unrelated Secret created in vcluster | ||
|
|
||
| // check if this particular secret was created by this plugin | ||
| if parseFromAnnotation(vObj.GetAnnotations(), vImportedAnnotation).Name != "" { | ||
| // delete synced secret because the host secret was deleted | ||
| ctx.Log.Infof("delete imported secret %s/%s because host secret no longer exists", vObj.GetNamespace(), vObj.GetName()) | ||
| err := ctx.VirtualClient.Delete(ctx.Context, vObj) | ||
| if err != nil { | ||
| return ctrl.Result{}, fmt.Errorf("failed to delete pull secret %s/%s: %v", vObj.GetNamespace(), vObj.GetName(), err) | ||
| } | ||
| } | ||
|
|
||
| // ignore all unrelated Secrets | ||
| return ctrl.Result{}, nil | ||
| } | ||
|
|
||
| // IsManaged determines if a physical object is managed by the vcluster | ||
| func (s *importSecretSyncer) IsManaged(ctx context.Context, pObj client.Object) (bool, error) { | ||
| // check in multi namespace mode | ||
| if !translate.Default.IsTargetedNamespace(pObj.GetNamespace()) { | ||
| return false, nil | ||
| } | ||
|
|
||
| return parseFromAnnotation(pObj.GetAnnotations(), pImportAnnotation).Name != "", nil | ||
| } | ||
|
|
||
| // VirtualToPhysical translates a virtual name to a physical name | ||
| func (s *importSecretSyncer) VirtualToPhysical(ctx context.Context, req types.NamespacedName, vObj client.Object) types.NamespacedName { | ||
| if vObj == nil { | ||
| return types.NamespacedName{} | ||
| } | ||
|
|
||
| // exclude all objects that are not part of the vCluster namespace | ||
| name := parseFromAnnotation(vObj.GetAnnotations(), vImportedAnnotation) | ||
| if !translate.Default.IsTargetedNamespace(name.Namespace) { | ||
| return types.NamespacedName{} | ||
| } | ||
|
|
||
| return name | ||
| } | ||
|
|
||
| // PhysicalToVirtual translates a physical name to a virtual name | ||
| func (s *importSecretSyncer) PhysicalToVirtual(ctx context.Context, req types.NamespacedName, pObj client.Object) types.NamespacedName { | ||
| if pObj == nil { | ||
| return types.NamespacedName{} | ||
| } | ||
|
|
||
| return parseFromAnnotation(pObj.GetAnnotations(), pImportAnnotation) | ||
| } | ||
|
|
||
| func (s *importSecretSyncer) translateUpdateUp(pObj, vObj *corev1.Secret) *corev1.Secret { | ||
| var updated *corev1.Secret | ||
|
|
||
| // check annotations | ||
| expectedAnnotations := getVirtualAnnotations(pObj) | ||
| if !equality.Semantic.DeepEqual(vObj.GetAnnotations(), expectedAnnotations) { | ||
| updated = translator.NewIfNil(updated, vObj) | ||
| updated.Annotations = expectedAnnotations | ||
| } | ||
|
|
||
| // check labels | ||
| if !equality.Semantic.DeepEqual(vObj.GetLabels(), pObj.GetLabels()) { | ||
| updated = translator.NewIfNil(updated, vObj) | ||
| updated.Labels = pObj.GetLabels() | ||
| } | ||
|
|
||
| // check data | ||
| if !equality.Semantic.DeepEqual(vObj.Data, pObj.Data) { | ||
| updated = translator.NewIfNil(updated, vObj) | ||
| updated.Data = pObj.Data | ||
| } | ||
|
|
||
| return updated | ||
| } | ||
|
|
||
| func getVirtualAnnotations(pSecret *corev1.Secret) map[string]string { | ||
| annotations := map[string]string{} | ||
| for k, v := range pSecret.Annotations { | ||
| if k == pImportAnnotation { | ||
| continue | ||
| } | ||
|
|
||
| annotations[k] = v | ||
| } | ||
|
|
||
| annotations[vImportedAnnotation] = pSecret.Namespace + "/" + pSecret.Name | ||
| return annotations | ||
| } | ||
|
|
||
| func parseFromAnnotation(annotations map[string]string, annotation string) types.NamespacedName { | ||
| if annotations == nil || annotations[annotation] == "" { | ||
| return types.NamespacedName{} | ||
| } | ||
|
|
||
| splitted := strings.Split(annotations[annotation], "/") | ||
| if len(splitted) != 2 { | ||
| klog.Infof("Retrieved malformed import annotation %s: %s, expected NAMESPACE/NAME", annotation, annotations[annotation]) | ||
|
|
||
| return types.NamespacedName{} | ||
| } | ||
|
|
||
| return types.NamespacedName{ | ||
| Namespace: splitted[0], | ||
| Name: splitted[1], | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| /vendor | ||
| /devspace.yaml | ||
| /devspace_start.sh | ||
| /.devspace | ||
| /README.md | ||
| /plugin.yaml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| /vendor | ||
| /devspace.yaml | ||
| /devspace_start.sh | ||
| /.devspace | ||
| /README.md | ||
| /plugin.yaml |
Oops, something went wrong.