Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up

a graphite, grafana, statsd, carbon plugin for dokku

License

NotificationsYou must be signed in to change notification settings

dokku/dokku-graphite

Repository files navigation

Official graphite plugin for dokku. Currently defaults to installingdokku/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 --name graphite

Commands

graphite:app-links <app>                           # list all graphite service links for a given appgraphite:backup-set-public-key-encryption <service> <public-key-id> # set GPG Public Key encryption for all future backups of graphite servicegraphite:backup-unset-public-key-encryption <service> # unset GPG Public Key encryption for future backups of the graphite servicegraphite:create <service> [--create-flags...]      # create a graphite servicegraphite:destroy <service> [-f|--force]            # delete the graphite service/data/container if there are no links leftgraphite:enter <service>                           # enter or run a command in a running graphite service containergraphite:exists <service>                          # check if the graphite service existsgraphite: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 informationgraphite:link <service> <app> [--link-flags...]    # link the graphite service to the appgraphite:linked <service> <app>                    # check if the graphite service is linked to an appgraphite:links <service>                           # list all apps linked to the graphite servicegraphite:list                                      # list all graphite servicesgraphite:logs <service> [-t|--tail] <tail-num-optional> # print the most recent log(s) for this servicegraphite:nginx-expose <service> <domain>           # expose the graphite service's grafana via an nginx vhostgraphite:nginx-unexpose <service>                  # expose the graphite service's grafana via an nginx vhostgraphite:pause <service>                           # pause a running graphite servicegraphite:promote <service> <app>                   # promote service <service> as STATSD_URL in <app>graphite:restart <service>                         # graceful shutdown and restart of the graphite service containergraphite:set <service> <key> <value>               # set or clear a property for a servicegraphite:start <service>                           # start a previously stopped graphite servicegraphite:stop <service>                            # stop a running graphite servicegraphite:unexpose <service>                        # unexpose a previously exposed graphite servicegraphite:unlink <service> <app>                    # unlink the graphite service from the appgraphite: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 thedocs/ folder is used to generate the plugin documentation. Please consult thegraphite:help command for any undocumented commands.

Basic Usage

create a graphite service

# usagedokku 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. Itmust 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

# usagedokku 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-dirdokku graphite:info lollipop --data-dirdokku graphite:info lollipop --dsndokku graphite:info lollipop --exposed-portsdokku graphite:info lollipop --iddokku graphite:info lollipop --internal-ipdokku graphite:info lollipop --initial-networkdokku graphite:info lollipop --linksdokku graphite:info lollipop --post-create-networkdokku graphite:info lollipop --post-start-networkdokku graphite:info lollipop --service-rootdokku graphite:info lollipop --statusdokku graphite:info lollipop --version

list all graphite services

# usagedokku graphite:list

List all services:

dokku graphite:list

print the most recent log(s) for this service

# usagedokku 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

# usagedokku 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 ourplayground 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/DATABASEDOKKU_STATSD_LOLLIPOP_PORT=tcp://172.17.0.1:8125DOKKU_STATSD_LOLLIPOP_PORT_8125_TCP=tcp://172.17.0.1:8125DOKKU_STATSD_LOLLIPOP_PORT_8125_TCP_PROTO=tcpDOKKU_STATSD_LOLLIPOP_PORT_8125_TCP_PORT=8125DOKKU_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 theexpose subcommand. Another service can be linked to your app:

dokku graphite:link other_service playground

It is possible to change the protocol forSTATSD_URL by setting the environment variableSTATSD_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=statsd2dokku graphite:link lollipop playground

This will causeSTATSD_URL to be set as:

statsd2://dokku-graphite-lollipop:8125

unlink the graphite service from the app

# usagedokku 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

# usagedokku 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

# usagedokku 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 tomoby/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)

# usagedokku 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

# usagedokku 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

# usagedokku 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 replaceSTATSD_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_serviceDOKKU_STATSD_BLUE_URL=statsd://other_service:ANOTHER_PASSWORD@dokku-graphite-other-service:8125/other_serviceDOKKU_STATSD_SILVER_URL=statsd://lollipop:SOME_PASSWORD@dokku-graphite-lollipop:8125/lollipop

start a previously stopped graphite service

# usagedokku graphite:start<service>

Start the service:

dokku graphite:start lollipop

stop a running graphite service

# usagedokku graphite:stop<service>

Stop the service and removes the running container:

dokku graphite:stop lollipop

pause a running graphite service

# usagedokku graphite:pause<service>

Pause the running container for the service:

dokku graphite:pause lollipop

graceful shutdown and restart of the graphite service container

# usagedokku graphite:restart<service>

Restart the service:

dokku graphite:restart lollipop

upgrade service to the specified versions

# usagedokku 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

# usagedokku graphite:app-links<app>

List all graphite services that are linked to theplayground app.

dokku graphite:app-links playground

check if the graphite service exists

# usagedokku 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

# usagedokku graphite:linked<service><app>

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

dokku graphite:linked lollipop playground

list all apps linked to the graphite service

# usagedokku graphite:links<service>

List all apps linked to thelollipop graphite service.

dokku graphite:links lollipop

Backups

Datastore backups are supported via AWS S3 and S3 compatible services likeminio.

You may skip thebackup-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 thebackup command.

Backups can be performed using the backup commands:

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

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

Set theGPG 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

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

Unset theGPG Public Key encryption for backups:

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

Disablingdocker image pull calls

If you wish to disable thedocker image pull calls that the plugin triggers, you may set theGRAPHITE_DISABLE_PULL environment variable totrue. Once disabled, you will need to pull the service image you wish to deploy as shown in thestderr output.

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

[8]ページ先頭
©2009-2025 Movatter.jp