Skip to content

Latest commit

 

History

History
541 lines (385 loc) · 16.8 KB

README.md

File metadata and controls

541 lines (385 loc) · 16.8 KB
Raw

dokku graphite Build Status IRC Network

Official graphite plugin for dokku. Currently defaults to installing dokku/docker-grafana-graphite 6.4.4.

Requirements

  • dokku 0.19.x+
  • docker 1.8.x

Installation

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

Commands

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

Basic Usage

create a graphite service

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

Create a graphite service named lollipop:

dokku graphite:create lollipop

You can also specify the image and image version to use for the service. It must be compatible with the dokku/docker-grafana-graphite image.

export STATSD_IMAGE="dokku/docker-grafana-graphite"
export STATSD_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
dokku graphite:create lollipop

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

export STATSD_CUSTOM_ENV="USER=alpha;HOST=beta"
dokku graphite:create lollipop

print the service information

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

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

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

list all graphite services

# usage
dokku graphite:list

List all services:

dokku graphite:list

print the most recent log(s) for this service

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

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

dokku graphite:logs lollipop --tail

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

dokku graphite:logs lollipop --tail 5

link the graphite service to the app

# usage
dokku graphite: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 graphite 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 graphite: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_STATSD_LOLLIPOP_NAME=/lollipop/DATABASE
DOKKU_STATSD_LOLLIPOP_PORT=tcp://172.17.0.1:8125
DOKKU_STATSD_LOLLIPOP_PORT_8125_TCP=tcp://172.17.0.1:8125
DOKKU_STATSD_LOLLIPOP_PORT_8125_TCP_PROTO=tcp
DOKKU_STATSD_LOLLIPOP_PORT_8125_TCP_PORT=8125
DOKKU_STATSD_LOLLIPOP_PORT_8125_TCP_ADDR=172.17.0.1

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

STATSD_URL=statsd://dokku-graphite-lollipop:8125

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

It is possible to change the protocol for STATSD_URL by setting the environment variable STATSD_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 STATSD_DATABASE_SCHEME=statsd2
dokku graphite:link lollipop playground

This will cause STATSD_URL to be set as:

statsd2://dokku-graphite-lollipop:8125

unlink the graphite service from the app

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

flags:

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

You can unlink a graphite service:

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

dokku graphite:unlink lollipop playground

set or clear a property for a service

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

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

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

Set multiple networks:

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

Unset the post-create-network value:

dokku graphite: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 graphite service container

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

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

dokku graphite:enter lollipop touch /tmp/test

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

# usage
dokku graphite: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 graphite:expose lollipop 8125 8126 80 81 2003

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

dokku graphite:expose lollipop 127.0.0.1:8125 8126 80 81 2003

unexpose a previously exposed graphite service

# usage
dokku graphite:unexpose <service>

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

dokku graphite:unexpose lollipop

promote service as STATSD_URL in 

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

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

DOKKU_STATSD_BLUE_URL=statsd://other_service:ANOTHER_PASSWORD@dokku-graphite-other-service:8125/other_service

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

NOTE: this will restart your app

dokku graphite:promote other_service playground

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

STATSD_URL=statsd://other_service:ANOTHER_PASSWORD@dokku-graphite-other-service:8125/other_service
DOKKU_STATSD_BLUE_URL=statsd://other_service:ANOTHER_PASSWORD@dokku-graphite-other-service:8125/other_service
DOKKU_STATSD_SILVER_URL=statsd://lollipop:SOME_PASSWORD@dokku-graphite-lollipop:8125/lollipop

start a previously stopped graphite service

# usage
dokku graphite:start <service>

Start the service:

dokku graphite:start lollipop

stop a running graphite service

# usage
dokku graphite:stop <service>

Stop the service and removes the running container:

dokku graphite:stop lollipop

pause a running graphite service

# usage
dokku graphite:pause <service>

Pause the running container for the service:

dokku graphite:pause lollipop

graceful shutdown and restart of the graphite service container

# usage
dokku graphite:restart <service>

Restart the service:

dokku graphite:restart lollipop

upgrade service to the specified versions

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

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

dokku graphite:upgrade lollipop

Service Automation

Service scripting can be executed using the following commands:

list all graphite service links for a given app

# usage
dokku graphite:app-links <app>

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

dokku graphite:app-links playground

check if the graphite service exists

# usage
dokku graphite:exists <service>

Here we check if the lollipop graphite service exists.

dokku graphite:exists lollipop

check if the graphite service is linked to an app

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

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

dokku graphite:linked lollipop playground

list all apps linked to the graphite service

# usage
dokku graphite:links <service>

List all apps linked to the lollipop graphite service.

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

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

Set the GPG Public Key for encrypting backups:

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

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

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

Unset the GPG Public Key encryption for backups:

dokku graphite: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 GRAPHITE_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.