chore(workflow): optimize installation steps

duanhongyi · duanhongyi · commit 9e72e7e1136e · 2021-09-09T15:03:32.000+08:00
diff --git a/_scripts/install-cli.sh b/_scripts/install-cli.sh
@@ -2,7 +2,7 @@
 set -eo pipefail
 shopt -s expand_aliases
 
-checkPlatformArch() {
+check_platform_arch() {
   local supported="darwin-amd64 darwin-arm64 linux-amd64 linux-386 linux-arm linux-arm64 windows-386 windows-amd64"
 
   if ! echo "${supported}" | tr ' ' '\n' | grep -q "${PLATFORM}-${ARCH}"; then
@@ -24,7 +24,7 @@ else
 fi
 
 # initArch discovers the architecture for this system.
-initArch() {
+init_arch() {
   ARCH=$(uname -m)
   case $ARCH in
     armv5*) ARCH="armv5";;
@@ -38,13 +38,13 @@ initArch() {
   esac
 }
 
-initLatestVersion() {
+init_latest_version() {
   VERSION=$(curl -Ls $DRYCC_BIN_URL_BASE|grep /drycc/workflow-cli/releases/tag/ | grep -v no-underline | head -n 1 | cut -d '"' -f 2| awk '{n=split($NF,a,"/");print a[n]}' | awk 'a !~ $0{print}; {a=$0}')
 }
 
-initArch
-initLatestVersion
-checkPlatformArch
+init_arch
+init_latest_version
+check_platform_arch
 
 DRYCC_CLI="drycc-${VERSION}-${PLATFORM}-${ARCH}"
 DRYCC_CLI_PATH="${DRYCC_CLI}"
diff --git a/_scripts/install.sh b/_scripts/install.sh
@@ -23,7 +23,7 @@ if [[ -z "${DRYCC_ADMIN_USERNAME}" || -z "${DRYCC_ADMIN_PASSWORD}" ]] ; then
 fi
 
 # initArch discovers the architecture for this system.
-initArch() {
+init_arch() {
   ARCH=$(uname -m)
   case $ARCH in
     armv5*) ARCH="armv5";;
@@ -42,9 +42,9 @@ function clean_before_exit {
     sleep 3
 }
 trap clean_before_exit EXIT
-initArch
+init_arch
 
-function get_helm {
+function install_helm {
   tar_name="helm-canary-linux-${ARCH}.tar.gz"
   curl -fsSL -o "${tar_name}" "https://get.helm.sh/${tar_name}"
   tar -zxvf "${tar_name}"
@@ -89,84 +89,97 @@ else
   INSTALL_K3S_EXEC="agent --flannel-backend=none"
 fi
 
-alias install-k3s="curl -sfL "${k3s_install_url}" |sh - $@"
-export INSTALL_K3S_EXEC
-install-k3s
-mount bpffs -t bpf /sys/fs/bpf
-
-get_helm
+function install_k3s {
+  export INSTALL_K3S_EXEC
+  curl -sfL "${k3s_install_url}" |sh -
+}
 
-helm repo add drycc https://charts.drycc.cc/${CHANNEL:-stable}
-helm repo update
+function install_components {
+  mount bpffs -t bpf /sys/fs/bpf
+  install_helm
+  helm repo add drycc https://charts.drycc.cc/${CHANNEL:-stable}
+  helm repo update
 
-echo -e "\\033[32m---> Waiting for helm to install components...\\033[0m"
+  echo -e "\\033[32m---> Waiting for helm to install components...\\033[0m"
 
-helm install cilium drycc/cilium --set operator.replicas=1 --namespace kube-system --wait
-helm install metallb drycc/metallb --namespace kube-system --wait -f - <<EOF
+  helm install cilium drycc/cilium --set operator.replicas=1 --namespace kube-system --wait
+  helm install metallb drycc/metallb --namespace kube-system --wait -f - <<EOF
 configInline:
   address-pools:
    - name: default
      protocol: layer2
      addresses:
      - ${METALLB_ADDRESS_POOLS:-172.16.0.0/12}
 EOF
-helm install ingress-nginx drycc/ingress-nginx --namespace kube-system --wait
-helm install longhorn drycc/longhorn --create-namespace --set persistence.defaultClass=false --set persistence.defaultClassReplicaCount=1 --namespace longhorn-system --wait
-helm install cert-manager drycc/cert-manager --namespace cert-manager --create-namespace --set installCRDs=true --wait
-helm install catalog drycc/catalog --set asyncBindingOperationsEnabled=true --namespace catalog --create-namespace --wait
-
-echo -e "\\033[32m---> Start installing workflow...\\033[0m"
-
-RABBITMQ_USERNAME=$(cat /proc/sys/kernel/random/uuid)
-RABBITMQ_PASSWORD=$(cat /proc/sys/kernel/random/uuid)
-
-helm install drycc drycc/workflow \
-  --set builder.service.type=LoadBalancer \
-  --set global.cluster_domain="cluster.local" \
-  --set global.platform_domain="${PLATFORM_DOMAIN}" \
-  --set global.ingress_class=nginx \
-  --set fluentd.daemon_environment.CONTAINER_TAIL_PARSER_TYPE="/^(?<time>.+) (?<stream>stdout|stderr)( (?<tags>.))? (?<log>.*)$/" \
-  --set controller.app_storage_class=longhorn \
-  --set minio.persistence.enabled=true \
-  --set minio.persistence.size=${MINIO_PERSISTENCE_SIZE:-5Gi} \
-  --set minio.persistence.storageClass="longhorn" \
-  --set rabbitmq.username="${RABBITMQ_USERNAME}" \
-  --set rabbitmq.password="${RABBITMQ_PASSWORD}" \
-  --set rabbitmq.persistence.enabled=true \
-  --set rabbitmq.persistence.size=${RABBITMQ_PERSISTENCE_SIZE:-5Gi} \
-  --set rabbitmq.persistence.storageClass="longhorn" \
-  --set influxdb.persistence.enabled=true \
-  --set influxdb.persistence.size=${INFLUXDB_PERSISTENCE_SIZE:-5Gi} \
-  --set influxdb.persistence.storageClass="longhorn" \
-  --set monitor.grafana.persistence.enabled=true \
-  --set monitor.grafana.persistence.size=${MONITOR_PERSISTENCE_SIZE:-5Gi} \
-  --set monitor.grafana.persistence.storageClass="longhorn" \
-  --set passport.admin_username=${DRYCC_ADMIN_USERNAME} \
-  --set passport.admin_password=${DRYCC_ADMIN_PASSWORD} \
-  --namespace drycc \
-  --create-namespace --wait --timeout 30m0s
-
-HELMBROKER_USERNAME=$(cat /proc/sys/kernel/random/uuid)
-HELMBROKER_PASSWORD=$(cat /proc/sys/kernel/random/uuid)
-
-echo -e "\\033[32m---> Start installing helmbroker...\\033[0m"
-
-helm install helmbroker drycc/helmbroker \
-  --set ingress_class="nginx" \
-  --set platform_domain="cluster.local" \
-  --set persistence.storageClass="longhorn" \
-  --set persistence.size=${HELMBROKER_PERSISTENCE_SIZE:-5Gi} \
-  --set platform_domain=${PLATFORM_DOMAIN} \
-  --set username=${HELMBROKER_USERNAME} \
-  --set password=${HELMBROKER_PASSWORD} \
-  --set environment.HELMBROKER_CELERY_BROKER="amqp://${RABBITMQ_USERNAME}:${RABBITMQ_PASSWORD}@drycc-rabbitmq-0.drycc-rabbitmq.drycc.svc.cluster.local:5672/drycc" \
-  --namespace drycc --create-namespace --wait -f - <<EOF
+  helm install ingress-nginx drycc/ingress-nginx --namespace kube-system --wait
+  helm install cert-manager drycc/cert-manager --namespace cert-manager --create-namespace --set installCRDs=true --wait
+  helm install catalog drycc/catalog --set asyncBindingOperationsEnabled=true --namespace catalog --create-namespace --wait
+}
+
+function install_longhorn {
+  helm install longhorn drycc/longhorn --create-namespace \
+    --set persistence.defaultClass=false \
+    --set persistence.defaultClassReplicaCount=1 \
+    --namespace longhorn-system --wait
+}
+
+function install_drycc {
+  echo -e "\\033[32m---> Start installing workflow...\\033[0m"
+
+  RABBITMQ_USERNAME=$(cat /proc/sys/kernel/random/uuid)
+  RABBITMQ_PASSWORD=$(cat /proc/sys/kernel/random/uuid)
+
+  helm install drycc drycc/workflow \
+    --set builder.service.type=LoadBalancer \
+    --set global.cluster_domain="cluster.local" \
+    --set global.platform_domain="${PLATFORM_DOMAIN}" \
+    --set global.ingress_class=nginx \
+    --set fluentd.daemon_environment.CONTAINER_TAIL_PARSER_TYPE="/^(?<time>.+) (?<stream>stdout|stderr)( (?<tags>.))? (?<log>.*)$/" \
+    --set controller.app_storage_class=longhorn \
+    --set minio.persistence.enabled=true \
+    --set minio.persistence.size=${MINIO_PERSISTENCE_SIZE:-5Gi} \
+    --set minio.persistence.storageClass="longhorn" \
+    --set rabbitmq.username="${RABBITMQ_USERNAME}" \
+    --set rabbitmq.password="${RABBITMQ_PASSWORD}" \
+    --set rabbitmq.persistence.enabled=true \
+    --set rabbitmq.persistence.size=${RABBITMQ_PERSISTENCE_SIZE:-5Gi} \
+    --set rabbitmq.persistence.storageClass="longhorn" \
+    --set influxdb.persistence.enabled=true \
+    --set influxdb.persistence.size=${INFLUXDB_PERSISTENCE_SIZE:-5Gi} \
+    --set influxdb.persistence.storageClass="longhorn" \
+    --set monitor.grafana.persistence.enabled=true \
+    --set monitor.grafana.persistence.size=${MONITOR_PERSISTENCE_SIZE:-5Gi} \
+    --set monitor.grafana.persistence.storageClass="longhorn" \
+    --set passport.admin_username=${DRYCC_ADMIN_USERNAME} \
+    --set passport.admin_password=${DRYCC_ADMIN_PASSWORD} \
+    --namespace drycc \
+    --create-namespace --wait --timeout 30m0s
+  echo -e "\\033[32m---> Rabbitmq username: $RABBITMQ_USERNAME\\033[0m"
+  echo -e "\\033[32m---> Rabbitmq password: $RABBITMQ_PASSWORD\\033[0m"
+}
+
+function install_helmbroker {
+  HELMBROKER_USERNAME=$(cat /proc/sys/kernel/random/uuid)
+  HELMBROKER_PASSWORD=$(cat /proc/sys/kernel/random/uuid)
+
+  echo -e "\\033[32m---> Start installing helmbroker...\\033[0m"
+
+  helm install helmbroker drycc/helmbroker \
+    --set ingress_class="nginx" \
+    --set platform_domain="cluster.local" \
+    --set persistence.storageClass="longhorn" \
+    --set persistence.size=${HELMBROKER_PERSISTENCE_SIZE:-5Gi} \
+    --set platform_domain=${PLATFORM_DOMAIN} \
+    --set username=${HELMBROKER_USERNAME} \
+    --set password=${HELMBROKER_PASSWORD} \
+    --set environment.HELMBROKER_CELERY_BROKER="amqp://${RABBITMQ_USERNAME}:${RABBITMQ_PASSWORD}@drycc-rabbitmq-0.drycc-rabbitmq.drycc.svc.cluster.local:5672/drycc" \
+    --namespace drycc --create-namespace --wait -f - <<EOF
 repositories:
 - name: drycc-helm-broker
   url: ${addons_url}
 EOF
 
-kubectl apply -f - <<EOF
+  kubectl apply -f - <<EOF
 apiVersion: servicecatalog.k8s.io/v1beta1
 kind: ClusterServiceBroker
 metadata:
@@ -183,11 +196,16 @@ spec:
   url: https://${HELMBROKER_USERNAME}:${HELMBROKER_PASSWORD}@drycc-helmbroker.${PLATFORM_DOMAIN}
 EOF
 
-BUILDER_IP=$(kubectl get svc drycc-builder -n drycc -o="jsonpath={.status.loadBalancer.ingress[0].ip}")
-INGRESS_IP=$(kubectl get svc ingress-nginx-controller -n kube-system -o="jsonpath={.status.loadBalancer.ingress[0].ip}")
+  echo -e "\\033[32m---> Helmbroker username: $HELMBROKER_USERNAME\\033[0m"
+  echo -e "\\033[32m---> Helmbroker password: $HELMBROKER_PASSWORD\\033[0m"
+}
+
+function config_haproxy {
+  BUILDER_IP=$(kubectl get svc drycc-builder -n drycc -o="jsonpath={.status.loadBalancer.ingress[0].ip}")
+  INGRESS_IP=$(kubectl get svc ingress-nginx-controller -n kube-system -o="jsonpath={.status.loadBalancer.ingress[0].ip}")
 
-if [[ "${USE_HAPROXY:-true}" == "true" ]] ; then
-  cat << EOF > "/etc/haproxy/haproxy.cfg"
+  if [[ "${USE_HAPROXY:-true}" == "true" ]] ; then
+    cat << EOF > "/etc/haproxy/haproxy.cfg"
 global
    log /dev/log    local0
    log /dev/log    local1 notice
@@ -222,15 +240,40 @@ listen builder
    timeout server  30000
    server builder ${BUILDER_IP}:2222 check
 EOF
-fi
+  fi
 
-mkdir -p /run/haproxy
-systemctl enable haproxy
-systemctl restart haproxy
+  mkdir -p /run/haproxy
+  systemctl enable haproxy
+  systemctl restart haproxy
+}
 
-echo -e "\\033[32m---> Please save the following information for future use.\\033[0m"
-echo -e "\\033[32m---> Rabbitmq username: $RABBITMQ_USERNAME\\033[0m"
-echo -e "\\033[32m---> Rabbitmq password: $RABBITMQ_PASSWORD\\033[0m"
-echo -e "\\033[32m---> Helmbroker username: $HELMBROKER_USERNAME\\033[0m"
-echo -e "\\033[32m---> Helmbroker password: $HELMBROKER_PASSWORD\\033[0m"
-echo -e "\\033[32m---> Installation complete, enjoy life...\\033[0m"
+# --- add quotes to command arguments ---
+quote() {
+    for arg in "$@"; do
+        printf '%s\n' "$arg" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/'/"
+    done
+}
+
+# --- escape most punctuation characters, except quotes, forward slash, and space ---
+escape() {
+    printf '%s' "$@" | sed -e 's/\([][!#$%&()*;<=>?\_`{|}]\)/\\\1/g;'
+}
+
+# --- re-evaluate args to include env command ---
+eval set -- $(escape "${INSTALL_DRYCC_EXEC}") $(quote "$@")
+
+if [[ -z "$@" ]] ; then
+  install_k3s
+  install_components
+  install_longhorn
+  install_drycc
+  install_helmbroker
+  config_haproxy
+  echo -e "\\033[32m---> Installation complete, enjoy life...\\033[0m"
+else
+  for command in "$@"
+  do
+      $command
+      echo -e "\\033[32m---> Installation $command complete, enjoy life...\\033[0m"
+  done
+fi
diff --git a/src/installing-workflow/index.md b/src/installing-workflow/index.md
@@ -139,4 +139,29 @@ For more installation parameters, please check the [values.yaml](https://github.
 After installing Workflow, [register a user and deploy an application](../quickstart/deploy-an-app.md).
 
 [Kubernetes v1.16.15+]: system-requirements.md#kubernetes-versions
-[helm]: https://github.com/kubernetes/helm/blob/master/docs/install.md
+
+## Configure DNS
+
+User must to set up a hostname, and assumes the `drycc.$host` convention.
+
+We need to point the `drycc.$host` record to the public IP address of your builder. You can get the public IP using the following command. A wildcard entry is necessary here as apps will use the same rule after they are deployed.
+
+```
+$ kubectl get svc drycc-builder --namespace drycc
+NAME              CLUSTER-IP   EXTERNAL-IP      PORT(S)                      AGE
+drycc-builder     10.0.25.3    138.91.243.152   2222:31625/TCP               33m
+```
+
+
+If we were using `drycc.cc` as a hostname, we would need to create the following A DNS records.
+
+| Name                         | Type          | Value          |
+| ---------------------------- |:-------------:| --------------:|
+| drycc-builder.drycc.cc       | A             | 138.91.243.152 |
+
+Once all of the pods are in the `READY` state, and `drycc.$host` resolves to the external IP found above, Workflow is up and running!
+
+After installing Workflow, [register a user and deploy an application](../quickstart/deploy-an-app.md).
+
+If your k8s does not provide public network loadblance, you need to install TCP proxy services such as haproxy on machines that can 
+access both internal and external networks, and then expose `80` and `443`.
diff --git a/src/installing-workflow/ingress.md b/src/installing-workflow/ingress.md
@@ -70,7 +70,7 @@ $ helm install stable/traefik --name ingress --namespace kube-system --set ssl.e
 
 ## Configure DNS
 
-User must to set up a hostname, and assumes the `drycc.$host` convention.
+User must to set up a hostname, and assumes the `*.$host` convention.
 
 We need to point the `*.$host` record to the public IP address of your ingress controller. You can get the public IP using the following command. A wildcard entry is necessary here as apps will use the same rule after they are deployed.
 
@@ -80,35 +80,16 @@ NAME              CLUSTER-IP   EXTERNAL-IP      PORT(S)                      AGE
 ingress-traefik   10.0.25.3    138.91.243.152   80:31625/TCP,443:30871/TCP   33m
 ```
 
-Additionally, we need to point the `drycc-builder.$host` record to the public IP address of the [Builder][].
-
-```
-$ kubectl get svc drycc-builder --namespace drycc
-NAME           CLUSTER-IP     EXTERNAL-IP     PORT(S)          AGE
-drycc-builder   10.0.165.140   40.86.182.187   2222:32488/TCP   33m
-```
-
-If ingress-nginx is used, ports can be exposed in the following ways.
-
-```
-kind: ConfigMap
-apiVersion: v1
-metadata:
-  name: tcp-services
-  namespace: ingress-nginx
-data:
-  2222: "drycc/drycc-builder:2222"
-```
 
 If we were using `drycc.cc` as a hostname, we would need to create the following A DNS records.
 
 | Name                         | Type          | Value          |
 | ---------------------------- |:-------------:| --------------:|
 | *.drycc.cc                   | A             | 138.91.243.152 |
-| drycc-builder.drycc.cc        | A             | 40.86.182.187  |
 
-Once all of the pods are in the `READY` state, and `drycc.$host` resolves to the external IP found above, Workflow is up and running!
+Once all of the pods are in the `READY` state, and `*.$host` resolves to the external IP found above, the preparation of ingress has been completed!
 
 After installing Workflow, [register a user and deploy an application](../quickstart/deploy-an-app.md).
 
-[builder]: ../understanding-workflow/components.md#builder
+If your k8s does not provide public network loadblance, you need to install TCP proxy services such as haproxy on machines that can 
+access both internal and external networks, and then expose `80` and `443`.
diff --git a/src/installing-workflow/system-requirements.md b/src/installing-workflow/system-requirements.md
@@ -29,7 +29,7 @@ Workflow supports Amazon Simple Storage Service (S3), Google Cloud Storage (GCS)
 Storage. See [configuring object storage](configuring-object-storage) for setup instructions.
 
 In addition, workflow needs to use RWX block storage services, such as cloud native [longhorn](https://longhorn.io/), 
-[openebs](https://openebs.io/), or external (glusterfs)[https://www.gluster.org/] or [ceph](https://ceph.io/).
+[openebs](https://openebs.io/), or external [glusterfs](https://www.gluster.org/) or [ceph](https://ceph.io/).
 
 ## Resource Requirements
 
