Skip to content

Latest commit

 

History

History
539 lines (383 loc) · 16.5 KB

README.md

File metadata and controls

539 lines (383 loc) · 16.5 KB
Raw

dokku pushpin Build Status IRC Network

Official pushpin plugin for dokku. Currently defaults to installing fanout/pushpin 1.40.1.

Requirements

  • dokku 0.19.x+
  • docker 1.8.x

Installation

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

Commands

pushpin:app-links <app>                            # list all pushpin service links for a given app
pushpin:backup-set-public-key-encryption <service> <public-key-id> # set GPG Public Key encryption for all future backups of pushpin service
pushpin:backup-unset-public-key-encryption <service> # unset GPG Public Key encryption for future backups of the pushpin service
pushpin:create <service> [--create-flags...]       # create a pushpin service
pushpin:destroy <service> [-f|--force]             # delete the pushpin service/data/container if there are no links left
pushpin:enter <service>                            # enter or run a command in a running pushpin service container
pushpin:exists <service>                           # check if the pushpin service exists
pushpin:expose <service> <ports...>                # expose a pushpin service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)
pushpin:info <service> [--single-info-flag]        # print the service information
pushpin:link <service> <app> [--link-flags...]     # link the pushpin service to the app
pushpin:linked <service> <app>                     # check if the pushpin service is linked to an app
pushpin:links <service>                            # list all apps linked to the pushpin service
pushpin:list                                       # list all pushpin services
pushpin:logs <service> [-t|--tail] <tail-num-optional> # print the most recent log(s) for this service
pushpin:pause <service>                            # pause a running pushpin service
pushpin:promote <service> <app>                    # promote service <service> as WEBSOCKET_URL in <app>
pushpin:restart <service>                          # graceful shutdown and restart of the pushpin service container
pushpin:set <service> <key> <value>                # set or clear a property for a service
pushpin:start <service>                            # start a previously stopped pushpin service
pushpin:stop <service>                             # stop a running pushpin service
pushpin:unexpose <service>                         # unexpose a previously exposed pushpin service
pushpin:unlink <service> <app>                     # unlink the pushpin service from the app
pushpin: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 pushpin:help. Plugin help output in conjunction with any files in the docs/ folder is used to generate the plugin documentation. Please consult the pushpin:help command for any undocumented commands.

Basic Usage

create a pushpin service

# usage
dokku pushpin: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 pushpin docker container

Create a pushpin service named lollipop:

dokku pushpin:create lollipop

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

export PUSHPIN_IMAGE="fanout/pushpin"
export PUSHPIN_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
dokku pushpin:create lollipop

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

export PUSHPIN_CUSTOM_ENV="USER=alpha;HOST=beta"
dokku pushpin:create lollipop

print the service information

# usage
dokku pushpin: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 pushpin:info lollipop

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

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

list all pushpin services

# usage
dokku pushpin:list

List all services:

dokku pushpin:list

print the most recent log(s) for this service

# usage
dokku pushpin: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 pushpin:logs lollipop

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

dokku pushpin:logs lollipop --tail

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

dokku pushpin:logs lollipop --tail 5

link the pushpin service to the app

# usage
dokku pushpin: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 pushpin 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 pushpin: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_PUSHPIN_LOLLIPOP_NAME=/lollipop/DATABASE
DOKKU_PUSHPIN_LOLLIPOP_PORT=tcp://172.17.0.1:5561
DOKKU_PUSHPIN_LOLLIPOP_PORT_5561_TCP=tcp://172.17.0.1:5561
DOKKU_PUSHPIN_LOLLIPOP_PORT_5561_TCP_PROTO=tcp
DOKKU_PUSHPIN_LOLLIPOP_PORT_5561_TCP_PORT=5561
DOKKU_PUSHPIN_LOLLIPOP_PORT_5561_TCP_ADDR=172.17.0.1

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

WEBSOCKET_URL=websocket://dokku-pushpin-lollipop:5561/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 pushpin:link other_service playground

It is possible to change the protocol for WEBSOCKET_URL by setting the environment variable PUSHPIN_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 PUSHPIN_DATABASE_SCHEME=websocket2
dokku pushpin:link lollipop playground

This will cause WEBSOCKET_URL to be set as:

websocket2://dokku-pushpin-lollipop:5561/lollipop

unlink the pushpin service from the app

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

flags:

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

You can unlink a pushpin service:

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

dokku pushpin:unlink lollipop playground

set or clear a property for a service

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

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

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

Set multiple networks:

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

Unset the post-create-network value:

dokku pushpin:set lollipop post-create-network

Service Lifecycle

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

enter or run a command in a running pushpin service container

# usage
dokku pushpin: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 pushpin:enter lollipop

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

dokku pushpin:enter lollipop touch /tmp/test

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

# usage
dokku pushpin: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 pushpin:expose lollipop 5561 7999 5560 5562 5563

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

dokku pushpin:expose lollipop 127.0.0.1:5561 7999 5560 5562 5563

unexpose a previously exposed pushpin service

# usage
dokku pushpin:unexpose <service>

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

dokku pushpin:unexpose lollipop

promote service as WEBSOCKET_URL in 

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

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

DOKKU_WEBSOCKET_BLUE_URL=websocket://other_service:ANOTHER_PASSWORD@dokku-pushpin-other-service:5561/other_service

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

NOTE: this will restart your app

dokku pushpin:promote other_service playground

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

WEBSOCKET_URL=websocket://other_service:ANOTHER_PASSWORD@dokku-pushpin-other-service:5561/other_service
DOKKU_WEBSOCKET_BLUE_URL=websocket://other_service:ANOTHER_PASSWORD@dokku-pushpin-other-service:5561/other_service
DOKKU_WEBSOCKET_SILVER_URL=websocket://lollipop:SOME_PASSWORD@dokku-pushpin-lollipop:5561/lollipop

start a previously stopped pushpin service

# usage
dokku pushpin:start <service>

Start the service:

dokku pushpin:start lollipop

stop a running pushpin service

# usage
dokku pushpin:stop <service>

Stop the service and removes the running container:

dokku pushpin:stop lollipop

pause a running pushpin service

# usage
dokku pushpin:pause <service>

Pause the running container for the service:

dokku pushpin:pause lollipop

graceful shutdown and restart of the pushpin service container

# usage
dokku pushpin:restart <service>

Restart the service:

dokku pushpin:restart lollipop

upgrade service to the specified versions

# usage
dokku pushpin: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 pushpin docker container

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

dokku pushpin:upgrade lollipop

Service Automation

Service scripting can be executed using the following commands:

list all pushpin service links for a given app

# usage
dokku pushpin:app-links <app>

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

dokku pushpin:app-links playground

check if the pushpin service exists

# usage
dokku pushpin:exists <service>

Here we check if the lollipop pushpin service exists.

dokku pushpin:exists lollipop

check if the pushpin service is linked to an app

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

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

dokku pushpin:linked lollipop playground

list all apps linked to the pushpin service

# usage
dokku pushpin:links <service>

List all apps linked to the lollipop pushpin service.

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

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

Set the GPG Public Key for encrypting backups:

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

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

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

Unset the GPG Public Key encryption for backups:

dokku pushpin: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 PUSHPIN_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.