Install Workflow
6 minute read
If you have a bare metal host, which 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 operating systems have specific requirements:
- (Red Hat/CentOS) Enterprise Linux, which usually use RPM package management
- Ubuntu (Desktop/Server/Cloud) Linux, a very popular distribution
- Debian GNU Linux, a very pure distribution of open source software
If you want to add support for more Linux distributions, please submit an issue on GitHub or submit a PR directly.
System Software
Some basic software needs to be installed before installing Drycc Workflow.
OS Configuration
Kubernetes requires a large number of ports. If you are not sure what they are, please disable the local firewall or open these ports. At the same time, because Kubernetes needs system time synchronization, you need to ensure that the system time is correct.
Installing NFSv4 Client
The command used to install an 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
For Debian and Ubuntu, use this command:
$ apt-get install curl
For RHEL, CentOS, and EKS with EKS Kubernetes Worker AMI with AmazonLinux2 image, use this command:
$ yum install curl
Hardware
Hardware requirements scale based on the size of your deployments. Minimum recommendations are outlined here.
- RAM: 1GB 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.com
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
Before installation, please make sure whether your installation environment is on the public network. If it is an intranet environment and there is no public IP, you need to disable the automatic certificate.
$ export CERT_MANAGER_ENABLED=false
Then 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 -
To install the beta version, please use the following script for installation.
$ export CHANNEL=testing
$ curl -sfL https://drycc-mirrors.drycc.cc/drycc/workflow/raw/refs/heads/main/install.sh | bash -
Note
If you are in China, you need to use mirror acceleration:
$ curl -sfL https://www.drycc.cc/install.sh | INSTALL_DRYCC_MIRROR=cn bash -
Install Node
A node can be a simple agent or a server; a server has the function of an agent. Multiple servers provide high availability, but the number of servers should not exceed 7 at most. There is no limit to the number of agents.
- First, check the cluster token of the master:
$ cat /var/lib/rancher/k3s/server/node-token
K1078e7213ca32bdaabb44536f14b9ce7926bb201f41c3f3edd39975c16ff4901ea::server:33bde27f-ac49-4483-b6ac-f4eec2c6dbfa
We assume that the IP address of the cluster master is 192.168.6.240.
- Then, set the environment variables:
$ export K3S_URL=https://192.168.6.240:6443
$ export K3S_TOKEN="K1078e7213ca32bdaabb44536f14b9ce7926bb201f41c3f3edd39975c16ff4901ea::server:33bde27f-ac49-4483-b6ac-f4eec2c6dbfa"
Note
If you are in China, you need to use mirror acceleration:
$ export INSTALL_DRYCC_MIRROR=cn
- Join the cluster as server:
$ curl -sfL https://www.drycc.cc/install.sh | bash -s - install_k3s_server
- Join the cluster as agent:
$ curl -sfL https://www.drycc.cc/install.sh | bash -s - install_k3s_agent
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 |
| DRYCC_ADMIN_USERNAME | Required item, specify Drycc’s admin username |
| DRYCC_ADMIN_PASSWORD | Required item, specify Drycc’s admin password |
| CERT_MANAGER_ENABLED | Whether to use automatic certificate. It is false by default |
| CHANNEL | By default, stable channel will be installed. You can also specify testing |
| KUBERNETES_SERVICE_HOST | Set with the HOST of the loadbalancer that was in front of kube-apiserver |
| KUBERNETES_SERVICE_PORT | Set with the PORT of the loadbalancer that was in front of kube-apiserver |
| METALLB_CONFIG_FILE | The metallb config file path, layer 2 network is used by default |
| LONGHORN_CONFIG_FILE | The Longhorn config file path |
| INSTALL_DRYCC_MIRROR | Specify the accelerated mirror location. Currently, only cn is supported |
| BUILDER_REPLICAS | Number of builder replicas to deploy |
| CONTROLLER_API_REPLICAS | Number of controller api replicas to deploy |
| CONTROLLER_CELERY_REPLICAS | Number of controller celery replicas to deploy |
| CONTROLLER_METRIC_REPLICAS | Number of controller metric replicas to deploy |
| CONTROLLER_MUTATE_REPLICAS | Number of controller mutate replicas to deploy |
| CONTROLLER_WEBHOOK_REPLICAS | Number of controller webhook replicas to deploy |
| CONTROLLER_APP_RUNTIME_CLASS | RuntimeClass is a feature for selecting the container runtime configuration |
| CONTROLLER_APP_GATEWAY_CLASS | GatewayClass allocated by drycc gateways; default GatewayClass is used by default |
| CONTROLLER_APP_STORAGE_CLASS | StorageClass allocated by drycc volumes; default storageClass is used by default |
| VALKEY_PERSISTENCE_SIZE | The size of the persistence space allocated to valkey, which is 5Gi by default |
| VALKEY_PERSISTENCE_STORAGE_CLASS | StorageClass of valkey; default storageClass is used by default |
| STORAGE_PERSISTENCE_SIZE | The size of the persistence space allocated to storage, which is 5Gi by default |
| STORAGE_PERSISTENCE_STORAGE_CLASS | StorageClass of storage; default storageClass is used by default |
| MONITOR_GRAFANA_PERSISTENCE_SIZE | The size of the persistence space allocated to monitor.grafana, which is 5Gi by default |
| MONITOR_GRAFANA_PERSISTENCE_STORAGE_CLASS | StorageClass of monitor grafana; default storageClass is used by default |
| DATABASE_PERSISTENCE_SIZE | The size of the persistence space allocated to database, which is 5Gi by default |
| DATABASE_PERSISTENCE_STORAGE_CLASS | StorageClass of database; default storageClass is used by default |
| TIMESERIES_REPLICAS | Number of timeseries replicas to deploy |
| TIMESERIES_PERSISTENCE_SIZE | The size of the persistence space allocated to timeseries, which is 5Gi by default |
| TIMESERIES_PERSISTENCE_STORAGE_CLASS | StorageClass of timeseries; default storageClass is used by default |
| PASSPORT_REPLICAS | Number of passport replicas to deploy |
| REGISTRY_REPLICAS | Number of registry replicas to deploy |
| HELMBROKER_API_REPLICAS | Number of helmbroker api replicas to deploy |
| HELMBROKER_CELERY_REPLICAS | Number of helmbroker celery replicas to deploy |
| HELMBROKER_PERSISTENCE_SIZE | The size of the persistence space allocated to helmbroker, which is 5Gi by default |
| HELMBROKER_PERSISTENCE_STORAGE_CLASS | StorageClass of helmbroker; default storageClass is used by default |
| VICTORIAMETRICS_CONFIG_FILE | The path of the victoriametrics configuration file, turn on this, the two below won’t work |
| VICTORIAMETRICS_VMAGENT_PERSISTENCE_SIZE | The size of the persistence space allocated to victoriametrics vmagent, which is 10Gi by default |
| VICTORIAMETRICS_VMAGENT_PERSISTENCE_STORAGE_CLASS | StorageClass of victoriametrics vmagent; default storageClass is used by default |
| VICTORIAMETRICS_VMSTORAGE_PERSISTENCE_SIZE | The size of the persistence space allocated to victoriametrics vmstorage, which is 10Gi by default |
| VICTORIAMETRICS_VMSTORAGE_PERSISTENCE_STORAGE_CLASS | StorageClass of victoriametrics vmstorage; default storageClass is used by default |
| K3S_DATA_DIR | The config of k3s data dir; If not set, the default path is used |
| ACME_SERVER | ACME Server url, default use letsencrypt |
| ACME_EAB_KEY_ID | The key ID of which your external account binding is indexed by the external account |
| ACME_EAB_KEY_SECRET | The key Secret of which your external account symmetric MAC key |
Since the installation script will install k3s, other environment variables can refer to k3s installation environment variables.
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 -
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.