From 7143c28fdef886b3f26a68803df33b3ff97e40c2 Mon Sep 17 00:00:00 2001 From: Ti Chi Robot Date: Tue, 24 Sep 2024 16:26:00 +0800 Subject: [PATCH] hack: support k3s as provider for local-up (#5727) (#5747) Co-authored-by: RidRisR <79858083+RidRisR@users.noreply.github.com> --- hack/local-up-by-k3s.sh | 179 +++++++++++++++++++++++++++++++++++ hack/local-up-by-kind.sh | 192 ++++++++++++++++++++++++++++++++++++++ hack/local-up-operator.sh | 182 ++++++------------------------------ 3 files changed, 397 insertions(+), 156 deletions(-) create mode 100755 hack/local-up-by-k3s.sh create mode 100644 hack/local-up-by-kind.sh diff --git a/hack/local-up-by-k3s.sh b/hack/local-up-by-k3s.sh new file mode 100755 index 00000000000..873bb66bd83 --- /dev/null +++ b/hack/local-up-by-k3s.sh @@ -0,0 +1,179 @@ +#!/usr/bin/env bash + +# Copyright 2020 PingCAP, Inc. +# +# 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, +# See the License for the specific language governing permissions and +# limitations under the License. + +# +# This command runs tidb-operator in Kubernetes. +# + +set -o errexit +set -o nounset +set -o pipefail + +ROOT=$(unset CDPATH && cd $(dirname "${BASH_SOURCE[0]}")/.. && pwd) +cd $ROOT + +source "${ROOT}/hack/lib.sh" + +function usage() { + cat <<'EOF' +This commands run tidb-operator in Kubernetes. + +Usage: hack/local-up-operator.sh [-hd] + + -h show this message and exit + -i install dependencies only + +Environments: + + PROVIDER Kubernetes provider. Defaults: k3s. + CLUSTER the name of e2e cluster. + KUBECONFIG path to the kubeconfig file, defaults: ~/.kube/config + KUBECONTEXT context in kubeconfig file, defaults to current context + NAMESPACE Kubernetes namespace in which we run our tidb-operator. + DOCKER_REGISTRY image docker registry + IMAGE_TAG image tag + SKIP_IMAGE_BUILD skip build and push images + +EOF +} + +installOnly=false +while getopts "h?i" opt; do + case "$opt" in + h|\?) + usage + exit 0 + ;; + i) + installOnly=true + ;; + esac +done + +PROVIDER=${PROVIDER:-k3s} +KUBECONFIG=${KUBECONFIG:-~/.kube/config} +KUBECONTEXT=${KUBECONTEXT:-} +NAMESPACE=${NAMESPACE:-pingcap} +DOCKER_REGISTRY=${DOCKER_REGISTRY:-localhost:5000} +IMAGE_TAG=${IMAGE_TAG:-latest} +SKIP_IMAGE_BUILD=${SKIP_IMAGE_BUILD:-} + +hack::ensure_kubectl +hack::ensure_helm + +function hack::create_namespace() { + local ns="$1" # The namespace to create + # Create the namespace + $KUBECTL_BIN create namespace $ns + # Wait for the namespace to become active + for ((i=0; i < 30; i++)); do + local phase=$(kubectl get ns $ns -ojsonpath='{.status.phase}') + if [ "$phase" == "Active" ]; then + echo "info: namespace $ns is active" + return 0 + fi + sleep 1 + done + echo "error: timed out waiting for namespace $ns to become active" + return 1 +} + +function hack::wait_for_deploy() { + local ns="$1" + local name="$2" + local retries="${3:-300}" + echo "info: waiting for pods of deployment $ns/$name are ready (retries: $retries, interval: 1s)" + for ((i = 0; i < retries; i++)) { + read a b <<<$($KUBECTL_BIN --context $KUBECONTEXT -n $ns get deploy/$name -ojsonpath='{.spec.replicas} {.status.readyReplicas}{"\n"}') + if [[ "$a" -gt 0 && "$a" -eq "$b" ]]; then + echo "info: all pods of deployment $ns/$name are ready (desired: $a, ready: $b)" + return 0 + fi + echo "info: pods of deployment $ns/$name (desired: $a, ready: $b)" + sleep 1 + } + echo "info: timed out waiting for pods of deployment $ns/$name are ready" + return 1 +} + +if [[ "$installOnly" == "true" ]]; then + exit 0 +fi + +echo "info: checking clusters" + +if [ "$PROVIDER" == "k3s" ]; then + echo "info: using k3s provider" + if ! kubectl cluster-info &>/dev/null; then + echo "error: k3s cluster not found, please ensure it is running" + exit 1 + fi +else + echo "error: only k3s PROVIDER is supported" + exit 1 +fi + +if [ -z "$KUBECONTEXT" ]; then + KUBECONTEXT=$(kubectl config current-context) + echo "info: KUBECONTEXT is not set, current context $KUBECONTEXT is used" +fi + +if [ -z "$SKIP_IMAGE_BUILD" ]; then + echo "info: building docker images" + DOCKER_REGISTRY=$DOCKER_REGISTRY IMAGE_TAG=$IMAGE_TAG make docker + + # Push images to the local registry + echo "info: pushing images to the local registry" + + docker push ${DOCKER_REGISTRY}/pingcap/tidb-operator:${IMAGE_TAG} + docker push ${DOCKER_REGISTRY}/pingcap/tidb-backup-manager:${IMAGE_TAG} +else + echo "info: skip building docker images" +fi + +echo "info: uninstall tidb-operator" +$KUBECTL_BIN -n "$NAMESPACE" delete deploy -l app.kubernetes.io/name=tidb-operator +$KUBECTL_BIN -n "$NAMESPACE" delete pods -l app.kubernetes.io/name=tidb-operator + +echo "info: create namespace '$NAMESPACE' if absent" +if ! $KUBECTL_BIN get ns "$NAMESPACE" &>/dev/null; then + hack::create_namespace "$NAMESPACE" +fi + +echo "info: installing crds" +if ! $KUBECTL_BIN create -f manifests/crd.yaml &>/dev/null; then + $KUBECTL_BIN replace -f manifests/crd.yaml +fi + +echo "info: deploying tidb-operator" +helm_template_args=( + --namespace "$NAMESPACE" + --set-string operatorImage=$DOCKER_REGISTRY/pingcap/tidb-operator:${IMAGE_TAG} + --set-string tidbBackupManagerImage=$DOCKER_REGISTRY/pingcap/tidb-backup-manager:${IMAGE_TAG} + --set-string controllerManager.logLevel=4 + --set-string scheduler.logLevel=4 + --set imagePullPolicy=Always +) + +$HELM_BIN template tidb-operator-dev ./charts/tidb-operator/ ${helm_template_args[@]} | kubectl -n "$NAMESPACE" apply -f - + +deploys=( + tidb-controller-manager + # tidb-scheduler +) +for deploy in ${deploys[@]}; do + echo "info: waiting for $NAMESPACE/$deploy to be ready" + hack::wait_for_deploy "$NAMESPACE" "$deploy" +done diff --git a/hack/local-up-by-kind.sh b/hack/local-up-by-kind.sh new file mode 100644 index 00000000000..cc87fcac463 --- /dev/null +++ b/hack/local-up-by-kind.sh @@ -0,0 +1,192 @@ +#!/usr/bin/env bash + +# Copyright 2020 PingCAP, Inc. +# +# 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, +# See the License for the specific language governing permissions and +# limitations under the License. + +# +# This command runs tidb-operator in Kubernetes. +# + +set -o errexit +set -o nounset +set -o pipefail + +ROOT=$(unset CDPATH && cd $(dirname "${BASH_SOURCE[0]}")/.. && pwd) +cd $ROOT + +source "${ROOT}/hack/lib.sh" + +function usage() { + cat <<'EOF' +This commands run tidb-operator in Kubernetes. + +Usage: hack/local-up-operator.sh [-hd] + + -h show this message and exit + -i install dependencies only + +Environments: + + PROVIDER Kubernetes provider. Defaults: kind. + CLUSTER the name of e2e cluster. Defaults to kind for kind provider. + KUBECONFIG path to the kubeconfig file, defaults: ~/.kube/config + KUBECONTEXT context in kubeconfig file, defaults to current context + NAMESPACE Kubernetes namespace in which we run our tidb-operator. + DOCKER_REGISTRY image docker registry + IMAGE_TAG image tag + SKIP_IMAGE_BUILD skip build and push images + +EOF +} + +installOnly=false +while getopts "h?i" opt; do + case "$opt" in + h|\?) + usage + exit 0 + ;; + i) + installOnly=true + ;; + esac +done + +PROVIDER=${PROVIDER:-kind} +CLUSTER=${CLUSTER:-} +KUBECONFIG=${KUBECONFIG:-~/.kube/config} +KUBECONTEXT=${KUBECONTEXT:-} +NAMESPACE=${NAMESPACE:-pingcap} +DOCKER_REGISTRY=${DOCKER_REGISTRY:-localhost:5000} +IMAGE_TAG=${IMAGE_TAG:-latest} +SKIP_IMAGE_BUILD=${SKIP_IMAGE_BUILD:-} + +hack::ensure_kubectl +hack::ensure_kind +hack::ensure_helm + +if [[ "$installOnly" == "true" ]]; then + exit 0 +fi + +function hack::create_namespace() { + local ns="$1" + $KUBECTL_BIN create namespace $ns + for ((i=0; i < 30; i++)); do + local phase=$(kubectl get ns $ns -ojsonpath='{.status.phase}') + if [ "$phase" == "Active" ]; then + return 0 + fi + sleep 1 + done + return 1 +} + +function hack::wait_for_deploy() { + local ns="$1" + local name="$2" + local retries="${3:-300}" + echo "info: waiting for pods of deployment $ns/$name are ready (retries: $retries, interval: 1s)" + for ((i = 0; i < retries; i++)) { + read a b <<<$($KUBECTL_BIN --context $KUBECONTEXT -n $ns get deploy/$name -ojsonpath='{.spec.replicas} {.status.readyReplicas}{"\n"}') + if [[ "$a" -gt 0 && "$a" -eq "$b" ]]; then + echo "info: all pods of deployment $ns/$name are ready (desired: $a, ready: $b)" + return 0 + fi + echo "info: pods of deployment $ns/$name (desired: $a, ready: $b)" + sleep 1 + } + echo "info: timed out waiting for pods of deployment $ns/$name are ready" + return 1 +} + +function hack::cluster_exists() { + local c="$1" + for n in $($KIND_BIN get clusters); do + if [ "$n" == "$c" ]; then + return 0 + fi + done + return 1 +} + +echo "info: checking clusters" + +if [ "$PROVIDER" == "kind" ]; then + if [ -z "$CLUSTER" ]; then + CLUSTER=kind + fi + if ! hack::cluster_exists "$CLUSTER"; then + echo "error: kind cluster '$CLUSTER' not found, please create it or specify the right cluster name with CLUSTER environment" + exit 1 + fi +else + echo "erorr: only kind PROVIDER is supported" + exit 1 +fi + +if [ -z "$KUBECONTEXT" ]; then + KUBECONTEXT=$(kubectl config current-context) + echo "info: KUBECONTEXT is not set, current context $KUBECONTEXT is used" +fi + +if [ -z "$SKIP_IMAGE_BUILD" ]; then + echo "info: building docker images" + DOCKER_REGISTRY=$DOCKER_REGISTRY IMAGE_TAG=$IMAGE_TAG make docker +else + echo "info: skip building docker images" +fi + +echo "info: loading images into cluster" +images=( + $DOCKER_REGISTRY/pingcap/tidb-operator:${IMAGE_TAG} + $DOCKER_REGISTRY/pingcap/tidb-backup-manager:${IMAGE_TAG} +) +for n in ${images[@]}; do + echo "info: loading image $n" + $KIND_BIN load docker-image --name $CLUSTER $n +done + +echo "info: uninstall tidb-operator" +$KUBECTL_BIN -n "$NAMESPACE" delete deploy -l app.kubernetes.io/name=tidb-operator +$KUBECTL_BIN -n "$NAMESPACE" delete pods -l app.kubernetes.io/name=tidb-operator + +echo "info: create namespace '$NAMESPACE' if absent" +if ! $KUBECTL_BIN get ns "$NAMESPACE" &>/dev/null; then + hack::create_namespace "$NAMESPACE" +fi + +echo "info: installing crds" +if ! $KUBECTL_BIN create -f manifests/crd.yaml &>/dev/null; then + $KUBECTL_BIN replace -f manifests/crd.yaml +fi + +echo "info: deploying tidb-operator" +helm_template_args=( + --namespace "$NAMESPACE" + --set-string operatorImage=$DOCKER_REGISTRY/pingcap/tidb-operator:${IMAGE_TAG} + --set-string tidbBackupManagerImage=$DOCKER_REGISTRY/pingcap/tidb-backup-manager:${IMAGE_TAG} + --set-string controllerManager.logLevel=4 + --set-string scheduler.logLevel=4 +) + +$HELM_BIN template tidb-operator-dev ./charts/tidb-operator/ ${helm_template_args[@]} | kubectl -n "$NAMESPACE" apply -f - + +deploys=( + tidb-controller-manager + # tidb-scheduler +) +for deploy in ${deploys[@]}; do + echo "info: waiting for $NAMESPACE/$deploy to be ready" + hack::wait_for_deploy "$NAMESPACE" "$deploy" +done diff --git a/hack/local-up-operator.sh b/hack/local-up-operator.sh index cc87fcac463..d89806b563e 100755 --- a/hack/local-up-operator.sh +++ b/hack/local-up-operator.sh @@ -17,176 +17,46 @@ # This command runs tidb-operator in Kubernetes. # -set -o errexit -set -o nounset -set -o pipefail - -ROOT=$(unset CDPATH && cd $(dirname "${BASH_SOURCE[0]}")/.. && pwd) -cd $ROOT - -source "${ROOT}/hack/lib.sh" +# Default provider is kind +PROVIDER=${PROVIDER:-kind} +# Function to display usage information function usage() { cat <<'EOF' -This commands run tidb-operator in Kubernetes. +This script runs tidb-operator in Kubernetes using the appropriate provider. -Usage: hack/local-up-operator.sh [-hd] +Usage: local-up-operator.sh [-hd] [-p PROVIDER] - -h show this message and exit - -i install dependencies only + -h Show this message and exit + -i Install dependencies only Environments: PROVIDER Kubernetes provider. Defaults: kind. - CLUSTER the name of e2e cluster. Defaults to kind for kind provider. - KUBECONFIG path to the kubeconfig file, defaults: ~/.kube/config - KUBECONTEXT context in kubeconfig file, defaults to current context + CLUSTER The name of the e2e cluster. + KUBECONFIG Path to the kubeconfig file, defaults: ~/.kube/config + KUBECONTEXT Context in kubeconfig file, defaults to the current context NAMESPACE Kubernetes namespace in which we run our tidb-operator. - DOCKER_REGISTRY image docker registry - IMAGE_TAG image tag - SKIP_IMAGE_BUILD skip build and push images + DOCKER_REGISTRY Image docker registry + IMAGE_TAG Image tag + SKIP_IMAGE_BUILD Skip build and push images EOF } -installOnly=false -while getopts "h?i" opt; do - case "$opt" in - h|\?) - usage - exit 0 +# Determine the appropriate script based on the provider +case "$PROVIDER" in + kind) + echo "Running with kind provider..." + bash hack/local-up-by-kind.sh "$@" ;; - i) - installOnly=true + k3s) + echo "Running with k3s provider..." + bash hack/local-up-by-k3s.sh "$@" ;; - esac -done - -PROVIDER=${PROVIDER:-kind} -CLUSTER=${CLUSTER:-} -KUBECONFIG=${KUBECONFIG:-~/.kube/config} -KUBECONTEXT=${KUBECONTEXT:-} -NAMESPACE=${NAMESPACE:-pingcap} -DOCKER_REGISTRY=${DOCKER_REGISTRY:-localhost:5000} -IMAGE_TAG=${IMAGE_TAG:-latest} -SKIP_IMAGE_BUILD=${SKIP_IMAGE_BUILD:-} - -hack::ensure_kubectl -hack::ensure_kind -hack::ensure_helm - -if [[ "$installOnly" == "true" ]]; then - exit 0 -fi - -function hack::create_namespace() { - local ns="$1" - $KUBECTL_BIN create namespace $ns - for ((i=0; i < 30; i++)); do - local phase=$(kubectl get ns $ns -ojsonpath='{.status.phase}') - if [ "$phase" == "Active" ]; then - return 0 - fi - sleep 1 - done - return 1 -} - -function hack::wait_for_deploy() { - local ns="$1" - local name="$2" - local retries="${3:-300}" - echo "info: waiting for pods of deployment $ns/$name are ready (retries: $retries, interval: 1s)" - for ((i = 0; i < retries; i++)) { - read a b <<<$($KUBECTL_BIN --context $KUBECONTEXT -n $ns get deploy/$name -ojsonpath='{.spec.replicas} {.status.readyReplicas}{"\n"}') - if [[ "$a" -gt 0 && "$a" -eq "$b" ]]; then - echo "info: all pods of deployment $ns/$name are ready (desired: $a, ready: $b)" - return 0 - fi - echo "info: pods of deployment $ns/$name (desired: $a, ready: $b)" - sleep 1 - } - echo "info: timed out waiting for pods of deployment $ns/$name are ready" - return 1 -} - -function hack::cluster_exists() { - local c="$1" - for n in $($KIND_BIN get clusters); do - if [ "$n" == "$c" ]; then - return 0 - fi - done - return 1 -} - -echo "info: checking clusters" - -if [ "$PROVIDER" == "kind" ]; then - if [ -z "$CLUSTER" ]; then - CLUSTER=kind - fi - if ! hack::cluster_exists "$CLUSTER"; then - echo "error: kind cluster '$CLUSTER' not found, please create it or specify the right cluster name with CLUSTER environment" + *) + echo "Unsupported provider: $PROVIDER" + usage exit 1 - fi -else - echo "erorr: only kind PROVIDER is supported" - exit 1 -fi - -if [ -z "$KUBECONTEXT" ]; then - KUBECONTEXT=$(kubectl config current-context) - echo "info: KUBECONTEXT is not set, current context $KUBECONTEXT is used" -fi - -if [ -z "$SKIP_IMAGE_BUILD" ]; then - echo "info: building docker images" - DOCKER_REGISTRY=$DOCKER_REGISTRY IMAGE_TAG=$IMAGE_TAG make docker -else - echo "info: skip building docker images" -fi - -echo "info: loading images into cluster" -images=( - $DOCKER_REGISTRY/pingcap/tidb-operator:${IMAGE_TAG} - $DOCKER_REGISTRY/pingcap/tidb-backup-manager:${IMAGE_TAG} -) -for n in ${images[@]}; do - echo "info: loading image $n" - $KIND_BIN load docker-image --name $CLUSTER $n -done - -echo "info: uninstall tidb-operator" -$KUBECTL_BIN -n "$NAMESPACE" delete deploy -l app.kubernetes.io/name=tidb-operator -$KUBECTL_BIN -n "$NAMESPACE" delete pods -l app.kubernetes.io/name=tidb-operator - -echo "info: create namespace '$NAMESPACE' if absent" -if ! $KUBECTL_BIN get ns "$NAMESPACE" &>/dev/null; then - hack::create_namespace "$NAMESPACE" -fi - -echo "info: installing crds" -if ! $KUBECTL_BIN create -f manifests/crd.yaml &>/dev/null; then - $KUBECTL_BIN replace -f manifests/crd.yaml -fi - -echo "info: deploying tidb-operator" -helm_template_args=( - --namespace "$NAMESPACE" - --set-string operatorImage=$DOCKER_REGISTRY/pingcap/tidb-operator:${IMAGE_TAG} - --set-string tidbBackupManagerImage=$DOCKER_REGISTRY/pingcap/tidb-backup-manager:${IMAGE_TAG} - --set-string controllerManager.logLevel=4 - --set-string scheduler.logLevel=4 -) - -$HELM_BIN template tidb-operator-dev ./charts/tidb-operator/ ${helm_template_args[@]} | kubectl -n "$NAMESPACE" apply -f - - -deploys=( - tidb-controller-manager - # tidb-scheduler -) -for deploy in ${deploys[@]}; do - echo "info: waiting for $NAMESPACE/$deploy to be ready" - hack::wait_for_deploy "$NAMESPACE" "$deploy" -done + ;; +esac