Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
bin
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

dokku mariadb Build Status IRC Network

Official mariadb plugin for dokku. Currently defaults to installing mariadb 10.4.10.

Requirements

  • dokku 0.12.x+
  • docker 1.8.x

Installation

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

Commands

mariadb:app-links <app>                            # list all mariadb service links for a given app
mariadb:backup <service> <bucket-name> [--use-iam] # creates a backup of the mariadb service to an existing s3 bucket
mariadb:backup-auth <service> <aws-access-key-id> <aws-secret-access-key> <aws-default-region> <aws-signature-version> <endpoint-url> # sets up authentication for backups on the mariadb service
mariadb:backup-deauth <service>                    # removes backup authentication for the mariadb service
mariadb:backup-schedule <service> <schedule> <bucket-name> [--use-iam] # schedules a backup of the mariadb service
mariadb:backup-schedule-cat <service>              # cat the contents of the configured backup cronfile for the service
mariadb:backup-set-encryption <service> <passphrase> # sets encryption for all future backups of mariadb service
mariadb:backup-unschedule <service>                # unschedules the backup of the mariadb service
mariadb:backup-unset-encryption <service>          # unsets encryption for future backups of the mariadb service
mariadb:clone <service> <new-service> [--clone-flags...] # create container <new-name> then copy data from <name> into <new-name>
mariadb:connect <service>                          # connect to the service via the mariadb connection tool
mariadb:create <service> [--create-flags...]       # create a mariadb service
mariadb:destroy <service> [-f|--force]             # delete the mariadb service/data/container if there are no links left
mariadb:enter <service>                            # enter or run a command in a running mariadb service container
mariadb:exists <service>                           # check if the mariadb service exists
mariadb:export <service>                           # export a dump of the mariadb service database
mariadb:expose <service> <ports...>                # expose a mariadb service on custom port if provided (random port otherwise)
mariadb:import <service>                           # import a dump into the mariadb service database
mariadb:info <service> [--single-info-flag]        # print the service information
mariadb:link <service> <app> [--link-flags...]     # link the mariadb service to the app
mariadb:linked <service> <app>                     # check if the mariadb service is linked to an app
mariadb:links <service>                            # list all apps linked to the mariadb service
mariadb:list                                       # list all mariadb services
mariadb:logs <service> [-t|--tail]                 # print the most recent log(s) for this service
mariadb:promote <service> <app>                    # promote service <service> as DATABASE_URL in <app>
mariadb:restart <service>                          # graceful shutdown and restart of the mariadb service container
mariadb:start <service>                            # start a previously stopped mariadb service
mariadb:stop <service>                             # stop a running mariadb service
mariadb:unexpose <service>                         # unexpose a previously exposed mariadb service
mariadb:unlink <service> <app>                     # unlink the mariadb service from the app
mariadb: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 mariadb:help. Please consult the mariadb:help command for any undocumented commands.

Basic Usage

create a mariadb service

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

flags:

  • -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
  • -p|--password PASSWORD: override the user-level service password
  • -r|--root-password PASSWORD: override the root-level service password

Create a mariadb service named lolipop:

dokku mariadb:create lolipop

You can also specify the image and image version to use for the service. It must be compatible with the mariadb image.

export DATABASE_IMAGE="mariadb"
export DATABASE_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
dokku mariadb:create lolipop

You can also specify custom environment variables to start the mariadb service in semi-colon separated form.

export DATABASE_CUSTOM_ENV="USER=alpha;HOST=beta"
dokku mariadb:create lolipop

print the service information

# usage
dokku mariadb: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
  • --links: show the service app links
  • --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 mariadb:info lolipop

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

dokku mariadb:info lolipop --config-dir
dokku mariadb:info lolipop --data-dir
dokku mariadb:info lolipop --dsn
dokku mariadb:info lolipop --exposed-ports
dokku mariadb:info lolipop --id
dokku mariadb:info lolipop --internal-ip
dokku mariadb:info lolipop --links
dokku mariadb:info lolipop --service-root
dokku mariadb:info lolipop --status
dokku mariadb:info lolipop --version

list all mariadb services

# usage
dokku mariadb:list 

List all services:

dokku mariadb:list

print the most recent log(s) for this service

# usage
dokku mariadb:logs <service> [-t|--tail]

flags:

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

You can tail logs for a particular service:

dokku mariadb:logs lolipop

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

dokku mariadb:logs lolipop --tail

link the mariadb service to the app

# usage
dokku mariadb: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

A mariadb 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 mariadb:link lolipop 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_DATABASE_LOLIPOP_NAME=/lolipop/DATABASE
DOKKU_DATABASE_LOLIPOP_PORT=tcp://172.17.0.1:3306
DOKKU_DATABASE_LOLIPOP_PORT_3306_TCP=tcp://172.17.0.1:3306
DOKKU_DATABASE_LOLIPOP_PORT_3306_TCP_PROTO=tcp
DOKKU_DATABASE_LOLIPOP_PORT_3306_TCP_PORT=3306
DOKKU_DATABASE_LOLIPOP_PORT_3306_TCP_ADDR=172.17.0.1

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

DATABASE_URL=mysql://lolipop:SOME_PASSWORD@dokku-mariadb-lolipop:3306/lolipop

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 mariadb:link other_service playground

It is possible to change the protocol for DATABASE_URL by setting the environment variable MARIADB_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 MARIADB_DATABASE_SCHEME=mysql2
dokku mariadb:link lolipop playground

This will cause DATABASE_URL to be set as:

mysql2://lolipop:SOME_PASSWORD@dokku-mariadb-lolipop:3306/lolipop

unlink the mariadb service from the app

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

You can unlink a mariadb service:

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

dokku mariadb:unlink lolipop playground

Service Lifecycle

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

connect to the service via the mariadb connection tool

# usage
dokku mariadb:connect <service>

Connect to the service via the mariadb connection tool:

dokku mariadb:connect lolipop

enter or run a command in a running mariadb service container

# usage
dokku mariadb:enter <service>

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

dokku mariadb:enter lolipop

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

dokku mariadb:enter lolipop touch /tmp/test

expose a mariadb service on custom port if provided (random port otherwise)

# usage
dokku mariadb: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 mariadb:expose lolipop 3306

unexpose a previously exposed mariadb service

# usage
dokku mariadb:unexpose <service>

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

dokku mariadb:unexpose lolipop

promote service as DATABASE_URL in

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

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

DOKKU_DATABASE_BLUE_URL=mysql://other_service:ANOTHER_PASSWORD@dokku-mariadb-other-service:3306/other_service

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

NOTE: this will restart your app

dokku mariadb:promote other_service playground

This will replace DATABASE_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:

DATABASE_URL=mysql://other_service:ANOTHER_PASSWORD@dokku-mariadb-other-service:3306/other_service
DOKKU_DATABASE_BLUE_URL=mysql://other_service:ANOTHER_PASSWORD@dokku-mariadb-other-service:3306/other_service
DOKKU_DATABASE_SILVER_URL=mysql://lolipop:SOME_PASSWORD@dokku-mariadb-lolipop:3306/lolipop

start a previously stopped mariadb service

# usage
dokku mariadb:start <service>

Start the service:

dokku mariadb:start lolipop

stop a running mariadb service

# usage
dokku mariadb:stop <service>

Stop the service and the running container:

dokku mariadb:stop lolipop

graceful shutdown and restart of the mariadb service container

# usage
dokku mariadb:restart <service>

Restart the service:

dokku mariadb:restart lolipop

upgrade service to the specified versions

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

flags:

  • -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
  • -R|--restart-apps "true": whether to force an app restart

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

dokku mariadb:upgrade lolipop

Service Automation

Service scripting can be executed using the following commands:

list all mariadb service links for a given app

# usage
dokku mariadb:app-links <app>

List all mariadb services that are linked to the 'playground' app.

dokku mariadb:app-links playground

create container then copy data from into

# usage
dokku mariadb:clone <service> <new-service> [--clone-flags...]

flags:

  • -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
  • -p|--password PASSWORD: override the user-level service password
  • -r|--root-password PASSWORD: override the root-level service password

You can clone an existing service to a new one:

dokku mariadb:clone lolipop lolipop-2

check if the mariadb service exists

# usage
dokku mariadb:exists <service>

Here we check if the lolipop mariadb service exists.

dokku mariadb:exists lolipop

check if the mariadb service is linked to an app

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

Here we check if the lolipop mariadb service is linked to the 'playground' app.

dokku mariadb:linked lolipop playground

list all apps linked to the mariadb service

# usage
dokku mariadb:links <service>

List all apps linked to the 'lolipop' mariadb service.

dokku mariadb:links lolipop

Data Management

The underlying service data can be imported and exported with the following commands:

import a dump into the mariadb service database

# usage
dokku mariadb:import <service>

Import a datastore dump:

dokku mariadb:import lolipop < database.dump

export a dump of the mariadb service database

# usage
dokku mariadb:export <service>

By default, datastore output is exported to stdout:

dokku mariadb:export lolipop

You can redirect this output to a file:

dokku mariadb:export lolipop > lolipop.dump

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:

sets up authentication for backups on the mariadb service

# usage
dokku mariadb:backup-auth <service> <aws-access-key-id> <aws-secret-access-key> <aws-default-region> <aws-signature-version> <endpoint-url>

Setup s3 backup authentication:

dokku mariadb:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY

Setup s3 backup authentication with different region:

dokku mariadb:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION

Setup s3 backup authentication with different signature version and endpoint:

dokku mariadb:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL

More specific example for minio auth:

dokku mariadb:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE

removes backup authentication for the mariadb service

# usage
dokku mariadb:backup-deauth <service>

Remove s3 authentication:

dokku mariadb:backup-deauth lolipop

creates a backup of the mariadb service to an existing s3 bucket

# usage
dokku mariadb:backup <service> <bucket-name> [--use-iam]

flags:

  • -u|--use-iam: use the IAM profile associated with the current server

Backup the 'lolipop' service to the 'my-s3-bucket' bucket on ``AWS:

dokku mariadb:backup lolipop my-s3-bucket --use-iam

sets encryption for all future backups of mariadb service

# usage
dokku mariadb:backup-set-encryption <service> <passphrase>

Set the GPG-compatible passphrase for encrypting backups for backups:

dokku mariadb:backup-set-encryption lolipop

unsets encryption for future backups of the mariadb service

# usage
dokku mariadb:backup-unset-encryption <service>

Unset the GPG encryption passphrase for backups:

dokku mariadb:backup-unset-encryption lolipop

schedules a backup of the mariadb service

# usage
dokku mariadb:backup-schedule <service> <schedule> <bucket-name> [--use-iam]

flags:

  • -u|--use-iam: use the IAM profile associated with the current server

Schedule a backup:

'schedule' is a crontab expression, eg. "0 3 * * *" for each day at 3am

dokku mariadb:backup-schedule lolipop "0 3 * * *" my-s3-bucket

Schedule a backup and authenticate via iam:

dokku mariadb:backup-schedule lolipop "0 3 * * *" my-s3-bucket --use-iam

cat the contents of the configured backup cronfile for the service

# usage
dokku mariadb:backup-schedule-cat <service>

Cat the contents of the configured backup cronfile for the service:

dokku mariadb:backup-schedule-cat lolipop

unschedules the backup of the mariadb service

# usage
dokku mariadb:backup-unschedule <service>

Remove the scheduled backup from cron:

dokku mariadb:backup-unschedule lolipop

Disabling docker pull calls

If you wish to disable the docker pull calls that the plugin triggers, you may set the MARIADB_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 pull is disabled.