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 rabbitmq plugin for dokku

License

NotificationsYou must be signed in to change notification settings

dokku/dokku-rabbitmq

Repository files navigation

Official rabbitmq plugin for dokku. Currently defaults to installingrabbitmq 4.0.7-management.

Requirements

  • dokku 0.19.x+
  • docker 1.8.x

Installation

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

Commands

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

Basic Usage

create a rabbitmq service

# usagedokku rabbitmq: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 rabbitmq docker container

Create a rabbitmq service named lollipop:

dokku rabbitmq:create lollipop

You can also specify the image and image version to use for the service. Itmust be compatible with the rabbitmq image.

export RABBITMQ_IMAGE="rabbitmq"export RABBITMQ_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"dokku rabbitmq:create lollipop

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

export RABBITMQ_CUSTOM_ENV="USER=alpha;HOST=beta"dokku rabbitmq:create lollipop

print the service information

# usagedokku rabbitmq: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 rabbitmq:info lollipop

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

dokku rabbitmq:info lollipop --config-dirdokku rabbitmq:info lollipop --data-dirdokku rabbitmq:info lollipop --dsndokku rabbitmq:info lollipop --exposed-portsdokku rabbitmq:info lollipop --iddokku rabbitmq:info lollipop --internal-ipdokku rabbitmq:info lollipop --initial-networkdokku rabbitmq:info lollipop --linksdokku rabbitmq:info lollipop --post-create-networkdokku rabbitmq:info lollipop --post-start-networkdokku rabbitmq:info lollipop --service-rootdokku rabbitmq:info lollipop --statusdokku rabbitmq:info lollipop --version

list all rabbitmq services

# usagedokku rabbitmq:list

List all services:

dokku rabbitmq:list

print the most recent log(s) for this service

# usagedokku rabbitmq: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 rabbitmq:logs lollipop

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

dokku rabbitmq:logs lollipop --tail

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

dokku rabbitmq:logs lollipop --tail 5

link the rabbitmq service to the app

# usagedokku rabbitmq: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 rabbitmq 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 rabbitmq: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_RABBITMQ_LOLLIPOP_NAME=/lollipop/DATABASEDOKKU_RABBITMQ_LOLLIPOP_PORT=tcp://172.17.0.1:5672DOKKU_RABBITMQ_LOLLIPOP_PORT_5672_TCP=tcp://172.17.0.1:5672DOKKU_RABBITMQ_LOLLIPOP_PORT_5672_TCP_PROTO=tcpDOKKU_RABBITMQ_LOLLIPOP_PORT_5672_TCP_PORT=5672DOKKU_RABBITMQ_LOLLIPOP_PORT_5672_TCP_ADDR=172.17.0.1

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

RABBITMQ_URL=amqp://lollipop:SOME_PASSWORD@dokku-rabbitmq-lollipop:5672/lollipop

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

It is possible to change the protocol forRABBITMQ_URL by setting the environment variableRABBITMQ_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 RABBITMQ_DATABASE_SCHEME=amqp2dokku rabbitmq:link lollipop playground

This will causeRABBITMQ_URL to be set as:

amqp2://lollipop:SOME_PASSWORD@dokku-rabbitmq-lollipop:5672/lollipop

unlink the rabbitmq service from the app

# usagedokku rabbitmq:unlink<service><app>

flags:

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

You can unlink a rabbitmq service:

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

dokku rabbitmq:unlink lollipop playground

set or clear a property for a service

# usagedokku rabbitmq:set<service><key><value>

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

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

Set multiple networks:

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

Unset the post-create-network value:

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

# usagedokku rabbitmq: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 rabbitmq:enter lollipop

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

dokku rabbitmq:enter lollipop touch /tmp/test

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

# usagedokku rabbitmq: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 rabbitmq:expose lollipop 5672 4369 35197 15672

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

dokku rabbitmq:expose lollipop 127.0.0.1:5672 4369 35197 15672

unexpose a previously exposed rabbitmq service

# usagedokku rabbitmq:unexpose<service>

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

dokku rabbitmq:unexpose lollipop

promote service as RABBITMQ_URL in

# usagedokku rabbitmq:promote<service><app>

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

DOKKU_RABBITMQ_BLUE_URL=amqp://other_service:ANOTHER_PASSWORD@dokku-rabbitmq-other-service:5672/other_service

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

NOTE: this will restart your app

dokku rabbitmq:promote other_service playground

This will replaceRABBITMQ_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:

RABBITMQ_URL=amqp://other_service:ANOTHER_PASSWORD@dokku-rabbitmq-other-service:5672/other_serviceDOKKU_RABBITMQ_BLUE_URL=amqp://other_service:ANOTHER_PASSWORD@dokku-rabbitmq-other-service:5672/other_serviceDOKKU_RABBITMQ_SILVER_URL=amqp://lollipop:SOME_PASSWORD@dokku-rabbitmq-lollipop:5672/lollipop

start a previously stopped rabbitmq service

# usagedokku rabbitmq:start<service>

Start the service:

dokku rabbitmq:start lollipop

stop a running rabbitmq service

# usagedokku rabbitmq:stop<service>

Stop the service and removes the running container:

dokku rabbitmq:stop lollipop

pause a running rabbitmq service

# usagedokku rabbitmq:pause<service>

Pause the running container for the service:

dokku rabbitmq:pause lollipop

graceful shutdown and restart of the rabbitmq service container

# usagedokku rabbitmq:restart<service>

Restart the service:

dokku rabbitmq:restart lollipop

upgrade service to the specified versions

# usagedokku rabbitmq: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 rabbitmq docker container

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

dokku rabbitmq:upgrade lollipop

Service Automation

Service scripting can be executed using the following commands:

list all rabbitmq service links for a given app

# usagedokku rabbitmq:app-links<app>

List all rabbitmq services that are linked to theplayground app.

dokku rabbitmq:app-links playground

check if the rabbitmq service exists

# usagedokku rabbitmq:exists<service>

Here we check if the lollipop rabbitmq service exists.

dokku rabbitmq:exists lollipop

check if the rabbitmq service is linked to an app

# usagedokku rabbitmq:linked<service><app>

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

dokku rabbitmq:linked lollipop playground

list all apps linked to the rabbitmq service

# usagedokku rabbitmq:links<service>

List all apps linked to thelollipop rabbitmq service.

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

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

Set theGPG Public Key for encrypting backups:

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

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

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

Unset theGPG Public Key encryption for backups:

dokku rabbitmq: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 theRABBITMQ_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