Merge pull request #28 from cloudogu/feature/global_k8s_version

Feature/global k8s version

Author: schnatterer

CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- Specify `--kube-version ` for `helm template` and kubectl image through the `k8sVersion` parameter.  
+  ⚠️ `k8sVersion` has a default value, so this is no breaking change per se. However, depending on the helm chart used, 
+  the rendered result might look different from before where no `--kube-version` parameter was used.  
+  We recommend setting the `k8sVersion`. Double-check the commits in your GitOps repo. 
+
+### Changed
+- Changed kubectl image from `lachlanevenson/k8s-kubectl` to `bitnami/kubectl`, because it is available for every k8s version out there
+
+### Fixed
+- Don't fail when no `values-shared.yaml` is provided
+
 ## [0.2.0](https://github.com/cloudogu/gitops-build-lib/releases/tag/0.2.0) - 2023-03-10
 
 ### Added

README.md

@@ -130,6 +130,7 @@ gitops-folder in git. For production it will open a PR with the changes.
 
 ```groovy
 def gitopsConfig = [
+    k8sVersion: '1.24.8', /* Default: '1.24.8' */
     scm: [
         provider:       'SCMManager',
         credentialsId:  'scmm-user',
@@ -337,6 +338,13 @@ First of all there are some mandatory properties e.g. the information about your
    * `cesBuildLibRepo:    'https://github.com/cloudogu/ces-build-lib'`
    * `cesBuildLibVersion: '1.62.0'`
    * `mainBranch:         'main'`
+* Optional: `k8sVersion: '1.24.8'` Is used for target k8s version in helm template in Argo CD deployments with helm. Is also used to determine the kubectl version, when no specific buildImage is specified.  
+  It is recommended to use a Jenkins environment variable to specify the version, so that you don't have to bump every pipeline after a k8s version upgrade in your cluster, e.g.
+```
+def gitopsConfig = [  
+    k8sVersion: env.K8S_VERSION_TEAM_A  
+]
+```
 
 ---
 
@@ -348,12 +356,13 @@ All of these have set default images, but you can change them if you wish to.
 def gitopsConfig = [
     buildImages: [
         // These are used to run helm and kubectl commands in the core logic
-        helm: 'ghcr.io/cloudogu/helm:3.5.4-1',
-        kubectl: 'lachlanevenson/k8s-kubectl:v1.19.3',
+        helm: 'ghcr.io/cloudogu/helm:3.11.1-2',
+        // if you specify k8sVersion parameter, then by default bitnami/kubectl:${k8sVersion} will be used
+        kubectl: 'bitnami/kubectl:1.24.8',
         // These are used for each specific validator via an imageRef property inside the validators config. See [Validators] for examples.
-        kubeval: 'ghcr.io/cloudogu/helm:3.5.4-1',
-        helmKubeval: 'ghcr.io/cloudogu/helm:3.5.4-1',
-        yamllint: 'cytopia/yamllint:1.25-0.7'
+        kubeval: 'ghcr.io/cloudogu/helm:3.11.1-2',
+        helmKubeval: 'ghcr.io/cloudogu/helm:3.11.1-2',
+        yamllint: 'cytopia/yamllint:1.25-0.9'
     ]
 ]
 ```
@@ -613,6 +622,7 @@ We decided to generate plain k8s Resources from Helm applications before we push
 
 - With ArgoCD you can only set one source for your application. In case of helm it is common to have a source Repository for your chart and a scource Repository for your configuration files (values.yaml). In order to use two different sources for your helm application you will need some sort of workaround (e.g. Helm dependencies in `Chart.yaml`).  
 - ArgoCD itself uses `helm template` to apply plain k8s Resources to the cluster. By templating the helm application before pushing to the gitops repository, we have the same resources in our repository as in our cluster. Which leads to increased transparency.
+The parameter `k8sVersion` from the gitops config is used as a parameter with `--kube-version` in order to template version-specific manifests such as changed api versions.
 
 ---
 

src/com/cloudogu/gitopsbuildlib/deployment/helm/Helm.groovy

@@ -42,7 +42,13 @@ class Helm extends Deployment {
         // writing the merged-values.yaml via writeYaml into a file has the advantage, that it gets formatted as valid yaml
         // This makes it easier to read in and indent for the inline use in the helmRelease.
         // It enables us to reuse the `fileToInlineYaml` function, without writing a complex formatting logic.
-        script.writeFile file: "${script.env.WORKSPACE}/${helmChartTempDir}/mergedValues.yaml", text: mergeValuesFiles(gitopsConfig, ["${script.env.WORKSPACE}/${sourcePath}/values-${stage}.yaml", "${script.env.WORKSPACE}/${sourcePath}/values-shared.yaml"] as String[])
+
+        def valueFiles = ["${script.env.WORKSPACE}/${sourcePath}/values-${stage}.yaml"]
+        // only add values-shared.yaml, if it exists
+        if (script.fileExists("${script.env.WORKSPACE}/${sourcePath}/values-shared.yaml")) {
+            valueFiles.add("${script.env.WORKSPACE}/${sourcePath}/values-shared.yaml")
+        }
+        script.writeFile file: "${script.env.WORKSPACE}/${helmChartTempDir}/mergedValues.yaml", text: mergeValuesFiles(gitopsConfig, valueFiles as String[])
 
         updateYamlValue("${script.env.WORKSPACE}/${helmChartTempDir}/mergedValues.yaml", gitopsConfig)
 

src/com/cloudogu/gitopsbuildlib/deployment/helm/helmrelease/ArgoCDRelease.groovy

@@ -33,17 +33,17 @@ class ArgoCDRelease extends HelmRelease {
             chartPath = helmConfig.chartPath
         }
 
-        return createHelmRelease(chartPath as String, application, namespace, gitopsConfig.buildImages.helm, mergedValuesFile)
+        return createHelmRelease(gitopsConfig, chartPath as String, application, namespace, gitopsConfig.buildImages.helm, mergedValuesFile)
     }
 
     private String createResourcesFromHelmRepo(Map gitopsConfig, String application, String namespace, String mergedValuesFile) {
-        return createHelmRelease(gitopsConfig.deployments.helm.chartName, application, namespace, gitopsConfig.buildImages.helm, mergedValuesFile)
+        return createHelmRelease(gitopsConfig, gitopsConfig.deployments.helm.chartName, application, namespace, gitopsConfig.buildImages.helm, mergedValuesFile)
     }
 
-    private String createHelmRelease(def chartPath, String application, String namespace, def helmImageConfig, String mergedValuesFile) {
+    private String createHelmRelease(Map gitopsConfig, def chartPath, String application, String namespace, def helmImageConfig, String mergedValuesFile) {
         String helmRelease = ""
         dockerWrapper.withDockerImage(helmImageConfig) {
-            String templateScript = "helm template ${application} ${script.env.WORKSPACE}/.helmChartTempDir/chart/${chartPath} -n ${namespace} -f ${mergedValuesFile}"
+            String templateScript = "helm template ${application} ${script.env.WORKSPACE}/.helmChartTempDir/chart/${chartPath} -n ${namespace} --kube-version ${gitopsConfig.k8sVersion} -f ${mergedValuesFile}"
             helmRelease = script.sh returnStdout: true, script: templateScript
         }
 

test/com/cloudogu/gitopsbuildlib/ScriptMock.groovy

@@ -32,6 +32,7 @@ to:
     List<String> actualWriteYamlArgs = new LinkedList<>()
     List<String> actualReadFileArgs = new LinkedList<>()
     List<String> actualWriteFileArgs = new LinkedList<>()
+    List<String> actualFileExistsArgs = new LinkedList<>()
 
     def mock =
         [
@@ -52,6 +53,7 @@ to:
             writeYaml: { args -> actualWriteYamlArgs += args.toString() },
             readFile : { args -> actualReadFileArgs += args.toString(); return configYaml},
             writeFile: { args -> actualWriteFileArgs += args.toString() },
+            fileExists: { args -> actualFileExistsArgs += args.toString(); return true },
             env   : [
                 WORKSPACE: 'workspace'
             ],

test/com/cloudogu/gitopsbuildlib/deployment/helm/helmrelease/ArgoCDReleaseTest.groovy

@@ -13,6 +13,7 @@ class ArgoCDReleaseTest {
     @Test
     void 'correct helm release with git repo and chartPath'() {
         argoCdReleaseTest.create([
+            k8sVersion: '1.24.8',
             application: 'app',
             deployments: [
                 helm: [
@@ -33,12 +34,13 @@ class ArgoCDReleaseTest {
             'this/is/a/valuesfile')
 
         assertThat(scriptMock.dockerMock.actualImages[0]).isEqualTo('helmImg')
-        assertThat(scriptMock.actualShArgs[0]).isEqualTo('[returnStdout:true, script:helm template app workspace/.helmChartTempDir/chart/path -n namespace -f this/is/a/valuesfile]')
+        assertThat(scriptMock.actualShArgs[0]).isEqualTo('[returnStdout:true, script:helm template app workspace/.helmChartTempDir/chart/path -n namespace --kube-version 1.24.8 -f this/is/a/valuesfile]')
     }
 
     @Test
     void 'correct helm release with git repo without chartPath'() {
         argoCdReleaseTest.create([
+            k8sVersion: '1.24.8',
             application: 'app',
             deployments: [
                 helm: [
@@ -58,12 +60,13 @@ class ArgoCDReleaseTest {
             'this/is/a/valuesfile')
 
         assertThat(scriptMock.dockerMock.actualImages[0]).isEqualTo('helmImg')
-        assertThat(scriptMock.actualShArgs[0]).isEqualTo('[returnStdout:true, script:helm template app workspace/.helmChartTempDir/chart/ -n namespace -f this/is/a/valuesfile]')
+        assertThat(scriptMock.actualShArgs[0]).isEqualTo('[returnStdout:true, script:helm template app workspace/.helmChartTempDir/chart/ -n namespace --kube-version 1.24.8 -f this/is/a/valuesfile]')
     }
 
     @Test
     void 'correct helm release with helm repo'() {
         argoCdReleaseTest.create([
+            k8sVersion: '1.24.8',
             application: 'app',
             deployments: [
                 helm: [
@@ -83,6 +86,6 @@ class ArgoCDReleaseTest {
             'this/is/a/valuesfile')
 
         assertThat(scriptMock.dockerMock.actualImages[0]).isEqualTo('helmImg')
-        assertThat(scriptMock.actualShArgs[0]).isEqualTo('[returnStdout:true, script:helm template app workspace/.helmChartTempDir/chart/chartName -n namespace -f this/is/a/valuesfile]')
+        assertThat(scriptMock.actualShArgs[0]).isEqualTo('[returnStdout:true, script:helm template app workspace/.helmChartTempDir/chart/chartName -n namespace --kube-version 1.24.8 -f this/is/a/valuesfile]')
     }
 }

vars/deployViaGitops.groovy

@@ -18,9 +18,14 @@ List getMandatoryFields() {
     ]
 }
 
-Map createDefaultConfig() {
+Map createDefaultConfig(String k8sVersion) {
+
+    if (k8sVersion == null || k8sVersion == ""){
+        k8sVersion = "1.24.8"
+    }
 
     return [
+        k8sVersion             : "${k8sVersion}",
         cesBuildLibRepo         : 'https://github.com/cloudogu/ces-build-lib',
         cesBuildLibVersion      : '1.62.0',
         cesBuildLibCredentialsId: '',
@@ -32,7 +37,7 @@ Map createDefaultConfig() {
             ],
             kubectl: [
                 credentialsId: '',
-                image: 'lachlanevenson/k8s-kubectl:v1.24.8'
+                image: "bitnami/kubectl:${k8sVersion}"
             ],
             // We use the helm image (that also contains kubeval plugin) to speed up builds by allowing to reuse image
             kubeval: [
@@ -91,7 +96,7 @@ Map createDefaultConfig() {
 
 void call(Map gitopsConfig) {
     // Merge default config with the one passed as parameter
-    gitopsConfig = mergeMaps(createDefaultConfig(), gitopsConfig)
+    gitopsConfig = mergeMaps(createDefaultConfig(gitopsConfig.k8sVersion as String), gitopsConfig)
     if (validateConfig(gitopsConfig)) {
         cesBuildLib = initCesBuildLib(gitopsConfig.cesBuildLibRepo, gitopsConfig.cesBuildLibVersion, gitopsConfig.cesBuildLibCredentialsId)
         deploy(gitopsConfig)