feat(workflow): add all-in-one install scripts

Author: duanhongyi

.drone/drone.yml

@@ -8,6 +8,7 @@ steps:
   privileged: true
   commands:
   - make docker-build docker-build-docs 
+  - cp _scripts/* _build/html
   - cd _build/html && echo "www.drycc.cc" > CNAME && git init
   environment:
     SSH_DEPLOY_KEY:

_scripts/install.sh

@@ -0,0 +1,83 @@
+#!/usr/bin/env bash
+set -eo pipefail
+shopt -s expand_aliases
+
+if [[ -z "${PLATFORM_DOMAIN}" ]] ; then
+  echo -e "\\033[31m---> Please set the PLATFORM_DOMAIN variable.\\033[0m"
+  echo -e "\\033[31m---> For example:\\033[0m"
+  echo -e "\\033[31m---> export PLATFORM_DOMAIN=drycc.cc\\033[0m"
+  echo -e "\\033[31m---> And confirm that wildcard domain name resolution has been set.\\033[0m"
+  echo -e "\\033[31m---> For example, the current server IP is 8.8.8.8\\033[0m"
+  echo -e "\\033[31m---> Please point *.drycc.cc to 8.8.8.8\\033[0m"
+  exit 1
+fi	
+
+function clean_before_exit {
+    # delay before exiting, so stdout/stderr flushes through the logging system
+    rm -rf helm-broker
+    sleep 3
+}
+trap clean_before_exit EXIT
+
+if [[ "${INSTALL_K3S_MIRROR}"=="cn" ]] ; then
+  k3s_install_url="http://rancher-mirror.cnrancher.com/k3s/k3s-install.sh"
+else
+  k3s_install_url="https://get.k3s.io"
+fi
+if [[ -z "${K3S_URL}" ]] ; then
+  INSTALL_K3S_EXEC="server --no-flannel --cluster-cidr=10.233.0.0/16"
+else
+  INSTALL_K3S_EXEC="agent --no-flannel"
+fi
+
+export INSTALL_K3S_EXEC='--no-flannel'
+
+alias install-k3s="curl -sfL "${k3s_install_url}" | sh - $@"
+
+install-k3s
+
+curl -sfL https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 | bash -
+
+helm repo add cilium https://helm.cilium.io/
+helm repo add longhorn https://charts.longhorn.io
+helm repo add jetstack https://charts.jetstack.io
+helm repo add svc-cat https://kubernetes-sigs.github.io/service-catalog
+helm repo add drycc https://charts.drycc.cc/${CHANNEL:-stable}
+helm repo update
+git clone --dept 1 https://github.com/kyma-project/helm-broker
+
+
+helm install cilium --set operator.replicas=1 cilium/cilium --namespace kube-system
+helm install longhorn --create-namespace --set persistence.defaultClassReplicaCount=1 longhorn/longhorn --namespace longhorn-system
+helm install cert-manager jetstack/cert-manager --namespace cert-manager --create-namespace --set installCRDs=true
+helm install catalog svc-cat/catalog --set asyncBindingOperationsEnabled=true --namespace catalog --create-namespace
+helm install helm-broker --set global.helm_broker.dir=/ --set global.helm_controller.dir=/ helm-broker/charts/helm-broker/  --namespace helm-broker --create-namespace
+
+
+echo -e "\\033[32m---> Waiting cert-manager...\\033[0m"
+while [ $(kubectl get pods -n cert-manager|grep Running|wc -l) -le 2 ]
+do
+    kubectl get pods -n cert-manager
+    sleep 10
+done
+
+helm install drycc drycc/workflow \
+  --set builder.service.type=LoadBalancer \
+  --set global.platform_domain="${PLATFORM_DOMAIN}" \
+  --set global.ingress_class=traefik \
+  --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=50Gi \
+  --set minio.persistence.storageClass="longhorn" \
+  --set rabbitmq.persistence.enabled=true \
+  --set rabbitmq.persistence.size=5Gi \
+  --set rabbitmq.persistence.storageClass="longhorn" \
+  --set influxdb.persistence.enabled=true \
+  --set influxdb.persistence.size=20Gi \
+  --set influxdb.persistence.storageClass="longhorn" \
+  --set monitor.grafana.persistence.enabled=true \
+  --set monitor.grafana.persistence.size=20Gi \
+  --set monitor.grafana.persistence.storageClass="longhorn" \
+  --namespace drycc \
+  --create-namespace

_scripts/uninstall.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -eo pipefail
+shopt -s expand_aliases
+
+/usr/local/bin/k3s-killall.sh
+/usr/local/bin/k3s-uninstall.sh

mkdocs.yml

@@ -8,29 +8,14 @@ nav:
   - Home: index.md
   - Quick Start:
     - Overview: quickstart/index.md
+    - Install Workflow: quickstart/install-workflow.md
     - Install CLI Tools: quickstart/install-cli-tools.md
-    - AWS:
-      - Boot: quickstart/provider/aws/boot.md
-      - DNS: quickstart/provider/aws/dns.md
-      - Install Workflow: quickstart/provider/aws/install-aws.md
-    - Azure:
-      - Boot: quickstart/provider/azure-acs/boot.md
-      - DNS: quickstart/provider/azure-acs/dns.md
-      - Install Workflow: quickstart/provider/azure-acs/install-azure-acs.md
-    - GKE:
-      - Boot: quickstart/provider/gke/boot.md
-      - DNS: quickstart/provider/gke/dns.md
-      - Install Workflow: quickstart/provider/gke/install-gke.md
-    - Minikube:
-      - Boot: quickstart/provider/minikube/boot.md
-      - DNS: quickstart/provider/minikube/dns.md
-      - Install Workflow: quickstart/provider/minikube/install-minikube.md
     - Deploy Your First App: quickstart/deploy-an-app.md
   - Understanding Workflow:
     - Concepts: understanding-workflow/concepts.md
     - Architecture: understanding-workflow/architecture.md
     - Components: understanding-workflow/components.md
-  - Installing Workflow:
+  - Installing To Kubenetes:
     - System Requirements: installing-workflow/system-requirements.md
     - Installing Ingress: installing-workflow/ingress.md
     - Installing Workflow: installing-workflow/index.md

src/quickstart/index.md

@@ -8,24 +8,13 @@ Get started with Drycc Workflow in three easy steps.
 
 This guide will help you set up a cluster suitable for evaluation, development and testing. When you are ready for staging and production, view our [production checklist](../managing-workflow/production-deployments.md).
 
-## Step 1: Install CLI tools
+## Step 1: Install Workflow
 
-For the quickstart we will [install both Helm and Drycc Workflow CLI](install-cli-tools.md).
+For the quickstart we will [install Drycc Workflow](install-workflow.md).
 
-## Step 2: Boot Kubernetes and Install Drycc Workflow
+## Step 2: Install CLI tools
 
-There are many ways to boot and run Kubernetes. You may choose to get up and running in cloud environments or locally on
-your laptop.
-
-Cloud-based options:
-
-* [Google Container Engine](provider/gke/boot.md): provides a managed Kubernetes environment, available with a few clicks.
-* [Amazon Web Services](provider/aws/boot.md): uses Kubernetes upstream `kube-up.sh` to boot a cluster on AWS EC2.
-* [Azure Container Service](provider/azure-acs/boot.md): uses Azure Container Service to provision Kubernetes and install Workflow.
-
-If you would like to test on your local machine follow, our guide for [Minikube](provider/minikube/boot.md).
-
-If you have already created a Kubernetes cluster, check out the [system requirements](../installing-workflow/system-requirements.md) and then proceed to [install Drycc Workflow on your own Kubernetes cluster](../installing-workflow/index.md).
+For the quickstart we will [install Drycc Workflow CLI](install-cli-tools.md).
 
 ## Step 3: Deploy your first app
 

src/quickstart/install-cli-tools.md

@@ -25,26 +25,3 @@ Check your work by running `drycc version`:
 
 !!! note
     Note that version numbers may vary as new releases become available
-
-## Helm Installation
-
-We will install Drycc Workflow using Helm which is a tool for installing and managing software in a
-Kubernetes cluster.
-
-Install the latest `helm` cli for Linux or Mac OS X by following the
-[installation instructions][helm-install].
-
-## Step 2: Boot a Kubernetes Cluster and Install Drycc Workflow
-
-There are many ways to boot and run Kubernetes. You may choose to get up and running in cloud environments or locally on your laptop.
-
-Cloud-based options:
-
-* [Google Container Engine](provider/gke/boot.md): provides a managed Kubernetes environment, available with a few clicks.
-* [Amazon Web Services](provider/aws/boot.md): uses Kubernetes upstream [kops](https://github.com/kubernetes/kops) to boot a cluster on AWS EC2.
-* [Azure Container Service](provider/azure-acs/boot.md): provides a managed Kubernetes environment.
-
-If you would like to test on your local machine follow our guide for [Minikube](provider/minikube/boot.md).
-
-
-[helm-install]: https://github.com/kubernetes/helm#install

src/quickstart/install-workflow.md

@@ -0,0 +1,135 @@
+# Install Workflow
+
+If you have a pure host, it can be a cloud server, bare metal server, virtual machine, or even your laptop. Then this chapter is very suitable for you.
+
+## Operating Systems
+
+Drycc is expected to work on most modern Linux systems. Some OSS have specific requirements:
+
+* (Red Hat/CentOS) Enterprise Linux, they usually use RPM package management.
+* Ubuntu (Desktop/Server/Cloud) Linux, a very popular distribution.
+* Debian GNU Linux, a very pure distribution of opensource software.
+
+If you want to add more Linux distribution support, please submit a issue on github or submit PR directly.
+
+## System Software
+
+Some basic software needs to be installed before installing drycc workflow.
+
+### Installing open-iscsi
+
+The command used to install open-iscsi differs depending on the Linux distribution.
+We recommend using Ubuntu as the guest OS image since it contains open-iscsi already.
+You may need to edit the cluster security group to allow SSH access.
+For SUSE and openSUSE, use this command:
+
+```
+$ zypper install open-iscsi
+```
+
+For Debian and Ubuntu, use this command:
+
+```
+$ apt-get install open-iscsi
+```
+
+For RHEL, CentOS, and EKS with EKS Kubernetes Worker AMI with AmazonLinux2 image, use this command:
+
+```
+$ yum install iscsi-initiator-utils
+```
+
+### Installing NFSv4 client
+
+The command used to install a NFSv4 client differs depending on the Linux distribution.
+
+For Debian and Ubuntu, use this command:
+
+```
+$ apt-get install nfs-common
+```
+
+For RHEL, CentOS, and EKS with EKS Kubernetes Worker AMI with AmazonLinux2 image, use this command:
+
+```
+$ yum install nfs-utils
+```
+
+### Installing curl and git
+
+For Debian and Ubuntu, use this command:
+
+```
+$ apt-get install curl git
+```
+
+For RHEL, CentOS, and EKS with EKS Kubernetes Worker AMI with AmazonLinux2 image, use this command:
+
+```
+$ yum install curl git
+```
+
+## Hardware
+
+Hardware requirements scale based on the size of your deployments. Minimum recommendations are outlined here.
+
+* RAM: 1G Minimum (we recommend at least 2GB)
+* CPU: 1 Minimum
+
+This configuration only contains the minimum requirements that can meet the operation.
+
+## Disk
+
+Drycc performance depends on the performance of the database. To ensure optimal speed, we recommend using an SSD when possible. Disk performance will vary on ARM devices utilizing an SD card or eMMC.
+
+## Domain Name
+
+Drycc needs a root domain name under your full control and points this domain name to the server to be installed.
+Suppose there is a wildcard domain pointing to the current server to install drycc, which is the name `*.dryccdoman.com`.
+We need to set the `PLATFORM_DOMAIN` environment variables before installation.
+
+```
+$ export PLATFORM_DOMAIN=dryccdoman.co
+```
+
+Of course, if it is a test environment, we can also use `nip.io`, an IP to domain name service.
+For example, your host IP is `59.46.3.190`, we will get the following domain name `59.46.3.190.nip.io`
+
+```
+$ export PLATFORM_DOMAIN=59.46.3.190.nip.io
+```
+
+## Install
+
+You can use the installation script available at https://www.drycc.cc/install.sh to install drycc as a service on systemd and openrc based systems.
+
+```
+$ curl -sfL https://www.drycc.cc/install.sh | bash -
+```
+
+!!! important
+    Users in Chinese mainland can use the following methods to speed up installation:
+
+    ```
+    $ curl -sfL https://www.drycc.cc/install.sh | INSTALL_K3S_MIRROR=cn bash -
+    ```
+
+### Install Options
+
+When using this method to install drycc, the following environment variables can be used to configure the installation:
+
+ENVIRONMENT VARIABLE            | DESCRIPTION
+--------------------------------|------------------------------------------------------------------------------------------------
+PLATFORM_DOMAIN                 | Required item, specify drycc's domain name
+CHANNEL                         | By default, drycc of the `stable` channel will be installed. You can also specify `testing`
+INSTALL_K3S_MIRROR              | Specify the accelerated mirror location. Currently, only `cn` is supported
+
+Since the installation script will install k3s, other environment variables can refer to k3s installation [environment variables](https://rancher.com/docs/k3s/latest/en/installation/install-options/).
+    
+## Uninstall
+
+If you installed drycc using an installation script, you can uninstall the entire drycc using this script.
+
+```
+$ curl -sfL https://www.drycc.cc/uninstall.sh | bash -
+```