Release 1.11.4

Refs dokku/dokku-postgres#197

.circleci/config.yml

@@ -0,0 +1,60 @@
+version: 2.1
+
+commands:
+  build:
+    description: "run the build"
+    parameters:
+      python_version:
+        type: string
+        default: "3.7.0"
+    steps:
+      - checkout
+      - run: pyenv global << parameters.python_version >>
+      - run: make setup
+      - run: sudo sysctl -w vm.max_map_count=262144
+      - run:
+          command: |
+            make generate
+            if ! git diff --quiet README.md; then
+              echo "Please run `make generate`"
+              git status --short
+              git --no-pager diff README.md
+              exit 1
+            fi
+      - run: make test
+      - store_artifacts:
+          path: build
+          destination: build
+      - store_artifacts:
+          path: tmp/test-results
+          destination: test-results
+      - store_test_results:
+          path: tmp/test-results
+
+executors:
+  machine:
+    machine:
+      docker_layer_caching: false
+      image: ubuntu-1604:201903-01
+
+jobs:
+  build-master:
+    environment:
+      DOKKU_VERSION: master
+    executor: machine
+    steps:
+      - build
+
+  build-version:
+    environment:
+      DOKKU_VERSION: v0.19.0
+    executor: machine
+    steps:
+      - build
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - "build-master"
+      - "build-version"

.travis.yml

@@ -1,9 +0,0 @@
-dist: trusty
-language: bash
-env:
-  - DOKKU_VERSION=master
-  - DOKKU_VERSION=v0.17.0
-install: make setup
-before_script: sudo sysctl -w vm.max_map_count=262144
-script: make test
-after_failure: make report

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (C) 2018 Jose Diaz-Gonzalez
+Copyright (C) 2020 Jose Diaz-Gonzalez
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

Makefile

@@ -1,5 +1,9 @@
 HARDWARE = $(shell uname -m)
 SYSTEM_NAME  = $(shell uname -s | tr '[:upper:]' '[:lower:]')
+SHFMT_VERSION = 3.0.2
+XUNIT_TO_GITHUB_VERSION = 0.3.0
+XUNIT_READER_VERSION = 0.1.0
+
 
 bats:
 ifeq ($(SYSTEM_NAME),darwin)
@@ -28,7 +32,7 @@ ifneq ($(shell shfmt --version >/dev/null 2>&1 ; echo $$?),0)
 ifeq ($(shfmt),Darwin)
 	brew install shfmt
 else
-	wget -qO /tmp/shfmt https://github.com/mvdan/sh/releases/download/v2.6.2/shfmt_v2.6.2_linux_amd64
+	wget -qO /tmp/shfmt https://github.com/mvdan/sh/releases/download/v$(SHFMT_VERSION)/shfmt_v$(SHFMT_VERSION)_linux_amd64
 	chmod +x /tmp/shfmt
 	sudo mv /tmp/shfmt /usr/local/bin/shfmt
 endif
@@ -61,9 +65,15 @@ unit-tests:
 	@cd tests && echo "executing tests: $(shell cd tests ; ls *.bats | xargs)"
 	cd tests && bats --formatter bats-format-junit -e -T -o ../tmp/test-results/bats *.bats
 
+tmp/xunit-reader:
+	mkdir -p tmp
+	curl -o tmp/xunit-reader.tgz -sL https://github.com/josegonzalez/go-xunit-reader/releases/download/v$(XUNIT_READER_VERSION)/xunit-reader_$(XUNIT_READER_VERSION)_$(SYSTEM_NAME)_$(HARDWARE).tgz
+	tar xf tmp/xunit-reader.tgz -C tmp
+	chmod +x tmp/xunit-reader
+
 tmp/xunit-to-github:
 	mkdir -p tmp
-	curl -o tmp/xunit-to-github.tgz -sL https://github.com/josegonzalez/go-xunit-to-github/releases/download/v0.3.0/xunit-to-github_0.3.0_$(SYSTEM_NAME)_$(HARDWARE).tgz
+	curl -o tmp/xunit-to-github.tgz -sL https://github.com/josegonzalez/go-xunit-to-github/releases/download/v$(XUNIT_TO_GITHUB_VERSION)/xunit-to-github_$(XUNIT_TO_GITHUB_VERSION)_$(SYSTEM_NAME)_$(HARDWARE).tgz
 	tar xf tmp/xunit-to-github.tgz -C tmp
 	chmod +x tmp/xunit-to-github
 
@@ -73,7 +83,9 @@ setup:
 
 test: lint unit-tests
 
-report: tmp/xunit-to-github
+report: tmp/xunit-reader tmp/xunit-to-github
+	tmp/xunit-reader -p 'tmp/test-results/bats/*.xml'
+	tmp/xunit-reader -p 'tmp/test-results/shellcheck/*.xml'
 ifdef TRAVIS_REPO_SLUG
 ifdef GITHUB_ACCESS_TOKEN
 ifneq ($(TRAVIS_PULL_REQUEST),false)
@@ -81,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

README.md

@@ -1,78 +1,127 @@
-# dokku postgres [![Build Status](https://img.shields.io/travis/dokku/dokku-postgres.svg?branch=master "Build Status")](https://travis-ci.org/dokku/dokku-postgres) [![IRC Network](https://img.shields.io/badge/irc-freenode-blue.svg "IRC Freenode")](https://webchat.freenode.net/?channels=dokku)
+# dokku postgres [![Build Status](https://img.shields.io/circleci/project/github/dokku/dokku-postgres.svg?branch=master&style=flat-square "Build Status")](https://circleci.com/gh/dokku/dokku-postgres/tree/master) [![IRC Network](https://img.shields.io/badge/irc-freenode-blue.svg?style=flat-square "IRC Freenode")](https://webchat.freenode.net/?channels=dokku)
 
 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 <app>          List all postgres service links for a given app
+postgres:app-links <app>                           # list all postgres service links for a given app
-postgres:backup <name> <bucket> (--use-iam) Create a backup of the postgres service to an existing s3 bucket
+postgres:backup <service> <bucket-name> [--use-iam] # creates a backup of the postgres service to an existing s3 bucket
-postgres:backup-auth <name> <aws_access_key_id> <aws_secret_access_key> (<aws_default_region>) (<aws_signature_version>) (<endpoint_url>) Sets up authentication for backups on the postgres service
+postgres:backup-auth <service> <aws-access-key-id> <aws-secret-access-key> <aws-default-region> <aws-signature-version> <endpoint-url> # sets up authentication for backups on the postgres service
-postgres:backup-deauth <name>     Removes backup authentication for the postgres service
+postgres:backup-deauth <service>                   # removes backup authentication for the postgres service
-postgres:backup-schedule <name> <schedule> <bucket> Schedules a backup of the postgres service
+postgres:backup-schedule <service> <schedule> <bucket-name> [--use-iam] # schedules a backup of the postgres service
-postgres:backup-schedule-cat <name> Show the backup schedule for the service
+postgres:backup-schedule-cat <service>             # cat the contents of the configured backup cronfile for the service
-postgres:backup-set-encryption <name> <passphrase> Set a GPG passphrase for backups
+postgres:backup-set-encryption <service> <passphrase> # sets encryption for all future backups of postgres service
-postgres:backup-unschedule <name> Unschedules the backup of the postgres service
+postgres:backup-unschedule <service>               # unschedules the backup of the postgres service
-postgres:backup-unset-encryption <name> Removes backup encryption for future backups of the postgres service
+postgres:backup-unset-encryption <service>         # unsets encryption for future backups of the postgres service
-postgres:clone <name> <new-name>  Create container <new-name> then copy data from <name> into <new-name>
+postgres:clone <service> <new-service> [--clone-flags...] # create container <new-name> then copy data from <name> into <new-name>
-postgres:connect <name>           Connect via psql to a postgres service
+postgres:connect <service>                         # connect to the service via the postgres connection tool
-postgres:create <name>            Create a postgres service with environment variables
+postgres:create <service> [--create-flags...]      # create a postgres service
-postgres:destroy <name>           Delete the service, delete the data and stop its container if there are no links left
+postgres:destroy <service> [-f|--force]            # delete the postgres service/data/container if there are no links left
-postgres:enter <name> [command]   Enter or run a command in a running postgres service container
+postgres:enter <service>                           # enter or run a command in a running postgres service container
-postgres:exists <service>         Check if the postgres service exists
+postgres:exists <service>                          # check if the postgres service exists
-postgres:export <name> > <file>   Export a dump of the postgres service database
+postgres:export <service>                          # export a dump of the postgres service database
-postgres:expose <name> [port]     Expose a postgres service on custom port if provided (random port otherwise)
+postgres:expose <service> <ports...>               # expose a postgres service on custom port if provided (random port otherwise)
-postgres:import <name> < <file>   Import a dump into the postgres service database
+postgres:import <service>                          # import a dump into the postgres service database
-postgres:info <name>              Print the connection information
+postgres:info <service> [--single-info-flag]       # print the service information
-postgres:link <name> <app>        Link the postgres service to the app
+postgres:link <service> <app> [--link-flags...]    # link the postgres service to the app
-postgres:linked <name> <app>      Check if the postgres service is linked to an app
+postgres:linked <service> <app>                    # check if the postgres service is linked to an app
-postgres:list                     List all postgres services
+postgres:links <service>                           # list all apps linked to the postgres service
-postgres:logs <name> [-t]         Print the most recent log(s) for this service
+postgres:list                                      # list all postgres services
-postgres:promote <name> <app>     Promote service <name> as DATABASE_URL in <app>
+postgres:logs <service> [-t|--tail]                # print the most recent log(s) for this service
-postgres:restart <name>           Graceful shutdown and restart of the postgres service container
+postgres:promote <service> <app>                   # promote service <service> as DATABASE_URL in <app>
-postgres:start <name>             Start a previously stopped postgres service
+postgres:restart <service>                         # graceful shutdown and restart of the postgres service container
-postgres:stop <name>              Stop a running postgres service
+postgres:start <service>                           # start a previously stopped postgres service
-postgres:unexpose <name>          Unexpose a previously exposed postgres service
+postgres:stop <service>                            # stop a running postgres service
-postgres:unlink <name> <app>      Unlink the postgres service from the app
+postgres:unexpose <service>                        # unexpose a previously exposed postgres service
-postgres:upgrade <name>           Upgrade service <service> to the specified version
+postgres:unlink <service> <app>                    # unlink the postgres service from the app
+postgres:upgrade <service> [--upgrade-flags...]    # upgrade service <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
+
+### create a postgres service
 
 ```shell
-# create a postgres service named lolipop
+# usage
-dokku postgres:create lolipop
+dokku postgres:create <service> [--create-flags...]
+```
 
-# you can also specify the image and image
+flags:
-# 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
 
-# you can also specify custom environment
+- `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with
-# variables to start the postgres service
+- `-i|--image IMAGE`: the image name to start the service with
-# in semi-colon separated form
+- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
-export POSTGRES_CUSTOM_ENV="USER=alpha;HOST=beta"
+- `-p|--password PASSWORD`: override the user-level service password
-dokku postgres:create lolipop
+- `-r|--root-password PASSWORD`: override the root-level service password
 
-# get connection information as follows
+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 postgres image. 
+
+```shell
+export DATABASE_IMAGE="postgres"
+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 service information
+
+```shell
+# usage
+dokku postgres: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
+- `--links`: show the service app links
+- `--service-root`: show the service root directory
+- `--status`: show the service running status
+- `--version`: show the service image version
+
+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,199 +131,525 @@ dokku postgres:info lolipop --links
 dokku postgres:info lolipop --service-root
 dokku postgres:info lolipop --status
 dokku postgres:info lolipop --version
+```
 
-# a bash prompt can be opened against a running service
+### list all postgres services
-# filesystem changes will not be saved to disk
-dokku postgres:enter lolipop
 
-# you may also run a command directly against the service
+```shell
-# filesystem changes will not be saved to disk
+# usage
-dokku postgres:enter lolipop ls -lah /
+dokku postgres:list 
+```
 
-# a postgres service can be linked to a
+List all services:
-# 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
 
-# the following environment variables will be set automatically by docker (not
+```shell
-# on the app itself, so they won’t be listed when calling dokku config)
+dokku postgres:list
-#
+```
-#   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
+### print the most recent log(s) for this service
-dokku postgres:link other_service playground
 
-# since DATABASE_URL is already in use, another environment variable will be
+```shell
-# generated automatically
+# usage
-#
+dokku postgres:logs <service> [-t|--tail]
-#   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
+flags:
-# 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
+- `-t|--tail`: do not stop when end of the logs are reached and wait for additional output
-# 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
+You can tail logs for a particular 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
-
-# you can import a dump
-dokku postgres:import lolipop < database.dump
-
-# you can clone an existing database to a new one
-dokku postgres:clone lolipop new_database
-
-# finally, you can destroy the container
-dokku postgres:destroy lolipop
 ```
 
-## Changing database adapter
+By default, logs will not be tailed, but you can do this with the --tail flag:
 
-It's possible to change the protocol for DATABASE_URL by setting
+```shell
-the environment variable POSTGRES_DATABASE_SCHEME on the app:
+dokku postgres:logs lolipop --tail
+```
+
+### link the postgres service to the app
+
+```shell
+# usage
+dokku postgres: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
+
+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 `POSTGRES_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 POSTGRES_DATABASE_SCHEME=postgres2
 dokku postgres:link lolipop playground
 ```
 
-Will cause DATABASE_URL to be set as
+This 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`
+postgres2://lolipop:SOME_PASSWORD@dokku-postgres-lolipop:5432/lolipop
-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:
-
-```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
 ```
 
-## Configuration
+### unlink the postgres service from the app
-
-If you wish to tune the postgres instances various .conf files, you can find them by using the postgres:info command.
 
 ```shell
-dokku postgres:info lolipop
+# usage
-# or
+dokku postgres:unlink <service> <app>
-dokku postgres:info lolipop --data-dir
 ```
 
-## Backups
+You can unlink a postgres service:
+
+> NOTE: this will restart your app and unset related environment variables
+
+```shell
+dokku postgres:unlink lolipop playground
+```
+
+### Service Lifecycle
+
+The lifecycle of each service can be managed through the following commands:
+
+### connect to the service via the postgres connection tool
+
+```shell
+# usage
+dokku postgres:connect <service>
+```
+
+Connect to the service via the postgres connection tool:
+
+```shell
+dokku postgres:connect lolipop
+```
+
+### enter or run a command in a running postgres service container
+
+```shell
+# usage
+dokku postgres:enter <service>
+```
+
+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 <service> <ports...>
+```
+
+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 5432
+```
+
+### unexpose a previously exposed postgres service
+
+```shell
+# usage
+dokku postgres:unexpose <service>
+```
+
+Unexpose the service, removing access to it from the public interface (`0.0.0.0`):
+
+```shell
+dokku postgres:unexpose lolipop
+```
+
+### promote service <service> as DATABASE_URL in <app>
+
+```shell
+# usage
+dokku postgres:promote <service> <app>
+```
+
+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
+```
+
+### start a previously stopped postgres service
+
+```shell
+# usage
+dokku postgres:start <service>
+```
+
+Start the service:
+
+```shell
+dokku postgres:start lolipop
+```
+
+### stop a running postgres service
+
+```shell
+# usage
+dokku postgres:stop <service>
+```
+
+Stop the service and the running container:
+
+```shell
+dokku postgres:stop lolipop
+```
+
+### graceful shutdown and restart of the postgres service container
+
+```shell
+# usage
+dokku postgres:restart <service>
+```
+
+Restart the service:
+
+```shell
+dokku postgres:restart lolipop
+```
+
+### upgrade service <service> to the specified versions
+
+```shell
+# usage
+dokku postgres:upgrade <service> [--upgrade-flags...]
+```
+
+flags:
+
+- `-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
+- `-R|--restart-apps "true"`: whether to force an app restart
+
+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 <app>
+```
+
+List all postgres services that are linked to the 'playground' app. 
+
+```shell
+dokku postgres:app-links playground
+```
+
+### create container <new-name> then copy data from <name> into <new-name>
+
+```shell
+# usage
+dokku postgres:clone <service> <new-service> [--clone-flags...]
+```
+
+flags:
+
+- `-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
+- `-p|--password PASSWORD`: override the user-level service password
+- `-r|--root-password PASSWORD`: override the root-level service password
+
+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 <service>
+```
+
+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 <service> <app>
+```
+
+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 <service>
+```
+
+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 <service>
+```
+
+Import a datastore dump:
+
+```shell
+dokku postgres:import lolipop < database.dump
+```
+
+### export a dump of the postgres service database
+
+```shell
+# usage
+dokku postgres:export <service>
+```
+
+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
+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.
-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 <service> <aws-access-key-id> <aws-secret-access-key> <aws-default-region> <aws-signature-version> <endpoint-url>
 ```
-# setup s3 backup authentication
+
+Setup s3 backup authentication:
+
+```shell
 dokku postgres:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
-
-# remove s3 authentication
-dokku postgres:backup-deauth lolipop
-
-# backup the `lolipop` service to the `BUCKET_NAME` bucket on AWS
-dokku postgres:backup lolipop BUCKET_NAME
-
-# 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
-
-# cat the contents of the configured backup cronfile for the service
-dokku postgres:backup-schedule-cat lolipop
-
-# remove the scheduled backup from cron
-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:
 
-```
+```shell
-# 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
+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
+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
 ```
 
-## Importing Data
+### removes backup authentication for the postgres service
-
-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
+# usage
+dokku postgres:backup-deauth <service>
 ```
 
-## Security
+Remove s3 authentication:
 
-The connection to the database is done over SSL. A self-signed certificate is
+```shell
-automatically generated when creating the service. It can be replaced by a
+dokku postgres:backup-deauth lolipop
-custom certificate by overwriting the `server.crt` and `server.key` files in
+```
-`/var/lib/dokku/services/postgres/<DB_NAME>/data`.
-The `server.key` must be chmoded to 600 and must be owned by the postgres user
-or root.
 
-## Disabling `docker pull` calls
+### creates a backup of the postgres service to an existing s3 bucket
+
+```shell
+# usage
+dokku postgres:backup <service> <bucket-name> [--use-iam]
+```
+
+flags:
+
+- `-u|--use-iam`: use the IAM profile associated with the current server
+
+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 <service> <passphrase>
+```
+
+Set the GPG-compatible passphrase for encrypting backups 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 <service>
+```
+
+Unset the `GPG` encryption passphrase for backups:
+
+```shell
+dokku postgres:backup-unset-encryption lolipop
+```
+
+### schedules a backup of the postgres service
+
+```shell
+# usage
+dokku postgres:backup-schedule <service> <schedule> <bucket-name> [--use-iam]
+```
+
+flags:
+
+- `-u|--use-iam`: use the IAM profile associated with the current server
+
+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 <service>
+```
+
+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
+
+```shell
+# usage
+dokku postgres:backup-unschedule <service>
+```
+
+Remove the scheduled backup from cron:
+
+```shell
+dokku postgres:backup-unschedule lolipop
+```
+
+### 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.
 

bin/generate

@@ -0,0 +1,481 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from __future__ import print_function
+import os
+import re
+
+
+def compile(service, version, variable, alias, image, scheme, ports, unimplemented, dokku_version):
+    return (
+        "\n\n".join(
+            [
+                header(service),
+                description(service, version),
+                requirements_section(dokku_version),
+                installation_section(service, dokku_version),
+                commands_section(service, variable, alias, image, scheme, ports, unimplemented),
+                usage_section(service, variable, alias, image, scheme, ports, unimplemented),
+            ]
+        )
+        .replace("\n\n\n\n\n", "\n")
+        .replace("\n\n\n\n", "\n")
+        .replace("\n\n\n", "\n\n")
+    )
+
+
+def header(service):
+    return " ".join(
+        [
+            f"# dokku {service}",
+            f'[![Build Status](https://img.shields.io/circleci/project/github/dokku/dokku-{service}.svg?branch=master&style=flat-square "Build Status")](https://circleci.com/gh/dokku/dokku-{service}/tree/master)',
+            f'[![IRC Network](https://img.shields.io/badge/irc-freenode-blue.svg?style=flat-square "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_section(dokku_version):
+    return "\n".join(
+        ["## Requirements", "", f"- dokku {dokku_version}", "- docker 1.8.x",]
+    )
+
+
+def installation_section(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_section(service, variable, alias, image, scheme, ports, unimplemented):
+    content = [
+        "## Commands",
+        "",
+        "```",
+    ]
+
+    subcommands = os.listdir("subcommands")
+    subcommands.sort()
+
+    command_list = []
+    descriptions = []
+    for filename in subcommands:
+        if filename in unimplemented:
+            continue
+        data = command_data(filename, service, variable, alias, image, 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_section(service, variable, alias, image, scheme, ports, unimplemented):
+    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, variable, alias, image, scheme, ports, unimplemented),
+            usage_lifecycle(service, variable, alias, image, scheme, ports, unimplemented),
+            usage_automation(service, variable, alias, image, scheme, ports, unimplemented),
+            usage_data_management(service, variable, alias, image, scheme, ports, unimplemented),
+            usage_backup(service, variable, alias, image, scheme, ports, unimplemented),
+            usage_docker_pull(service, variable, alias, image, scheme, ports, unimplemented),
+        ]
+    )
+
+
+def usage_intro(service, variable, alias, image, scheme, ports, unimplemented):
+    commands = ["create", "info", "list", "logs", "link", "unlink"]
+    content = ["### Basic Usage"]
+
+    return fetch_commands_content(
+        service, variable, alias, image, scheme, ports, unimplemented, commands, content
+    )
+
+
+def usage_lifecycle(service, variable, alias, image, scheme, ports, unimplemented):
+    commands = [
+        "connect",
+        "enter",
+        "expose",
+        "unexpose",
+        "promote",
+        "start",
+        "stop",
+        "restart",
+        "upgrade",
+    ]
+    content = [
+        "### Service Lifecycle",
+        "",
+        "The lifecycle of each service can be managed through the following commands:",
+        "",
+    ]
+
+    return fetch_commands_content(
+        service, variable, alias, image, scheme, ports, unimplemented, commands, content
+    )
+
+
+def usage_automation(service, variable, alias, image, scheme, ports, unimplemented):
+    commands = ["app-links", "clone", "exists", "linked", "links"]
+    content = [
+        "### Service Automation",
+        "",
+        "Service scripting can be executed using the following commands:",
+        "",
+    ]
+
+    return fetch_commands_content(
+        service, variable, alias, image, scheme, ports, unimplemented, commands, content
+    )
+
+
+def usage_data_management(service, variable, alias, image, scheme, ports, unimplemented):
+    commands = ["import", "export"]
+    content = [
+        "### Data Management",
+        "",
+        "The underlying service data can be imported and exported with the following commands:",
+        "",
+    ]
+
+    return fetch_commands_content(
+        service, variable, alias, image, scheme, ports, unimplemented, commands, content
+    )
+
+
+def usage_backup(service, variable, alias, image, scheme, ports, unimplemented):
+    commands = [
+        "backup-auth",
+        "backup-deauth",
+        "backup",
+        "backup-set-encryption",
+        "backup-unset-encryption",
+        "backup-schedule",
+        "backup-schedule-cat",
+        "backup-unschedule",
+    ]
+    content = [
+        "### 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:",
+        "",
+    ]
+
+    return fetch_commands_content(
+        service, variable, alias, image, scheme, ports, unimplemented, commands, content
+    )
+
+
+def usage_docker_pull(service, variable, alias, image, scheme, ports, unimplemented):
+    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 fetch_commands_content(
+    service, variable, alias, image, scheme, ports, unimplemented, commands, content
+):
+    i = 0
+    for command in commands:
+        output = command_help(command, service, variable, alias, image, scheme, ports, unimplemented)
+        if output == "":
+            continue
+        content.append(output)
+        i += 1
+
+    if i == 0:
+        return ""
+
+    return "\n".join(content)
+
+
+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, variable, alias, image, scheme, ports, unimplemented):
+    if command in unimplemented:
+        return ""
+
+    data = command_data(command, service, variable, alias, image, 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(data["examples"])
+
+    return "\n" + "\n".join(content)
+
+
+def command_data(command, service, variable, alias, image, 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_VARIABLE}", variable)
+            line = line.replace("${PLUGIN_DEFAULT_ALIAS}", alias)
+            line = line.replace("${PLUGIN_IMAGE}", image)
+            line = line.replace("${PLUGIN_SCHEME}", scheme)
+            line = line.replace("${PLUGIN_DATASTORE_PORTS[0]}", ports[0])
+            line = line.replace("${PLUGIN_DATASTORE_PORTS[@]}", " ".join(ports))
+
+            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(
+        upperfirst(i.strip()) for i in sentence_lines.split(".")
+    ).strip()
+    if not sentences.endswith(".") and not sentences.endswith(":"):
+        sentences += ":"
+
+    text = []
+    for sentence in sentences.split("."):
+        parts = []
+        for word in sentence.strip().split(" "):
+            if word.isupper() and len(word) > 1:
+                for ending in [':', '.']:
+                    if word.endswith(ending):
+                        word = '`{0}`{1}'.format(word[:-1], ending)
+                else:
+                    word = '`{0}`'.format(word)
+            parts.append(word)
+        text.append(" ".join(parts))
+
+    text = ". ".join(text)
+
+    # some cleanup
+    text = text.replace("(0. 0. 0. 0)", "(`0.0.0.0`)")
+
+    return text
+
+
+def upperfirst(x):
+    return x[:1].upper() + x[1:]
+
+
+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 main():
+    service = None
+    version = None
+    variable = None
+    image = None
+    alias = None
+    unimplemented = []
+    with open("config") as f:
+        for line in f.readlines():
+            if "IMAGE_VERSION=${" in line:
+                version = re.search('"(.+)"', line).group(1)
+            if "_IMAGE=${" in line:
+                image = 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_VARIABLE=" in line:
+                variable = 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(" ")
+            if "PLUGIN_UNIMPLEMENTED_SUBCOMMANDS=" in line:
+                match = re.search("\((.+)\)", line)
+                if match is not None:
+                    unimplemented = [s.strip('"') for s in match.group(1).split(" ")]
+
+    text = compile(service, version, variable, alias, image, scheme, ports, unimplemented, "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()

common-functions

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
 set -eo pipefail
 [[ $DOKKU_TRACE ]] && set -x
 source "$PLUGIN_AVAILABLE_PATH/config/functions"
@@ -217,7 +218,7 @@ service_backup() {
   fi
 
   # shellcheck disable=SC2086
-  docker run --rm $BACKUP_PARAMETERS dokku/s3backup:0.10.1
+  docker run --rm $BACKUP_PARAMETERS "$PLUGIN_S3BACKUP_IMAGE"
 }
 
 service_backup_auth() {
@@ -394,7 +395,7 @@ service_info() {
     "--version: $(service_version "$SERVICE")"
   )
   if [[ -z "$INFO_FLAG" ]]; then
-    dokku_log_info2 "Container Information"
+    dokku_log_info2 "$SERVICE $PLUGIN_COMMAND_PREFIX service information"
     for flag in "${flag_map[@]}"; do
       key="$(echo "${flag#--}" | cut -f1 -d' ' | tr - ' ')"
       dokku_log_verbose "$(printf "%-20s %-25s" "${key^}" "${flag#*: }")"
@@ -494,19 +495,16 @@ service_links() {
 service_list() {
   declare desc="Lists all services and their status"
   local SERVICES=$(ls "$PLUGIN_DATA_ROOT" 2>/dev/null)
+
   if [[ -z $SERVICES ]]; then
     dokku_log_warn "There are no $PLUGIN_SERVICE services"
-  else
+    return
-    LIST=""
-    if [[ -z "$DOKKU_QUIET_OUTPUT" ]]; then
-      LIST="NAME,VERSION,STATUS,EXPOSED PORTS,LINKS\n"
   fi
 
+  dokku_log_info2_quiet "$PLUGIN_SERVICE services"
   for SERVICE in $SERVICES; do
-      LIST+="$SERVICE,$(service_version "$SERVICE"),$(service_status "$SERVICE"),$(service_exposed_ports "$SERVICE"),$(service_linked_apps "$SERVICE")\n"
+    echo "$SERVICE"
   done
-    printf "%b" "$LIST" | column -t -s,
-  fi
 }
 
 service_logs() {
@@ -689,7 +687,7 @@ service_port_unpause() {
   echo "${PORTS[@]}" >"$PORT_FILE"
 
   # shellcheck disable=SC2046
-  docker run -d --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" --name "$EXPOSED_NAME" $(docker_ports_options "${PORTS[@]}") --restart always --label dokku=ambassador --label "dokku.ambassador=$PLUGIN_COMMAND_PREFIX" dokku/ambassador:0.3.1 >/dev/null
+  docker run -d --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" --name "$EXPOSED_NAME" $(docker_ports_options "${PORTS[@]}") --restart always --label dokku=ambassador --label "dokku.ambassador=$PLUGIN_COMMAND_PREFIX" "$PLUGIN_AMBASSADOR_IMAGE" >/dev/null
   if [[ "$LOG_FAIL" == "true" ]]; then
     dokku_log_info1 "Service $SERVICE exposed on port(s) [container->host]: $(service_exposed_ports "$SERVICE")"
   fi
@@ -740,13 +738,7 @@ service_status() {
   local ID="$(cat "$SERVICE_ROOT/ID")"
   local CONTAINER_STATUS
 
-  is_container_status "$ID" "Dead" && echo "dead" && return 0
+  CONTAINER_STATUS=$(docker inspect -f "{{.State.Status}}" "$ID" 2>/dev/null || true)
-  is_container_status "$ID" "OOMKilled" && echo "oomkilled" && return 0
-  is_container_status "$ID" "Paused" && echo "paused" && return 0
-  is_container_status "$ID" "Restarting" && echo "restarting" && return 0
-  is_container_status "$ID" "Running" && echo "running" && return 0
-
-  CONTAINER_STATUS=$(docker inspect -f "{{.State.Status}}" "$CID" 2>/dev/null || true)
   [[ -n "$CONTAINER_STATUS" ]] && echo "$CONTAINER_STATUS" && return 0
   echo "missing" && return 0
 }

config

@@ -24,3 +24,8 @@ export PLUGIN_BASE_PATH="$PLUGIN_PATH"
 if [[ -n $DOKKU_API_VERSION ]]; then
   export PLUGIN_BASE_PATH="$PLUGIN_ENABLED_PATH"
 fi
+
+export PLUGIN_BUSYBOX_IMAGE="busybox:1.31.1-uclibc"
+export PLUGIN_AMBASSADOR_IMAGE="dokku/ambassador:0.3.3"
+export PLUGIN_S3BACKUP_IMAGE="dokku/s3backup:0.10.3"
+export PLUGIN_WAIT_IMAGE="dokku/wait:0.4.3"

functions

@@ -76,7 +76,7 @@ service_create_container() {
   echo "$ID" >"$SERVICE_ROOT/ID"
 
   dokku_log_verbose_quiet "Waiting for container to be ready"
-  docker run --rm --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" dokku/wait:0.4.1 -p "$PLUGIN_DATASTORE_WAIT_PORT" >/dev/null
+  docker run --rm --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" "$PLUGIN_WAIT_IMAGE" -p "$PLUGIN_DATASTORE_WAIT_PORT" >/dev/null
 
   dokku_log_verbose_quiet "Creating container database"
   docker exec "$SERVICE_NAME" su - postgres -c "createdb -E utf8 $DATABASE_NAME" 2>/dev/null || dokku_log_verbose_quiet 'Already exists'

help-functions

@@ -164,8 +164,8 @@ fn-help-list-example() {
   # shellcheck disable=SC2034
   declare desc="return $PLUGIN_COMMAND_PREFIX plugin help content"
   cat <<help_list
-      NAME, VERSION, STATUS, EXPOSED PORTS, LINKS
+      $PLUGIN_SERVICE services
-      service-name, $PLUGIN_COMMAND_PREFIX:$PLUGIN_IMAGE_VERSION, running, -, app-name
+      service-name
 help_list
 }
 
@@ -191,7 +191,7 @@ fn-help-subcommand-args() {
     if [[ "$arg" == *_FLAG ]]; then
       arg="${arg/_FLAG/}"
       if [[ $arg == "INFO" ]]; then
-        arg="SINGLE_INFO_FLAG..."
+        arg="SINGLE_INFO_FLAG"
         args+=" ${BLUE}[--${arg//_/-}]${NORMAL}"
       else
         args+=" ${BLUE}[-${arg:0:1}|--${arg//_/-}]${NORMAL}"

install

@@ -17,10 +17,10 @@ plugin-install() {
   }
 
   pull-docker-image "${PLUGIN_IMAGE}:${PLUGIN_IMAGE_VERSION}"
-  pull-docker-image "busybox:1.31.0-uclibc"
+  pull-docker-image "$PLUGIN_BUSYBOX_IMAGE"
-  pull-docker-image "dokku/ambassador:0.3.1"
+  pull-docker-image "$PLUGIN_AMBASSADOR_IMAGE"
-  pull-docker-image "dokku/s3backup:0.10.1"
+  pull-docker-image "$PLUGIN_S3BACKUP_IMAGE"
-  pull-docker-image "dokku/wait:0.4.1"
+  pull-docker-image "$PLUGIN_WAIT_IMAGE"
 
   mkdir -p "$PLUGIN_DATA_ROOT" || echo "Failed to create $PLUGIN_SERVICE data directory"
   chown dokku:dokku "$PLUGIN_DATA_ROOT"

plugin.toml

@@ -1,4 +1,4 @@
 [plugin]
 description = "dokku postgres service plugin"
-version = "1.9.5"
+version = "1.11.4"
 [plugin.config]

subcommands/backup-set-encryption

@@ -6,7 +6,7 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-backup-set-encryption-cmd() {
-  #E set a GPG passphrase for backups
+  #E set the GPG-compatible passphrase for encrypting backups for backups
   #E dokku $PLUGIN_COMMAND_PREFIX:backup-set-encryption lolipop
   #A service, service to run command against
   #A passphrase, a GPG-compatible passphrase

subcommands/backup-unset-encryption

@@ -6,7 +6,7 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-backup-unset-encryption-cmd() {
-  #E unset a GPG encryption key for backups
+  #E unset the GPG encryption passphrase for backups
   #E dokku $PLUGIN_COMMAND_PREFIX:backup-unset-encryption lolipop
   #A service, service to run command against
   declare desc="unsets encryption for future backups of the $PLUGIN_SERVICE service"

subcommands/destroy

@@ -45,7 +45,7 @@ service-destroy-cmd() {
   service_container_rm "$SERVICE"
 
   dokku_log_verbose_quiet "Removing data"
-  docker run --rm -v "$SERVICE_HOST_ROOT/data:/data" -v "$SERVICE_HOST_ROOT/config:/config" busybox:1.31.0-uclibc chmod 777 -R /config /data
+  docker run --rm -v "$SERVICE_HOST_ROOT/data:/data" -v "$SERVICE_HOST_ROOT/config:/config" "$PLUGIN_BUSYBOX_IMAGE" chmod 777 -R /config /data
   rm -rf "$SERVICE_ROOT"
 
   dokku_log_info2 "$PLUGIN_SERVICE container deleted: $SERVICE"

subcommands/info

@@ -30,7 +30,7 @@ service-info-cmd() {
   #F --service-root, show the service root directory
   #F --status, show the service running status
   #F --version, show the service image version
-  declare desc="print the connection information"
+  declare desc="print the service information"
   local cmd="$PLUGIN_COMMAND_PREFIX:info" argv=("$@")
   [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1" INFO_FLAG="$2"

subcommands/link

@@ -30,10 +30,10 @@ service-link-cmd() {
   #E use the 'expose' subcommand. another service can be linked to your app:
   #E dokku $PLUGIN_COMMAND_PREFIX:link other_service playground
   #E it is possible to change the protocol for ${PLUGIN_DEFAULT_ALIAS}_URL by setting the
-  #E environment variable ${PLUGIN_DEFAULT_ALIAS}_DATABASE_SCHEME on the app. doing so will
+  #E environment variable ${PLUGIN_VARIABLE}_DATABASE_SCHEME on the app. doing so will
   #E after linking will cause the plugin to think the service is not
   #E linked, and we advise you to unlink before proceeding.
-  #E dokku config:set playground ${PLUGIN_DEFAULT_ALIAS}_DATABASE_SCHEME=${PLUGIN_SCHEME}2
+  #E dokku config:set playground ${PLUGIN_VARIABLE}_DATABASE_SCHEME=${PLUGIN_SCHEME}2
   #E dokku $PLUGIN_COMMAND_PREFIX:link lolipop playground
   #E this will cause ${PLUGIN_DEFAULT_ALIAS}_URL to be set as:
   #E

tests/service_link.bats

@@ -85,7 +85,7 @@ teardown() {
 
 @test "($PLUGIN_COMMAND_PREFIX:link) links to app with docker-options" {
   dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
-  run dokku docker-options my_app
+  run dokku docker-options:report my_app
   assert_contains "${lines[*]}" "--link dokku.postgres.l:dokku-postgres-l"
   assert_success
   dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app

tests/service_list.bats

@@ -10,27 +10,13 @@ teardown() {
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:list) with no exposed ports, no linked apps" {
-  run dokku "$PLUGIN_COMMAND_PREFIX:list"
+  run dokku --quiet "$PLUGIN_COMMAND_PREFIX:list"
-  assert_contains "${lines[*]}" "l     postgres:11.6  running  -              -"
+  assert_output "l"
-}
-
-@test "($PLUGIN_COMMAND_PREFIX:list) with exposed ports" {
-  dokku "$PLUGIN_COMMAND_PREFIX:expose" l 4242
-  run dokku "$PLUGIN_COMMAND_PREFIX:list"
-  assert_contains "${lines[*]}" "l     postgres:11.6  running  5432->4242     -"
-}
-
-@test "($PLUGIN_COMMAND_PREFIX:list) with linked app" {
-  dokku apps:create my_app
-  dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
-  run dokku "$PLUGIN_COMMAND_PREFIX:list"
-  assert_contains "${lines[*]}" "l     postgres:11.6  running  -              my_app"
-  dokku --force apps:destroy my_app
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:list) when there are no services" {
   dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
   run dokku "$PLUGIN_COMMAND_PREFIX:list"
-  assert_contains "${lines[*]}" "There are no Postgres services"
+  assert_output "${lines[*]}" "There are no $PLUGIN_SERVICE services"
   dokku "$PLUGIN_COMMAND_PREFIX:create" l
 }

tests/setup.sh

@@ -2,9 +2,13 @@
 set -eo pipefail
 [[ $TRACE ]] && set -x
 sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 762E3157
-echo "deb http://nginx.org/packages/ubuntu `lsb_release -cs` nginx" | sudo tee /etc/apt/sources.list.d/nginx.list
+echo "deb http://nginx.org/packages/ubuntu $(lsb_release -cs) nginx" | sudo tee /etc/apt/sources.list.d/nginx.list
 curl -fsSL https://nginx.org/keys/nginx_signing.key | sudo apt-key add -
 
+sudo mkdir -p /etc/nginx
+sudo curl https://raw.githubusercontent.com/dokku/dokku/master/tests/dhparam.pem -o /etc/nginx/dhparam.pem
+
+echo "dokku dokku/skip_key_file boolean true" | sudo debconf-set-selections
 wget https://raw.githubusercontent.com/dokku/dokku/master/bootstrap.sh
 if [[ "$DOKKU_VERSION" == "master" ]]; then
   sudo bash bootstrap.sh

tests/shellcheck-exclude

@@ -1,3 +1,7 @@
 # SC1090 - Can't follow non-constant source. Use a directive to specify location - https://github.com/koalaman/shellcheck/wiki/SC1090
 # SC2034 - Variable appears unused. Verify it or export it - https://github.com/koalaman/shellcheck/wiki/SC2034
 # SC2155 - Declare and assign separately to avoid masking return values - https://github.com/koalaman/shellcheck/wiki/SC2155
+# SC2206 - Quote to prevent word splitting/globbing, or split robustly with mapfile or read -a - https://github.com/koalaman/shellcheck/wiki/SC2206
+# SC2207 - Prefer mapfile or read -a to split command output (or quote to avoid splitting) - https://github.com/koalaman/shellcheck/wiki/SC2207
+# SC2220 - Invalid flags are not handled. Add a *) case - https://github.com/koalaman/shellcheck/wiki/SC2220
+# SC2230 - which is non-standard. Use builtin 'command -v' instead - https://github.com/koalaman/shellcheck/wiki/SC2230