remove env variable for k8s version and replace lachlanevenson/k8s-kubectl image with rancher/kubectl. Use k8sVersion parameter from config as kubectl version when it is not explicitly specified.

Author: lukma99

CHANGELOG.md

@@ -7,11 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-
-## [0.3.0](https://github.com/cloudogu/gitops-build-lib/releases/tag/0.3.0) - 2023-XX-YY
-
 ### Added
-- Specify version for `helm template` through the `k8sVersion` parameter
+- Specify version for `helm template` and kubectl image through the `k8sVersion` parameter
+
+### Changed
+- Changed kubectl image from `lachlanevenson/k8s-kubectl` to `rancher/kubectl`, because it is available for every k8s version out there
 
 ### Fixed
 - Don't fail when no `values-shared.yaml` is provided

README.md

@@ -130,7 +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' if env-Variable GITOPS_BUILD_LIB_K8S_VERSION not specified */
+    k8sVersion: '1.24.8', /* Default: '1.24.8' */
     scm: [
         provider:       'SCMManager',
         credentialsId:  'scmm-user',
@@ -338,6 +338,8 @@ 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 an 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.
 
 ---
 
@@ -349,12 +351,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 rancher/kubectl:v${k8sVersion} will be used
+        kubectl: 'rancher/kubectl:v1.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'
+        yamllint: 'cytopia/yamllint:1.25-0.9'
     ]
 ]
 ```
@@ -614,9 +617,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.
-`k8sVersion` can also be specified through an env-variable called `GITOPS_BUILD_LIB_K8S_VERSION`.
 
 ---
 

vars/deployViaGitops.groovy

@@ -18,12 +18,9 @@ List getMandatoryFields() {
     ]
 }
 
-Map createDefaultConfig() {
+Map createDefaultConfig(String k8sVersion) {
 
-    def k8sVersion = ""
-    if (env.GITOPS_BUILD_LIB_K8S_VERSION){
-        k8sVersion = env.GITOPS_BUILD_LIB_K8S_VERSION
-    } else{
+    if (k8sVersion == null || k8sVersion == ""){
         k8sVersion = "1.24.8"
     }
 
@@ -40,7 +37,7 @@ Map createDefaultConfig() {
             ],
             kubectl: [
                 credentialsId: '',
-                image: 'lachlanevenson/k8s-kubectl:v1.24.8'
+                image: "rancher/kubectl:v${k8sVersion}"
             ],
             // We use the helm image (that also contains kubeval plugin) to speed up builds by allowing to reuse image
             kubeval: [
@@ -99,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)