diff --git a/.travis.yml b/.travis.yml index 7307069..cef07e1 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,5 +5,15 @@ env: - DOKKU_VERSION=v0.19.0 install: make setup before_script: sudo sysctl -w vm.max_map_count=262144 -script: make test +script: + # Check that README etc. is up to date + - > + make generate; + if [[ $(git diff) ]]; then + echo "Please run `make generate`"; + git status --short; + git diff; + exit 1; + fi + - make test after_failure: make report diff --git a/Makefile b/Makefile index 6bea3ce..e908c94 100644 --- a/Makefile +++ b/Makefile @@ -93,3 +93,14 @@ ifneq ($(TRAVIS_PULL_REQUEST),false) endif endif endif + +.PHONY: clean +clean: + rm -f README.md + +.PHONY: generate +generate: clean README.md + +.PHONY: README.md +README.md: + bin/generate diff --git a/README.md b/README.md index 2c86800..dbee62c 100644 --- a/README.md +++ b/README.md @@ -2,77 +2,121 @@ Official postgres plugin for dokku. Currently defaults to installing [postgres 11.6](https://hub.docker.com/_/postgres/). -## requirements +## Requirements - dokku 0.12.x+ - docker 1.8.x -## installation +## Installation ```shell # on 0.12.x+ sudo dokku plugin:install https://github.com/dokku/dokku-postgres.git postgres ``` -## commands +## Commands ``` -postgres:app-links List all postgres service links for a given app -postgres:backup (--use-iam) Create a backup of the postgres service to an existing s3 bucket -postgres:backup-auth () () () Sets up authentication for backups on the postgres service -postgres:backup-deauth Removes backup authentication for the postgres service -postgres:backup-schedule Schedules a backup of the postgres service -postgres:backup-schedule-cat Show the backup schedule for the service -postgres:backup-set-encryption Set a GPG passphrase for backups -postgres:backup-unschedule Unschedules the backup of the postgres service -postgres:backup-unset-encryption Removes backup encryption for future backups of the postgres service -postgres:clone Create container then copy data from into -postgres:connect Connect via psql to a postgres service -postgres:create Create a postgres service with environment variables -postgres:destroy Delete the service, delete the data and stop its container if there are no links left -postgres:enter [command] Enter or run a command in a running postgres service container -postgres:exists Check if the postgres service exists -postgres:export > Export a dump of the postgres service database -postgres:expose [port] Expose a postgres service on custom port if provided (random port otherwise) -postgres:import < Import a dump into the postgres service database -postgres:info Print the connection information -postgres:link Link the postgres service to the app -postgres:linked Check if the postgres service is linked to an app -postgres:list List all postgres services -postgres:logs [-t] Print the most recent log(s) for this service -postgres:promote Promote service as DATABASE_URL in -postgres:restart Graceful shutdown and restart of the postgres service container -postgres:start Start a previously stopped postgres service -postgres:stop Stop a running postgres service -postgres:unexpose Unexpose a previously exposed postgres service -postgres:unlink Unlink the postgres service from the app -postgres:upgrade Upgrade service to the specified version +postgres:app-links # list all postgres service links for a given app +postgres:backup [--use-iam] # creates a backup of the postgres service to an existing s3 bucket +postgres:backup-auth # sets up authentication for backups on the postgres service +postgres:backup-deauth # removes backup authentication for the postgres service +postgres:backup-schedule [--use-iam] # schedules a backup of the postgres service +postgres:backup-schedule-cat # cat the contents of the configured backup cronfile for the service +postgres:backup-set-encryption # sets encryption for all future backups of postgres service +postgres:backup-unschedule # unschedules the backup of the postgres service +postgres:backup-unset-encryption # unsets encryption for future backups of the postgres service +postgres:clone [--clone-flags...] # create container then copy data from into +postgres:connect # connect to the service via the postgres connection tool +postgres:create [--create-flags...] # create a postgres service +postgres:destroy [-f|--force] # delete the postgres service/data/container if there are no links left +postgres:enter # enter or run a command in a running postgres service container +postgres:exists # check if the postgres service exists +postgres:export # export a dump of the postgres service database +postgres:expose # expose a postgres service on custom port if provided (random port otherwise) +postgres:import # import a dump into the postgres service database +postgres:info [--single-info-flag] # print the connection information +postgres:link [--link-flags...] # link the postgres service to the app +postgres:linked # check if the postgres service is linked to an app +postgres:links # list all apps linked to the postgres service +postgres:list # list all postgres services +postgres:logs [-t|--tail] # print the most recent log(s) for this service +postgres:promote # promote service as DATABASE_URL in +postgres:restart # graceful shutdown and restart of the postgres service container +postgres:start # start a previously stopped postgres service +postgres:stop # stop a running postgres service +postgres:unexpose # unexpose a previously exposed postgres service +postgres:unlink # unlink the postgres service from the app +postgres:upgrade [--upgrade-flags...] # upgrade service to the specified versions ``` -## usage +## Usage + +Help for any commands can be displayed by specifying the command as an argument to postgres:help. Please consult the `postgres:help` command for any undocumented commands. + +### Basic Usage +### list all postgres services ```shell -# create a postgres service named lolipop -dokku postgres:create lolipop +# usage +dokku postgres:list +``` -# you can also specify the image and image -# version to use for the service -# it *must* be compatible with the -# official postgres image -export POSTGRES_IMAGE="postgres" -export POSTGRES_IMAGE_VERSION="11.6" -dokku postgres:create lolipop +examples: -# you can also specify custom environment -# variables to start the postgres service -# in semi-colon separated form -export POSTGRES_CUSTOM_ENV="USER=alpha;HOST=beta" -dokku postgres:create lolipop +List all services: -# get connection information as follows +```shell +dokku postgres:list +``` +### create a postgres service + +```shell +# usage +dokku postgres:create [--create-flags...] +``` + +examples: + +Create a postgres service named lolipop: + +```shell +dokku postgres:create lolipop +``` + +You can also specify the image and image version to use for the service. It *must* be compatible with the ${plugin_image} image. : + +```shell +export DATABASE_IMAGE="${PLUGIN_IMAGE}" +export DATABASE_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}" +dokku postgres:create lolipop +``` + +You can also specify custom environment variables to start the postgres service in semi-colon separated form. : + +```shell +export DATABASE_CUSTOM_ENV="USER=alpha;HOST=beta" +dokku postgres:create lolipop +``` +### print the connection information + +```shell +# usage +dokku postgres:info [--single-info-flag] +``` + +examples: + +Get connection information as follows: + +```shell dokku postgres:info lolipop +``` -# you can also retrieve a specific piece of service info via flags +You can also retrieve a specific piece of service info via flags: + +```shell +dokku postgres:info lolipop --config-dir dokku postgres:info lolipop --data-dir dokku postgres:info lolipop --dsn dokku postgres:info lolipop --exposed-ports @@ -82,219 +126,526 @@ dokku postgres:info lolipop --links dokku postgres:info lolipop --service-root dokku postgres:info lolipop --status dokku postgres:info lolipop --version +``` +### print the most recent log(s) for this service -# a bash prompt can be opened against a running service -# filesystem changes will not be saved to disk -dokku postgres:enter lolipop +```shell +# usage +dokku postgres:logs [-t|--tail] +``` -# you may also run a command directly against the service -# filesystem changes will not be saved to disk -dokku postgres:enter lolipop ls -lah / +examples: -# a postgres 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 postgres:link lolipop playground +You can tail logs for a particular service: -# 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_POSTGRES_LOLIPOP_NAME=/lolipop/DATABASE -# DOKKU_POSTGRES_LOLIPOP_PORT=tcp://172.17.0.1:5432 -# DOKKU_POSTGRES_LOLIPOP_PORT_5432_TCP=tcp://172.17.0.1:5432 -# DOKKU_POSTGRES_LOLIPOP_PORT_5432_TCP_PROTO=tcp -# DOKKU_POSTGRES_LOLIPOP_PORT_5432_TCP_PORT=5432 -# DOKKU_POSTGRES_LOLIPOP_PORT_5432_TCP_ADDR=172.17.0.1 -# -# and the following will be set on the linked application by default -# -# DATABASE_URL=postgres://postgres:SOME_PASSWORD@dokku-postgres-lolipop:5432/lolipop -# -# NOTE: the host exposed here only works internally in docker containers. If -# you want your container to be reachable from outside, you should use `expose`. - -# another service can be linked to your app -dokku postgres:link other_service playground - -# since DATABASE_URL is already in use, another environment variable will be -# generated automatically -# -# DOKKU_POSTGRES_BLUE_URL=postgres://postgres:ANOTHER_PASSWORD@dokku-postgres-other_service:5432/other_service - -# you can then promote the new service to be the primary one -# NOTE: this will restart your app -dokku postgres:promote other_service playground - -# this will replace DATABASE_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: -# -# DATABASE_URL=postgres://postgres:ANOTHER_PASSWORD@dokku-postgres-other_service:5432/other_service -# DOKKU_POSTGRES_BLUE_URL=postgres://postgres:ANOTHER_PASSWORD@dokku-postgres-other_service:5432/other_service -# DOKKU_POSTGRES_SILVER_URL=postgres://postgres:SOME_PASSWORD@dokku-postgres-lolipop:5432/lolipop - -# you can also unlink a postgres service -# NOTE: this will restart your app and unset related environment variables -dokku postgres:unlink lolipop playground - -# you can tail logs for a particular service +```shell dokku postgres:logs lolipop -dokku postgres:logs lolipop -t # to tail +``` -# you can dump the database -dokku postgres:export lolipop > lolipop.dump +By default, logs will not be tailed, but you can do this with the --tail flag: -# you can import a dump -dokku postgres:import lolipop < database.dump +```shell +dokku postgres:logs lolipop --tail +``` +### link the postgres service to the app -# you can clone an existing database to a new one -dokku postgres:clone lolipop new_database +```shell +# usage +dokku postgres:link [--link-flags...] +``` -# finally, you can destroy the container +examples: + +A postgres 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 + +```shell +dokku postgres: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_DATABASE_LOLIPOP_NAME=/lolipop/DATABASE +DOKKU_DATABASE_LOLIPOP_PORT=tcp://172.17.0.1:5432 +DOKKU_DATABASE_LOLIPOP_PORT_5432_TCP=tcp://172.17.0.1:5432 +DOKKU_DATABASE_LOLIPOP_PORT_5432_TCP_PROTO=tcp +DOKKU_DATABASE_LOLIPOP_PORT_5432_TCP_PORT=5432 +DOKKU_DATABASE_LOLIPOP_PORT_5432_TCP_ADDR=172.17.0.1 +``` + +The following will be set on the linked application by default: + +``` +DATABASE_URL=postgres://lolipop:SOME_PASSWORD@dokku-postgres-lolipop:5432/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: + +```shell +dokku postgres:link other_service playground +``` + +It is possible to change the protocol for database_url by setting the environment variable database_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. : + +```shell +dokku config:set playground DATABASE_DATABASE_SCHEME=postgres2 +dokku postgres:link lolipop playground +``` + +This will cause database_url to be set as: + +``` +postgres2://lolipop:SOME_PASSWORD@dokku-postgres-lolipop:5432/lolipop +``` +### unlink the postgres service from the app + +```shell +# usage +dokku postgres:unlink +``` + +examples: + +You can unlink a postgres service: + +> NOTE: this will restart your app and unset related environment variables + +```shell +dokku postgres:unlink lolipop playground +``` +### delete the postgres service/data/container if there are no links left + +```shell +# usage +dokku postgres:destroy [-f|--force] +``` + +examples: + +Destroy the service, it's data, and the running container: + +```shell dokku postgres:destroy lolipop ``` -## Changing database adapter +### Service Lifecycle -It's possible to change the protocol for DATABASE_URL by setting -the environment variable POSTGRES_DATABASE_SCHEME on the app: +The lifecycle of each service can be managed through the following commands: -``` -dokku config:set playground POSTGRES_DATABASE_SCHEME=postgres2 -dokku postgres:link lolipop playground -``` - -Will cause DATABASE_URL to be set as -postgres2://postgres:SOME_PASSWORD@dokku-postgres-lolipop:5432/lolipop - -CAUTION: Changing POSTGRES_DATABASE_SCHEME after linking will cause dokku to -believe the postgres is not linked when attempting to use `dokku postgres:unlink` -or `dokku postgres:promote`. -You should be able to fix this by - -- Changing DATABASE_URL manually to the new value. - -OR - -- Set POSTGRES_DATABASE_SCHEME back to its original setting -- Unlink the service -- Change POSTGRES_DATABASE_SCHEME to the desired setting -- Relink the service - -## upgrade/downgrade - -At the moment a database can’t be upgraded (or downgraded) inplace. Instead a clone has to be made, like this: +### connect to the service via the postgres connection tool ```shell -# Our original DB using PG 9.5 -$ dokku postgres:create db9.5 - -# Migrate it like this for example -$ POSTGRES_IMAGE_VERSION=9.6 dokku postgres:clone db9.5 db9.6 - -# If it was linked to an application, first link the new DB -$ dokku postgres:link db9.6 my_app -# Then unlink the old one -$ dokku postgres:unlink db9.5 my_app - -# And last, destroy the old container -$ dokku postgres:destroy db9.5 +# usage +dokku postgres:connect ``` -## Configuration +examples: -If you wish to tune the postgres instances various .conf files, you can find them by using the postgres:info command. +Connect to the service via the postgres connection tool: ```shell -dokku postgres:info lolipop -# or -dokku postgres:info lolipop --data-dir +dokku postgres:connect lolipop +``` +### enter or run a command in a running postgres service container + +```shell +# usage +dokku postgres:enter ``` -## Backups +examples: + +A bash prompt can be opened against a running service. Filesystem changes will not be saved to disk. : + +```shell +dokku postgres:enter lolipop +``` + +You may also run a command directly against the service. Filesystem changes will not be saved to disk. : + +```shell +dokku postgres:enter lolipop touch /tmp/test +``` +### expose a postgres service on custom port if provided (random port otherwise) + +```shell +# usage +dokku postgres:expose +``` + +examples: + +Expose the service on the service's normal ports, allowing access to it from the public interface (0. 0. 0. 0): + +```shell +dokku postgres:expose lolipop ${PLUGIN_DATASTORE_PORTS[@]} +``` +### unexpose a previously exposed postgres service + +```shell +# usage +dokku postgres:unexpose +``` + +examples: + +Unexpose the service, removing access to it from the public interface (0. 0. 0. 0): + +```shell +dokku postgres:unexpose lolipop +``` +### promote service as DATABASE_URL in + +```shell +# usage +dokku postgres:promote +``` + +examples: + +If you have a postgres service linked to an app and try to link another postgres service another link environment variable will be generated automatically: + +``` +DOKKU_DATABASE_BLUE_URL=postgres://other_service:ANOTHER_PASSWORD@dokku-postgres-other-service:5432/other_service +``` + +You can promote the new service to be the primary one: + +> NOTE: this will restart your app + +```shell +dokku postgres:promote other_service playground +``` + +This will replace database_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: + +``` +DATABASE_URL=postgres://other_service:ANOTHER_PASSWORD@dokku-postgres-other-service:5432/other_service +DOKKU_DATABASE_BLUE_URL=postgres://other_service:ANOTHER_PASSWORD@dokku-postgres-other-service:5432/other_service +DOKKU_DATABASE_SILVER_URL=postgres://lolipop:SOME_PASSWORD@dokku-postgres-lolipop:5432/lolipop +``` +### graceful shutdown and restart of the postgres service container + +```shell +# usage +dokku postgres:restart +``` + +examples: + +Restart the service: + +```shell +dokku postgres:restart lolipop +``` +### start a previously stopped postgres service + +```shell +# usage +dokku postgres:start +``` + +examples: + +Start the service: + +```shell +dokku postgres:start lolipop +``` +### stop a running postgres service + +```shell +# usage +dokku postgres:stop +``` + +examples: + +Stop the service and the running container: + +```shell +dokku postgres:stop lolipop +``` +### upgrade service to the specified versions + +```shell +# usage +dokku postgres:upgrade [--upgrade-flags...] +``` + +examples: + +You can upgrade an existing service to a new image or image-version: + +```shell +dokku postgres:upgrade lolipop +``` + +### Service Automation + +Service scripting can be executed using the following commands: + +### list all postgres service links for a given app + +```shell +# usage +dokku postgres:app-links +``` + +examples: + +List all postgres services that are linked to the 'playground' app. : + +```shell +dokku postgres:app-links playground +``` +### create container then copy data from into + +```shell +# usage +dokku postgres:clone [--clone-flags...] +``` + +examples: + +You can clone an existing service to a new one: + +```shell +dokku postgres:clone lolipop lolipop-2 +``` +### check if the postgres service exists + +```shell +# usage +dokku postgres:exists +``` + +examples: + +Here we check if the lolipop postgres service exists. : + +```shell +dokku postgres:exists lolipop +``` +### check if the postgres service is linked to an app + +```shell +# usage +dokku postgres:linked +``` + +examples: + +Here we check if the lolipop postgres service is linked to the 'playground' app. : + +```shell +dokku postgres:linked lolipop playground +``` +### list all apps linked to the postgres service + +```shell +# usage +dokku postgres:links +``` + +examples: + +List all apps linked to the 'lolipop' postgres service. : + +```shell +dokku postgres:links lolipop +``` + +### Data Management + +The underlying service data can be imported and exported with the following commands: + +### import a dump into the postgres service database + +```shell +# usage +dokku postgres:import +``` + +examples: + +Import a datastore dump: + +```shell +dokku postgres:import lolipop < database.dump +``` +### export a dump of the postgres service database + +```shell +# usage +dokku postgres:export +``` + +examples: + +By default, datastore output is exported to stdout: + +```shell +dokku postgres:export lolipop +``` + +You can redirect this output to a file: + +```shell +dokku postgres:export lolipop > lolipop.dump +``` + +### Backups Datastore backups are supported via AWS S3 and S3 compatible services like [minio](https://github.com/minio/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. +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 postgres service + +```shell +# usage +dokku postgres:backup-auth ``` -# setup s3 backup authentication + +examples: + +Setup s3 backup authentication: + +```shell dokku postgres:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY +``` -# remove s3 authentication +Setup s3 backup authentication with different region: + +```shell +dokku postgres:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION +``` + +Setup s3 backup authentication with different signature version and endpoint: + +```shell +dokku postgres:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL +``` + +More specific example for minio auth: + +```shell +dokku postgres:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE +``` +### removes backup authentication for the postgres service + +```shell +# usage +dokku postgres:backup-deauth +``` + +examples: + +Remove s3 authentication: + +```shell dokku postgres:backup-deauth lolipop +``` +### creates a backup of the postgres service to an existing s3 bucket -# backup the `lolipop` service to the `BUCKET_NAME` bucket on AWS -dokku postgres:backup lolipop BUCKET_NAME +```shell +# usage +dokku postgres:backup [--use-iam] +``` -# schedule a backup -# CRON_SCHEDULE is a crontab expression, eg. "0 3 * * *" for each day at 3am -dokku postgres:backup-schedule lolipop CRON_SCHEDULE BUCKET_NAME +examples: -# cat the contents of the configured backup cronfile for the service +Backup the 'lolipop' service to the 'my-s3-bucket' bucket on aws: + +```shell +dokku postgres:backup lolipop my-s3-bucket --use-iam +``` +### sets encryption for all future backups of postgres service + +```shell +# usage +dokku postgres:backup-set-encryption +``` + +examples: + +Set a gpg passphrase for backups: + +```shell +dokku postgres:backup-set-encryption lolipop +``` +### unsets encryption for future backups of the postgres service + +```shell +# usage +dokku postgres:backup-unset-encryption +``` + +examples: + +Unset a gpg encryption key for backups: + +```shell +dokku postgres:backup-unset-encryption lolipop +``` +### schedules a backup of the postgres service + +```shell +# usage +dokku postgres:backup-schedule [--use-iam] +``` + +examples: + +Schedule a backup: + +> 'schedule' is a crontab expression, eg. "0 3 * * *" for each day at 3am + +```shell +dokku postgres:backup-schedule lolipop "0 3 * * *" my-s3-bucket +``` + +Schedule a backup and authenticate via iam: + +```shell +dokku postgres:backup-schedule lolipop "0 3 * * *" my-s3-bucket --use-iam +``` +### cat the contents of the configured backup cronfile for the service + +```shell +# usage +dokku postgres:backup-schedule-cat +``` + +examples: + +Cat the contents of the configured backup cronfile for the service: + +```shell dokku postgres:backup-schedule-cat lolipop +``` +### unschedules the backup of the postgres service -# remove the scheduled backup from cron +```shell +# usage +dokku postgres:backup-unschedule +``` + +examples: + +Remove the scheduled backup from cron: + +```shell dokku postgres:backup-unschedule lolipop ``` -Backup auth can also be set up for different regions, signature versions and endpoints (e.g. for minio): - -``` -# setup s3 backup authentication with different region -dokku postgres:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION - -# setup s3 backup authentication with different signature version and endpoint -dokku postgres: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 postgres:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE -``` - -## Importing Data - -The `import` command should be used with any non-plain-text files exported by `pg_dump`. To import a SQL file, use `connect` like this: - -```shell -dokku postgres:connect db < ./dump.sql -``` - -## Security - -The connection to the database is done over SSL. A self-signed certificate is -automatically generated when creating the service. It can be replaced by a -custom certificate by overwriting the `server.crt` and `server.key` files in -`/var/lib/dokku/services/postgres//data`. -The `server.key` must be chmoded to 600 and must be owned by the postgres user -or root. - -## Disabling `docker pull` calls +### Disabling `docker pull` calls If you wish to disable the `docker pull` calls that the plugin triggers, you may set the `POSTGRES_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. - -## Postgis - -Official Postgres docker images doesn't include postgis extension. To be able to use postgis, you will need postgres+postgis docker container compatible with official ones. - -You can use for example `postgis/postgis` container: - -``` -export POSTGRES_IMAGE="postgis/postgis" -export POSTGRES_IMAGE_VERSION="latest" - -dokku postgres:create postgis-database - -dokku postgres:connect postgis-database - -CREATE EXTENSION postgis; -``` - -Reference issue: https://github.com/dokku/dokku-postgres/issues/52 +Please ensure the proper images are in place when `docker pull` is disabled. \ No newline at end of file diff --git a/bin/generate b/bin/generate new file mode 100755 index 0000000..805ee7c --- /dev/null +++ b/bin/generate @@ -0,0 +1,399 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +from __future__ import print_function +import os +import re + + +def header(service): + return " ".join([ + f"# dokku {service}", + f"[![Build Status](https://img.shields.io/travis/dokku/dokku-{service}.svg?branch=master \"Build Status\")](https://travis-ci.org/dokku/dokku-{service})", + f"[![IRC Network](https://img.shields.io/badge/irc-freenode-blue.svg \"IRC Freenode\")](https://webchat.freenode.net/?channels=dokku)", + ]) + + +def description(service, version): + return f"Official {service} plugin for dokku. Currently defaults to installing [{service} {version}](https://hub.docker.com/_/{service}/)." + + +def requirements(dokku_version): + return "\n".join([ + "## Requirements", + "", + f"- dokku {dokku_version}", + "- docker 1.8.x", + ]) + + +def installation(service, dokku_version): + return "\n".join([ + "## Installation", + "", + "```shell", + f"# on {dokku_version}", + f"sudo dokku plugin:install https://github.com/dokku/dokku-{service}.git {service}", + "```", + ]) + + +def commands(service, alias, scheme, ports): + content = [ + "## Commands", + "", + "```", + ] + + subcommands = os.listdir("subcommands") + subcommands.sort() + + command_list = [] + descriptions = [] + for filename in subcommands: + data = command_data(filename, service, alias, scheme, ports) + description = data["description"] + arguments = data["arguments_string"] + + command_list.append(f"{service}:{filename} {arguments}") + descriptions.append(description) + + maxlen = max(map(len, command_list)) + if maxlen > 50: + maxlen = 50 + for command, description in zip(command_list, descriptions): + space_count = maxlen - len(command) + content.append("{0}{1} # {2}".format(command, " " * space_count, description)) + + content.append("```") + return "\n".join(content) + + +def usage(service, alias, scheme, ports): + return "\n\n".join([ + "## Usage", + f"Help for any commands can be displayed by specifying the command as an argument to {service}:help. Please consult the `{service}:help` command for any undocumented commands.", + usage_intro(service, alias, scheme, ports), + usage_lifecycle(service, alias, scheme, ports), + usage_automation(service, alias, scheme, ports), + usage_data_management(service, alias, scheme, ports), + usage_backup(service, alias, scheme, ports), + usage_docker_pull(service, alias, scheme, ports), + ]) + + +def usage_intro(service, alias, scheme, ports): + return "\n".join([ + "### Basic Usage", + command_help("list", service, alias, scheme, ports), + command_help("create", service, alias, scheme, ports), + command_help("info", service, alias, scheme, ports), + command_help("logs", service, alias, scheme, ports), + command_help("link", service, alias, scheme, ports), + command_help("unlink", service, alias, scheme, ports), + command_help("destroy", service, alias, scheme, ports), + ]) + + +def usage_lifecycle(service, alias, scheme, ports): + return "\n".join([ + "### Service Lifecycle", + "", + "The lifecycle of each service can be managed through the following commands:", + "", + command_help("connect", service, alias, scheme, ports), + command_help("enter", service, alias, scheme, ports), + command_help("expose", service, alias, scheme, ports), + command_help("unexpose", service, alias, scheme, ports), + command_help("promote", service, alias, scheme, ports), + command_help("restart", service, alias, scheme, ports), + command_help("start", service, alias, scheme, ports), + command_help("stop", service, alias, scheme, ports), + command_help("upgrade", service, alias, scheme, ports), + ]) + + +def usage_automation(service, alias, scheme, ports): + return "\n".join([ + "### Service Automation", + "", + "Service scripting can be executed using the following commands:", + "", + command_help("app-links", service, alias, scheme, ports), + command_help("clone", service, alias, scheme, ports), + command_help("exists", service, alias, scheme, ports), + command_help("linked", service, alias, scheme, ports), + command_help("links", service, alias, scheme, ports), + ]) + + +def usage_data_management(service, alias, scheme, ports): + return "\n".join([ + "### Data Management", + "", + "The underlying service data can be imported and exported with the following commands:", + "", + command_help("import", service, alias, scheme, ports), + command_help("export", service, alias, scheme, ports), + ]) + + +def usage_backup(service, alias, scheme, ports): + return "\n".join([ + "### Backups", + "", + "Datastore backups are supported via AWS S3 and S3 compatible services like [minio](https://github.com/minio/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:", + "", + command_help("backup-auth", service, alias, scheme, ports), + command_help("backup-deauth", service, alias, scheme, ports), + command_help("backup", service, alias, scheme, ports), + command_help("backup-set-encryption", service, alias, scheme, ports), + command_help("backup-unset-encryption", service, alias, scheme, ports), + command_help("backup-schedule", service, alias, scheme, ports), + command_help("backup-schedule-cat", service, alias, scheme, ports), + command_help("backup-unschedule", service, alias, scheme, ports), + ]) + + +def usage_docker_pull(service, alias, scheme, ports): + service_prefix = service.upper() + return "\n".join([ + "### Disabling `docker pull` calls", + "", + f"If you wish to disable the `docker pull` calls that the plugin triggers, you may set the `{service_prefix}_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.", + ]) + + +def parse_args(line): + line = line.strip() + arguments = [] + for arg in re.findall("([A-Z_]+)", line): + arg = arg.replace("_", "-").lower() + if arg.endswith("optional-flag"): + arg = arg.replace("-optional-flag", "") + arguments.append(f"[--{arg}]") + elif arg.endswith("-flag"): + if arg == "info-flag": + arguments.append(f"[--single-info-flag]") + else: + arg = arg.replace("-flag", "") + first_letter = arg[0] + arguments.append(f"[-{first_letter}|--{arg}]") + elif arg.endswith("-flags-list"): + arg = arg.replace("-list", "") + arguments.append(f"[--{arg}...]") + elif arg.endswith("list"): + arg = arg.replace("-list", "") + arguments.append(f"<{arg}...>") + else: + arguments.append(f"<{arg}>") + return " ".join(arguments) + + +def command_help(command, service, alias, scheme, ports): + data = command_data(command, service, alias, scheme, ports) + content = [ + f"### {data['description']}", + "", + "```shell", + "# usage", + f"dokku {service}:{command} {data['arguments_string']}", + "```", + ] + + # if len(data["arguments"]) > 0: + # content.append("") + # content.append("arguments:") + # content.append("") + # for argument in data["arguments"]: + # content.append(f"- {argument}") + + # if len(data["flags"]) > 0: + # content.append("") + # content.append("flags:") + # content.append("") + # for flag in data["flags"]: + # content.append(f"- {flag}") + + if len(data["examples"]) > 0: + content.append("") + content.append("examples:") + content.append("") + content.append(data["examples"]) + + return "\n".join(content) + + +def command_data(command, service, alias, scheme, ports): + description = None + arguments = [] + arguments_string = "" + example_lines = [] + flags = [] + with open(os.path.join("subcommands", command)) as f: + for line in f.readlines(): + line = line.strip() + line = line.replace("$PLUGIN_SERVICE", service) + line = line.replace("$PLUGIN_COMMAND_PREFIX", service) + line = line.replace("${PLUGIN_COMMAND_PREFIX}", service) + line = line.replace("${PLUGIN_DEFAULT_ALIAS}", alias) + line = line.replace("${PLUGIN_SCHEME}", scheme) + line = line.replace("${PLUGIN_DATASTORE_PORTS[0]}", ports[0]) + + if "declare desc" in line: + description = re.search('"(.+)"', line).group(1) + elif "$1" in line: + arguments_string = parse_args(line) + elif line.startswith("#A "): + argument = line.replace("#A ", "") + parts = [a.strip() for a in argument.split(",", 1)] + arguments.append(f"`{parts[0]}`: {parts[1]}") + elif line.startswith("#F "): + flag = line.replace("#F ", "") + parts = [a.strip() for a in flag.split(",", 1)] + flags.append(f"`{parts[0]}`: {parts[1]}") + elif line.startswith("#E "): + example_lines.append(line.replace("#E ", "")) + + examples = [] + sentence_lines = [] + command_lines = [] + codeblock_lines = [] + blockquote_lines = [] + for line in example_lines: + if line.startswith("export") or line.startswith("dokku"): + if len(blockquote_lines) > 0: + examples.append("\n" + process_blockquote(blockquote_lines)) + blockquote_lines = [] + if len(codeblock_lines) > 0: + examples.append("\n" + process_codeblock(codeblock_lines)) + codeblock_lines = [] + if len(sentence_lines) > 0: + examples.append("\n" + process_sentence(sentence_lines)) + sentence_lines = [] + + command_lines.append(line) + elif line.startswith(" "): + if len(blockquote_lines) > 0: + examples.append("\n" + process_blockquote(blockquote_lines)) + blockquote_lines = [] + if len(command_lines) > 0: + examples.append("\n" + process_command(command_lines)) + command_lines = [] + if len(sentence_lines) > 0: + examples.append("\n" + process_sentence(sentence_lines)) + sentence_lines = [] + + codeblock_lines.append(line.strip()) + elif line.startswith(">"): + if len(codeblock_lines) > 0: + examples.append("\n" + process_codeblock(codeblock_lines)) + codeblock_lines = [] + if len(command_lines) > 0: + examples.append("\n" + process_command(command_lines)) + command_lines = [] + if len(sentence_lines) > 0: + examples.append("\n" + process_sentence(sentence_lines)) + sentence_lines = [] + + blockquote_lines.append(line) + else: + if len(blockquote_lines) > 0: + examples.append("\n" + process_blockquote(blockquote_lines)) + blockquote_lines = [] + if len(codeblock_lines) > 0: + examples.append("\n" + process_codeblock(codeblock_lines)) + codeblock_lines = [] + if len(command_lines) > 0: + examples.append("\n" + process_command(command_lines)) + command_lines = [] + + sentence_lines.append(line) + + if len(blockquote_lines) > 0: + examples.append("\n" + process_blockquote(blockquote_lines)) + blockquote_lines = [] + if len(codeblock_lines) > 0: + examples.append("\n" + process_codeblock(codeblock_lines)) + codeblock_lines = [] + if len(command_lines) > 0: + examples.append("\n" + process_command(command_lines)) + command_lines = [] + if len(sentence_lines) > 0: + examples.append("\n" + process_sentence(sentence_lines)) + sentence_lines = [] + + return { + "description": description, + "arguments_string": arguments_string, + "arguments": arguments, + "flags": flags, + "examples": "\n".join(examples).strip(), + } + + +def process_sentence(sentence_lines): + sentence_lines = " ".join(sentence_lines) + sentences = ". ".join(i.strip().capitalize() for i in sentence_lines.split(".")) + if not sentences.endswith(".") and not sentences.endswith(":"): + sentences += ":" + return sentences + + +def process_blockquote(blockquote_lines): + return "\n".join(blockquote_lines) + + +def process_command(command_lines): + command_lines = "\n".join(command_lines) + return f"```shell\n{command_lines}\n```" + + +def process_codeblock(codeblock_lines): + codeblock_lines = "\n".join(codeblock_lines) + return f"```\n{codeblock_lines}\n```" + + +def compile(service, version, alias, scheme, ports, dokku_version): + return "\n\n".join([ + header(service), + description(service, version), + requirements(dokku_version), + installation(service, dokku_version), + commands(service, alias, scheme, ports), + usage(service, alias, scheme, ports), + ]) + + +def main(): + service = None + version = None + alias = None + with open("config") as f: + for line in f.readlines(): + if "IMAGE_VERSION=${" in line: + version = re.search('"(.+)"', line).group(1) + if "PLUGIN_COMMAND_PREFIX=" in line: + service = re.search('"(.+)"', line).group(1) + if "PLUGIN_DEFAULT_ALIAS=" in line: + alias = re.search('"(.+)"', line).group(1) + if "PLUGIN_SCHEME=" in line: + scheme = re.search('"(.+)"', line).group(1) + if "PLUGIN_DATASTORE_PORTS=" in line: + ports = re.search('\((.+)\)', line).group(1).split(" ") + + text = compile(service, version, alias, scheme, ports, "0.12.x+") + + base_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__))) + readme_file = os.path.join(base_path, 'README.md') + with open(readme_file, 'w') as f: + f.write(text) + + +if __name__ == "__main__": + main()