13 KiB
K3s Scheduler
Important
New as of 0.33.0
scheduler-k3s:cluster-add [ssh://user@host:port] # Adds a server node to a Dokku-managed cluster
scheduler-k3s:cluster-list # Lists all nodes in a Dokku-managed cluster
scheduler-k3s:cluster-remove [node-id] # Removes client node to a Dokku-managed cluster
scheduler-k3s:initialize # Initializes a cluster
scheduler-k3s:report [<app>] [<flag>] # Displays a scheduler-k3s report for one or more apps
scheduler-k3s:set [<app>|--global] <key> (<value>) # Set or clear a scheduler-k3s property for an app or the scheduler
scheduler-k3s:show-kubeconfig # Displays the kubeconfig for remote usage
scheduler-k3s:uninstall # Uninstalls k3s from the Dokku server
Note
The k3s plugin replaces the external scheduler-kubernetes plugin. Users can continue to use the external plugin as necessary, but all future development will occur on the official core k3s plugin.
For multi-server support, Dokku provides the ability for users to setup a K3s cluster. As with all schedulers, it is set on a per-app basis. The scheduler can currently be overridden by running the following command:
dokku scheduler:set node-js-app selected k3s
As it is the default, unsetting the selected scheduler property is also a valid way to reset the scheduler.
dokku scheduler:set node-js-app k3s
Usage
Initializing a cluster
Warning
This command must be run as root
Clusters can be initialized via the scheduler-k3s:initialize command. This will start a k3s cluster on the Dokku node itself.
dokku scheduler-k3s:initialize
By default, the k3s installation can run both app and system workloads. For clusters where app workloads are run on distinct worker nodes, initialize the cluster with the --taint-scheduling flag, which will allow only Critical cluster components on the k3s control-plane nodes.
dokku scheduler-k3s:initialize --taint-scheduling
By default, Dokku will attempt to auto-detect the IP address of the server. In cases where the auto-detected IP address is incorrect, an override may be specified via the --server-ip flag:
dokku scheduler-k3s:initialize --server-ip 192.168.20.15
Adding nodes to the cluster
Warning
The
dokkuuser must be able to ssh onto the server in order to connect nodes to the cluster. The remote user must be root or have sudo enabled, or the install will fail.
Adding a worker node
Nodes that run app workloads can be added via the scheduler-k3s:cluster-add command. This will ssh onto the specified server, install k3s, and join it to the current Dokku node in worker mode. Workers are typically used to run app workloads.
dokku scheduler-k3s:cluster-add ssh://root@worker-1.example.com
If the server isn't in the known_hosts file, the connection will fail. This can be bypassed by setting the --insecure-allow-unknown-hosts flag:
dokku scheduler-k3s:cluster-add --insecure-allow-unknown-hosts ssh://root@worker-1.example.com
By default, Dokku will attempt to auto-detect the IP address of the Dokku server for the remote server to connect to. In cases where the auto-detected IP address is incorrect, an override may be specified via the --server-ip flag:
dokku scheduler-k3s:cluster-add --server-ip 192.168.20.15 ssh://root@worker-1.example.com
Adding a server node
Note
Only the initial Dokku server will be properly configured for push deployment, and should be considered your git remote. Additional server nodes are for ensuring high-availability of the K3s etcd state. Ensure this server is properly backed up and restorable or deployments will not work.
Server nodes are typically used to replicate the cluster state, and it is recommended to have an odd number of nodes spread across several availability zones (datacenters in close proximity within a region). This allows for higher availability in the event of a cluster failure. Server nodes run control-plane services such as the traefik load balancer and the etcd backing store.
Server nodes can also be added with the scheduler-k3s:cluster-add command by specifying --role server. This will ssh onto the specified server, install k3s, and join it to the current Dokku node in server mode.
dokku scheduler-k3s:cluster-add --role server ssh://root@server-1.example.com
Server nodes allow any workloads to be scheduled on them by default, in addition to the control-plane, etcd, and the scheduler itself. To avoid app workloads being scheduled on your control-plane, use the --taint-scheduling flag:
dokku scheduler-k3s:cluster-add --role server --taint-scheduling ssh://root@server-1.example.com
If the server isn't in the known_hosts file, the connection will fail. This can be bypassed by setting the --insecure-allow-unknown-hosts flag:
dokku scheduler-k3s:cluster-add --role server --insecure-allow-unknown-hosts ssh://root@server-1.example.com
By default, Dokku will attempt to auto-detect the IP address of the Dokku server for the remote server to connect to. In cases where the auto-detected IP address is incorrect, an override may be specified via the --server-ip flag:
dokku scheduler-k3s:cluster-add --role server --server-ip 192.168.20.15 ssh://root@server-1.example.com
Changing the network interface
When attaching an worker or server node, the K3s plugin will look at the IP associated with the eth0 interface and use that to connect the new node to the cluster. To change this, set the network-interface property to the appropriate value.
dokku scheduler-k3s:set --global network-interface eth1
Changing deploy timeouts
By default, app deploys will timeout after 300s. To customize this value, set the deploy-timeout property via scheduler-k3s:set:
dokku scheduler-k3s:set node-js-app deploy-timeout 60s
The default value may be set by passing an empty value for the option:
dokku scheduler-k3s:set node-js-app deploy-timeout
The deploy-timeout property can also be set globally. The global default is 300s.
dokku scheduler-k3s:set --global deploy-timeout 60s
The default value may be set by passing an empty value for the option.
dokku scheduler-k3s:set --global deploy-timeout
Customizing the namespace
By default, app deploys will run against the default Kubernetes namespace. To customize this value, set the namespace property via scheduler-k3s:set:
dokku scheduler-k3s:set node-js-app namespace lollipop
The default value may be set by passing an empty value for the option:
dokku scheduler-k3s:set node-js-app namespace
The namespace property can also be set globally. The global default is default.
dokku scheduler-k3s:set --global namespace 60s
The default value may be set by passing an empty value for the option.
dokku scheduler-k3s:set --global namespace
Enabling rollback on failure
By default, app deploys do not rollback on failure. To enable this functionality, set the rollback-on-failure property via scheduler-k3s:set:
dokku scheduler-k3s:set node-js-app rollback-on-failure true
The default value may be set by passing an empty value for the option:
dokku scheduler-k3s:set node-js-app rollback-on-failure
The rollback-on-failure property can also be set globally. The global default is false.
dokku scheduler-k3s:set --global rollback-on-failure false
The default value may be set by passing an empty value for the option.
dokku scheduler-k3s:set --global rollback-on-failure
Using image pull secrets
When authenticating against a registry via registry:login, the scheduler-k3s plugin will authenticate all servers in the cluster against the registry specified. If desired, an image pull secret can be used instead. To customize this value, set the image-pull-secrets property via scheduler-k3s:set:
dokku scheduler-k3s:set node-js-app image-pull-secrets lollipop
The default value may be set by passing an empty value for the option:
dokku scheduler-k3s:set node-js-app image-pull-secrets
The image-pull-secrets property can also be set globally. The global default is empty string, and k3s will use the local registries.yaml for any private registry pulls.
dokku scheduler-k3s:set --global image-pull-secrets 60s
The default value may be set by passing an empty value for the option.
dokku scheduler-k3s:set --global image-pull-secrets
Enabling letsencrypt integration
By default, letsencrypt is disabled and https port mappings are ignored. To enable, set the letsencrypt-email-prod or letsencrypt-email-stag property with the --global flag:
# set the value for prod
dokku scheduler-k3s:set --global letsencrypt-email-prod automated@dokku.sh
# set the value for stag
dokku scheduler-k3s:set --global letsencrypt-email-stag automated@dokku.sh
After enabling and rebuilding, all apps with an https port mapping that utilize the related letsencrypt server will be automatically updated to enable ssl. All http requests will then be redirected to https.
Customizing the letsencrypt server
The letsencrypt integration is set to the production letsencrypt server by default. This can be changed on an app-level by setting the letsencrypt-server property with the scheduler-k3s:set command
dokku scheduler-k3s:set node-js-app letsencrypt-server staging
The default value may be set by passing an empty value for the option:
dokku scheduler-k3s:set node-js-app letsencrypt-server
The image-pull-secrets property can also be set globally. The global default is production.
dokku scheduler-k3s:set --global letsencrypt-server staging
The default value may be set by passing an empty value for the option.
dokku scheduler-k3s:set --global letsencrypt-server staging
Using kubectl remotely
Warning
Certain ports must be open for interacting with the remote kubernets api. Refer to the K3s networking documentation for the required open ports between servers prior to running the command.
By default, Dokku assumes that all it controls all actions on the cluster, and thus does not expose the kubectl binary for administrators. To interact with kubectl, you will need to retrieve the kubeconfig for the cluster and configure your client to use that configuration.
dokku scheduler-k3s:show-kubeconfig
Scheduler Interface
The following sections describe implemented and unimplemented scheduler functionality for the k3s scheduler.
Implemented Commands and Triggers
This plugin implements various functionality through plugn triggers to integrate with Docker for running apps on a single server. The following functionality is supported by the scheduler-k3s plugin.
apps:cloneapps:destroyapps:renamecronenterdeploy- healthchecks
- Due to Kubernetes limitations, only a single healthcheck is supported for each of the
liveness,readiness, andstartuphealthchecks - Due to Kubernetes limitations, content checks are not supported - Ports specified in theapp.jsonare ignored in favor of the container port on the port mapping detected logsps:stoprun- Thescheduler-post-runtrigger is not always triggeredrun:detachedrun:list
Unimplemented command functionality
run:logsps:inspect
The following Dokku functionality is not implemented at this time.
vectorlog integration- persistent storage
Logging support
App logs for the logs command are fetched by Dokku from running containers via the kubectl cli. Persisting logs via Vector is not implemented at this time. Users may choose to configure the Vector Kubernetes integration directly by following this guide.
Supported Resource Management Properties
The k3s scheduler supports a minimal list of resource limits and reservations. The following properties are supported:
Resource Limits
Note
Cron tasks retrieve resource limits based on the computed cron task ID. If unspecified, the default will be 1 CPU and 512m RAM.
- cpu: is specified in number of CPUs a process can access.
- memory: should be specified with a suffix of
b(bytes),k(kilobytes),m(megabytes),g(gigabytes). Default unit ism(megabytes).
Resource Reservations
Note
Cron tasks retrieve resource reservations based on the computed cron task ID. If unspecified, the default will be 1 CPU and 512m RAM.
- cpu: is specified in number of CPUs a process can access.
- memory: should be specified with a suffix of
b(bytes),k(kilobytes),m(megabytes),g(gigabytes). Default unit ism(megabytes).