dokku clickhouse

Official clickhouse plugin for dokku. Currently defaults to installing clickhouse/clickhouse-server 24.10.3.21.

Sponsors

The clickhouse plugin was generously sponsored by the following:

• coding-socks

Requirements

• dokku 0.19.x+
• docker 1.8.x

Installation

# on 0.19.x+
sudo dokku plugin:install https://github.com/dokku/dokku-clickhouse.git clickhouse

Commands

clickhouse:app-links <app>                         # list all clickhouse service links for a given app
clickhouse:backup-set-public-key-encryption <service> <public-key-id> # set GPG Public Key encryption for all future backups of clickhouse service
clickhouse:backup-unset-public-key-encryption <service> # unset GPG Public Key encryption for future backups of the clickhouse service
clickhouse:connect <service>                       # connect to the service via the clickhouse connection tool
clickhouse:create <service> [--create-flags...]    # create a clickhouse service
clickhouse:destroy <service> [-f|--force]          # delete the clickhouse service/data/container if there are no links left
clickhouse:enter <service>                         # enter or run a command in a running clickhouse service container
clickhouse:exists <service>                        # check if the clickhouse service exists
clickhouse:expose <service> <ports...>             # expose a clickhouse service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)
clickhouse:info <service> [--single-info-flag]     # print the service information
clickhouse:link <service> <app> [--link-flags...]  # link the clickhouse service to the app
clickhouse:linked <service> <app>                  # check if the clickhouse service is linked to an app
clickhouse:links <service>                         # list all apps linked to the clickhouse service
clickhouse:list                                    # list all clickhouse services
clickhouse:logs <service> [-t|--tail] <tail-num-optional> # print the most recent log(s) for this service
clickhouse:pause <service>                         # pause a running clickhouse service
clickhouse:promote <service> <app>                 # promote service <service> as CLICKHOUSE_URL in <app>
clickhouse:restart <service>                       # graceful shutdown and restart of the clickhouse service container
clickhouse:set <service> <key> <value>             # set or clear a property for a service
clickhouse:start <service>                         # start a previously stopped clickhouse service
clickhouse:stop <service>                          # stop a running clickhouse service
clickhouse:unexpose <service>                      # unexpose a previously exposed clickhouse service
clickhouse:unlink <service> <app>                  # unlink the clickhouse service from the app
clickhouse:upgrade <service> [--upgrade-flags...]  # upgrade service <service> to the specified versions

Usage

Help for any commands can be displayed by specifying the command as an argument to clickhouse:help. Plugin help output in conjunction with any files in the docs/ folder is used to generate the plugin documentation. Please consult the clickhouse:help command for any undocumented commands.

Basic Usage

create a clickhouse service

# usage
dokku clickhouse:create <service> [--create-flags...]

flags:

• -c|--config-options "--args --go=here": extra arguments to pass to the container create command (default: None)
• -C|--custom-env "USER=alpha;HOST=beta": semi-colon delimited environment variables to start the service with
• -i|--image IMAGE: the image name to start the service with
• -I|--image-version IMAGE_VERSION: the image version to start the service with
• -m|--memory MEMORY: container memory limit in megabytes (default: unlimited)
• -N|--initial-network INITIAL_NETWORK: the initial network to attach the service to
• -p|--password PASSWORD: override the user-level service password
• -P|--post-create-network NETWORKS: a comma-separated list of networks to attach the service container to after service creation
• -r|--root-password PASSWORD: override the root-level service password
• -S|--post-start-network NETWORKS: a comma-separated list of networks to attach the service container to after service start
• -s|--shm-size SHM_SIZE: override shared memory size for clickhouse docker container

Create a clickhouse service named lollipop:

dokku clickhouse:create lollipop

You can also specify the image and image version to use for the service. It must be compatible with the clickhouse/clickhouse-server image.

export CLICKHOUSE_IMAGE="clickhouse/clickhouse-server"
export CLICKHOUSE_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
dokku clickhouse:create lollipop

You can also specify custom environment variables to start the clickhouse service in semicolon-separated form.

export CLICKHOUSE_CUSTOM_ENV="USER=alpha;HOST=beta"
dokku clickhouse:create lollipop

print the service information

# usage
dokku clickhouse:info <service> [--single-info-flag]

flags:

• --config-dir: show the service configuration directory
• --data-dir: show the service data directory
• --dsn: show the service DSN
• --exposed-ports: show service exposed ports
• --id: show the service container id
• --internal-ip: show the service internal ip
• --initial-network: show the initial network being connected to
• --links: show the service app links
• --post-create-network: show the networks to attach to after service container creation
• --post-start-network: show the networks to attach to after service container start
• --service-root: show the service root directory
• --status: show the service running status
• --version: show the service image version

Get connection information as follows:

dokku clickhouse:info lollipop

You can also retrieve a specific piece of service info via flags:

dokku clickhouse:info lollipop --config-dir
dokku clickhouse:info lollipop --data-dir
dokku clickhouse:info lollipop --dsn
dokku clickhouse:info lollipop --exposed-ports
dokku clickhouse:info lollipop --id
dokku clickhouse:info lollipop --internal-ip
dokku clickhouse:info lollipop --initial-network
dokku clickhouse:info lollipop --links
dokku clickhouse:info lollipop --post-create-network
dokku clickhouse:info lollipop --post-start-network
dokku clickhouse:info lollipop --service-root
dokku clickhouse:info lollipop --status
dokku clickhouse:info lollipop --version

list all clickhouse services

# usage
dokku clickhouse:list

List all services:

dokku clickhouse:list

print the most recent log(s) for this service

# usage
dokku clickhouse:logs <service> [-t|--tail] <tail-num-optional>

flags:

• -t|--tail [<tail-num>]: do not stop when end of the logs are reached and wait for additional output

You can tail logs for a particular service:

dokku clickhouse:logs lollipop

By default, logs will not be tailed, but you can do this with the --tail flag:

dokku clickhouse:logs lollipop --tail

The default tail setting is to show all logs, but an initial count can also be specified:

dokku clickhouse:logs lollipop --tail 5

link the clickhouse service to the app

# usage
dokku clickhouse:link <service> <app> [--link-flags...]

flags:

• -a|--alias "BLUE_DATABASE": an alternative alias to use for linking to an app via environment variable
• -q|--querystring "pool=5": ampersand delimited querystring arguments to append to the service link
• -n|--no-restart "false": whether or not to restart the app on link (default: true)

A clickhouse service can be linked to a container. This will use native docker links via the docker-options plugin. Here we link it to our playground app.

NOTE: this will restart your app

dokku clickhouse:link lollipop playground

The following environment variables will be set automatically by docker (not on the app itself, so they won’t be listed when calling dokku config):

DOKKU_CLICKHOUSE_LOLLIPOP_NAME=/lollipop/DATABASE
DOKKU_CLICKHOUSE_LOLLIPOP_PORT=tcp://172.17.0.1:9000
DOKKU_CLICKHOUSE_LOLLIPOP_PORT_9000_TCP=tcp://172.17.0.1:9000
DOKKU_CLICKHOUSE_LOLLIPOP_PORT_9000_TCP_PROTO=tcp
DOKKU_CLICKHOUSE_LOLLIPOP_PORT_9000_TCP_PORT=9000
DOKKU_CLICKHOUSE_LOLLIPOP_PORT_9000_TCP_ADDR=172.17.0.1

The following will be set on the linked application by default:

CLICKHOUSE_URL=clickhouse://lollipop:SOME_PASSWORD@dokku-clickhouse-lollipop:9000/lollipop

The host exposed here only works internally in docker containers. If you want your container to be reachable from outside, you should use the expose subcommand. Another service can be linked to your app:

dokku clickhouse:link other_service playground

It is possible to change the protocol for CLICKHOUSE_URL by setting the environment variable CLICKHOUSE_DATABASE_SCHEME on the app. Doing so will after linking will cause the plugin to think the service is not linked, and we advise you to unlink before proceeding.

dokku config:set playground CLICKHOUSE_DATABASE_SCHEME=clickhouse2
dokku clickhouse:link lollipop playground

This will cause CLICKHOUSE_URL to be set as:

clickhouse2://lollipop:SOME_PASSWORD@dokku-clickhouse-lollipop:9000/lollipop

If you specify CLICKHOUSE_DATABASE_SCHEME to equal http, well also automatically adjust CLICKHOUSE_URL` to match the http interface:

http://lollipop:SOME_PASSWORD@dokku-clickhouse-lollipop:${PLUGIN_DATASTORE_PORTS[1]}

unlink the clickhouse service from the app

# usage
dokku clickhouse:unlink <service> <app>

flags:

• -n|--no-restart "false": whether or not to restart the app on unlink (default: true)

You can unlink a clickhouse service:

NOTE: this will restart your app and unset related environment variables

dokku clickhouse:unlink lollipop playground

set or clear a property for a service

# usage
dokku clickhouse:set <service> <key> <value>

Set the network to attach after the service container is started:

dokku clickhouse:set lollipop post-create-network custom-network

Set multiple networks:

dokku clickhouse:set lollipop post-create-network custom-network,other-network

Unset the post-create-network value:

dokku clickhouse:set lollipop post-create-network

Service Lifecycle

The lifecycle of each service can be managed through the following commands:

connect to the service via the clickhouse connection tool

# usage
dokku clickhouse:connect <service>

Connect to the service via the clickhouse connection tool:

NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098

dokku clickhouse:connect lollipop

enter or run a command in a running clickhouse service container

# usage
dokku clickhouse:enter <service>

A bash prompt can be opened against a running service. Filesystem changes will not be saved to disk.

NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098

dokku clickhouse:enter lollipop

You may also run a command directly against the service. Filesystem changes will not be saved to disk.

dokku clickhouse:enter lollipop touch /tmp/test

expose a clickhouse service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)

# usage
dokku clickhouse:expose <service> <ports...>

Expose the service on the service's normal ports, allowing access to it from the public interface (0.0.0.0):

dokku clickhouse:expose lollipop 9000 8123

Expose the service on the service's normal ports, with the first on a specified ip adddress (127.0.0.1):

dokku clickhouse:expose lollipop 127.0.0.1:9000 8123

unexpose a previously exposed clickhouse service

# usage
dokku clickhouse:unexpose <service>

Unexpose the service, removing access to it from the public interface (0.0.0.0):

dokku clickhouse:unexpose lollipop

promote service as CLICKHOUSE_URL in

# usage
dokku clickhouse:promote <service> <app>

If you have a clickhouse service linked to an app and try to link another clickhouse service another link environment variable will be generated automatically:

DOKKU_CLICKHOUSE_BLUE_URL=clickhouse://other_service:ANOTHER_PASSWORD@dokku-clickhouse-other-service:9000/other_service

You can promote the new service to be the primary one:

NOTE: this will restart your app

dokku clickhouse:promote other_service playground

This will replace CLICKHOUSE_URL with the url from other_service and generate another environment variable to hold the previous value if necessary. You could end up with the following for example:

CLICKHOUSE_URL=clickhouse://other_service:ANOTHER_PASSWORD@dokku-clickhouse-other-service:9000/other_service
DOKKU_CLICKHOUSE_BLUE_URL=clickhouse://other_service:ANOTHER_PASSWORD@dokku-clickhouse-other-service:9000/other_service
DOKKU_CLICKHOUSE_SILVER_URL=clickhouse://lollipop:SOME_PASSWORD@dokku-clickhouse-lollipop:9000/lollipop

start a previously stopped clickhouse service

# usage
dokku clickhouse:start <service>

Start the service:

dokku clickhouse:start lollipop

stop a running clickhouse service

# usage
dokku clickhouse:stop <service>

Stop the service and removes the running container:

dokku clickhouse:stop lollipop

pause a running clickhouse service

# usage
dokku clickhouse:pause <service>

Pause the running container for the service:

dokku clickhouse:pause lollipop

graceful shutdown and restart of the clickhouse service container

# usage
dokku clickhouse:restart <service>

Restart the service:

dokku clickhouse:restart lollipop

upgrade service to the specified versions

# usage
dokku clickhouse:upgrade <service> [--upgrade-flags...]

flags:

• -c|--config-options "--args --go=here": extra arguments to pass to the container create command (default: None)
• -C|--custom-env "USER=alpha;HOST=beta": semi-colon delimited environment variables to start the service with
• -i|--image IMAGE: the image name to start the service with
• -I|--image-version IMAGE_VERSION: the image version to start the service with
• -N|--initial-network INITIAL_NETWORK: the initial network to attach the service to
• -P|--post-create-network NETWORKS: a comma-separated list of networks to attach the service container to after service creation
• -R|--restart-apps "true": whether or not to force an app restart (default: false)
• -S|--post-start-network NETWORKS: a comma-separated list of networks to attach the service container to after service start
• -s|--shm-size SHM_SIZE: override shared memory size for clickhouse docker container

You can upgrade an existing service to a new image or image-version:

dokku clickhouse:upgrade lollipop

Service Automation

Service scripting can be executed using the following commands:

list all clickhouse service links for a given app

# usage
dokku clickhouse:app-links <app>

List all clickhouse services that are linked to the playground app.

dokku clickhouse:app-links playground

check if the clickhouse service exists

# usage
dokku clickhouse:exists <service>

Here we check if the lollipop clickhouse service exists.

dokku clickhouse:exists lollipop

check if the clickhouse service is linked to an app

# usage
dokku clickhouse:linked <service> <app>

Here we check if the lollipop clickhouse service is linked to the playground app.

dokku clickhouse:linked lollipop playground

list all apps linked to the clickhouse service

# usage
dokku clickhouse:links <service>

List all apps linked to the lollipop clickhouse service.

dokku clickhouse:links lollipop

Backups

Datastore backups are supported via AWS S3 and S3 compatible services like minio.

You may skip the backup-auth step if your dokku install is running within EC2 and has access to the bucket via an IAM profile. In that case, use the --use-iam option with the backup command.

Backups can be performed using the backup commands:

set GPG Public Key encryption for all future backups of clickhouse service

# usage
dokku clickhouse:backup-set-public-key-encryption <service> <public-key-id>

Set the GPG Public Key for encrypting backups:

dokku clickhouse:backup-set-public-key-encryption lollipop

unset GPG Public Key encryption for future backups of the clickhouse service

# usage
dokku clickhouse:backup-unset-public-key-encryption <service>

Unset the GPG Public Key encryption for backups:

dokku clickhouse:backup-unset-public-key-encryption lollipop

Disabling docker image pull calls

If you wish to disable the docker image pull calls that the plugin triggers, you may set the CLICKHOUSE_DISABLE_PULL environment variable to true. Once disabled, you will need to pull the service image you wish to deploy as shown in the stderr output.

Please ensure the proper images are in place when docker image pull is disabled.