Bash-এর সাথে স্বয়ংক্রিয়ভাবে হেলম স্থাপনা

আমাদের কিছু অ্যাপ্লিকেশান কুবারনেটস ক্লাস্টারে হোস্ট করা হয়েছে এবং আমরা ডিপ্লয়মেন্ট স্বয়ংক্রিয় করতে গিটল্যাব কন্টিনিউয়াস ইন্টিগ্রেশন (CI) ব্যবহার করি এবং আমাদের অ্যাপ্লিকেশনগুলি মোতায়েন করার জন্য Helm 2 ব্যবহার করি। হেলম চার্টগুলি কুবারনেটস অবজেক্টের YAML ফাইলগুলির টেমপ্লেটগুলির সঞ্চয়স্থান সক্ষম করে ভেরিয়েবল সহ যা চার্টটি স্থাপনের সময় ব্যবহার করা হলে পাস করা কমান্ড-লাইন আর্গুমেন্ট থেকে প্রোগ্রাম্যাটিকভাবে সেট করা যেতে পারে। এটি আমাদের গিটল্যাব-সুরক্ষিত পরিবেশ ভেরিয়েবলে বা হ্যাশিকর্প ভল্টে গুরুত্বপূর্ণ গোপনীয়তা সংরক্ষণ করতে এবং CI স্থাপনার কাজের মধ্যে ব্যবহার করতে দেয়।

আমাদের স্থাপনার কাজ একটি ব্যাশ স্ক্রিপ্ট ব্যবহার করে স্থাপনার প্রক্রিয়া চালানোর জন্য। এই ব্যাশ স্ক্রিপ্টটি অনেকগুলি বৈশিষ্ট্য উপস্থাপন করে যা একটি CI/CD পরিবেশের মধ্যে ব্যবহারের জন্য মূল্যবান:

1. এটি CI/CD পরিবেশের বাইরে ব্যবহারের সুবিধা দেয়। GitLab CI এবং অন্যান্য CI সিস্টেমগুলি একটি CI টেক্সট ফাইলের একটি "স্ক্রিপ্ট" বিভাগে এক্সিকিউটেবল শেল কোডের লাইন হিসাবে কাজের ধাপগুলি সংরক্ষণ করে (উদাহরণস্বরূপ gitlab-ci.yml)। যদিও এটি মৌলিক এক্সিকিউটেবল পদক্ষেপগুলি বাহ্যিক নির্ভরতা ছাড়াই সংরক্ষণ করা যেতে পারে তা নিশ্চিত করার জন্য দরকারী, এটি ডেভেলপারদের পরীক্ষা বা ম্যানুয়াল স্থাপনার পরিস্থিতিতে একই কোড ব্যবহার করতে বাধা দেয়। উপরন্তু, ব্যাশ সিস্টেমের অনেক উন্নত বৈশিষ্ট্য এই স্ক্রিপ্ট বিভাগে সহজে ব্যবহার করা যাবে না।
2. এটি গুরুত্বপূর্ণ স্থাপনার প্রক্রিয়াগুলির ইউনিট পরীক্ষার সুবিধা দেয়৷ CI সিস্টেমের কোনোটিই ডিপ্লয়মেন্ট লজিক প্রত্যাশিতভাবে কাজ করে কিনা তা পরীক্ষা করার উপায় প্রদান করে না। সাবধানে নির্মিত ব্যাশ স্ক্রিপ্টগুলি BATS দিয়ে ইউনিট পরীক্ষা করা যেতে পারে।
3. এটি স্ক্রিপ্টের মধ্যে পৃথক ফাংশন পুনঃব্যবহারের সুবিধা দেয়। শেষ বিভাগে একটি গার্ড ক্লজ ব্যবহার করা হয়েছে, if [[ "${BASH_SOURCE[0]}" =="${0}" ]] , যা run_mainকে বাধা দেয় যখন স্ক্রিপ্টটি কার্যকর করা হচ্ছে না তখন কল করা থেকে ফাংশন। এটি স্ক্রিপ্টটিকে উৎস করার অনুমতি দেয়, যা ব্যবহারকারীদের এর মধ্যে থাকা অনেকগুলি দরকারী পৃথক ফাংশন ব্যবহার করতে দেয়। সঠিক BATS পরীক্ষার জন্য এটি অত্যন্ত গুরুত্বপূর্ণ।
4. এটি সংবেদনশীল তথ্য রক্ষা করতে পরিবেশের ভেরিয়েবল ব্যবহার করে এবং স্ক্রিপ্টটিকে অনেক প্রকল্প এবং প্রকল্প অ্যাপ্লিকেশন পরিবেশে পুনরায় ব্যবহারযোগ্য করে তোলে। GitLab CI রানার দ্বারা চালিত হলে এই পরিবেশের অনেকগুলি ভেরিয়েবল উপলব্ধ করে। GitLab CI-এর বাইরে স্ক্রিপ্ট ব্যবহার করার আগে এগুলি ম্যানুয়ালি সেট করতে হবে।

স্ক্রিপ্টটি Kubernetes-এ একটি অ্যাপ্লিকেশনের জন্য একটি হেলম চার্ট স্থাপন করার জন্য প্রয়োজনীয় সমস্ত কাজ সম্পাদন করে এবং kubectl এবং Helm ব্যবহার করে স্থাপনা প্রস্তুত হওয়ার জন্য অপেক্ষা করে। কুবারনেটস ক্লাস্টারে টিলার চালানোর পরিবর্তে হেলম একটি স্থানীয় টিলার ইনস্টলেশনের সাথে চলে। কুবারনেটস HELM_USER এবং HELM_PASSWORD কুবারনেটস CLUSTER_SERVER-এ লগ ইন করতে ব্যবহৃত হয় এবং PROJECT_NAMESPACE . টিলার শুরু হয়েছে, হেলম শুধুমাত্র ক্লায়েন্ট মোডে শুরু করা হয়েছে এবং এর রেপো আপডেট করা হয়েছে। টেমপ্লেটটি হেলমের সাথে লিন্ট করা হয়েছে যাতে সিনট্যাক্স ত্রুটিগুলি দুর্ঘটনাক্রমে সংঘটিত না হয়। তারপর হেলম আপগ্রেড --ইনস্টল ব্যবহার করে টেমপ্লেটটি ঘোষণামূলক মোডে স্থাপন করা হয় . হেলম --ওয়েট পতাকা ব্যবহার করে স্থাপনা প্রস্তুত হওয়ার জন্য অপেক্ষা করে .

স্ক্রিপ্ট নিশ্চিত করে যে কিছু নির্দিষ্ট টেমপ্লেট ভেরিয়েবল স্থাপনের সময় সেট করা আছে এবং বিশেষ প্রকল্প-নির্দিষ্ট ভেরিয়েবলগুলিকে GitLab CIPROJECT_SPECIFIC_DEPLOY_ARGS-এ নির্দিষ্ট করার অনুমতি দেয় পরিবেশ সূচক. স্থাপনার জন্য প্রয়োজনীয় সমস্ত এনভায়রনমেন্ট ভেরিয়েবল স্ক্রিপ্ট এক্সিকিউশনের প্রথম দিকে চেক করা হয় এবং স্ক্রিপ্টটি অ-শূন্য প্রস্থান স্ট্যাটাস সহ প্রস্থান করে যদি কোনো অনুপস্থিত থাকে।

এই স্ক্রিপ্টটি একাধিক গিটল্যাব সিআই-হোস্টেড প্রকল্পে ব্যবহার করা হয়েছে। এটি প্রতিটি প্রকল্পে স্থাপনার যুক্তির পরিবর্তে আমাদের কোডে ফোকাস করতে সাহায্য করেছে।

লিপি

#!/bin/bash



# MIT License

#

# Copyright (c) 2019 Darin London

#

# Permission is hereby granted, free of charge, to any person obtaining a copy

# of this software and associated documentation files (the "Software"), to deal

# in the Software without restriction, including without limitation the rights

# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

# copies of the Software, and to permit persons to whom the Software is

# furnished to do so, subject to the following conditions:

#

# The above copyright notice and this permission notice shall be included in all

# copies or substantial portions of the Software.

#

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

# SOFTWARE.



log_level_for()

{

  case "${1}" in

    "error")

      echo 1

      ;;



    "warn")

      echo 2

      ;;



    "debug")

      echo 3

      ;;



    "info")

      echo 4

      ;;

    *)

      echo -1

      ;;

  esac

}



current_log_level()

{

  log_level_for "${LOG_LEVEL}"

}



error()

{

  [ $(log_level_for "error") -le $(current_log_level) ] &&  echo "${1}" >&2

}



warn()

{

  [ $(log_level_for "warn") -le $(current_log_level) ] &&  echo "${1}" >&2

}



debug()

{

  [ $(log_level_for "debug") -le $(current_log_level) ] &&  echo "${1}" >&2

}



info()

{

  [ $(log_level_for "info") -le $(current_log_level) ] &&  echo "${1}" >&2

}



check_required_environment() {

  local required_env="${1}"



  for reqvar in $required_env

  do

    if [ -z "${!reqvar}" ]

    then

      error "missing ENVIRONMENT ${reqvar}!"

      return 1

    fi

  done

}



check_default_environment() {

  local required_env="${1}"



  for varpair in $required_env

  do

    local manual_environment=$(echo "${varpair}" | cut -d':' -f1)

    local default_if_not_set=$(echo "${varpair}" | cut -d':' -f2)

    if [ -z "${!manual_environment}" ] && [ -z "${!default_if_not_set}" ]

    then

      error "missing default ENVIRONMENT, set ${manual_environment} or ${default_if_not_set}!"

      return 1

    fi

  done

}



dry_run() {

  [ ${DRY_RUN} ] && info "skipping for dry run" && return

  return 1

}



init_tiller() {

  info "initializing local tiller"

  dry_run && return



  export TILLER_NAMESPACE=$PROJECT_NAMESPACE

  export HELM_HOST=localhost:44134

  # https://rimusz.net/tillerless-helm/

  # run tiller locally instead of in the cluster

  tiller --storage=secret &

  export TILLER_PID=$!

  sleep 1

  kill -0 ${TILLER_PID}

  if [ $? -gt 0 ]

  then

    error "tiller not running!"

    return 1

  fi

}



init_helm() {

  info "initializing helm"

  dry_run && return



  helm init --client-only

  if [ $? -gt 0 ]

  then

    error "could not initialize helm"

    return 1

  fi

}



init_helm_with_tiller() {

  init_tiller || return 1

  init_helm || return 1

  info "updating helm client repository information"

  dry_run && return

  helm repo update

  if [ $? -gt 0 ]

  then

    error "could not update helm repository information"

    return 1

  fi

}



decommission_tiller() {

  if [ -n "${TILLER_PID}" ]

  then

    kill ${TILLER_PID}

    if [ $? -gt 0 ]

    then

     return

    fi

  fi

}



check_required_deploy_arg_environment() {

  [ -z "${PROJECT_SPECIFIC_DEPLOY_ARGS}" ] && return

  for reqvar in ${PROJECT_SPECIFIC_DEPLOY_ARGS}

  do

    if [ -z ${!reqvar} ]

    then

      error "missing Deployment ENVIRONMENT ${reqvar} required!"

      return 1

    fi

  done

}



project_specific_deploy_args() {

  [ -z "${PROJECT_SPECIFIC_DEPLOY_ARGS}" ] && echo "" && return



  extraArgs=''

  for deploy_arg_key in ${PROJECT_SPECIFIC_DEPLOY_ARGS}

  do

    extraArgs="${extraArgs} --set $(echo "${deploy_arg_key}" | sed 's/__/\./g' | tr '[:upper:]' '[:lower:]')=${!deploy_arg_key}"

  done



  echo "${extraArgs}"

}



check_required_cluster_login_environment() {

  check_required_environment "HELM_TOKEN HELM_USER PROJECT_NAMESPACE CLUSTER_SERVER" || return 1

}



cluster_login() {

  info "authenticating ${HELM_USER} in ${PROJECT_NAMESPACE}"

  dry_run && return



  kubectl config set-cluster ci_kube --server="${CLUSTER_SERVER}" || return 1

  kubectl config set-credentials "${HELM_USER}" --token="${HELM_TOKEN}" || return 1

  kubectl config set-context ${PROJECT_NAMESPACE}-deploy  --cluster=ci_kube --namespace=${PROJECT_NAMESPACE} --user=${HELM_USER} || return 1

  kubectl config use-context ${PROJECT_NAMESPACE}-deploy || return 1

}



lint_template() {

  info "linting template"

  dry_run && return



  helm lint ${CI_PROJECT_DIR}/helm-chart/${CI_PROJECT_NAME}

}



check_required_image_pull_environment() {

  if [ "${CI_PROJECT_VISIBILITY}" == "public" ]

  then

    check_required_environment "CI_REGISTRY CI_DEPLOY_USER CI_DEPLOY_PASSWORD" || return 1

  fi

}



image_pull_settings() {

  if [ "${CI_PROJECT_VISIBILITY}" == "public" ]

  then

    echo ""

  else

    echo "--set registry.root=${CI_REGISTRY} --set registry.secret.username=${CI_DEPLOY_USER} --set registry.secret.password=${CI_DEPLOY_PASSWORD}"

  fi

}



deployment_name() {

  if [ -n "${DEPLOYMENT_NAME}" ]

  then

    echo "${DEPLOYMENT_NAME}"

  else

    echo "${CI_ENVIRONMENT_SLUG}-${CI_PROJECT_NAME}"

  fi

}



deploy_template() {

  info "deploying $(deployment_name) from template"

  if dry_run

  then

    info "helm upgrade --force --recreate-pods --debug --set image.repository=${CI_REGISTRY_IMAGE}/${CI_PROJECT_NAME} --set image.tag=${CI_COMMIT_SHORT_SHA} --set environment=${CI_ENVIRONMENT_NAME} --set-string git_commit=${CI_COMMIT_SHORT_SHA} --set git_ref=${CI_COMMIT_REF_SLUG} --set ci_job_id=${CI_JOB_ID} $(environment_url_settings) $(image_pull_settings) $(project_specific_deploy_args) --wait --install $(deployment_name) ${CI_PROJECT_DIR}/helm-chart/${CI_PROJECT_NAME}"

  else

    helm upgrade --force --recreate-pods --debug \

    --set image.repository="${CI_REGISTRY_IMAGE}/${CI_PROJECT_NAME}" \

    --set image.tag="${CI_COMMIT_SHORT_SHA}" \

    --set environment="${CI_ENVIRONMENT_NAME}" \

    --set-string git_commit="${CI_COMMIT_SHORT_SHA}" \

    --set git_ref="${CI_COMMIT_REF_SLUG}" \

    --set ci_job_id="${CI_JOB_ID}" \

    $(image_pull_settings) \

    $(project_specific_deploy_args) \

    --wait \

    --install $(deployment_name) ${CI_PROJECT_DIR}/helm-chart/${CI_PROJECT_NAME}

  fi

}



get_pods() {

  kubectl get pods -l ci_job_id="${CI_JOB_ID}"

}



watch_deployment() {

  local watch_deployment=$(deployment_name)

  if [ -n "${WATCH_DEPLOYMENT}" ]

  then

    watch_deployment="${WATCH_DEPLOYMENT}"

  fi

  info "waiting until deployment ${watch_deployment} is ready"

  dry_run && return



  kubectl rollout status deployment/${watch_deployment} -w || return 1

  sleep 5

  get_pods || return 1

  # see what has been deployed

  kubectl describe deployment -l app=${CI_PROJECT_NAME},environment=${CI_ENVIRONMENT_NAME},git_commit=${CI_COMMIT_SHORT_SHA} || return 1

  if [ -n "${CI_ENVIRONMENT_URL}" ]

  then

    kubectl describe service -l app=${CI_PROJECT_NAME},environment=${CI_ENVIRONMENT_NAME} || return 1

    kubectl describe route -l app=${CI_PROJECT_NAME},environment=${CI_ENVIRONMENT_NAME} || return 1

  fi

}



run_main() {

  check_required_environment "CI_PROJECT_NAME CI_PROJECT_DIR CI_COMMIT_REF_SLUG CI_REGISTRY_IMAGE CI_ENVIRONMENT_NAME CI_JOB_ID CI_COMMIT_SHORT_SHA" || return 1

  check_default_environment "WATCH_DEPLOYMENT:CI_ENVIRONMENT_SLUG" || return 1

  check_required_deploy_arg_environment || return 1

  check_required_cluster_login_environment || return 1

  check_required_image_pull_environment || return 1

  cluster_login

  if [ $? -gt 0 ]

  then

    error "could not login kubectl"

    return 1

  fi



  init_helm_with_tiller

  if [ $? -gt 0 ]

  then

    error "could not initialize helm"

    return 1

  fi



  lint_template

  if [ $? -gt 0 ]

  then

    error "linting failed"

    return 1

  fi



  deploy_template

  if [ $? -gt 0 ]

  then

    error "could not deploy template"

    return 1

  fi



  watch_deployment

  if [ $? -gt 0 ]

  then

    error "could not watch deployment"

    return 1

  fi



  decommission_tiller

  info "ALL Complete!"

  return

}



if [[ "${BASH_SOURCE[0]}" == "${0}" ]]

then

  run_main

  if [ $? -gt 0 ]

  then

    exit 1

  fi

fi