-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CRD changes, adding `.spec.namespace` attribute. Deploying Shipwright Build Controller, and dependencies, on a target namespace informed on the CRD spec. Additionally, implementing Kubernetes Finalizer workflow to remove objects with actions centered on the Reconciler directly. Co-authored-by: Adam Kaplan <adam.kaplan@redhat.com>
1 parent
45bd730
commit 15400d2
Showing
18 changed files
with
508 additions
and
124 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
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,4 @@ | ||
| // This package contains the CRD code, describing how the operator API will work in Kubernetes. When | ||
| // the contents of this package are modified, you must run `make` command to make sure files with | ||
| // `zz_generated.` prefix are updated, the additional code is generated as expected. | ||
| package v1alpha1 |
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
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,25 @@ | ||
| package controllers | ||
|
|
||
| import ( | ||
| ctrl "sigs.k8s.io/controller-runtime" | ||
| ) | ||
|
|
||
| // Requeue triggers a object requeue. | ||
| func Requeue() (ctrl.Result, error) { | ||
| return ctrl.Result{Requeue: true}, nil | ||
| } | ||
|
|
||
| // RequeueOnError triggers requeue when error is not nil. | ||
| func RequeueOnError(err error) (ctrl.Result, error) { | ||
| return ctrl.Result{}, err | ||
| } | ||
|
|
||
| // RequeueWithError triggers a object requeue because the informed error happend. | ||
| func RequeueWithError(err error) (ctrl.Result, error) { | ||
| return ctrl.Result{Requeue: true}, err | ||
| } | ||
|
|
||
| // NoRequeue all done, the object does not need reconciliation anymore. | ||
| func NoRequeue() (ctrl.Result, error) { | ||
| return ctrl.Result{Requeue: false}, nil | ||
| } |
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,173 @@ | ||
| package controllers | ||
|
|
||
| import ( | ||
| "context" | ||
| "os" | ||
| "testing" | ||
| "time" | ||
|
|
||
| o "github.com/onsi/gomega" | ||
| "github.com/shipwright-io/operator/api/v1alpha1" | ||
| appsv1 "k8s.io/api/apps/v1" | ||
| corev1 "k8s.io/api/core/v1" | ||
| "k8s.io/apimachinery/pkg/api/errors" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/runtime" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| "sigs.k8s.io/controller-runtime/pkg/client/fake" | ||
| "sigs.k8s.io/controller-runtime/pkg/log/zap" | ||
| "sigs.k8s.io/controller-runtime/pkg/reconcile" | ||
| ) | ||
|
|
||
| func init() { | ||
| // exporting the environment variable which points Manifestival to the release.yaml file, | ||
| // containing all resources managed by it | ||
| _ = os.Setenv("KO_DATA_PATH", "../cmd/operator/kodata") | ||
| } | ||
|
|
||
| // bootstrapShipwrightBuildReconciler start up a new instance of ShipwrightBuildReconciler which is | ||
| // ready to interact with Manifestival, returning the Manifestival instance and the client. | ||
| func bootstrapShipwrightBuildReconciler( | ||
| t *testing.T, | ||
| b *v1alpha1.ShipwrightBuild, | ||
| ) (client.Client, *ShipwrightBuildReconciler) { | ||
| g := o.NewGomegaWithT(t) | ||
|
|
||
| s := runtime.NewScheme() | ||
| s.AddKnownTypes(corev1.SchemeGroupVersion, &corev1.Namespace{}) | ||
| s.AddKnownTypes(appsv1.SchemeGroupVersion, &appsv1.Deployment{}) | ||
| s.AddKnownTypes(v1alpha1.GroupVersion, &v1alpha1.ShipwrightBuild{}) | ||
|
|
||
| logger := zap.New() | ||
|
|
||
| c := fake.NewFakeClientWithScheme(s, b) | ||
| r := &ShipwrightBuildReconciler{Client: c, Scheme: s, Logger: logger} | ||
|
|
||
| // creating targetNamespace on which Shipwright-Build will be deployed against, before the other | ||
| // tests takes place | ||
| if b.Spec.TargetNamespace != "" { | ||
| t.Logf("Creating test namespace '%s'", b.Spec.TargetNamespace) | ||
| t.Run("create-test-namespace", func(t *testing.T) { | ||
| err := c.Create( | ||
| context.TODO(), | ||
| &corev1.Namespace{ObjectMeta: metav1.ObjectMeta{Name: b.Spec.TargetNamespace}}, | ||
| &client.CreateOptions{}, | ||
| ) | ||
| g.Expect(err).To(o.BeNil()) | ||
| }) | ||
| } | ||
|
|
||
| // manifestival instance is setup as part of controller-=runtime's SetupWithManager, thus calling | ||
| // the setup before all other methods | ||
| t.Run("setupManifestival", func(t *testing.T) { | ||
| err := r.setupManifestival(logger) | ||
| g.Expect(err).To(o.BeNil()) | ||
| }) | ||
|
|
||
| return c, r | ||
| } | ||
|
|
||
| // TestShipwrightBuildReconciler_Finalizers testing adding and removing finalizers on the resource. | ||
| func TestShipwrightBuildReconciler_Finalizers(t *testing.T) { | ||
| g := o.NewGomegaWithT(t) | ||
|
|
||
| b := &v1alpha1.ShipwrightBuild{ObjectMeta: metav1.ObjectMeta{Name: "name", Namespace: "default"}} | ||
| _, r := bootstrapShipwrightBuildReconciler(t, b) | ||
|
|
||
| // adding one entry on finalizers slice, making sure it's registered | ||
| t.Run("setFinalizer", func(t *testing.T) { | ||
| err := r.setFinalizer(context.TODO(), b) | ||
|
|
||
| g.Expect(err).To(o.BeNil()) | ||
| g.Expect(b.GetFinalizers()).To(o.Equal([]string{FinalizerAnnotation})) | ||
| }) | ||
|
|
||
| // removing previously added finalizer entry, making sure slice it's empty afterwards | ||
| t.Run("unsetFinalizer", func(t *testing.T) { | ||
| err := r.unsetFinalizer(context.TODO(), b) | ||
|
|
||
| g.Expect(err).To(o.BeNil()) | ||
| g.Expect(b.GetFinalizers()).To(o.Equal([]string{})) | ||
| }) | ||
| } | ||
|
|
||
| // testShipwrightBuildReconcilerReconcile simulates the reconciliation process for rolling out and | ||
| // rolling back manifests in the informed target namespace name. | ||
| func testShipwrightBuildReconcilerReconcile(t *testing.T, targetNamespace string) { | ||
| g := o.NewGomegaWithT(t) | ||
|
|
||
| namespacedName := types.NamespacedName{Namespace: "default", Name: "name"} | ||
| deploymentName := types.NamespacedName{ | ||
| Namespace: targetNamespace, | ||
| Name: "shipwright-build-controller", | ||
| } | ||
| req := reconcile.Request{NamespacedName: namespacedName} | ||
|
|
||
| b := &v1alpha1.ShipwrightBuild{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: namespacedName.Name, | ||
| Namespace: namespacedName.Namespace, | ||
| }, | ||
| Spec: v1alpha1.ShipwrightBuildSpec{ | ||
| TargetNamespace: targetNamespace, | ||
| }, | ||
| } | ||
| c, r := bootstrapShipwrightBuildReconciler(t, b) | ||
|
|
||
| t.Logf("Deploying Shipwright Controller against '%s' namespace", targetNamespace) | ||
|
|
||
| // rolling out all manifests on the desired namespace, making sure the deployment for Shipwright | ||
| // Build Controller is created accordingly | ||
| t.Run("rollout-manifests", func(t *testing.T) { | ||
| ctx := context.TODO() | ||
|
|
||
| res, err := r.Reconcile(ctx, req) | ||
| g.Expect(err).To(o.BeNil()) | ||
| g.Expect(res.Requeue).To(o.BeFalse()) | ||
|
|
||
| err = c.Get(ctx, deploymentName, &appsv1.Deployment{}) | ||
| g.Expect(err).To(o.BeNil()) | ||
| }) | ||
|
|
||
| // rolling back all changes, making sure the main deployment is also not found afterwards | ||
| t.Run("rollback-manifests", func(t *testing.T) { | ||
| ctx := context.TODO() | ||
|
|
||
| err := r.Get(ctx, namespacedName, b) | ||
| g.Expect(err).To(o.BeNil()) | ||
|
|
||
| // setting a deletion timestemp on the build object, it triggers the rollback logic so the | ||
| // reconciliation should remove the objects previously deployed | ||
| b.SetDeletionTimestamp(&metav1.Time{Time: time.Now()}) | ||
| err = r.Update(ctx, b, &client.UpdateOptions{}) | ||
| g.Expect(err).To(o.BeNil()) | ||
|
|
||
| res, err := r.Reconcile(ctx, req) | ||
| g.Expect(err).To(o.BeNil()) | ||
| g.Expect(res.Requeue).To(o.BeFalse()) | ||
|
|
||
| err = c.Get(ctx, deploymentName, &appsv1.Deployment{}) | ||
| g.Expect(errors.IsNotFound(err)).To(o.BeTrue()) | ||
| }) | ||
| } | ||
|
|
||
| // TestShipwrightBuildReconciler_Reconcile runs rollout/rollback tests against different namespaces. | ||
| func TestShipwrightBuildReconciler_Reconcile(t *testing.T) { | ||
| tests := []struct { | ||
| testName string | ||
| targetNamespace string | ||
| }{{ | ||
| testName: "target namespace is informed", | ||
| targetNamespace: "namespace", | ||
| }, { | ||
| testName: "target namespace is not informed", | ||
| targetNamespace: defaultTargetNamespace, | ||
| }} | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.testName, func(t *testing.T) { | ||
| testShipwrightBuildReconcilerReconcile(t, tt.targetNamespace) | ||
| }) | ||
| } | ||
| } |
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,21 @@ | ||
| package controllers | ||
|
|
||
| // To minimize the risk of privilege escalation or destructive behavior, the controller is only | ||
| // allowed to modify named resources that deploy Shipwright Build. This is especially true for the | ||
| // cluster roles and custom resource definitions included in the release manifest. | ||
|
|
||
| // +kubebuilder:rbac:groups=operator.shipwright.io,resources=shipwrightbuilds,verbs=get;list;watch;create;update;patch;delete | ||
| // +kubebuilder:rbac:groups=operator.shipwright.io,resources=shipwrightbuilds/status,verbs=get;update;patch | ||
| // +kubebuilder:rbac:groups=operator.shipwright.io,resources=shipwrightbuilds/finalizers,verbs=update | ||
| // +kubebuilder:rbac:groups=shipwright.io,resources=*,verbs=create;delete;get;list;patch;update;watch | ||
| // +kubebuilder:rbac:groups=core,resources=pods;services;services/finalizers;endpoints;persistentvolumeclaims;events;configmaps;secrets;serviceaccounts,verbs=create;delete;get;list;patch;update;watch | ||
| // +kubebuilder:rbac:groups=apps,resources=deployments;daemonsets;replicasets;statefulsets,verbs=create;delete;get;list;patch;update;watch | ||
| // +kubebuilder:rbac:groups=apps,resourceNames=shipwright-build,resources=deployments/finalizers,verbs=update | ||
| // +kubebuilder:rbac:groups=rbac.authorization.k8s.io,resources=clusterroles,verbs=get;list;watch;create | ||
| // +kubebuilder:rbac:groups=rbac.authorization.k8s.io,resources=clusterroles,resourceNames=shipwright-build-controller,verbs=update;patch;delete | ||
| // +kubebuilder:rbac:groups=rbac.authorization.k8s.io,resources=clusterrolebindings,verbs=get;list;watch;create | ||
| // +kubebuilder:rbac:groups=rbac.authorization.k8s.io,resources=clusterrolebindings,resourceNames=shipwright-build-controller,verbs=update;patch;delete | ||
| // +kubebuilder:rbac:groups=apiextensions.k8s.io,resources=customresourcedefinitions,verbs=get;list;watch;create | ||
| // +kubebuilder:rbac:groups=apiextensions.k8s.io,resources=customresourcedefinitions,resourceNames=builds.shipwright.io;buildruns.shipwright.io;buildstrategies.shipwright.io;clusterbuildstrategies.shipwright.io,verbs=update;patch;delete | ||
| // +kubebuilder:rbac:groups=monitoring.coreos.com,resources=servicemonitors,verbs=get;create | ||
| // +kubebuilder:rbac:groups=tekton.dev,resources=tasks;taskruns,verbs=create;delete;get;list;patch;update;watch |
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,28 @@ | ||
| package controllers | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| ) | ||
|
|
||
| // koDataPathEnv ko data-path environment variable. | ||
| const koDataPathEnv = "KO_DATA_PATH" | ||
|
|
||
| // koDataPath retrieve the data path environment variable, returning error when not found. | ||
| func koDataPath() (string, error) { | ||
| dataPath, exists := os.LookupEnv(koDataPathEnv) | ||
| if !exists { | ||
| return "", fmt.Errorf("'%s' is not set", koDataPathEnv) | ||
| } | ||
| return dataPath, nil | ||
| } | ||
|
|
||
| // contains returns true if the string if found in the slice. | ||
| func contains(slice []string, str string) bool { | ||
| for _, s := range slice { | ||
| if s == str { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } |
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 |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| #! /bin/bash | ||
|
|
||
| set -x | ||
| set -e | ||
|
|
||
| fixCommand="$*" | ||
|
|
||
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