Updates TektonInstallerSet to allow replica changes to a deployment

pkg/reconciler/kubernetes/tektoninstallerset/install.go

@@ -21,10 +21,18 @@ import (
 	"strings"
 
 	mf "github.com/manifestival/manifestival"
+	"github.com/tektoncd/operator/pkg/reconciler/common"
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
+	apierrs "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime"
+	"knative.dev/pkg/ptr"
+)
+
+const (
+	replicasForHash    = 999
+	lastAppliedHashKey = "operator.tekton.dev/last-applied-hash"
 )
 
 var (
@@ -107,9 +115,15 @@ func (i *installer) EnsureNamespaceScopedResources() error {
 }
 
 func (i *installer) EnsureDeploymentResources() error {
+
+	for _, d := range i.Manifest.Filter(mf.Any(deploymentPred)).Resources() {
+		if err := i.ensureDeployment(&d); err != nil {
+			return err
+		}
+	}
+
 	if err := i.Manifest.Filter(
 		mf.Any(
-			deploymentPred,
 			servicePred,
 			routePred,
 		)).Apply(); err != nil {
@@ -118,6 +132,136 @@ func (i *installer) EnsureDeploymentResources() error {
 	return nil
 }
 
+func computeDeploymentHash(d appsv1.Deployment) (string, error) {
+	// set replicas to a constant value and then calculate hash so
+	// that later if user updates replicas, we can exclude that change.
+	// setting the replicas to same const and checking the hash
+	// so that we can allow only replica change revert any other change
+	// done to the deployment spec
+	d.Spec.Replicas = ptr.Int32(replicasForHash)
+
+	return common.ComputeHashOf(d.Spec)
+}
+
+func (i *installer) createDeployment(expected *unstructured.Unstructured) error {
+
+	dep := &appsv1.Deployment{}
+	err := runtime.DefaultUnstructuredConverter.FromUnstructured(expected.Object, dep)
+	if err != nil {
+		return err
+	}
+
+	hash, err := computeDeploymentHash(*dep)
+	if err != nil {
+		return fmt.Errorf("failed to compute hash of deployment: %v", err)
+	}
+
+	if len(dep.Annotations) == 0 {
+		dep.Annotations = map[string]string{}
+	}
+	dep.Annotations[lastAppliedHashKey] = hash
+
+	unstrObj, err := runtime.DefaultUnstructuredConverter.ToUnstructured(dep)
+	if err != nil {
+		return err
+	}
+	expected.SetUnstructuredContent(unstrObj)
+
+	return i.Manifest.Client.Create(expected)
+}
+
+func (i *installer) updateDeployment(existing *unstructured.Unstructured, existingDeployment, expectedDeployment *appsv1.Deployment) error {
+
+	// save on cluster replicas in a var and assign it back to deployment
+	onClusterReplicas := existingDeployment.Spec.Replicas
+
+	existingDeployment.Spec = expectedDeployment.Spec
+	existingDeployment.Spec.Replicas = onClusterReplicas
+
+	// compute new hash of spec and add as annotation
+	newHash, err := computeDeploymentHash(*existingDeployment)
+	if err != nil {
+		return fmt.Errorf("failed to compute new hash of existing deployment: %v", err)
+	}
+
+	if len(existingDeployment.Annotations) == 0 {
+		existingDeployment.Annotations = map[string]string{}
+	}
+
+	existingDeployment.Annotations[lastAppliedHashKey] = newHash
+
+	unstrObj, err := runtime.DefaultUnstructuredConverter.ToUnstructured(existingDeployment)
+	if err != nil {
+		return err
+	}
+	existing.SetUnstructuredContent(unstrObj)
+
+	return i.Manifest.Client.Update(existing)
+}
+
+func (i *installer) ensureDeployment(expected *unstructured.Unstructured) error {
+
+	// check if deployment already exist
+	existing, err := i.Manifest.Client.Get(expected)
+	if err != nil {
+
+		// If deployment doesn't exist, then create new
+		if apierrs.IsNotFound(err) {
+			return i.createDeployment(expected)
+		}
+		return err
+	}
+
+	// if already exist then check if spec is changed
+	existingDeployment := &appsv1.Deployment{}
+	if err := runtime.DefaultUnstructuredConverter.FromUnstructured(existing.Object, existingDeployment); err != nil {
+		return err
+	}
+
+	expectedDeployment := &appsv1.Deployment{}
+	if err := runtime.DefaultUnstructuredConverter.FromUnstructured(expected.Object, expectedDeployment); err != nil {
+		return err
+	}
+
+	// compare existing deployment spec hash with the one saved in annotation
+	// if annotation doesn't exist then update the deployment
+
+	existingDepSpecHash, err := computeDeploymentHash(*existingDeployment)
+	if err != nil {
+		return fmt.Errorf("failed to compute hash of existing deployment: %v", err)
+	}
+
+	hashFromAnnotation, hashExist := existingDeployment.Annotations[lastAppliedHashKey]
+
+	// if hash doesn't exist then update the deployment with hash
+	if !hashExist {
+		return i.updateDeployment(existing, existingDeployment, expectedDeployment)
+	}
+
+	// if both hashes are same, that means deployment on cluster is the same as when it
+	// was created (there may be change in replica which we allow)
+	if existingDepSpecHash == hashFromAnnotation {
+
+		// there might be a case where deployment in installerSet spec might have changed
+		// compare the expected deployment spec hash with the hash in annotation
+		expectedDepSpecHash, err := computeDeploymentHash(*expectedDeployment)
+		if err != nil {
+			return fmt.Errorf("failed to compute hash of expected deployment: %v", err)
+		}
+
+		if expectedDepSpecHash != hashFromAnnotation {
+			return i.updateDeployment(existing, existingDeployment, expectedDeployment)
+		}
+
+		return nil
+	}
+
+	// hash is changed so revert back to original deployment
+	// keeping the replicas change if exist
+
+	return i.updateDeployment(existing, existingDeployment, expectedDeployment)
+}
+
 func (i *installer) IsWebhookReady() error {
 
 	for _, u := range i.Manifest.Filter(deploymentPred).Resources() {

pkg/reconciler/kubernetes/tektoninstallerset/install_test.go

@@ -25,9 +25,11 @@ import (
 	"github.com/manifestival/manifestival/fake"
 	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/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/schema"
 )
 
 var (
@@ -50,6 +52,8 @@ var (
 
 type fakeClient struct {
 	err            error
+	getErr         error
+	createErr      error
 	resourcesExist bool
 	creates        []unstructured.Unstructured
 	deletes        []unstructured.Unstructured
@@ -60,7 +64,7 @@ func (f *fakeClient) Get(obj *unstructured.Unstructured) (*unstructured.Unstruct
 	if f.resourcesExist {
 		resource = &unstructured.Unstructured{}
 	}
-	return resource, f.err
+	return resource, f.getErr
 }
 
 func (f *fakeClient) Delete(obj *unstructured.Unstructured, options ...mf.DeleteOption) error {
@@ -71,7 +75,7 @@ func (f *fakeClient) Delete(obj *unstructured.Unstructured, options ...mf.Delete
 func (f *fakeClient) Create(obj *unstructured.Unstructured, options ...mf.ApplyOption) error {
 	obj.SetAnnotations(nil) // Deleting the extra annotation. Irrelevant for the test.
 	f.creates = append(f.creates, *obj)
-	return f.err
+	return f.createErr
 }
 
 func (f *fakeClient) Update(obj *unstructured.Unstructured, options ...mf.ApplyOption) error {
@@ -150,6 +154,11 @@ func TestInstaller(t *testing.T) {
 
 	// reset created array
 	client.creates = []unstructured.Unstructured{}
+	client.resourcesExist = false
+	client.getErr = errors.NewNotFound(schema.GroupResource{
+		Group:    "apps/v1",
+		Resource: "Deployment",
+	}, "test-deployment")
 
 	want = []unstructured.Unstructured{deployment, service}