Merge pull request #37 from keptn-sandbox/feat/introduce_configversion

feat: introduce configVersion

Author: thschue

README.md

@@ -4,9 +4,9 @@ The operators in this repository make keptn configurable via Custom Resources an
 ## Compatibility Matrix
 
 | Author           | Keptn Version | [Keptn GitOps Operator Images](https://hub.docker.com/r/checkelmann/gitlab-service/tags) |
-|:-----------------|:---------------------:|:----------------------------------------------------------------------------------------:|
-| @thschue         |      0.11.x         |    keptnsandbox/gitops-operator:0.1.0-dev <br> keptnsandbox/keptn-operator:0.1.0-dev     |
-
+|:-----------------|:-------------:|:----------------------------------------------------------------------------------------:|
+| @thschue         |    0.11.x     |    keptnsandbox/gitops-operator:0.1.0-dev <br> keptnsandbox/keptn-operator:0.1.0-dev     |
+| @thschue         |    0.12.x     |    keptnsandbox/gitops-operator:0.1.0-dev <br> keptnsandbox/keptn-operator:0.1.0-dev     |
 
 ## Prerequisites
 * In order to be able to create and delete stages, the keptn operator depends on a patched version of the configuration-service and the shipyard controller
@@ -30,7 +30,7 @@ Following, a few parameters have to be set upfront:
 export API_HOSTNAME="<hostname>"
 export API_TOKEN="<api-token>"
 export RSA_PRIVATE_KEY="<private-key>"
-export GITOPS_VERSION="0.1.0-pre.6"
+export GITOPS_VERSION="0.1.0-pre.7"
 ```
 
 ### Install Custom Resource Definitions / Create Namespace

gitops-operator/controllers/common/types/types.go

@@ -30,10 +30,11 @@ type KeptnArtifactMetadata struct {
 
 //KeptnArtifactMetadataSpec specifies details of service artifacts
 type KeptnArtifactMetadataSpec struct {
-	Version      string `json:"version,omitempty"`
-	ChartDir     string `json:"chartDir,omitempty"`
-	OverwriteTag bool   `json:"overwriteTag,omitempty"`
-	Project      string `json:"project"`
+	Version       string `yaml:"version,omitempty"`
+	ConfigVersion string `yaml:"configVersion,omitempty"`
+	ChartDir      string `yaml:"chartDir,omitempty"`
+	OverwriteTag  bool   `yaml:"overwriteTag,omitempty"`
+	Project       string `yaml:"project"`
 }
 
 type configurationData struct {

gitops-operator/controllers/utils_artifactdelivery.go

@@ -36,7 +36,10 @@ func (r *KeptnGitRepositoryReconciler) composeData(gitClient common.GitClient, t
 	// Copy the Base Directory
 
 	for service, metadata := range services {
-		tag := service.DirectoryName + "-" + metadata.Version
+		if metadata.ConfigVersion == "" {
+			metadata.ConfigVersion = "0"
+		}
+		tag := service.DirectoryName + "-" + metadata.Version + "-" + metadata.ConfigVersion
 
 		err := gitClient.TagExists(tag)
 		if err != nil {

keptn-operator/api/v1/keptnservicedeployment_types.go

@@ -27,22 +27,25 @@ import (
 type KeptnServiceDeploymentSpec struct {
 	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
 	// Important: Run "make" to regenerate code after modifying this file
-	Project          string `json:"project"`
-	Service          string `json:"service"`
-	Stage            string `json:"stage"`
-	Version          string `json:"version"`
-	Author           string `json:"author,omitempty"`
-	SourceCommitHash string `json:"sourceCommitHash,omitempty"`
+	Project          string            `json:"project"`
+	Service          string            `json:"service"`
+	Stage            string            `json:"stage"`
+	Version          string            `json:"version"`
+	ConfigVersion    string            `json:"configVersion,omitempty"`
+	Author           string            `json:"author,omitempty"`
+	SourceCommitHash string            `json:"sourceCommitHash,omitempty"`
+	Labels           map[string]string `json:"labels,omitempty"`
 }
 
 // KeptnServiceDeploymentStatus defines the observed state of KeptnServiceDeployment
 type KeptnServiceDeploymentStatus struct {
-	DeployedVersion    string                              `json:"deployedVersion,omitempty"`
-	UpdatePending      bool                                `json:"updatePending,omitempty"`
-	KeptnContext       string                              `json:"keptnContext,omitempty"`
-	LastAppliedHash    string                              `json:"lastAppliedHash,omitempty"`
-	Prerequisites      KeptnServiceDeploymentPrerequisites `json:"prerequisites,omitempty"`
-	DeploymentProgress KeptnServiceDeploymentProgress      `json:"progress,omitempty"`
+	DeployedVersion       string                              `json:"deployedVersion,omitempty"`
+	DeployedConfigVersion string                              `json:"deployedConfigVersion,omitempty"`
+	UpdatePending         bool                                `json:"updatePending,omitempty"`
+	KeptnContext          string                              `json:"keptnContext,omitempty"`
+	LastAppliedHash       string                              `json:"lastAppliedHash,omitempty"`
+	Prerequisites         KeptnServiceDeploymentPrerequisites `json:"prerequisites,omitempty"`
+	DeploymentProgress    KeptnServiceDeploymentProgress      `json:"progress,omitempty"`
 }
 
 //KeptnServiceDeploymentPrerequisites defines all of the objects needed to deploy a service

keptn-operator/api/v1/zz_generated.deepcopy.go

@@ -39,6 +39,12 @@ spec:
             properties:
               author:
                 type: string
+              configVersion:
+                type: string
+              labels:
+                additionalProperties:
+                  type: string
+                type: object
               project:
                 description: 'INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
                   Important: Run "make" to regenerate code after modifying this file'
@@ -61,6 +67,8 @@ spec:
             description: KeptnServiceDeploymentStatus defines the observed state of
               KeptnServiceDeployment
             properties:
+              deployedConfigVersion:
+                type: string
               deployedVersion:
                 type: string
               keptnContext:

keptn-operator/config/crd/bases/keptn.sh_keptnservicedeployments.yaml

@@ -262,6 +262,22 @@ func getKeptnContext(client client.Client, ctx context.Context, namespace string
 }
 
 func (r *KeptnServiceDeploymentReconciler) triggerTask(deployment *apiv1.KeptnServiceDeployment, deploymentEvent string, shkeptncontext string) (string, error) {
+	configVersion := "0"
+
+	if deployment.Spec.ConfigVersion != "" {
+		configVersion = deployment.Spec.ConfigVersion
+	}
+
+	labels := map[string]string{
+		"version":       deployment.Spec.Version,
+		"configVersion": configVersion,
+	}
+
+	if len(deployment.Spec.Labels) != 0 {
+		for key, value := range deployment.Spec.Labels {
+			labels[key] = value
+		}
+	}
 
 	httpclient := nethttp.Client{
 		Timeout: 30 * time.Second,
@@ -273,12 +289,8 @@ func (r *KeptnServiceDeploymentReconciler) triggerTask(deployment *apiv1.KeptnSe
 			Service: deployment.Spec.Service,
 			Project: deployment.Spec.Project,
 			Stage:   deployment.Spec.Stage,
-			Labels: map[string]string{
-				"version":          deployment.Spec.Version,
-				"author":           deployment.Spec.Author,
-				"sourceCommitHash": deployment.Spec.SourceCommitHash,
-			},
-			Image: deployment.Spec.Service + ":" + deployment.Spec.Version,
+			Labels:  labels,
+			Image:   deployment.Spec.Service + ":" + deployment.Spec.Version,
 		},
 		Source:      "Keptn GitOps Operator",
 		SpecVersion: "1.0",

keptn-operator/controllers/keptnservicedeploymentcontroller/keptnservicedeployment_controller.go

@@ -52,6 +52,10 @@ func (eh *PromotionHandler) HandlePromotionTriggeredEvent() error {
 	} else {
 		eh.KeptnHandler.Logger.Info("Using version: " + version)
 	}
+	configVersion, ok := eventData.Labels["configVersion"]
+	if !ok {
+		configVersion = "0"
+	}
 
 	namespaceSupplier := common.EnvBasedStringSupplier(namespaceEnvVarName, defaultNamespace)
 
@@ -66,11 +70,11 @@ func (eh *PromotionHandler) HandlePromotionTriggeredEvent() error {
 		return err
 	}
 
-	err = eh.GitHandler.UpdateGitRepo(mysecret, eventData.Stage, eventData.Service, version)
+	err = eh.GitHandler.UpdateGitRepo(mysecret, eventData.Stage, eventData.Service, version, configVersion)
 	if err != nil {
 		count := 0
 		for err != nil && count <= 5 {
-			err = eh.GitHandler.UpdateGitRepo(mysecret, eventData.Stage, eventData.Service, version)
+			err = eh.GitHandler.UpdateGitRepo(mysecret, eventData.Stage, eventData.Service, version, configVersion)
 			count++
 		}
 		eh.KeptnHandler.Logger.Error(fmt.Sprintf("Could not update service %v/%v for stage %v: %v", eventData.Project, eventData.Service, eventData.Stage, err.Error()))

promotion-service/eventhandler/eventhandlers.go

@@ -28,7 +28,7 @@ import (
 
 //go:generate moq -pkg githandler_mock -skip-ensure -out ../eventhandler/fake/githandler_mock.go . GitHandlerInterface
 type GitHandlerInterface interface {
-	UpdateGitRepo(credentials *GitRepositoryConfig, stage string, service string, version string) error
+	UpdateGitRepo(credentials *GitRepositoryConfig, stage string, service string, version string, configVersion string) error
 }
 
 type GitHandler struct {
@@ -76,7 +76,7 @@ func GetGitCredentials(remoteURI, user, token string, branch string) (*GitReposi
 }
 
 //UpdateGitRepo updates the upstream repository
-func (gh *GitHandler) UpdateGitRepo(credentials *GitRepositoryConfig, stage string, service string, version string) error {
+func (gh *GitHandler) UpdateGitRepo(credentials *GitRepositoryConfig, stage string, service string, version string, configVersion string) error {
 	authentication := &http.BasicAuth{
 		Username: credentials.User,
 		Password: credentials.Token,
@@ -85,7 +85,7 @@ func (gh *GitHandler) UpdateGitRepo(credentials *GitRepositoryConfig, stage stri
 	cloneOptionsMaster := git.CloneOptions{
 		URL:           credentials.RemoteURI,
 		Auth:          authentication,
-		ReferenceName: plumbing.ReferenceName("refs/tags/" + service + "-" + version),
+		ReferenceName: plumbing.ReferenceName("refs/tags/" + service + "-" + version + "-" + configVersion),
 		SingleBranch:  true,
 	}
 
@@ -153,7 +153,7 @@ func (gh *GitHandler) UpdateGitRepo(credentials *GitRepositoryConfig, stage stri
 		log.Println("Could not add files")
 	}
 
-	_, err = w.Commit("Updated to version "+version, &commitOptions)
+	_, err = w.Commit("Updated to version "+version+"-"+configVersion, &commitOptions)
 	if err != nil {
 		log.Println("Couldn't commit "+stage, err)
 		return err