Quick Start

• 1: Quick Start
• 2: Install Workflow
• 3: Install CLI Tools
• 4: Deploy Your First App

1 - Quick Start

Get started with Drycc Workflow in three simple steps:

1. Install CLI tools for Helm and Drycc Workflow
2. Boot a Kubernetes cluster and install Drycc Workflow
3. Deploy your first application

This guide helps you set up a cluster suitable for evaluation, development, and testing. When you are ready for staging and production, view our production checklist.

Step 1: Install Workflow

Install Drycc Workflow on your infrastructure.

Step 2: Install CLI tools

Install the Drycc Workflow CLI tools on your local machine.

Step 3: Deploy your first app

Finally, log in and deploy your first application.

2 - Install Workflow

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 -

$ 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"

$ 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:

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 -

3 - Install CLI Tools

Drycc Workflow Client CLI

The Drycc command-line interface (CLI) lets you interact with Drycc Workflow. Use the CLI to create, configure, and manage applications.

Install the drycc client for Linux or macOS with:

$ curl -sfL https://www.drycc.cc/install-cli.sh | bash -

$ curl -sfL https://www.drycc.cc/install-cli.sh | INSTALL_DRYCC_MIRROR=cn bash -

For other platforms, please visit: https://github.com/drycc/workflow-cli/releases

The installer places the drycc binary in your current directory, but you should move it somewhere in your $PATH:

$ sudo ln -fs $PWD/drycc /usr/local/bin/drycc

or:

$ sudo mv $PWD/drycc /usr/local/bin/drycc

Check your work by running drycc version:

$ drycc version
v1.1.0

Update the workflow CLI to the latest release:

$ drycc update

4 - Deploy Your First App

Determine Your Host and Hostname Values

Drycc Workflow requires a wildcard DNS record to dynamically map application names to the router.

You should already have DNS set up pointing to your known host. The $hostname value can be calculated by prepending drycc. to the value set in global.platformDomain.

Login to Workflow

Workflow uses the passport component to create and authorize users. If you already have an account, use drycc login to authenticate against the Drycc Workflow API.

$ drycc login http://drycc.example.com
Opening browser to http://drycc.example.com/v2/login/drycc/?key=4ccc81ee2dce4349ad5261ceffe72c71
Waiting for login... .o.Logged in as admin
Configuration file written to /root/.drycc/client.json

Or you can login with username and password:

$ drycc login http://drycc.example.com --username=demo --password=demo
Configuration file written to /root/.drycc/client.json

Deploy an Application

Drycc Workflow supports three different types of applications: Buildpacks, Dockerfiles, and Container Images. Our first application will be a simple container image-based application, so you don’t have to wrestle with checking out code.

Run drycc create to create a new application on Drycc Workflow. If you do not specify a name for your application, Workflow automatically generates a friendly (and sometimes funny) name.

$ drycc create --no-remote
Creating Application... done, created proper-barbecue
If you want to add a git remote for this app later, use `drycc git remote -a proper-barbecue`

Our application has been created and named proper-barbecue. As with the drycc hostname, any HTTP traffic to proper-barbecue will be automatically routed to your application pods by the edge router.

Let’s use the CLI to tell the platform to deploy an application and then use curl to send a request to the app:

$ drycc pull drycc/example-go -a proper-barbecue
Creating build... done
$ curl http://proper-barbecue.$hostname
Powered by Drycc

Workflow’s edge router knows all about application names and automatically sends traffic to the right application. The router sends traffic for proper-barbecue.104.197.125.75.nip.io to your app, just like drycc.104.197.125.75.nip.io was sent to the Workflow API service.

Change Application Configuration

Next, let’s change some configuration using the CLI. Our example app is built to read configuration from the environment. By using drycc config set we can change how the application behaves:

$ drycc config set POWERED_BY="Container Images + Kubernetes" -a proper-barbecue
Creating config... done

Behind the scenes, Workflow creates a new release for your application and uses Kubernetes to provide a zero-downtime rolling deploy to the new release!

Validate that our configuration change has worked:

$ curl http://proper-barbecue.104.197.125.75.nip.io
Powered by Container Images + Kubernetes

Scale Your Application

Last, let’s scale our application by adding more application processes. Using the CLI you can easily add and remove additional processes to service requests:

$ drycc scale web=2 -a proper-barbecue
Scaling processes... but first, coffee!
done in 36s

NAME                                RELEASE    STATE    PTYPE       STARTED
proper-barbecue-v18-web-rk644       v18        up       web         2023-12-08T03:09:25UTC
proper-barbecue-v18-web-0ag04       v18        up       web         2023-12-08T03:09:25UTC

Congratulations! You have deployed, configured, and scaled your first application using Drycc Workflow.

Going Further

There is a lot more you can do with Drycc Workflow. Play around with the CLI:

• Roll back to a previous release with drycc rollback -a proper-barbecue
• See application logs with drycc grafana
• Try one of our other example applications like:
  • drycc/ruby-getting-started
  • drycc/python-getting-started
  • drycc/php-getting-started
• Read about using application Buildpacks or Dockerfiles
• Join our #community slack channel and meet the team!