knubie / dokku-couchdb

a couchdb plugin for dokku

dokku couchdb

Official couchdb plugin for dokku. Currently defaults to installing couchdb 2.3.1.

Requirements

• dokku 0.12.x+
• docker 1.8.x

Installation

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

Commands

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

Basic Usage

create a couchdb service

# usage
dokku couchdb: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 couchdb service named lolipop:

dokku couchdb:create lolipop

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

export COUCHDB_IMAGE="couchdb"
export COUCHDB_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
dokku couchdb:create lolipop

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

export COUCHDB_CUSTOM_ENV="USER=alpha;HOST=beta"
dokku couchdb:create lolipop

print the service information

# usage
dokku couchdb: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 couchdb:info lolipop

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

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

list all couchdb services

# usage
dokku couchdb:list 

List all services:

dokku couchdb:list

print the most recent log(s) for this service

# usage
dokku couchdb: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 couchdb:logs lolipop

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

dokku couchdb:logs lolipop --tail

link the couchdb service to the app

# usage
dokku couchdb: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 couchdb 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 couchdb: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_COUCHDB_LOLIPOP_NAME=/lolipop/DATABASE
DOKKU_COUCHDB_LOLIPOP_PORT=tcp://172.17.0.1:5984
DOKKU_COUCHDB_LOLIPOP_PORT_5984_TCP=tcp://172.17.0.1:5984
DOKKU_COUCHDB_LOLIPOP_PORT_5984_TCP_PROTO=tcp
DOKKU_COUCHDB_LOLIPOP_PORT_5984_TCP_PORT=5984
DOKKU_COUCHDB_LOLIPOP_PORT_5984_TCP_ADDR=172.17.0.1

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

COUCHDB_URL=http://lolipop:SOME_PASSWORD@dokku-couchdb-lolipop:5984/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 couchdb:link other_service playground

It is possible to change the protocol for COUCHDB_URL by setting the environment variable COUCHDB_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 COUCHDB_DATABASE_SCHEME=http2
dokku couchdb:link lolipop playground

This will cause COUCHDB_URL to be set as:

http2://lolipop:SOME_PASSWORD@dokku-couchdb-lolipop:5984/lolipop

unlink the couchdb service from the app

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

You can unlink a couchdb service:

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

dokku couchdb:unlink lolipop playground

Service Lifecycle

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

connect to the service via the couchdb connection tool

# usage
dokku couchdb:connect <service>

Connect to the service via the couchdb connection tool:

dokku couchdb:connect lolipop

enter or run a command in a running couchdb service container

# usage
dokku couchdb:enter <service>

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

dokku couchdb:enter lolipop

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

dokku couchdb:enter lolipop touch /tmp/test

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

# usage
dokku couchdb: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 couchdb:expose lolipop 5984

unexpose a previously exposed couchdb service

# usage
dokku couchdb:unexpose <service>

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

dokku couchdb:unexpose lolipop

promote service as COUCHDB_URL in

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

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

DOKKU_COUCHDB_BLUE_URL=http://other_service:ANOTHER_PASSWORD@dokku-couchdb-other-service:5984/other_service

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

NOTE: this will restart your app

dokku couchdb:promote other_service playground

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

COUCHDB_URL=http://other_service:ANOTHER_PASSWORD@dokku-couchdb-other-service:5984/other_service
DOKKU_COUCHDB_BLUE_URL=http://other_service:ANOTHER_PASSWORD@dokku-couchdb-other-service:5984/other_service
DOKKU_COUCHDB_SILVER_URL=http://lolipop:SOME_PASSWORD@dokku-couchdb-lolipop:5984/lolipop

start a previously stopped couchdb service

# usage
dokku couchdb:start <service>

Start the service:

dokku couchdb:start lolipop

stop a running couchdb service

# usage
dokku couchdb:stop <service>

Stop the service and the running container:

dokku couchdb:stop lolipop

graceful shutdown and restart of the couchdb service container

# usage
dokku couchdb:restart <service>

Restart the service:

dokku couchdb:restart lolipop

upgrade service to the specified versions

# usage
dokku couchdb: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 couchdb:upgrade lolipop

Service Automation

Service scripting can be executed using the following commands:

list all couchdb service links for a given app

# usage
dokku couchdb:app-links <app>

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

dokku couchdb:app-links playground

create container then copy data from into

# usage
dokku couchdb: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 couchdb:clone lolipop lolipop-2

check if the couchdb service exists

# usage
dokku couchdb:exists <service>

Here we check if the lolipop couchdb service exists.

dokku couchdb:exists lolipop

check if the couchdb service is linked to an app

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

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

dokku couchdb:linked lolipop playground

list all apps linked to the couchdb service

# usage
dokku couchdb:links <service>

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

dokku couchdb:links lolipop

Data Management

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

import a dump into the couchdb service database

# usage
dokku couchdb:import <service>

Import a datastore dump:

dokku couchdb:import lolipop < database.dump

export a dump of the couchdb service database

# usage
dokku couchdb:export <service>

By default, datastore output is exported to stdout:

dokku couchdb:export lolipop

You can redirect this output to a file:

dokku couchdb: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 couchdb service

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

Setup s3 backup authentication:

dokku couchdb:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY

Setup s3 backup authentication with different region:

dokku couchdb:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION

Setup s3 backup authentication with different signature version and endpoint:

dokku couchdb: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 couchdb:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE

removes backup authentication for the couchdb service

# usage
dokku couchdb:backup-deauth <service>

Remove s3 authentication:

dokku couchdb:backup-deauth lolipop

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

# usage
dokku couchdb: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 couchdb:backup lolipop my-s3-bucket --use-iam

sets encryption for all future backups of couchdb service

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

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

dokku couchdb:backup-set-encryption lolipop

unsets encryption for future backups of the couchdb service

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

Unset the GPG encryption passphrase for backups:

dokku couchdb:backup-unset-encryption lolipop

schedules a backup of the couchdb service

# usage
dokku couchdb: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 couchdb:backup-schedule lolipop "0 3 * * *" my-s3-bucket

Schedule a backup and authenticate via iam:

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

cat the contents of the configured backup cronfile for the service

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

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

dokku couchdb:backup-schedule-cat lolipop

unschedules the backup of the couchdb service

# usage
dokku couchdb:backup-unschedule <service>

Remove the scheduled backup from cron:

dokku couchdb:backup-unschedule lolipop

Disabling docker pull calls

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