vars/createKubernetesCluster.groovy

#!/usr/bin/env groovy
// -----------------------------------------------------------------------
// Copyright 2021-2023 Open Networking Foundation (ONF) and the ONF Contributors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// -----------------------------------------------------------------------
// Intent: sets up a kubernetes cluster (using kind)
// -----------------------------------------------------------------------

// -----------------------------------------------------------------------
// -----------------------------------------------------------------------
String getIam(String func) {
    // Cannot rely on a stack trace due to jenkins manipulation
    String src = 'vars/createKubernetesCluster.groovy'
    String iam = [src, func].join('::')
    return iam
}

// -----------------------------------------------------------------------
// Intent: Log progress message
// -----------------------------------------------------------------------
void enter(String name) {
    // Announce ourselves for log usability
    String iam = getIam(name)
    println("${iam}: ENTER")
    return
}

// -----------------------------------------------------------------------
// Intent: Log progress message
// -----------------------------------------------------------------------
void leave(String name) {
    // Announce ourselves for log usability
    String iam = getIam(name)
    println("${iam}: LEAVE")
    return
}

// -----------------------------------------------------------------------
// -----------------------------------------------------------------------
def call(Map config=[:]) {

    String iam = getIam('main')
    enter('main')

    // note that I can't define this outside the function as there's no global scope in Groovy
    def defaultConfig = [
        branch: 'master', // branch=master ?!?
        nodes: 1,
        name: 'kind-ci'
    ]

    def cfg = defaultConfig + config

    println "Deploying Kind cluster with the following parameters: ${cfg}."

    // TODO support different configs
    def data = '''
kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
nodes:
- role: worker
- role: worker
- role: control-plane
  kubeadmConfigPatches:
  - |
    kind: InitConfiguration
    nodeRegistration:
      kubeletExtraArgs:
        node-labels: "ingress-ready=true"
  extraPortMappings:
  - containerPort: 80
    hostPort: 80
    protocol: TCP
  - containerPort: 443
    hostPort: 443
    protocol: TCP
  - containerPort: 30115
    hostPort: 30115
  - containerPort: 30120
    hostPort: 30120
'''
    writeFile(file: 'kind.cfg', text: data)

    // TODO: Skip kind install, make install-kind-command has done it already
    sh """
      mkdir -p $WORKSPACE/bin

      # download kind (should we add it to the base image?)
      curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.11.0/kind-linux-amd64
      chmod +x ./kind
      mv ./kind $WORKSPACE/bin/kind
    """

    // install voltctl
    installVoltctl("${cfg.branch}")

    sh(label  : 'Start kind cluster',
       script : """
cat <<EOM

** -----------------------------------------------------------------------
** IAM: ${iam}
** Starting kind cluster
** -----------------------------------------------------------------------
EOM
      # start the kind cluster
      kind create cluster --name ${cfg.name} --config kind.cfg

      # remove NoSchedule taint from nodes
      for MNODE in \$(kubectl get node --selector='node-role.kubernetes.io/master' -o json | jq -r '.items[].metadata.name'); do
          kubectl taint node "\$MNODE" node-role.kubernetes.io/master:NoSchedule-
      done
      # install ingress-nginx to allow usage of ingress to expose voltha
      # endpoints (etcd and voltha-api)
      kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/helm-chart-4.2.5/deploy/static/provider/kind/deploy.yaml
      # remove validating webhook for now, since some of the pipelines seem to
      # fail with errors related to calling this hook and although there is a
      # lot of talk in the internet about this issue, the solution very much
      # depends on your exact setup (and it might not be worth investigating the
      # details for a k8s version which has been EOL since some time now)
      # https://stackoverflow.com/questions/61616203/nginx-ingress-controller-failed-calling-webhook
      # This should be removed and properly fixed once we upgrade to a recent
      # k8s version and a fitting ingress-nginx deployment
      kubectl delete -A ValidatingWebhookConfiguration ingress-nginx-admission

""")

    sh(label  : 'Normalize config permissions',
       script : """
      ## ----------------------------------------------------------------------
      ## This logic is problematic, when run on a node processing concurrent
      ## jobs over-write will corrupt config for the other running job.
      ## ----------------------------------------------------------------------
      ## Future enhancement:  Optimal answer would be to create and use configs
      ## from a job-specific temp/config directory.
      ## ----------------------------------------------------------------------

      umask 022

      echo
      echo "** Generate $HOME/.kube/config"
      mkdir -p "$HOME/.kube"
      chmod u=rwx "$HOME/.kube"
      kind get kubeconfig --name ${cfg.name} > "$HOME/.kube/config"
      chmod -R u+w,go-rwx "$HOME/.kube"

      echo
      echo "Display .kube/ and .volt/ configs"
      /bin/ls -l "$HOME/.kube" "$HOME/.volt"
""")

    sh(label  : 'Install kail',
       script : """
cat <<EOM

** -----------------------------------------------------------------------
** IAM: ${iam}
** Install kail
** -----------------------------------------------------------------------
EOM
      make -C "$WORKSPACE/voltha-system-tests" KAIL_PATH="$WORKSPACE/bin" kail
""")

    leave('main')
    return
}

// [EOF]