Compare commits

..

93 Commits

Author SHA1 Message Date
Jose Diaz-Gonzalez
d654334225 Release 1.26.1 2023-01-28 16:34:48 -05:00
Jose Diaz-Gonzalez
409cd36b63 docs: update the ci workflow badge
Refs https://github.com/badges/shields/issues/8671
2023-01-28 16:32:52 -05:00
josegonzalez
5a181a6a4c Merge pull request #271 from dokku/5468-dokku-lib-host-root
feat: respect DOKKU_LIB_HOST_ROOT for mounted data volumes
2022-12-27 00:22:59 -05:00
Jose Diaz-Gonzalez
077aa4dc11 feat: respect DOKKU_LIB_HOST_ROOT for mounted data volumes
This change allows folks to change where dokku mounts data from for all official plugins, removing the need to specify the configuration on a one-off basis.

Refs dokku/dokku#5468
2022-12-26 23:49:28 -05:00
Jose Diaz-Gonzalez
6ebdb98ac8 Release 1.26.0 2022-12-26 19:02:25 -05:00
josegonzalez
b7e092db39 Merge pull request #270 from dokku/pause-stop-rm
Add :pause subcommand and make :stop subcommand actually remove the container
2022-12-26 18:44:39 -05:00
Jose Diaz-Gonzalez
3f338c7985 feat: add :pause subcommand and make :stop subcommand actually remove the container 2022-12-26 18:21:10 -05:00
Jose Diaz-Gonzalez
1cde514fba docs: update readme 2022-12-26 17:27:30 -05:00
Jose Diaz-Gonzalez
d281d63afb Release 1.25.0 2022-10-12 01:28:19 -04:00
Jose Diaz-Gonzalez
535bbd839f Merge pull request #257 from dokku/dependabot/docker/postgres-14.5
chore(deps): bump postgres from 14.4 to 14.5
2022-10-11 21:46:51 -07:00
Jose Diaz-Gonzalez
1c4d20cd18 Merge pull request #262 from dokku/arm-support
Update all related images to add arm/arm64 support
2022-10-11 21:45:48 -07:00
Jose Diaz-Gonzalez
90f6f1db08 feat: update all related images to add arm/arm64 support 2022-10-11 23:59:25 -04:00
dependabot[bot]
f0c5009e1a chore(deps): bump postgres from 14.4 to 14.5
Bumps postgres from 14.4 to 14.5.

---
updated-dependencies:
- dependency-name: postgres
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-08-12 02:07:29 +00:00
Jose Diaz-Gonzalez
674d10ea4d Release 1.24.0 2022-07-25 01:31:15 -04:00
Jose Diaz-Gonzalez
4e3a77ab0e feat: add method for listing all plugin services
This will allow other plugins to iterate over the services exposed by a plugin and instantiate whatever is necessary for those services.
2022-07-25 01:30:32 -04:00
Jose Diaz-Gonzalez
4ea17b07dc Release 1.23.0 2022-07-25 01:17:26 -04:00
Jose Diaz-Gonzalez
d5a4cddc3f chore: run shfmt 2022-07-25 01:15:32 -04:00
Jose Diaz-Gonzalez
2909ba7a9b Merge pull request #256 from dokku/filter-services
fix: refactor how services are filtered
2022-07-25 01:12:09 -04:00
Jose Diaz-Gonzalez
307f5d7378 fix: update clone test 2022-07-25 00:37:04 -04:00
Jose Diaz-Gonzalez
9cf8a5880f fix: refactor how services are filtered
The previous method did not include the service type in the user-auth-service hook, which meant it was kinda guess/check as to whether a datastore was filtered correctly for the service in question.

Additionally, we now handle newlines correctly, ensuring that when there _is_ filtering, we treat each datastore as a distinct one.
2022-07-24 23:53:47 -04:00
Jose Diaz-Gonzalez
63eb33d99c fix: move warning below service name verification 2022-07-19 01:34:21 -04:00
Jose Diaz-Gonzalez
704c24a9ef Release 1.22.0 2022-07-10 15:30:58 -04:00
Jose Diaz-Gonzalez
140639917d refactor: set the plugin name as the first argument to the service-action trigger
This is a breaking change, but is necessary as otherwise it is impossible to know which datastore plugin a team is meant for.
2022-07-10 15:29:11 -04:00
Jose Diaz-Gonzalez
8a738a832a Release 1.21.1 2022-07-07 03:08:03 -04:00
Jose Diaz-Gonzalez
7a3c4f7345 fix: ensure we respect the file path for service links 2022-07-07 03:07:37 -04:00
Jose Diaz-Gonzalez
a9948765cd Release 1.21.0 2022-07-07 03:04:21 -04:00
Jose Diaz-Gonzalez
4696033532 feat: implement service filtering
If a user implements the user-auth-service trigger in a plugin and that plugin does not echo the passed in app(s) on stdout, the app is assumed to not exist. This mirrors the functionality for applications in regards to auth filtering.

This may still need auditing to ensure it covers everything and doesn't cause issues, but local testing implies that everything is working as expected.
2022-07-07 02:54:14 -04:00
Jose Diaz-Gonzalez
c7231ffb90 Release 1.20.3 2022-07-06 01:49:02 -04:00
Jose Diaz-Gonzalez
20164dca78 fix: ensure the new service does not exist when cloning an existing service 2022-07-06 01:47:31 -04:00
Jose Diaz-Gonzalez
78c2d69811 Release 1.20.2 2022-07-06 01:38:16 -04:00
Jose Diaz-Gonzalez
f311936216 fix: ensure we check if the service exists before entering it 2022-07-06 01:36:40 -04:00
Jose Diaz-Gonzalez
5c5fd31e36 Release 1.20.1 2022-07-05 22:21:06 -04:00
Jose Diaz-Gonzalez
a6a603c571 Release 1.20.0 2022-07-05 22:18:23 -04:00
Jose Diaz-Gonzalez
7d535eedcb Merge pull request #254 from dokku/dependabot/docker/postgres-14.4
chore(deps): bump postgres from 14.2 to 14.4
2022-07-05 22:18:07 -04:00
dependabot[bot]
b6658bd6f3 chore(deps): bump postgres from 14.2 to 14.4
Bumps postgres from 14.2 to 14.4.

---
updated-dependencies:
- dependency-name: postgres
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-06-22 02:13:35 +00:00
Jose Diaz-Gonzalez
71840d6a65 Merge pull request #247 from erickedji/patch-1
Extend server certificate validity to 1000 years
2022-05-11 22:42:31 -04:00
Jose Diaz-Gonzalez
7ca117f72e Merge pull request #248 from dokku/dependabot/docker/postgres-14.2
chore(deps): bump postgres from 14.1 to 14.2
2022-05-11 22:42:14 -04:00
dependabot[bot]
7a75ce83a1 chore(deps): bump postgres from 14.1 to 14.2
Bumps postgres from 14.1 to 14.2.

---
updated-dependencies:
- dependency-name: postgres
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-02-14 02:14:06 +00:00
Jose Diaz-Gonzalez
e0e32d268e Release 1.19.3 2022-02-03 10:31:12 -05:00
Jose Diaz-Gonzalez
c22a2c5bca fix: always chown the image files 2022-02-03 10:30:27 -05:00
Jose Diaz-Gonzalez
760c21b044 docs: clarify unit for container memory limit 2022-01-22 04:31:53 -05:00
Jose Diaz-Gonzalez
1f0cdba967 Release 1.19.2 2022-01-22 04:24:34 -05:00
Jose Diaz-Gonzalez
0d4a6bc320 fix: ensure service config files are owned by the dokku system user
Refs dokku/dokku-postgres#245
2022-01-22 04:23:53 -05:00
Jose Diaz-Gonzalez
0209f16188 Release 1.19.1 2022-01-22 04:12:00 -05:00
Jose Diaz-Gonzalez
e0c8375c3a Release 1.19.0 2022-01-22 04:08:47 -05:00
Jose Diaz-Gonzalez
3781dec5f7 Merge pull request #241 from dokku/dependabot/docker/postgres-14.1
chore(deps): bump postgres from 13.4 to 14.1
2022-01-22 04:08:36 -05:00
Komlan Akpédjé KEDJI
6fb12698f1 Extend server certificate validity to 1000 years
It is a self-signed, therefore not providing authentication, only traffic encryption.
The default validity (30 days) is too short.
As there is no auto-renewal mechanism, a longer default period is appropriate.
2022-01-15 10:23:50 +01:00
Jose Diaz-Gonzalez
84101e17e9 Release 1.18.0 2021-12-25 16:50:08 -05:00
Jose Diaz-Gonzalez
a68d2e71d0 feat: add ability to skip restarts when linking datastores
This allows multiple datastores to be linked at a given time, thus decreasing provisioning times.
2021-12-25 16:44:16 -05:00
dependabot[bot]
d99ae93279 chore(deps): bump postgres from 13.4 to 14.1
Bumps postgres from 13.4 to 14.1.

---
updated-dependencies:
- dependency-name: postgres
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-11-15 02:08:50 +00:00
Jose Diaz-Gonzalez
af01981e52 Release 1.17.0 2021-10-26 22:28:00 -04:00
Jose Diaz-Gonzalez
1c7d121a07 feat: allow tailing a specific number of log lines 2021-10-26 22:27:14 -04:00
Jose Diaz-Gonzalez
2f33b6deb3 Release 1.16.1 2021-10-24 05:17:45 -04:00
Jose Diaz-Gonzalez
78d74dfc3c fix: silence config-options error when there are no config-options set 2021-10-24 05:08:28 -04:00
Jose Diaz-Gonzalez
5ad84c4efe Release 1.16.0 2021-10-23 19:34:04 -04:00
Jose Diaz-Gonzalez
46a940fd28 feat: allow quiet header for :info command 2021-10-23 19:33:18 -04:00
Jose Diaz-Gonzalez
5c21b534d4 Release 1.15.0 2021-10-07 17:59:48 -04:00
Jose Diaz-Gonzalez
f1d60d6f4b fix: start linked datastores when an app is started or restored
This won't _also_ fix issues when an app is deployed as there isn't an exposed hook for it, but it should fix many other issues.

For the app deployment problem, we'll need a new hook upstream.

Refs dokku/dokku-redis#138
2021-09-13 04:54:58 -04:00
Jose Diaz-Gonzalez
32fdea93fd Release 1.14.1 2021-09-13 04:34:07 -04:00
Jose Diaz-Gonzalez
42f07d10a8 fix: ensure cloned/renamed apps have a link to linked services
Previously they would just 'disappear', resulting in broken applications until the app was relinked to the service in question.

Closes dokku/dokku-redis#142
2021-09-13 04:28:33 -04:00
Jose Diaz-Gonzalez
5e3cf5fab4 Merge pull request #237 from fwolfst/fix_doc_typo
remove trailing dot in shell command example
2021-09-13 04:25:15 -04:00
Felix Wolfsteller
4174b7e617 remove trailing dot in shell command example 2021-09-13 10:21:29 +02:00
Jose Diaz-Gonzalez
e4f475b31b Release 1.14.0 2021-09-13 03:34:06 -04:00
Jose Diaz-Gonzalez
615db75c3d docs: document how to convert the data dump to plain sql
Closes #214
2021-09-13 03:27:29 -04:00
Jose Diaz-Gonzalez
2af9cb0203 fix: drop unecessary database dump
This was part of a test and inadvertently committed...
2021-09-13 03:26:54 -04:00
Jose Diaz-Gonzalez
6bfd8040a2 docs: use a 'standard' name for the data dump 2021-09-13 03:25:06 -04:00
Jose Diaz-Gonzalez
b2e1a78073 docs: document the possibility of zombie processes on ssh disconnect for :connect and :enter commands
Apparently terminating the ssh connection that runs 'docker exec' may result in a process leak as the signal isn't propagated properly (moby/moby#9098). Since we cannot fix this, we should document it so that users do not stumble upon the issue unawares.

Closes dokku/dokku-postgres#212
2021-09-13 03:21:23 -04:00
Jose Diaz-Gonzalez
8b002c7a7c fix: do not create the new database automatically
This should only be done if importing a given database. Instead, always import into the specified database name.

Refs #218
2021-09-13 02:59:01 -04:00
Jose Diaz-Gonzalez
7ca7c20ef8 fix: pin the image and image version of a created service at creation time
This will help ensure that users upgrading to a new plugin version who stop/start databases will always get the same version. This is particularly important for datastores such as elasticsearch and postgres that have more involved upgraded processes.
2021-09-13 02:28:41 -04:00
Jose Diaz-Gonzalez
36b5a80263 docs: document using postgis
The previous example on using an alternative image isn't verbose enough for some users, so we use the new readme generation facilities to inject a note for postgis usage.

Closes #213
2021-09-13 01:37:22 -04:00
Jose Diaz-Gonzalez
5855d1bdd5 docs: document the process of upgrading major postgres versions
While it would be nice to automatically handle this, there is a ton of pain in doing so. Rather than being smart about it, document the process so that users can make rational decisions about their upgrade process.

Closes dokku/dokku-postgres#219
2021-09-13 01:26:58 -04:00
Jose Diaz-Gonzalez
b8a8b139f9 docs: add folder for supplementary documentation 2021-09-13 01:23:26 -04:00
Jose Diaz-Gonzalez
0d84637c85 docs: add ability to inject supplementary documentation into the readme
Some commands - such as link or upgrade - have extra documenation on a per-plugin basis. Rather than make some sort of weird templating logic in the help output generation, that documentation is added directly to the repository and then injected at generation time.
2021-09-13 01:21:19 -04:00
Jose Diaz-Gonzalez
d72138aad3 docs: properly spell lollipop
I've been misspelling my stand-in variable name for years...
2021-09-13 00:57:34 -04:00
Jose Diaz-Gonzalez
3ab20b0b4f feat: allow setting shm-size on created containers
Refs dokku/dokku-postgres#188
Closes dokku/dokku-postgres#201
2021-09-13 00:46:48 -04:00
Jose Diaz-Gonzalez
9e6d072531 Merge pull request #208 from Schlepptop/fix-unlink
Fix #203
2021-09-13 00:03:05 -04:00
Jose Diaz-Gonzalez
254c68c326 Merge branch 'master' into fix-unlink 2021-09-13 00:02:52 -04:00
Jose Diaz-Gonzalez
0387c2d30b feat: restore the imported database to the service's database
Refs #207
2021-09-12 23:48:10 -04:00
Jose Diaz-Gonzalez
4cef2b9207 docs: correctly represent the url and env vars that get injected via docker link
Closes dokku/dokku-postgres#221
2021-09-12 23:38:52 -04:00
Jose Diaz-Gonzalez
7a17f22d6c docs: fix the variable reference for plugins where the alias does not match the variable
Closes dokku/dokku-postgres#199
2021-09-12 22:55:02 -04:00
Jose Diaz-Gonzalez
535f40143d Merge pull request #228 from benatkin/function-command-desc-tense
make tense in command descriptions more consistent
2021-09-12 22:37:36 -04:00
Benjamin Atkin
952036bbaa make tense in command descriptions more consistent 2021-09-12 22:36:31 -04:00
Jose Diaz-Gonzalez
1b37774e05 chore: drop extra print in readme generator 2021-09-12 22:33:06 -04:00
Jose Diaz-Gonzalez
db78a92687 dev: add file (for linting) and nano (for in-container editing) to devcontainer 2021-09-12 22:20:42 -04:00
Jose Diaz-Gonzalez
6d948290e7 fix: use updated python shebang 2021-09-12 22:18:01 -04:00
Jose Diaz-Gonzalez
1afdffef8d feat: add ability to set container config options during create/clone/upgrade actions
Also add to documentation where possible.

Closes dokku/dokku-mongo#131
2021-09-12 22:16:14 -04:00
Jose Diaz-Gonzalez
38bfaea286 fix: allow non-english characters in :connect shell
Closes dokku/dokku-mysql#116
2021-09-12 08:24:58 -04:00
Jose Diaz-Gonzalez
e85d96b3a1 feat: add the ability to constrain memory on service start/clone
Refs dokku/dokku-redis#86
2021-09-12 07:43:02 -04:00
Jose Diaz-Gonzalez
0657f47442 docs: add a note as to how to specify an interface/ip to bind on when exposing a service
Closes dokku/dokku-mongo#128
2021-09-12 07:09:55 -04:00
Jose Diaz-Gonzalez
2b4ff03bff docs: translate single-quotes into backticks 2021-09-12 07:01:58 -04:00
Jose Diaz-Gonzalez
2c7a655c87 docs: document how to restore a backup 2021-09-12 06:59:50 -04:00
schlepptop
34f02b6aa4 Empty commit; trigger retest 2020-07-19 14:26:01 +02:00
schlepptop
fc7ddc3e2a Fix #203 2020-07-18 16:55:23 +02:00
64 changed files with 877 additions and 339 deletions

View File

@@ -18,7 +18,7 @@ main() {
# built in the Dockerfile
PLUGIN_NAME="$(source /tmp/.env && echo "$PLUGIN_NAME")"
PLUGIN_VARIABLE="$(source /tmp/.env && echo "$PLUGIN_VARIABLE")"
echo "export ${PLUGIN_VARIABLE}_HOST_ROOT=${SERVICE_HOST_ROOT}/$PLUGIN_NAME" > /etc/default/dokku
echo "export ${PLUGIN_VARIABLE}_HOST_ROOT=${SERVICE_HOST_ROOT}/$PLUGIN_NAME" >/etc/default/dokku
}
main "$@"
main "$@"

View File

@@ -1,7 +1,7 @@
FROM dokku/dokku:latest
RUN apt-get update
RUN apt-get install --no-install-recommends -y build-essential && \
RUN apt-get install --no-install-recommends -y build-essential file nano && \
apt-get clean autoclean && \
apt-get autoremove --yes && \
rm -rf /var/lib/apt/lists/* && \

View File

@@ -1 +1 @@
FROM postgres:13.4
FROM postgres:14.5

277
README.md
View File

@@ -1,6 +1,6 @@
# dokku postgres [![Build Status](https://img.shields.io/github/workflow/status/dokku/dokku-postgres/CI/master?style=flat-square "Build Status")](https://github.com/dokku/dokku-postgres/actions/workflows/ci.yml?query=branch%3Amaster) [![IRC Network](https://img.shields.io/badge/irc-libera-blue.svg?style=flat-square "IRC Libera")](https://webchat.libera.chat/?channels=dokku)
# dokku postgres [![Build Status](https://img.shields.io/github/actions/workflow/status/dokku/dokku-postgres/ci.yml?branch=master&style=flat-square "Build Status")](https://github.com/dokku/dokku-postgres/actions/workflows/ci.yml?query=branch%3Amaster) [![IRC Network](https://img.shields.io/badge/irc-libera-blue.svg?style=flat-square "IRC Libera")](https://webchat.libera.chat/?channels=dokku)
Official postgres plugin for dokku. Currently defaults to installing [postgres 13.4](https://hub.docker.com/_/postgres/).
Official postgres plugin for dokku. Currently defaults to installing [postgres 14.5](https://hub.docker.com/_/postgres/).
## Requirements
@@ -18,14 +18,14 @@ sudo dokku plugin:install https://github.com/dokku/dokku-postgres.git postgres
```
postgres:app-links <app> # list all postgres service links for a given app
postgres:backup <service> <bucket-name> [--use-iam] # creates a backup of the postgres service to an existing s3 bucket
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 <service> # removes backup authentication for the postgres service
postgres:backup-schedule <service> <schedule> <bucket-name> [--use-iam] # schedules a backup of the postgres service
postgres:backup <service> <bucket-name> [--use-iam] # create a backup of the postgres service to an existing s3 bucket
postgres:backup-auth <service> <aws-access-key-id> <aws-secret-access-key> <aws-default-region> <aws-signature-version> <endpoint-url> # set up authentication for backups on the postgres service
postgres:backup-deauth <service> # remove backup authentication for the postgres service
postgres:backup-schedule <service> <schedule> <bucket-name> [--use-iam] # schedule a backup of the postgres service
postgres:backup-schedule-cat <service> # cat the contents of the configured backup cronfile for the service
postgres:backup-set-encryption <service> <passphrase> # sets encryption for all future backups of postgres service
postgres:backup-unschedule <service> # unschedules the backup of the postgres service
postgres:backup-unset-encryption <service> # unsets encryption for future backups of the postgres service
postgres:backup-set-encryption <service> <passphrase> # set encryption for all future backups of postgres service
postgres:backup-unschedule <service> # unschedule the backup of the postgres service
postgres:backup-unset-encryption <service> # unset encryption for future backups of the postgres service
postgres:clone <service> <new-service> [--clone-flags...] # create container <new-name> then copy data from <name> into <new-name>
postgres:connect <service> # connect to the service via the postgres connection tool
postgres:create <service> [--create-flags...] # create a postgres service
@@ -33,14 +33,15 @@ postgres:destroy <service> [-f|--force] # delete the postgres service
postgres:enter <service> # enter or run a command in a running postgres service container
postgres:exists <service> # check if the postgres service exists
postgres:export <service> # export a dump of the postgres service database
postgres:expose <service> <ports...> # expose a postgres service on custom port if provided (random port otherwise)
postgres:expose <service> <ports...> # expose a postgres service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)
postgres:import <service> # import a dump into the postgres service database
postgres:info <service> [--single-info-flag] # print the service information
postgres:link <service> <app> [--link-flags...] # link the postgres service to the app
postgres:linked <service> <app> # check if the postgres service is linked to an app
postgres:links <service> # list all apps linked to the postgres service
postgres:list # list all postgres services
postgres:logs <service> [-t|--tail] # print the most recent log(s) for this service
postgres:logs <service> [-t|--tail] <tail-num-optional> # print the most recent log(s) for this service
postgres:pause <service> # pause a running postgres service
postgres:promote <service> <app> # promote service <service> as DATABASE_URL in <app>
postgres:restart <service> # graceful shutdown and restart of the postgres service container
postgres:start <service> # start a previously stopped postgres service
@@ -52,7 +53,7 @@ postgres:upgrade <service> [--upgrade-flags...] # upgrade service <service> t
## 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.
Help for any commands can be displayed by specifying the command as an argument to postgres:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `postgres:help` command for any undocumented commands.
### Basic Usage
@@ -65,31 +66,40 @@ dokku postgres:create <service> [--create-flags...]
flags:
- `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: `None`)
- `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with
- `-i|--image IMAGE`: the image name to start the service with
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
- `-p|--password PASSWORD`: override the user-level service password
- `-r|--root-password PASSWORD`: override the root-level service password
- `-s|--shm-size SHM_SIZE`: override shared memory size for postgres docker container
Create a postgres service named lolipop:
Create a postgres service named lollipop:
```shell
dokku postgres:create lolipop
dokku postgres:create lollipop
```
You can also specify the image and image version to use for the service. It *must* be compatible with the postgres image.
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
export POSTGRES_IMAGE="postgres"
export POSTGRES_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
dokku postgres:create lollipop
```
You can also specify custom environment variables to start the postgres service in semi-colon separated form.
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
export POSTGRES_CUSTOM_ENV="USER=alpha;HOST=beta"
dokku postgres:create lollipop
```
Official Postgres docker images does not include postgis extension (amongst others). The following example creates a new postgres service using `postgis/postgis:13-3.1` image, which includes the `postgis` extension.
```shell
dokku postgres:create postgis-database --image "postgis/postgis" --image-version "13-3.1"
```
### print the service information
@@ -115,22 +125,22 @@ flags:
Get connection information as follows:
```shell
dokku postgres:info lolipop
dokku postgres:info lollipop
```
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
dokku postgres:info lolipop --id
dokku postgres:info lolipop --internal-ip
dokku postgres:info lolipop --links
dokku postgres:info lolipop --service-root
dokku postgres:info lolipop --status
dokku postgres:info lolipop --version
dokku postgres:info lollipop --config-dir
dokku postgres:info lollipop --data-dir
dokku postgres:info lollipop --dsn
dokku postgres:info lollipop --exposed-ports
dokku postgres:info lollipop --id
dokku postgres:info lollipop --internal-ip
dokku postgres:info lollipop --links
dokku postgres:info lollipop --service-root
dokku postgres:info lollipop --status
dokku postgres:info lollipop --version
```
### list all postgres services
@@ -150,23 +160,29 @@ dokku postgres:list
```shell
# usage
dokku postgres:logs <service> [-t|--tail]
dokku postgres:logs <service> [-t|--tail] <tail-num-optional>
```
flags:
- `-t|--tail`: do not stop when end of the logs are reached and wait for additional output
- `-t|--tail [<tail-num>]`: do not stop when end of the logs are reached and wait for additional output
You can tail logs for a particular service:
```shell
dokku postgres:logs lolipop
dokku postgres:logs lollipop
```
By default, logs will not be tailed, but you can do this with the --tail flag:
```shell
dokku postgres:logs lolipop --tail
dokku postgres:logs lollipop --tail
```
The default tail setting is to show all logs, but an initial count can also be specified:
```shell
dokku postgres:logs lollipop --tail 5
```
### link the postgres service to the app
@@ -181,48 +197,48 @@ 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.
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
dokku postgres:link lollipop playground
```
The following environment variables will be set automatically by docker (not on the app itself, so they wont 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
DOKKU_POSTGRES_LOLLIPOP_NAME=/lollipop/DATABASE
DOKKU_POSTGRES_LOLLIPOP_PORT=tcp://172.17.0.1:5432
DOKKU_POSTGRES_LOLLIPOP_PORT_5432_TCP=tcp://172.17.0.1:5432
DOKKU_POSTGRES_LOLLIPOP_PORT_5432_TCP_PROTO=tcp
DOKKU_POSTGRES_LOLLIPOP_PORT_5432_TCP_PORT=5432
DOKKU_POSTGRES_LOLLIPOP_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
DATABASE_URL=postgres://lollipop:SOME_PASSWORD@dokku-postgres-lollipop:5432/lollipop
```
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:
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.
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
dokku postgres:link lollipop playground
```
This will cause `DATABASE_URL` to be set as:
```
postgres2://lolipop:SOME_PASSWORD@dokku-postgres-lolipop:5432/lolipop
postgres2://lollipop:SOME_PASSWORD@dokku-postgres-lollipop:5432/lollipop
```
### unlink the postgres service from the app
@@ -237,7 +253,7 @@ You can unlink a postgres service:
> NOTE: this will restart your app and unset related environment variables
```shell
dokku postgres:unlink lolipop playground
dokku postgres:unlink lollipop playground
```
### Service Lifecycle
@@ -253,8 +269,10 @@ dokku postgres:connect <service>
Connect to the service via the postgres connection tool:
> NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098
```shell
dokku postgres:connect lolipop
dokku postgres:connect lollipop
```
### enter or run a command in a running postgres service container
@@ -264,19 +282,21 @@ dokku postgres:connect lolipop
dokku postgres:enter <service>
```
A bash prompt can be opened against a running service. Filesystem changes will not be saved to disk.
A bash prompt can be opened against a running service. Filesystem changes will not be saved to disk.
> NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098
```shell
dokku postgres:enter lolipop
dokku postgres:enter lollipop
```
You may also run a command directly against the service. Filesystem changes will not be saved to disk.
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
dokku postgres:enter lollipop touch /tmp/test
```
### expose a postgres service on custom port if provided (random port otherwise)
### expose a postgres service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)
```shell
# usage
@@ -286,7 +306,13 @@ 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
dokku postgres:expose lollipop 5432
```
Expose the service on the service's normal ports, with the first on a specified ip adddress (127.0.0.1):
```shell
dokku postgres:expose lollipop 127.0.0.1:5432
```
### unexpose a previously exposed postgres service
@@ -299,7 +325,7 @@ dokku postgres:unexpose <service>
Unexpose the service, removing access to it from the public interface (`0.0.0.0`):
```shell
dokku postgres:unexpose lolipop
dokku postgres:unexpose lollipop
```
### promote service <service> as DATABASE_URL in <app>
@@ -328,7 +354,7 @@ This will replace `DATABASE_URL` with the url from other_service and generate an
```
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
DOKKU_DATABASE_SILVER_URL=postgres://lollipop:SOME_PASSWORD@dokku-postgres-lollipop:5432/lollipop
```
### start a previously stopped postgres service
@@ -341,7 +367,7 @@ dokku postgres:start <service>
Start the service:
```shell
dokku postgres:start lolipop
dokku postgres:start lollipop
```
### stop a running postgres service
@@ -351,10 +377,23 @@ dokku postgres:start lolipop
dokku postgres:stop <service>
```
Stop the service and the running container:
Stop the service and removes the running container:
```shell
dokku postgres:stop lolipop
dokku postgres:stop lollipop
```
### pause a running postgres service
```shell
# usage
dokku postgres:pause <service>
```
Pause the running container for the service:
```shell
dokku postgres:pause lollipop
```
### graceful shutdown and restart of the postgres service container
@@ -367,7 +406,7 @@ dokku postgres:restart <service>
Restart the service:
```shell
dokku postgres:restart lolipop
dokku postgres:restart lollipop
```
### upgrade service <service> to the specified versions
@@ -379,15 +418,48 @@ dokku postgres:upgrade <service> [--upgrade-flags...]
flags:
- `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: `None`)
- `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with
- `-i|--image IMAGE`: the image name to start the service with
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
- `-R|--restart-apps "true"`: whether to force an app restart
- `-s|--shm-size SHM_SIZE`: override shared memory size for postgres docker container
You can upgrade an existing service to a new image or image-version:
```shell
dokku postgres:upgrade lolipop
dokku postgres:upgrade lollipop
```
Postgres does not handle upgrading data for major versions automatically (eg. 11 => 12). Upgrades should be done manually. Users are encouraged to upgrade to the latest minor release for their postgres version before performing a major upgrade.
While there are many ways to upgrade a postgres database, for safety purposes, it is recommended that an upgrade is performed by exporting the data from an existing database and importing it into a new database. This also allows testing to ensure that applications interact with the database correctly after the upgrade, and can be used in a staging environment.
The following is an example of how to upgrade a postgres database named `lollipop-11` from 11.13 to 12.8.
```shell
# stop any linked apps
dokku ps:stop linked-app
# export the database contents
dokku postgres:export lollipop-11 > /tmp/lollipop-11.export
# create a new database at the desired version
dokku postgres:create lollipop-12 --image-version 12.8
# import the export file
dokku postgres:import lollipop-12 < /tmp/lollipop-11.export
# run any sql tests against the new database to verify the import went smoothly
# unlink the old database from your apps
dokku postgres:unlink lollipop-11 linked-app
# link the new database to your apps
dokku postgres:link lollipop-12 linked-app
# start the linked apps again
dokku ps:start linked-app
```
### Service Automation
@@ -401,7 +473,7 @@ Service scripting can be executed using the following commands:
dokku postgres:app-links <app>
```
List all postgres services that are linked to the 'playground' app.
List all postgres services that are linked to the `playground` app.
```shell
dokku postgres:app-links playground
@@ -416,16 +488,19 @@ dokku postgres:clone <service> <new-service> [--clone-flags...]
flags:
- `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: `None`)
- `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with
- `-i|--image IMAGE`: the image name to start the service with
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
- `-p|--password PASSWORD`: override the user-level service password
- `-r|--root-password PASSWORD`: override the root-level service password
- `-s|--shm-size SHM_SIZE`: override shared memory size for postgres docker container
You can clone an existing service to a new one:
```shell
dokku postgres:clone lolipop lolipop-2
dokku postgres:clone lollipop lollipop-2
```
### check if the postgres service exists
@@ -435,10 +510,10 @@ dokku postgres:clone lolipop lolipop-2
dokku postgres:exists <service>
```
Here we check if the lolipop postgres service exists.
Here we check if the lollipop postgres service exists.
```shell
dokku postgres:exists lolipop
dokku postgres:exists lollipop
```
### check if the postgres service is linked to an app
@@ -448,10 +523,10 @@ dokku postgres:exists lolipop
dokku postgres:linked <service> <app>
```
Here we check if the lolipop postgres service is linked to the 'playground' app.
Here we check if the lollipop postgres service is linked to the `playground` app.
```shell
dokku postgres:linked lolipop playground
dokku postgres:linked lollipop playground
```
### list all apps linked to the postgres service
@@ -461,10 +536,10 @@ dokku postgres:linked lolipop playground
dokku postgres:links <service>
```
List all apps linked to the 'lolipop' postgres service.
List all apps linked to the `lollipop` postgres service.
```shell
dokku postgres:links lolipop
dokku postgres:links lollipop
```
### Data Management
@@ -481,7 +556,7 @@ dokku postgres:import <service>
Import a datastore dump:
```shell
dokku postgres:import lolipop < database.dump
dokku postgres:import lollipop < data.dump
```
### export a dump of the postgres service database
@@ -494,13 +569,19 @@ dokku postgres:export <service>
By default, datastore output is exported to stdout:
```shell
dokku postgres:export lolipop
dokku postgres:export lollipop
```
You can redirect this output to a file:
```shell
dokku postgres:export lolipop > lolipop.dump
dokku postgres:export lollipop > data.dump
```
Note that the export will result in a file containing the binary postgres export data. It can be converted to plain text using `pg_restore` as follows
```shell
pg_restore data.dump -f plain.sql
```
### Backups
@@ -511,7 +592,7 @@ You may skip the `backup-auth` step if your dokku install is running within EC2
Backups can be performed using the backup commands:
### sets up authentication for backups on the postgres service
### set up authentication for backups on the postgres service
```shell
# usage
@@ -521,28 +602,28 @@ dokku postgres:backup-auth <service> <aws-access-key-id> <aws-secret-access-key>
Setup s3 backup authentication:
```shell
dokku postgres:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
dokku postgres:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
```
Setup s3 backup authentication with different region:
```shell
dokku postgres:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
dokku postgres:backup-auth lollipop 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
dokku postgres:backup-auth lollipop 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
dokku postgres:backup-auth lollipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
```
### removes backup authentication for the postgres service
### remove backup authentication for the postgres service
```shell
# usage
@@ -552,10 +633,10 @@ dokku postgres:backup-deauth <service>
Remove s3 authentication:
```shell
dokku postgres:backup-deauth lolipop
dokku postgres:backup-deauth lollipop
```
### creates a backup of the postgres service to an existing s3 bucket
### create a backup of the postgres service to an existing s3 bucket
```shell
# usage
@@ -566,13 +647,19 @@ 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`:`
Backup the `lollipop` service to the `my-s3-bucket` bucket on `AWS`:`
```shell
dokku postgres:backup lolipop my-s3-bucket --use-iam
dokku postgres:backup lollipop my-s3-bucket --use-iam
```
### sets encryption for all future backups of postgres service
Restore a backup file (assuming it was extracted via `tar -xf backup.tgz`):
```shell
dokku postgres:import lollipop < backup-folder/export
```
### set encryption for all future backups of postgres service
```shell
# usage
@@ -582,10 +669,10 @@ dokku postgres:backup-set-encryption <service> <passphrase>
Set the GPG-compatible passphrase for encrypting backups for backups:
```shell
dokku postgres:backup-set-encryption lolipop
dokku postgres:backup-set-encryption lollipop
```
### unsets encryption for future backups of the postgres service
### unset encryption for future backups of the postgres service
```shell
# usage
@@ -595,10 +682,10 @@ dokku postgres:backup-unset-encryption <service>
Unset the `GPG` encryption passphrase for backups:
```shell
dokku postgres:backup-unset-encryption lolipop
dokku postgres:backup-unset-encryption lollipop
```
### schedules a backup of the postgres service
### schedule a backup of the postgres service
```shell
# usage
@@ -614,13 +701,13 @@ 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
dokku postgres:backup-schedule lollipop "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
dokku postgres:backup-schedule lollipop "0 3 * * *" my-s3-bucket --use-iam
```
### cat the contents of the configured backup cronfile for the service
@@ -633,10 +720,10 @@ dokku postgres:backup-schedule-cat <service>
Cat the contents of the configured backup cronfile for the service:
```shell
dokku postgres:backup-schedule-cat lolipop
dokku postgres:backup-schedule-cat lollipop
```
### unschedules the backup of the postgres service
### unschedule the backup of the postgres service
```shell
# usage
@@ -646,7 +733,7 @@ dokku postgres:backup-unschedule <service>
Remove the scheduled backup from cron:
```shell
dokku postgres:backup-unschedule lolipop
dokku postgres:backup-unschedule lollipop
```
### Disabling `docker pull` calls

View File

@@ -5,7 +5,7 @@ import os
import re
def compile(service, version, variable, alias, image, scheme, ports, sponsors, unimplemented, dokku_version):
def compile(service, version, variable, alias, image, scheme, ports, sponsors, options, unimplemented, dokku_version):
prefix = "\n\n".join([
header(service),
description(service, image, version),
@@ -22,7 +22,7 @@ def compile(service, version, variable, alias, image, scheme, ports, sponsors, u
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),
usage_section(service, variable, alias, image, scheme, ports, options, unimplemented),
]
)
.replace("\n\n\n\n\n", "\n")
@@ -35,7 +35,7 @@ def header(service):
return " ".join(
[
f"# dokku {service}",
f'[![Build Status](https://img.shields.io/github/workflow/status/dokku/dokku-{service}/CI/master?style=flat-square "Build Status")](https://github.com/dokku/dokku-{service}/actions/workflows/ci.yml?query=branch%3Amaster)',
f'[![Build Status](https://img.shields.io/github/actions/workflow/status/dokku/dokku-{service}/ci.yml?branch=master&style=flat-square "Build Status")](https://github.com/dokku/dokku-{service}/actions/workflows/ci.yml?query=branch%3Amaster)',
f'[![IRC Network](https://img.shields.io/badge/irc-libera-blue.svg?style=flat-square "IRC Libera")](https://webchat.libera.chat/?channels=dokku)',
]
)
@@ -115,31 +115,31 @@ def commands_section(service, variable, alias, image, scheme, ports, unimplement
return "\n".join(content)
def usage_section(service, variable, alias, image, scheme, ports, unimplemented):
def usage_section(service, variable, alias, image, scheme, ports, options, 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),
f"Help for any commands can be displayed by specifying the command as an argument to {service}:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `{service}:help` command for any undocumented commands.",
usage_intro(service, variable, alias, image, scheme, ports, options, unimplemented),
usage_lifecycle(service, variable, alias, image, scheme, ports, options, unimplemented),
usage_automation(service, variable, alias, image, scheme, ports, options, unimplemented),
usage_data_management(service, variable, alias, image, scheme, ports, options, unimplemented),
usage_backup(service, variable, alias, image, scheme, ports, options, unimplemented),
usage_docker_pull(service, variable, alias, image, scheme, ports, options, unimplemented),
]
)
def usage_intro(service, variable, alias, image, scheme, ports, unimplemented):
def usage_intro(service, variable, alias, image, scheme, ports, options, unimplemented):
commands = ["create", "info", "list", "logs", "link", "unlink"]
content = ["### Basic Usage"]
return fetch_commands_content(
service, variable, alias, image, scheme, ports, unimplemented, commands, content
service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
)
def usage_lifecycle(service, variable, alias, image, scheme, ports, unimplemented):
def usage_lifecycle(service, variable, alias, image, scheme, ports, options, unimplemented):
commands = [
"connect",
"enter",
@@ -148,6 +148,7 @@ def usage_lifecycle(service, variable, alias, image, scheme, ports, unimplemente
"promote",
"start",
"stop",
"pause",
"restart",
"upgrade",
]
@@ -159,11 +160,11 @@ def usage_lifecycle(service, variable, alias, image, scheme, ports, unimplemente
]
return fetch_commands_content(
service, variable, alias, image, scheme, ports, unimplemented, commands, content
service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
)
def usage_automation(service, variable, alias, image, scheme, ports, unimplemented):
def usage_automation(service, variable, alias, image, scheme, ports, options, unimplemented):
commands = ["app-links", "clone", "exists", "linked", "links"]
content = [
"### Service Automation",
@@ -173,11 +174,11 @@ def usage_automation(service, variable, alias, image, scheme, ports, unimplement
]
return fetch_commands_content(
service, variable, alias, image, scheme, ports, unimplemented, commands, content
service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
)
def usage_data_management(service, variable, alias, image, scheme, ports, unimplemented):
def usage_data_management(service, variable, alias, image, scheme, ports, options, unimplemented):
commands = ["import", "export"]
content = [
"### Data Management",
@@ -187,11 +188,11 @@ def usage_data_management(service, variable, alias, image, scheme, ports, unimpl
]
return fetch_commands_content(
service, variable, alias, image, scheme, ports, unimplemented, commands, content
service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
)
def usage_backup(service, variable, alias, image, scheme, ports, unimplemented):
def usage_backup(service, variable, alias, image, scheme, ports, options, unimplemented):
commands = [
"backup-auth",
"backup-deauth",
@@ -214,11 +215,11 @@ def usage_backup(service, variable, alias, image, scheme, ports, unimplemented):
]
return fetch_commands_content(
service, variable, alias, image, scheme, ports, unimplemented, commands, content
service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
)
def usage_docker_pull(service, variable, alias, image, scheme, ports, unimplemented):
def usage_docker_pull(service, variable, alias, image, scheme, ports, options, unimplemented):
service_prefix = service.upper()
return "\n".join(
[
@@ -232,11 +233,11 @@ def usage_docker_pull(service, variable, alias, image, scheme, ports, unimplemen
def fetch_commands_content(
service, variable, alias, image, scheme, ports, unimplemented, commands, content
service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
):
i = 0
for command in commands:
output = command_help(command, service, variable, alias, image, scheme, ports, unimplemented)
output = command_help(command, service, variable, alias, image, scheme, ports, options, unimplemented)
if output == "":
continue
content.append(output)
@@ -274,7 +275,7 @@ def parse_args(line):
return " ".join(arguments)
def command_help(command, service, variable, alias, image, scheme, ports, unimplemented):
def command_help(command, service, variable, alias, image, scheme, ports, options, unimplemented):
if command in unimplemented:
return ""
@@ -300,12 +301,20 @@ def command_help(command, service, variable, alias, image, scheme, ports, unimpl
content.append("flags:")
content.append("")
for flag in data["flags"]:
if "--config-options" in flag and options != "":
flag = f"{flag} (default: `{options}`)"
content.append(f"- {flag}")
if len(data["examples"]) > 0:
content.append("")
content.append(data["examples"])
doc_file = os.path.join("docs", f"{command}.md")
if os.path.isfile(doc_file):
content.append("")
with open(doc_file) as f:
content.append(f.read())
return "\n" + "\n".join(content)
@@ -423,13 +432,13 @@ def command_data(command, service, variable, alias, image, scheme, ports):
def process_sentence(sentence_lines):
sentence_lines = " ".join(sentence_lines)
sentences = ". ".join(
upperfirst(i.strip()) for i in sentence_lines.split(".")
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("."):
for sentence in sentences.split(". "):
parts = []
for word in sentence.strip().split(" "):
if word.isupper() and len(word) > 1:
@@ -444,7 +453,11 @@ def process_sentence(sentence_lines):
text = ". ".join(text)
# some cleanup
text = text.replace("(0. 0. 0. 0)", "(`0.0.0.0`)")
text = text.replace("(0.0.0.0)", "(`0.0.0.0`)")
text = text.replace("'", "`")
text = text.replace("`s", "'s")
text = text.replace("``", "`")
text = text.strip(" ")
return text
@@ -473,6 +486,7 @@ def main():
variable = None
image = None
alias = None
options = None
unimplemented = []
with open("Dockerfile") as f:
@@ -499,6 +513,13 @@ def main():
if match is not None:
unimplemented = [s.strip('"') for s in match.group(1).split(" ")]
with open("config") as f:
for line in f.readlines():
if f"{variable}_CONFIG_OPTIONS" in line:
match = re.search('"(.+)"', line)
if match is not None:
options = match.group(1)
sponsors = []
with open("plugin.toml") as f:
for line in f.readlines():
@@ -506,7 +527,7 @@ def main():
sponsors = re.search("\[([\"\w\s,_-]+)\]", line).group(1)
sponsors = [s.strip("\"") for s in sponsors.split(",")]
text = compile(service, version, variable, alias, image, scheme, ports, sponsors, unimplemented, "0.19.x+")
text = compile(service, version, variable, alias, image, scheme, ports, sponsors, options, unimplemented, "0.19.x+")
base_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
readme_file = os.path.join(base_path, "README.md")

View File

@@ -1,7 +1,7 @@
#!/usr/bin/env bash
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
[[ " help $PLUGIN_COMMAND_PREFIX:help $PLUGIN_COMMAND_PREFIX $PLUGIN_COMMAND_PREFIX:default " == *" $1 "* ]] || [[ "$1" == "$PLUGIN_COMMAND_PREFIX:"* ]] || exit "$DOKKU_NOT_IMPLEMENTED_EXIT"
source "$PLUGIN_BASE_PATH/common/functions"
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x

View File

@@ -4,8 +4,87 @@ set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_AVAILABLE_PATH/config/functions"
add_to_links_file() {
declare desc="add an app to the service link file"
declare SERVICE="$1" APP="$2"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local LINKS_FILE="$SERVICE_ROOT/LINKS"
touch "$LINKS_FILE"
sed -i.bak "/^$APP\$/d" "$LINKS_FILE" && rm "$LINKS_FILE.bak"
echo "$APP" >>"$LINKS_FILE"
sort "$LINKS_FILE" -u -o "$LINKS_FILE"
}
auth_service_filter() {
declare desc="calls user-service plugin trigger"
declare SERVICES=("$@")
local user_auth_count
if [[ "${#SERVICES[@]}" -eq 0 ]]; then
return
fi
user_auth_count="$(find "$PLUGIN_PATH"/enabled/*/user-auth-service 2>/dev/null | wc -l)"
# no plugin trigger exists
if [[ $user_auth_count == 0 ]]; then
# echo out all the services since there is no plugin trigger
for SERVICE in "${SERVICES[@]}"; do
[[ -n "$SERVICE" ]] && echo "$SERVICE"
done
return 0
fi
# this plugin trigger exists in the core `20_events` plugin
if [[ "$user_auth_count" == 1 ]] && [[ -f "$PLUGIN_PATH"/enabled/20_events/user-auth-service ]]; then
# echo out all the services since there is no valid plugin trigger
for SERVICE in "${SERVICES[@]}"; do
[[ -n "$SERVICE" ]] && echo "$SERVICE"
done
return 0
fi
export SSH_USER=${SSH_USER:=$USER}
export SSH_NAME=${NAME:="default"}
# the output of this trigger should be all the services a user has access to
plugn trigger user-auth-service "$SSH_USER" "$SSH_NAME" "$PLUGIN_COMMAND_PREFIX" "${SERVICES[@]}"
}
fn-services-list() {
declare desc="prints a filtered list of all local apps"
declare FILTER="$1"
local services=()
pushd "$PLUGIN_DATA_ROOT" >/dev/null
for f in *; do
[[ -d $f ]] || continue
services+=("$f")
done
popd &>/dev/null || pushd "/tmp" >/dev/null
if [[ "${#services[@]}" -eq 0 ]]; then
return
fi
if [[ "$FILTER" == "false" ]]; then
for service in "${services[@]}"; do
if [[ -n "$service" ]]; then
echo "$service"
fi
done
return
fi
for service in $(auth_service_filter "${services[@]}" 2>/dev/null); do
if [[ -n "$service" ]]; then
echo "$service"
fi
done
}
docker_ports_options() {
declare desc="Exports a list of exposed ports"
declare desc="export a list of exposed ports"
declare PORTS=("$@")
for ((i = 0; i < ${#PLUGIN_DATASTORE_PORTS[@]}; i++)); do
echo -n "-p ${PORTS[i]}:${PLUGIN_DATASTORE_PORTS[i]} "
@@ -13,25 +92,25 @@ docker_ports_options() {
}
get_container_ip() {
declare desc="Retrieves the ip address of a container"
declare desc="retrieve the ip address of a container"
declare CONTAINER_ID="$1"
docker inspect --format '{{ .NetworkSettings.IPAddress }}' "$CONTAINER_ID" 2>/dev/null
}
get_database_name() {
declare desc="Retrieves a sanitized database name"
declare desc="retrieve a sanitized database name"
declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
if [[ ! -f "$SERVICE_ROOT/DATABASE_NAME" ]]; then
echo "$SERVICE" > "$SERVICE_ROOT/DATABASE_NAME"
echo "$SERVICE" >"$SERVICE_ROOT/DATABASE_NAME"
fi
cat "$SERVICE_ROOT/DATABASE_NAME"
}
get_random_ports() {
declare desc="Retrieves N random ports"
declare desc="retrieve N random ports"
declare iterations="${1:-1}"
for ((i = 0; i < iterations; i++)); do
local port=$RANDOM
@@ -50,19 +129,28 @@ get_random_ports() {
}
get_service_name() {
declare desc="Retrieves a docker service label"
declare desc="retrieve a docker service label"
declare SERVICE="$1"
echo "dokku.${PLUGIN_COMMAND_PREFIX}.$SERVICE"
}
get_url_from_config() {
declare desc="Retrieves a given _URL from a list of configuration variables"
declare desc="retrieve a given _URL from a list of configuration variables"
declare EXISTING_CONFIG="$1" CONFIG_VAR="$2"
echo "$EXISTING_CONFIG" | grep "$CONFIG_VAR" | sed "s/$CONFIG_VAR:\s*//" | xargs
}
in_links_file() {
declare desc="check if a service LINKS file contains an app"
declare SERVICE="$1" APP="$2"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local LINKS_FILE="$SERVICE_ROOT/LINKS"
grep -qE "^$APP\$" "$LINKS_FILE"
}
is_container_status() {
declare desc="Returns 0 or 1 depending upon whether a given container has a certain status"
declare desc="return 0 or 1 depending upon whether a given container has a certain status"
declare CID="$1" STATUS="$2"
local TEMPLATE="{{.State.$STATUS}}"
local CONTAINER_STATUS=$(docker inspect -f "$TEMPLATE" "$CID" 2>/dev/null || true)
@@ -90,7 +178,7 @@ is_implemented_command() {
}
is_valid_service_name() {
declare desc="Validates a service name"
declare desc="validate a service name"
declare SERVICE="$1"
[[ -z "$SERVICE" ]] && return 1
@@ -102,7 +190,7 @@ is_valid_service_name() {
}
remove_from_links_file() {
declare desc="Removes an app from the service link file"
declare desc="remove an app from the service link file"
declare SERVICE="$1" APP="$2"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local LINKS_FILE="$SERVICE_ROOT/LINKS"
@@ -137,7 +225,7 @@ retry-docker-command() {
}
service_alternative_alias() {
declare desc="Retrieves an alternative alias for a service"
declare desc="retrieve an alternative alias for a service"
declare EXISTING_CONFIG="$1"
local COLORS=(AQUA BLACK BLUE FUCHSIA GRAY GREEN LIME MAROON NAVY OLIVE PURPLE RED SILVER TEAL WHITE YELLOW)
local ALIAS
@@ -154,14 +242,16 @@ service_alternative_alias() {
}
service_app_links() {
declare desc="Outputs all service links for a given app"
declare desc="output all service links for a given app"
declare APP="$1"
local SERVICE LINKED_APP
local LINKED_APP SERVICE SERVICE_ROOT
pushd "$PLUGIN_DATA_ROOT" >/dev/null
for SERVICE in *; do
[[ -f "$SERVICE/LINKS" ]] || continue
for LINKED_APP in $(<"$SERVICE/LINKS"); do
for SERVICE in $(fn-services-list true); do
[[ -n "$SERVICE" ]] || continue
SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
[[ -f "$SERVICE_ROOT/LINKS" ]] || continue
for LINKED_APP in $(<"$SERVICE_ROOT/LINKS"); do
if [[ "$LINKED_APP" == "$APP" ]]; then
echo "$SERVICE"
fi
@@ -170,7 +260,7 @@ service_app_links() {
}
service_backup() {
declare desc="Creates a backup of a service to an existing s3 bucket"
declare desc="create a backup of a service to an existing s3 bucket"
declare SERVICE="$1" BUCKET_NAME="$2" USE_IAM_OPTIONAL_FLAG="$3"
local SERVICE_BACKUP_ROOT="$PLUGIN_DATA_ROOT/$SERVICE/backup"
local BACKUP_ENCRYPTION_CONFIG_ROOT="$PLUGIN_DATA_ROOT/$SERVICE/backup-encryption"
@@ -221,8 +311,47 @@ service_backup() {
docker run --rm $BACKUP_PARAMETERS "$PLUGIN_S3BACKUP_IMAGE"
}
service_commit_config() {
declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local CONFIG_VARIABLE="${PLUGIN_VARIABLE}_CONFIG_OPTIONS"
local ENV_VARIABLE="${PLUGIN_VARIABLE}_CUSTOM_ENV"
custom_env="${!ENV_VARIABLE}"
[[ -n "$SERVICE_CUSTOM_ENV" ]] && custom_env="$SERVICE_CUSTOM_ENV"
if [[ -n $custom_env ]]; then
echo "$custom_env" | tr ';' "\n" >"$SERVICE_ROOT/ENV"
else
echo "" >"$SERVICE_ROOT/ENV"
fi
config_options="${!CONFIG_VARIABLE}"
[[ -n "$PLUGIN_CONFIG_OPTIONS" ]] && config_options="$PLUGIN_CONFIG_OPTIONS"
if [[ -n "$config_options" ]]; then
echo "$config_options" >"$SERVICE_ROOT/CONFIG_OPTIONS"
else
echo "" >"$SERVICE_ROOT/CONFIG_OPTIONS"
fi
if [[ -n "$SERVICE_MEMORY" ]]; then
echo "$SERVICE_MEMORY" >"$SERVICE_ROOT/SERVICE_MEMORY"
fi
if [[ -n "$SERVICE_SHM_SIZE" ]]; then
echo "$SERVICE_SHM_SIZE" >"$SERVICE_ROOT/SHM_SIZE"
fi
if [[ -n "$PLUGIN_IMAGE" ]]; then
echo "$PLUGIN_IMAGE" >"$SERVICE_ROOT/IMAGE"
fi
if [[ -n "$PLUGIN_IMAGE_VERSION" ]]; then
echo "$PLUGIN_IMAGE_VERSION" >"$SERVICE_ROOT/IMAGE_VERSION"
fi
}
service_backup_auth() {
declare desc="Sets up authentication"
declare desc="set up authentication"
declare SERVICE="$1" AWS_ACCESS_KEY_ID="$2" AWS_SECRET_ACCESS_KEY="$3" AWS_DEFAULT_REGION="$4" AWS_SIGNATURE_VERSION="$5" ENDPOINT_URL="$6"
local SERVICE_BACKUP_ROOT="$PLUGIN_DATA_ROOT/$SERVICE/backup"
@@ -244,7 +373,7 @@ service_backup_auth() {
}
service_backup_deauth() {
declare desc="Removes authentication"
declare desc="remove authentication"
declare SERVICE="$1"
local SERVICE_ROOT="${PLUGIN_DATA_ROOT}/${SERVICE}"
local SERVICE_BACKUP_ROOT="${SERVICE_ROOT}/backup/"
@@ -282,7 +411,7 @@ service_backup_schedule_cat() {
}
service_backup_set_encryption() {
declare desc="Sets up backup encryption"
declare desc="set up backup encryption"
declare SERVICE="$1" ENCRYPTION_KEY="$2"
local SERVICE_ROOT="${PLUGIN_DATA_ROOT}/${SERVICE}"
local SERVICE_BACKUP_ENCRYPTION_ROOT="${SERVICE_ROOT}/backup-encryption/"
@@ -292,7 +421,7 @@ service_backup_set_encryption() {
}
service_backup_unschedule() {
declare desc="unschedules the backup of the service"
declare desc="unschedule the backup of the service"
declare SERVICE="$1"
local CRON_FILE="/etc/cron.d/dokku-${PLUGIN_COMMAND_PREFIX}-${SERVICE}"
@@ -300,7 +429,7 @@ service_backup_unschedule() {
}
service_backup_unset_encryption() {
declare desc="Removes backup encryption"
declare desc="remove backup encryption"
declare SERVICE="$1"
local SERVICE_ROOT="${PLUGIN_DATA_ROOT}/${SERVICE}"
local SERVICE_BACKUP_ENCRYPTION_ROOT="${SERVICE_ROOT}/backup-encryption/"
@@ -309,12 +438,12 @@ service_backup_unset_encryption() {
}
service_container_rm() {
declare desc="Stops a service and removes the running container"
declare desc="stop a service and remove the running container"
declare SERVICE="$1"
local SERVICE_NAME="$(get_service_name "$SERVICE")"
local ID
service_stop "$SERVICE"
service_pause "$SERVICE"
ID=$(docker ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
# this may be 'true' in tests...
if [[ -z "$ID" ]] || [[ "$ID" == "true" ]]; then
@@ -329,14 +458,14 @@ service_container_rm() {
}
service_dns_hostname() {
declare desc="Retrieves the alias of a service"
declare desc="retrieve the alias of a service"
declare SERVICE="$1"
local SERVICE_NAME="$(get_service_name "$SERVICE")"
echo "$SERVICE_NAME" | tr ._ -
}
service_enter() {
declare desc="enters running app container of specified proc type"
declare desc="enter running app container of specified proc type"
declare SERVICE="$1" && shift 1
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local ID="$(cat "$SERVICE_ROOT/ID")"
@@ -350,8 +479,16 @@ service_enter() {
docker exec $DOKKU_RUN_OPTS $ID $EXEC_CMD "${@:-/bin/bash}"
}
service_exists() {
declare desc="returns 0 or 1 depending on whether service exists or not"
declare SERVICE="$1"
[[ -z "$SERVICE" ]] && return 1
[[ -d "$PLUGIN_DATA_ROOT/$SERVICE" ]] && return 0
return 1
}
service_exposed_ports() {
declare desc="Lists exposed ports for a service"
declare desc="list exposed ports for a service"
declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local PORT_FILE="$SERVICE_ROOT/PORT"
@@ -363,8 +500,14 @@ service_exposed_ports() {
}
service_image_exists() {
declare desc="Checks if the current image exists"
local IMAGE="$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION"
declare desc="check if the current image exists"
declare SERVICE="$1"
local plugin_image="$PLUGIN_IMAGE"
local plugin_image_version="$PLUGIN_IMAGE_VERSION"
[[ -f "$SERVICE_ROOT/IMAGE" ]] && plugin_image="$(cat "$SERVICE_ROOT/IMAGE")"
[[ -f "$SERVICE_ROOT/IMAGE_VERSION" ]] && plugin_image_version="$(cat "$SERVICE_ROOT/IMAGE_VERSION")"
local IMAGE="$plugin_image:$plugin_image_version"
if [[ "$(docker images -q "$IMAGE" 2>/dev/null)" == "" ]]; then
return 1
@@ -374,7 +517,7 @@ service_image_exists() {
}
service_info() {
declare desc="Retrieves information about a given service"
declare desc="retrieve information about a given service"
declare SERVICE="$1" INFO_FLAG="$2"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local SERVICE_URL=$(service_url "$SERVICE")
@@ -384,6 +527,7 @@ service_info() {
local flag_map=(
"--config-dir: ${SERVICE_ROOT}/${PLUGIN_CONFIG_SUFFIX}"
"--config-options: $(cat "$SERVICE_ROOT/CONFIG_OPTIONS" 2>/dev/null || true)"
"--data-dir: ${SERVICE_ROOT}/data"
"--dsn: ${SERVICE_URL}"
"--exposed-ports: $(service_exposed_ports "$SERVICE")"
@@ -395,7 +539,7 @@ service_info() {
"--version: $(service_version "$SERVICE")"
)
if [[ -z "$INFO_FLAG" ]]; then
dokku_log_info2 "$SERVICE $PLUGIN_COMMAND_PREFIX service information"
dokku_log_info2_quiet "$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#*: }")"
@@ -413,7 +557,7 @@ service_info() {
}
service_is_linked() {
declare desc="Links a service to an application"
declare desc="link a service to an application"
declare SERVICE="$1" APP="$2"
update_plugin_scheme_for_app "$APP"
local SERVICE_URL=$(service_url "$SERVICE")
@@ -427,7 +571,7 @@ service_is_linked() {
}
service_link() {
declare desc="Links a service to an application"
declare desc="link a service to an application"
declare SERVICE="$1" APP="$2"
update_plugin_scheme_for_app "$APP"
local SERVICE_URL=$(service_url "$SERVICE")
@@ -453,10 +597,8 @@ service_link() {
fi
[[ -n $LINK ]] && dokku_log_fail "Already linked as $LINK"
plugn trigger service-action pre-link "$SERVICE" "$APP"
touch "$LINKS_FILE"
echo "$APP" >>"$LINKS_FILE"
sort "$LINKS_FILE" -u -o "$LINKS_FILE"
plugn trigger service-action pre-link "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
add_to_links_file "$SERVICE" "$APP"
if declare -f -F add_passed_docker_option >/dev/null; then
# shellcheck disable=SC2034
@@ -466,13 +608,17 @@ service_link() {
dokku docker-options:add "$APP" build,deploy,run "--link $SERVICE_NAME:$SERVICE_DNS_HOSTNAME"
fi
[[ -n "$SERVICE_QUERYSTRING" ]] && SERVICE_URL="${SERVICE_URL}?${SERVICE_QUERYSTRING}"
plugn trigger service-action post-link "$SERVICE" "$APP"
config_set "$APP" "${ALIAS}_URL=$SERVICE_URL"
plugn trigger service-action post-link-complete "$SERVICE" "$APP"
plugn trigger service-action post-link "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
if [[ "$DOKKU_GLOBAL_FLAGS" == *"--no-restart"* ]]; then
config_set --no-restart "$APP" "${ALIAS}_URL=$SERVICE_URL"
else
config_set "$APP" "${ALIAS}_URL=$SERVICE_URL"
fi
plugn trigger service-action post-link-complete "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
}
service_linked_apps() {
declare desc="Lists all apps linked to a service for info output"
declare desc="list all apps linked to a service for info output"
declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local LINKS_FILE="$SERVICE_ROOT/LINKS"
@@ -484,7 +630,7 @@ service_linked_apps() {
}
service_links() {
declare desc="Lists all apps linked to a service"
declare desc="list all apps linked to a service"
declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local LINKS_FILE="$SERVICE_ROOT/LINKS"
@@ -496,30 +642,30 @@ service_links() {
}
service_list() {
declare desc="Lists all services and their status"
local SERVICES=$(ls "$PLUGIN_DATA_ROOT" 2>/dev/null)
declare desc="list all services and their status"
if [[ -z $SERVICES ]]; then
mapfile -t services < <(fn-services-list true)
if [[ "${#services[@]}" -eq 0 ]] || [[ -z "$services" ]]; then
dokku_log_warn "There are no $PLUGIN_SERVICE services"
return
fi
dokku_log_info2_quiet "$PLUGIN_SERVICE services"
for SERVICE in $SERVICES; do
echo "$SERVICE"
for service in "${services[@]}"; do
echo "${service}"
done
}
service_logs() {
declare desc="Displays logs for a service"
declare SERVICE="$1" TAIL_FLAG="$2"
declare desc="display logs for a service"
declare SERVICE="$1" TAIL_FLAG="$2" TAIL_COUNT="$3"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local ID=$(cat "$SERVICE_ROOT/ID")
local RE_INTEGER='^[0-9]+$'
DOKKU_LOGS_ARGS="--tail 100"
DOKKU_LOGS_ARGS="--tail $TAIL_COUNT"
if [[ "$TAIL_FLAG" == "-t" ]] || [[ "$TAIL_FLAG" == "--tail" ]]; then
DOKKU_LOGS_ARGS="--follow"
DOKKU_LOGS_ARGS+=" --follow"
fi
docker inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist"
@@ -549,13 +695,14 @@ service_parse_args() {
"--querystring") set -- "$@" "-q" ;;
"--restart-apps") set -- "$@" "-R" ;;
"--root-password") set -- "$@" "-r" ;;
"--shm-size") set -- "$@" "-s" ;;
"--user") set -- "$@" "-u" ;;
*) set -- "$@" "$arg" ;;
esac
done
OPTIND=1
while getopts "a:c:C:d:i:I:m:p:q:R:r:u:" opt; do
while getopts "a:c:C:d:i:I:m:p:q:R:r:s:u:" opt; do
case "$opt" in
a)
SERVICE_ALIAS="${OPTARG^^}"
@@ -591,6 +738,9 @@ service_parse_args() {
r)
export SERVICE_ROOT_PASSWORD=$OPTARG
;;
s)
export SERVICE_SHM_SIZE=$OPTARG
;;
u)
export SERVICE_USER=$OPTARG
;;
@@ -600,7 +750,7 @@ service_parse_args() {
}
service_password() {
declare desc="Fetch the password for a service"
declare desc="fetch the password for a service"
declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local PASSWORD_FILE="$SERVICE_ROOT/PASSWORD"
@@ -610,7 +760,7 @@ service_password() {
}
service_root_password() {
declare desc="Fetch the root password for a service"
declare desc="fetch the root password for a service"
declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local PASSWORD_FILE="$SERVICE_ROOT/ROOTPASSWORD"
@@ -620,14 +770,14 @@ service_root_password() {
}
service_port_expose() {
declare desc="Wrapper for exposing service ports"
declare desc="wrapper for exposing service ports"
declare SERVICE="$1"
service_start "$SERVICE" "true"
service_port_unpause "$SERVICE" "true" "${@:2}"
}
service_port_pause() {
declare desc="Pauses service exposure"
declare desc="pause service exposure"
declare SERVICE="$1" LOG_FAIL="$2"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local EXPOSED_NAME="$(get_service_name "$SERVICE").ambassador"
@@ -657,7 +807,7 @@ service_port_pause() {
}
service_port_unexpose() {
declare desc="Wrapper for pausing exposed service ports"
declare desc="wrapper for pausing exposed service ports"
declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local PORT_FILE="$SERVICE_ROOT/PORT"
@@ -666,7 +816,7 @@ service_port_unexpose() {
}
service_port_unpause() {
declare desc="Starts service exposure"
declare desc="start service exposure"
declare SERVICE="$1" LOG_FAIL="$2"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local SERVICE_NAME="$(get_service_name "$SERVICE")"
@@ -697,7 +847,7 @@ service_port_unpause() {
}
service_promote() {
declare desc="Promotes a secondary service to the primary env var"
declare desc="promote a secondary service to the primary env var"
declare SERVICE="$1" APP="$2"
local PLUGIN_DEFAULT_CONFIG_VAR="${PLUGIN_DEFAULT_ALIAS}_URL"
local EXISTING_CONFIG=$(config_all "$APP")
@@ -725,7 +875,7 @@ service_promote() {
}
service_set_alias() {
declare desc="Sets the alias in use for a service"
declare desc="sets the alias in use for a service"
declare SERVICE="$1" ALIAS="$2"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local ALIAS_FILE="$SERVICE_ROOT/ALIAS"
@@ -735,7 +885,7 @@ service_set_alias() {
}
service_status() {
declare desc="Displays the status of a service"
declare desc="display the status of a service"
declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local ID="$(cat "$SERVICE_ROOT/ID")"
@@ -746,26 +896,26 @@ service_status() {
echo "missing" && return 0
}
service_stop() {
declare desc="Stops a running service"
service_pause() {
declare desc="pause a running service"
declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local SERVICE_NAME="$(get_service_name "$SERVICE")"
local ID=$(docker ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
[[ -z $ID ]] && dokku_log_warn "Service is already stopped" && return 0
[[ -z $ID ]] && dokku_log_warn "Service is already paused" && return 0
if [[ -n $ID ]]; then
dokku_log_info2_quiet "Stopping container"
dokku_log_info2_quiet "Pausing container"
docker stop "$SERVICE_NAME" >/dev/null
service_port_pause "$SERVICE"
dokku_log_verbose_quiet "Container stopped"
dokku_log_verbose_quiet "Container paused"
else
dokku_log_verbose_quiet "No container exists for $SERVICE"
fi
}
service_unlink() {
declare desc="Unlinks an application from a service"
declare desc="unlink an application from a service"
declare SERVICE="$1" APP="$2"
update_plugin_scheme_for_app "$APP"
local SERVICE_URL=$(service_url "$SERVICE")
@@ -774,7 +924,7 @@ service_unlink() {
local SERVICE_DNS_HOSTNAME=$(service_dns_hostname "$SERVICE")
local LINK=($(echo "$EXISTING_CONFIG" | grep "$SERVICE_URL" | cut -d: -f1)) || true
plugn trigger service-action pre-unlink "$SERVICE" "$APP"
plugn trigger service-action pre-unlink "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
remove_from_links_file "$SERVICE" "$APP"
if declare -f -F add_passed_docker_option >/dev/null; then
@@ -786,20 +936,24 @@ service_unlink() {
fi
[[ -z ${LINK[*]} ]] && dokku_log_fail "Not linked to app $APP"
plugn trigger service-action post-unlink "$SERVICE" "$APP"
config_unset "$APP" "${LINK[*]}"
plugn trigger service-action post-unlink-complete "$SERVICE" "$APP"
plugn trigger service-action post-unlink "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
if [[ "$DOKKU_GLOBAL_FLAGS" == *"--no-restart"* ]]; then
config_unset --no-restart "$APP" "${LINK[@]}"
else
config_unset "$APP" "${LINK[@]}"
fi
plugn trigger service-action post-unlink-complete "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
}
service_version() {
declare desc="Displays the running version for an image"
declare desc="display the running version for an image"
declare SERVICE="$1"
local SERVICE_NAME="$(get_service_name "$SERVICE")"
docker inspect -f '{{.Config.Image}}' "$SERVICE_NAME" 2>/dev/null || true
}
update_plugin_scheme_for_app() {
declare desc="Retrieves the updated plugin scheme"
declare desc="retrieve the updated plugin scheme"
declare APP="$1"
local DATABASE_SCHEME
@@ -808,19 +962,31 @@ update_plugin_scheme_for_app() {
}
verify_service_name() {
declare desc="Verifies that a service exists"
declare SERVICE="$1"
[[ -z "$SERVICE" ]] && dokku_log_fail "(verify_service_name) SERVICE must not be null"
[[ ! -d "$PLUGIN_DATA_ROOT/$SERVICE" ]] && dokku_log_fail "$PLUGIN_SERVICE service $SERVICE does not exist"
declare desc="verify that a service exists"
declare SERVICE="$@"
if [[ -z "$SERVICE" ]]; then
dokku_log_fail "SERVICE must not be empty"
fi
if [[ ! -d "$PLUGIN_DATA_ROOT/$SERVICE" ]]; then
dokku_log_fail "$PLUGIN_SERVICE service $SERVICE does not exist"
fi
SERVICE="$(auth_service_filter "$SERVICE")"
if [[ -z "$SERVICE" ]]; then
dokku_log_fail "$PLUGIN_SERVICE service $SERVICE does not exist"
fi
return 0
}
write_database_name() {
declare desc="Writes a sanitized database name"
declare desc="write a sanitized database name"
declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
# some datastores do not like special characters in database names
# so we need to normalize them out
echo "$SERVICE" | tr .- _ > "$SERVICE_ROOT/DATABASE_NAME"
echo "$SERVICE" | tr .- _ >"$SERVICE_ROOT/DATABASE_NAME"
}

13
config
View File

@@ -3,7 +3,8 @@ _DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
export POSTGRES_IMAGE=${POSTGRES_IMAGE:="$(awk -F '[ :]' '{print $2}' "${_DIR}/Dockerfile")"}
export POSTGRES_IMAGE_VERSION=${POSTGRES_IMAGE_VERSION:="$(awk -F '[ :]' '{print $3}' "${_DIR}/Dockerfile")"}
export POSTGRES_ROOT=${POSTGRES_ROOT:="$DOKKU_LIB_ROOT/services/postgres"}
export POSTGRES_HOST_ROOT=${POSTGRES_HOST_ROOT:=$POSTGRES_ROOT}
export DOKKU_LIB_HOST_ROOT=${DOKKU_LIB_HOST_ROOT:=$DOKKU_LIB_ROOT}
export POSTGRES_HOST_ROOT=${POSTGRES_HOST_ROOT:="$DOKKU_LIB_HOST_ROOT/services/postgres"}
export PLUGIN_UNIMPLEMENTED_SUBCOMMANDS=()
export PLUGIN_COMMAND_PREFIX="postgres"
@@ -27,7 +28,9 @@ 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"
export PLUGIN_BUSYBOX_IMAGE="busybox:1.34.1-uclibc"
export PLUGIN_AMBASSADOR_IMAGE="dokku/ambassador:0.5.0"
export PLUGIN_S3BACKUP_IMAGE="dokku/s3backup:0.14.0"
export PLUGIN_WAIT_IMAGE="dokku/wait:0.6.0"
export POSTGRES_CONFIG_OPTIONS=${POSTGRES_CONFIG_OPTIONS:=""}

4
docs/README.md Normal file
View File

@@ -0,0 +1,4 @@
# Extra Documentation
The documentation in this folder is supplemental to using this plugin. It is injected automatically into the plugin's readme during documentation generation.

5
docs/create.md Normal file
View File

@@ -0,0 +1,5 @@
Official Postgres docker images does not include postgis extension (amongst others). The following example creates a new postgres service using `postgis/postgis:13-3.1` image, which includes the `postgis` extension.
```shell
dokku postgres:create postgis-database --image "postgis/postgis" --image-version "13-3.1"
```

5
docs/export.md Normal file
View File

@@ -0,0 +1,5 @@
Note that the export will result in a file containing the binary postgres export data. It can be converted to plain text using `pg_restore` as follows
```shell
pg_restore data.dump -f plain.sql
```

30
docs/upgrade.md Normal file
View File

@@ -0,0 +1,30 @@
Postgres does not handle upgrading data for major versions automatically (eg. 11 => 12). Upgrades should be done manually. Users are encouraged to upgrade to the latest minor release for their postgres version before performing a major upgrade.
While there are many ways to upgrade a postgres database, for safety purposes, it is recommended that an upgrade is performed by exporting the data from an existing database and importing it into a new database. This also allows testing to ensure that applications interact with the database correctly after the upgrade, and can be used in a staging environment.
The following is an example of how to upgrade a postgres database named `lollipop-11` from 11.13 to 12.8.
```shell
# stop any linked apps
dokku ps:stop linked-app
# export the database contents
dokku postgres:export lollipop-11 > /tmp/lollipop-11.export
# create a new database at the desired version
dokku postgres:create lollipop-12 --image-version 12.8
# import the export file
dokku postgres:import lollipop-12 < /tmp/lollipop-11.export
# run any sql tests against the new database to verify the import went smoothly
# unlink the old database from your apps
dokku postgres:unlink lollipop-11 linked-app
# link the new database to your apps
dokku postgres:link lollipop-12 linked-app
# start the linked apps again
dokku ps:start linked-app
```

View File

@@ -3,7 +3,7 @@ source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
source "$PLUGIN_BASE_PATH/common/functions"
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$PLUGIN_AVAILABLE_PATH/config/functions"
if [[ -f "$PLUGIN_AVAILABLE_PATH/docker-options/functions" ]]; then
source "$PLUGIN_AVAILABLE_PATH/docker-options/functions"
@@ -17,7 +17,7 @@ service_connect() {
local SERVICE_TTY_OPTS
has_tty && SERVICE_TTY_OPTS="-t"
docker exec -i $SERVICE_TTY_OPTS "$SERVICE_NAME" psql -h localhost -U postgres "$DATABASE_NAME"
docker exec --env=LANG=C.UTF-8 --env=LC_ALL=C.UTF-8 -i $SERVICE_TTY_OPTS "$SERVICE_NAME" psql -h localhost -U postgres "$DATABASE_NAME"
}
service_create() {
@@ -40,7 +40,7 @@ service_create() {
docker pull "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" || dokku_log_fail "$PLUGIN_SERVICE image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION pull failed"
fi
plugn trigger service-action pre-create "$SERVICE"
plugn trigger service-action pre-create "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
mkdir -p "$SERVICE_ROOT" || dokku_log_fail "Unable to create service directory"
mkdir -p "$SERVICE_ROOT/data" || dokku_log_fail "Unable to create service data directory"
touch "$LINKS_FILE"
@@ -53,17 +53,11 @@ service_create() {
echo "$PASSWORD" >"$SERVICE_ROOT/PASSWORD"
chmod 640 "$SERVICE_ROOT/PASSWORD"
[[ -n "$SERVICE_CUSTOM_ENV" ]] && POSTGRES_CUSTOM_ENV="$SERVICE_CUSTOM_ENV"
if [[ -n $POSTGRES_CUSTOM_ENV ]]; then
echo "$POSTGRES_CUSTOM_ENV" | tr ';' "\n" >"$SERVICE_ROOT/ENV"
else
echo "" >"$SERVICE_ROOT/ENV"
fi
service_commit_config "$SERVICE"
write_database_name "$SERVICE"
plugn trigger service-action post-create "$SERVICE"
plugn trigger service-action post-create "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
service_create_container "$SERVICE"
plugn trigger service-action post-create-complete "$SERVICE"
plugn trigger service-action post-create-complete "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
}
service_create_container() {
@@ -75,7 +69,25 @@ service_create_container() {
local DATABASE_NAME="$(get_database_name "$SERVICE")"
local PREVIOUS_ID
ID=$(docker run --name "$SERVICE_NAME" -v "$SERVICE_HOST_ROOT/data:/var/lib/postgresql/data" -e "POSTGRES_PASSWORD=$PASSWORD" --env-file="$SERVICE_ROOT/ENV" -d --restart always --label dokku=service --label dokku.service=postgres "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION")
if [[ -f "$SERVICE_ROOT/CONFIG_OPTIONS" ]]; then
export CONFIG_OPTIONS="$(cat "$SERVICE_ROOT/CONFIG_OPTIONS")"
fi
[[ -f "$SERVICE_ROOT/SERVICE_MEMORY" ]] && SERVICE_MEMORY="$(cat "$SERVICE_ROOT/SERVICE_MEMORY")"
if [[ -n "$SERVICE_MEMORY" ]]; then
MEMORY_LIMIT="--memory=${SERVICE_MEMORY}m"
fi
[[ -f "$SERVICE_ROOT/SHM_SIZE" ]] && SERVICE_SHM_SIZE="$(cat "$SERVICE_ROOT/SHM_SIZE")"
if [[ -n "$SERVICE_SHM_SIZE" ]]; then
SHM_SIZE="--shm-size=${SERVICE_SHM_SIZE}"
fi
[[ -f "$SERVICE_ROOT/IMAGE" ]] && PLUGIN_IMAGE="$(cat "$SERVICE_ROOT/IMAGE")"
[[ -f "$SERVICE_ROOT/IMAGE_VERSION" ]] && PLUGIN_IMAGE_VERSION="$(cat "$SERVICE_ROOT/IMAGE_VERSION")"
# shellcheck disable=SC2086
ID=$(docker run --name "$SERVICE_NAME" $MEMORY_LIMIT $SHM_SIZE -v "$SERVICE_HOST_ROOT/data:/var/lib/postgresql/data" -e "POSTGRES_PASSWORD=$PASSWORD" --env-file="$SERVICE_ROOT/ENV" -d --restart always --label dokku=service --label dokku.service=postgres "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" $CONFIG_OPTIONS)
echo "$ID" >"$SERVICE_ROOT/ID"
dokku_log_verbose_quiet "Waiting for container to be ready"
@@ -85,7 +97,7 @@ service_create_container() {
docker exec "$SERVICE_NAME" su - postgres -c "createdb -E utf8 $DATABASE_NAME" 2>/dev/null || dokku_log_verbose_quiet 'Already exists'
dokku_log_verbose_quiet "Securing connection to database"
service_stop "$SERVICE" >/dev/null
service_pause "$SERVICE" >/dev/null
docker run --rm -i -v "$SERVICE_HOST_ROOT/data:/var/lib/postgresql/data" "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" bash -s <"$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/scripts/enable_ssl.sh" &>/dev/null
PREVIOUS_ID=$(docker ps -aq --no-trunc --filter "status=exited" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
@@ -151,6 +163,8 @@ service_start() {
service_create_container "$SERVICE"
else
if ! service_image_exists "$SERVICE"; then
[[ -f "$SERVICE_ROOT/IMAGE" ]] && PLUGIN_IMAGE="$(cat "$SERVICE_ROOT/IMAGE")"
[[ -f "$SERVICE_ROOT/IMAGE_VERSION" ]] && PLUGIN_IMAGE_VERSION="$(cat "$SERVICE_ROOT/IMAGE_VERSION")"
dokku_log_verbose_quiet "Missing image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION for $SERVICE"
else
dokku_log_verbose_quiet "Neither container nor valid configuration exists for $SERVICE"

View File

@@ -141,7 +141,7 @@ fn-help-contents-subcommand() {
}
fn-help-fancy-tput() {
declare desc="A wrapper around tput"
declare desc="a wrapper around tput"
if [[ -n "$DOKKU_NO_COLOR" ]] || [[ "$TERM" == "unknown" ]] || [[ "$TERM" == "dumb" ]]; then
return
@@ -151,7 +151,7 @@ fn-help-fancy-tput() {
}
fn-help-fancy-color() {
declare desc="A wrapper around colors"
declare desc="a wrapper around colors"
if [[ -n "$DOKKU_NO_COLOR" ]] || [[ "$TERM" == "unknown" ]] || [[ "$TERM" == "dumb" ]]; then
return
@@ -202,6 +202,9 @@ fn-help-subcommand-args() {
elif [[ "$arg" == *_LIST ]]; then
arg=${arg%_*}
args+=" <${arg//_/-}...>"
elif [[ "$arg" == *_OPTIONAL ]]; then
argName="${arg/_OPTIONAL/}"
args+=" [<${argName//_/-}>]"
else
args+=" <${arg//_/-}>"
fi
@@ -309,7 +312,7 @@ fn-help-subcommand-sanitize() {
}
_fn-help-apply-shell-expansion() {
declare desc="Expand environment variables for a shell command"
declare desc="expand environment variables for a shell command"
declare data="$1"
declare delimiter="__apply_shell_expansion_delimiter__"
declare command="cat <<$delimiter"$'\n'"$data"$'\n'"$delimiter"

24
install
View File

@@ -1,5 +1,6 @@
#!/usr/bin/env bash
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x
@@ -23,10 +24,10 @@ plugin-install() {
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"
chown "${DOKKU_SYSTEM_USER}:${DOKKU_SYSTEM_GROUP}" "$PLUGIN_DATA_ROOT"
mkdir -p "$PLUGIN_CONFIG_ROOT" || echo "Failed to create $PLUGIN_SERVICE config directory"
chown dokku:dokku "$PLUGIN_CONFIG_ROOT"
chown "${DOKKU_SYSTEM_USER}:${DOKKU_SYSTEM_GROUP}" "$PLUGIN_CONFIG_ROOT"
rm -f "/etc/sudoers.d/dokku-${PLUGIN_COMMAND_PREFIX}*"
_SUDOERS_FILE="/etc/sudoers.d/dokku-${PLUGIN_COMMAND_PREFIX}"
@@ -42,6 +43,25 @@ plugin-install() {
EOL
chmod 0440 "$_SUDOERS_FILE"
for SERVICE in $(fn-services-list false); do
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
if [[ ! -f "$SERVICE_ROOT/IMAGE" ]] || [[ ! -f "$SERVICE_ROOT/IMAGE_VERSION" ]]; then
local image="$(service_version "$SERVICE")"
if [[ "$image" == *":"* ]]; then
echo "${image%:*}" >"$SERVICE_ROOT/IMAGE"
echo "${image##*:}" >"$SERVICE_ROOT/IMAGE_VERSION"
fi
fi
chown "${DOKKU_SYSTEM_USER}:${DOKKU_SYSTEM_GROUP}" "$SERVICE_ROOT/IMAGE" "$SERVICE_ROOT/IMAGE_VERSION"
if [[ -f "$SERVICE_ROOT/${PLUGIN_VARIABLE}_CONFIG_OPTIONS" ]]; then
mv "$SERVICE_ROOT/${PLUGIN_VARIABLE}_CONFIG_OPTIONS" "$SERVICE_ROOT/CONFIG_OPTIONS"
chown "${DOKKU_SYSTEM_USER}:${DOKKU_SYSTEM_GROUP}" "$SERVICE_ROOT/CONFIG_OPTIONS"
fi
done
}
plugin-install "$@"

View File

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

18
post-app-clone-setup Executable file
View File

@@ -0,0 +1,18 @@
#!/usr/bin/env bash
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/functions"
set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x
plugin-post-app-clone-setup() {
declare OLD_APP_NAME="$1" NEW_APP_NAME="$2"
for SERVICE in $(fn-services-list false); do
if in_links_file "$SERVICE" "$OLD_APP_NAME"; then
add_to_links_file "$SERVICE" "$NEW_APP_NAME"
fi
done
}
plugin-post-app-clone-setup "$@"

18
post-app-rename-setup Executable file
View File

@@ -0,0 +1,18 @@
#!/usr/bin/env bash
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/functions"
set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x
plugin-post-app-rename-setup() {
declare OLD_APP_NAME="$1" NEW_APP_NAME="$2"
for SERVICE in $(fn-services-list false); do
if in_links_file "$SERVICE" "$OLD_APP_NAME"; then
add_to_links_file "$SERVICE" "$NEW_APP_NAME"
fi
done
}
plugin-post-app-rename-setup "$@"

View File

@@ -1,21 +1,13 @@
#!/usr/bin/env bash
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
source "$PLUGIN_BASE_PATH/common/functions"
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/functions"
set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x
PLUGIN_BASE_PATH="$PLUGIN_PATH"
if [[ -n $DOKKU_API_VERSION ]]; then
PLUGIN_BASE_PATH="$PLUGIN_ENABLED_PATH"
fi
source "$PLUGIN_BASE_PATH/common/functions"
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/functions"
APP="$1"
pushd "$PLUGIN_DATA_ROOT" >/dev/null
for SERVICE in *; do
for SERVICE in $(fn-services-list false); do
[[ -n "$SERVICE" ]] || continue
dokku_log_verbose_quiet "Unlinking from $SERVICE"
remove_from_links_file "$(basename "$SERVICE")" "$APP"
done
popd >/dev/null 2>&1 || pushd "/tmp" >/dev/null
exit 0

36
pre-restore Executable file
View File

@@ -0,0 +1,36 @@
#!/usr/bin/env bash
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/functions"
set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x
plugin-pre-restore() {
declare SCHEDULER="$1" APP="$2"
local status
if [[ "$SCHEDULER" != "docker-local" ]]; then
return
fi
for SERVICE in $(fn-services-list false); do
if ! in_links_file "$SERVICE" "$APP"; then
continue
fi
status="$(service_status "$SERVICE")"
if [[ "$status" == "running" ]]; then
continue
fi
if [[ "$status" == "restarting" ]]; then
dokku_log_warn "$PLUGIN_SERVICE service $SERVICE is restarting and may cause issues with linked app $APP"
continue
fi
dokku_log_warn "$PLUGIN_SERVICE service $SERVICE is not running, issuing service start"
service_start "$SERVICE"
done
}
plugin-pre-restore "$@"

32
pre-start Executable file
View File

@@ -0,0 +1,32 @@
#!/usr/bin/env bash
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/functions"
set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x
plugin-pre-start() {
declare APP="$1"
local status
for SERVICE in $(fn-services-list false); do
if ! in_links_file "$SERVICE" "$APP"; then
continue
fi
status="$(service_status "$SERVICE")"
if [[ "$status" == "running" ]]; then
continue
fi
if [[ "$status" == "restarting" ]]; then
dokku_log_warn "$PLUGIN_SERVICE service $SERVICE is restarting and may cause issues with linked app $APP"
continue
fi
dokku_log_warn "$PLUGIN_SERVICE service $SERVICE is not running, issuing service start"
service_start "$SERVICE"
done
}
plugin-pre-start "$@"

View File

@@ -1,6 +1,6 @@
#!/bin/bash
pushd /var/lib/postgresql/data >/dev/null
openssl req -new -newkey rsa:4096 -x509 -nodes -out server.crt -keyout server.key -batch
openssl req -new -newkey rsa:4096 -x509 -days 365000 -nodes -out server.crt -keyout server.key -batch
chmod 600 server.key
sed -i "s/^#ssl = off/ssl = on/" postgresql.conf
sed -i "s/^#ssl_ciphers =.*/ssl_ciphers = 'AES256+EECDH:AES256+EDH'/" postgresql.conf

20
service-list Executable file
View File

@@ -0,0 +1,20 @@
#!/usr/bin/env bash
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x
plugin-service-list() {
declare desc="allows listing all services for use by other dokku plugins"
declare SERVICE_TYPE="$1"
if [[ -n "$SERVICE_TYPE" ]] && [[ "$SERVICE_TYPE" != "$PLUGIN_COMMAND_PREFIX" ]]; then
return
fi
for service in $(fn-services-list false); do
echo "$PLUGIN_COMMAND_PREFIX:$service"
done
}
plugin-service-list "$@"

View File

@@ -6,12 +6,14 @@ source "$PLUGIN_BASE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-backup-cmd() {
#E backup the 'lolipop' service to the 'my-s3-bucket' bucket on AWS
#E dokku $PLUGIN_COMMAND_PREFIX:backup lolipop my-s3-bucket --use-iam
#E backup the 'lollipop' service to the 'my-s3-bucket' bucket on AWS
#E dokku $PLUGIN_COMMAND_PREFIX:backup lollipop my-s3-bucket --use-iam
#E restore a backup file (assuming it was extracted via 'tar -xf backup.tgz')
#E dokku $PLUGIN_COMMAND_PREFIX:import lollipop < backup-folder/export
#F -u|--use-iam, use the IAM profile associated with the current server
#A service, service to run command against
#A bucket-name, name of the s3 bucket to upload backups to
declare desc="creates a backup of the $PLUGIN_SERVICE service to an existing s3 bucket"
declare desc="create a backup of the $PLUGIN_SERVICE service to an existing s3 bucket"
local cmd="$PLUGIN_COMMAND_PREFIX:backup" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" BUCKET_NAME="$2" USE_IAM_OPTIONAL_FLAG="$3"

View File

@@ -7,20 +7,20 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-backup-auth-cmd() {
#E setup s3 backup authentication
#E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
#E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
#E setup s3 backup authentication with different region
#E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
#E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
#E setup s3 backup authentication with different signature version and endpoint
#E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL
#E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL
#E more specific example for minio auth
#E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
#E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lollipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
#A service, service to run command against
#A access-key-id, an amazon AWS_ACCESS_KEY_ID
#A aws-secret-access-key, an amazon AWS_SECRET_ACCESS_KEY
#A aws-default-region, (optional) a valid amazon S3 region
#A aws-signature-version, (optional) the AWS signature version to use when signing S3 requests
#A endpoint-url, (optional) an aws endpoint to upload to
declare desc="sets up authentication for backups on the $PLUGIN_SERVICE service"
declare desc="set up authentication for backups on the $PLUGIN_SERVICE service"
local cmd="$PLUGIN_COMMAND_PREFIX:backup-auth" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" AWS_ACCESS_KEY_ID="$2" AWS_SECRET_ACCESS_KEY="$3" AWS_DEFAULT_REGION="$4" AWS_SIGNATURE_VERSION="$5" ENDPOINT_URL="$6"

View File

@@ -7,9 +7,9 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-backup-deauth-cmd() {
#E remove s3 authentication
#E dokku $PLUGIN_COMMAND_PREFIX:backup-deauth lolipop
#E dokku $PLUGIN_COMMAND_PREFIX:backup-deauth lollipop
#A service, service to run command against
declare desc="removes backup authentication for the $PLUGIN_SERVICE service"
declare desc="remove backup authentication for the $PLUGIN_SERVICE service"
local cmd="$PLUGIN_COMMAND_PREFIX:backup-deauth" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1"

View File

@@ -8,14 +8,14 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-backup-schedule-cmd() {
#E schedule a backup
#E > 'schedule' is a crontab expression, eg. "0 3 * * *" for each day at 3am
#E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lolipop "0 3 * * *" my-s3-bucket
#E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lollipop "0 3 * * *" my-s3-bucket
#E schedule a backup and authenticate via iam
#E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lolipop "0 3 * * *" my-s3-bucket --use-iam
#E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lollipop "0 3 * * *" my-s3-bucket --use-iam
#F -u|--use-iam, use the IAM profile associated with the current server
#A service, service to run command against
#A schedule, a cron schedule to run backups on
#A bucket-name, name of the s3 bucket to upload backups to
declare desc="schedules a backup of the $PLUGIN_SERVICE service"
declare desc="schedule a backup of the $PLUGIN_SERVICE service"
local cmd="$PLUGIN_COMMAND_PREFIX:backup-schedule" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" SCHEDULE="$2" BUCKET_NAME="$3" USE_IAM_OPTIONAL_FLAG="$4"

View File

@@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-backup-schedule-cat-cmd() {
#E cat the contents of the configured backup cronfile for the service
#E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule-cat lolipop
#E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule-cat lollipop
#A service, service to run command against
declare desc="cat the contents of the configured backup cronfile for the service"
local cmd="$PLUGIN_COMMAND_PREFIX:backup-schedule-cat" argv=("$@")

View File

@@ -7,10 +7,10 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-backup-set-encryption-cmd() {
#E set the GPG-compatible passphrase for encrypting backups for backups
#E dokku $PLUGIN_COMMAND_PREFIX:backup-set-encryption lolipop
#E dokku $PLUGIN_COMMAND_PREFIX:backup-set-encryption lollipop
#A service, service to run command against
#A passphrase, a GPG-compatible passphrase
declare desc="sets encryption for all future backups of $PLUGIN_SERVICE service"
declare desc="set encryption for all future backups of $PLUGIN_SERVICE service"
local cmd="$PLUGIN_COMMAND_PREFIX:backup-set-encryption" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" PASSPHRASE="$2"

View File

@@ -7,9 +7,9 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-backup-unschedule-cmd() {
#E remove the scheduled backup from cron
#E dokku $PLUGIN_COMMAND_PREFIX:backup-unschedule lolipop
#E dokku $PLUGIN_COMMAND_PREFIX:backup-unschedule lollipop
#A service, service to run command against
declare desc="unschedules the backup of the $PLUGIN_SERVICE service"
declare desc="unschedule the backup of the $PLUGIN_SERVICE service"
local cmd="$PLUGIN_COMMAND_PREFIX:backup-unschedule" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1"

View File

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

View File

@@ -7,14 +7,17 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-clone-cmd() {
#E you can clone an existing service to a new one
#E dokku $PLUGIN_COMMAND_PREFIX:clone lolipop lolipop-2
#E dokku $PLUGIN_COMMAND_PREFIX:clone lollipop lollipop-2
#A service, service to run command against
#A new-service, name of new service
#F -c|--config-options "--args --go=here", extra arguments to pass to the container create command
#F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
#F -i|--image IMAGE, the image name to start the service with
#F -I|--image-version IMAGE_VERSION, the image version to start the service with
#F -m|--memory MEMORY, container memory limit in megabytes (default: unlimited)
#F -p|--password PASSWORD, override the user-level service password
#F -r|--root-password PASSWORD, override the root-level service password
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
declare desc="create container <new-name> then copy data from <name> into <new-name>"
local cmd="$PLUGIN_COMMAND_PREFIX:clone" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1
@@ -24,6 +27,9 @@ service-clone-cmd() {
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
[[ -z "$NEW_SERVICE" ]] && dokku_log_fail "Please specify a name for the new service"
verify_service_name "$SERVICE"
if service_exists "$NEW_SERVICE"; then
dokku_log_fail "Invalid service name $NEW_SERVICE. Verify the service name is not already in use."
fi
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local ID="$(cat "$SERVICE_ROOT/ID")"

View File

@@ -7,7 +7,8 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-connect-cmd() {
#E connect to the service via the $PLUGIN_COMMAND_PREFIX connection tool
#E dokku $PLUGIN_COMMAND_PREFIX:connect lolipop
#E > NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098
#E dokku $PLUGIN_COMMAND_PREFIX:connect lollipop
#A service, service to run command against
declare desc="connect to the service via the $PLUGIN_COMMAND_PREFIX connection tool"
local cmd="$PLUGIN_COMMAND_PREFIX:connect" argv=("$@")

View File

@@ -6,23 +6,26 @@ source "$PLUGIN_BASE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-create-cmd() {
#E create a $PLUGIN_COMMAND_PREFIX service named lolipop
#E dokku $PLUGIN_COMMAND_PREFIX:create lolipop
#E create a $PLUGIN_COMMAND_PREFIX service named lollipop
#E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
#E you can also specify the image and image version to use for the service.
#E it *must* be compatible with the ${PLUGIN_IMAGE} image.
#E export ${PLUGIN_DEFAULT_ALIAS}_IMAGE="${PLUGIN_IMAGE}"
#E export ${PLUGIN_DEFAULT_ALIAS}_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
#E dokku $PLUGIN_COMMAND_PREFIX:create lolipop
#E export ${PLUGIN_VARIABLE}_IMAGE="${PLUGIN_IMAGE}"
#E export ${PLUGIN_VARIABLE}_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
#E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
#E you can also specify custom environment variables to start
#E the ${PLUGIN_COMMAND_PREFIX} service in semi-colon separated form.
#E export ${PLUGIN_DEFAULT_ALIAS}_CUSTOM_ENV="USER=alpha;HOST=beta"
#E dokku $PLUGIN_COMMAND_PREFIX:create lolipop
#E export ${PLUGIN_VARIABLE}_CUSTOM_ENV="USER=alpha;HOST=beta"
#E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
#A service, service to run command against
#F -c|--config-options "--args --go=here", extra arguments to pass to the container create command
#F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
#F -i|--image IMAGE, the image name to start the service with
#F -I|--image-version IMAGE_VERSION, the image version to start the service with
#F -m|--memory MEMORY, container memory limit in megabytes (default: unlimited)
#F -p|--password PASSWORD, override the user-level service password
#F -r|--root-password PASSWORD, override the root-level service password
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
declare desc="create a $PLUGIN_SERVICE service"
local cmd="$PLUGIN_COMMAND_PREFIX:create" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1

View File

@@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-destroy-cmd() {
#E destroy the service, it's data, and the running container
#E dokku $PLUGIN_COMMAND_PREFIX:destroy lolipop
#E dokku $PLUGIN_COMMAND_PREFIX:destroy lollipop
#A service, service to run command against
#F -f|--force, force destroy without asking for confirmation
declare desc="delete the $PLUGIN_SERVICE service/data/container if there are no links left"
@@ -41,7 +41,7 @@ service-destroy-cmd() {
fi
dokku_log_info2_quiet "Deleting $SERVICE"
plugn trigger service-action pre-delete "$SERVICE"
plugn trigger service-action pre-delete "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
service_backup_unschedule "$SERVICE"
service_container_rm "$SERVICE"
@@ -49,7 +49,7 @@ service-destroy-cmd() {
docker run --rm -v "$SERVICE_HOST_ROOT/data:/data" -v "$SERVICE_HOST_ROOT/$PLUGIN_CONFIG_SUFFIX:/config" "$PLUGIN_BUSYBOX_IMAGE" chmod 777 -R /config /data
rm -rf "$SERVICE_ROOT"
plugn trigger service-action post-delete "$SERVICE"
plugn trigger service-action post-delete "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
dokku_log_info2 "$PLUGIN_SERVICE container deleted: $SERVICE"
}

View File

@@ -8,16 +8,18 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-enter-cmd() {
#E a bash prompt can be opened against a running service.
#E filesystem changes will not be saved to disk.
#E dokku $PLUGIN_COMMAND_PREFIX:enter lolipop
#E > NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098
#E dokku $PLUGIN_COMMAND_PREFIX:enter lollipop
#E you may also run a command directly against the service.
#E filesystem changes will not be saved to disk.
#E dokku $PLUGIN_COMMAND_PREFIX:enter lolipop touch /tmp/test
#E dokku $PLUGIN_COMMAND_PREFIX:enter lollipop touch /tmp/test
#A service, service to run command against
declare desc="enter or run a command in a running $PLUGIN_SERVICE service container"
local cmd="$PLUGIN_COMMAND_PREFIX:enter" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1"
verify_service_name "$SERVICE"
dokku_log_info1_quiet "Filesystem changes may not persist after container restarts"
service_enter "$SERVICE" "${@:2}"
}

View File

@@ -6,8 +6,8 @@ source "$PLUGIN_BASE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-exists-cmd() {
#E here we check if the lolipop $PLUGIN_COMMAND_PREFIX service exists.
#E dokku $PLUGIN_COMMAND_PREFIX:exists lolipop
#E here we check if the lollipop $PLUGIN_COMMAND_PREFIX service exists.
#E dokku $PLUGIN_COMMAND_PREFIX:exists lollipop
#A service, service to run command against
declare desc="check if the $PLUGIN_SERVICE service exists"
local cmd="$PLUGIN_COMMAND_PREFIX:exists" argv=("$@")

View File

@@ -7,9 +7,9 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-export-cmd() {
#E by default, datastore output is exported to stdout
#E dokku $PLUGIN_COMMAND_PREFIX:export lolipop
#E dokku $PLUGIN_COMMAND_PREFIX:export lollipop
#E you can redirect this output to a file
#E dokku $PLUGIN_COMMAND_PREFIX:export lolipop > lolipop.dump
#E dokku $PLUGIN_COMMAND_PREFIX:export lollipop > data.dump
#A service, service to run command against
declare desc="export a dump of the $PLUGIN_SERVICE service database"
local cmd="$PLUGIN_COMMAND_PREFIX:export" argv=("$@")

View File

@@ -7,10 +7,12 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-expose-cmd() {
#E expose the service on the service's normal ports, allowing access to it from the public interface (0.0.0.0)
#E dokku $PLUGIN_COMMAND_PREFIX:expose lolipop ${PLUGIN_DATASTORE_PORTS[@]}
#E dokku $PLUGIN_COMMAND_PREFIX:expose lollipop ${PLUGIN_DATASTORE_PORTS[@]}
#E expose the service on the service's normal ports, with the first on a specified ip adddress (127.0.0.1)
#E dokku $PLUGIN_COMMAND_PREFIX:expose lollipop 127.0.0.1:${PLUGIN_DATASTORE_PORTS[@]}
#A service, service to run command against
#A ports, a list of ports to run against
declare desc="expose a $PLUGIN_SERVICE service on custom port if provided (random port otherwise)"
declare desc="expose a $PLUGIN_SERVICE service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)"
local cmd="$PLUGIN_COMMAND_PREFIX:expose" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" PORTS_LIST=("${@:2}")

View File

@@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-import-cmd() {
#E import a datastore dump
#E dokku $PLUGIN_COMMAND_PREFIX:import lolipop < database.dump
#E dokku $PLUGIN_COMMAND_PREFIX:import lollipop < data.dump
#A service, service to run command against
declare desc="import a dump into the $PLUGIN_SERVICE service database"
local cmd="$PLUGIN_COMMAND_PREFIX:import" argv=("$@")

View File

@@ -7,18 +7,18 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-info-cmd() {
#E get connection information as follows:
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop
#E you can also retrieve a specific piece of service info via flags:
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --config-dir
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --data-dir
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --dsn
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --exposed-ports
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --id
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --internal-ip
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --links
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --service-root
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --status
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --version
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --config-dir
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --data-dir
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --dsn
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --exposed-ports
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --id
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --internal-ip
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --links
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --service-root
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --status
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --version
#A service, service to run command against
#F --config-dir, show the service configuration directory
#F --data-dir, show the service data directory

View File

@@ -10,20 +10,20 @@ service-link-cmd() {
#E this will use native docker links via the docker-options plugin.
#E here we link it to our 'playground' app.
#E > NOTE: this will restart your app
#E dokku $PLUGIN_COMMAND_PREFIX:link lolipop playground
#E dokku $PLUGIN_COMMAND_PREFIX:link lollipop playground
#E the following environment variables will be set automatically by docker
#E (not on the app itself, so they wont be listed when calling dokku config):
#E
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_NAME=/lolipop/DATABASE
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]}
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]}
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PROTO=tcp
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PORT=${PLUGIN_DATASTORE_PORTS[0]}
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_ADDR=172.17.0.1
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_NAME=/lollipop/DATABASE
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]}
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]}
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PROTO=tcp
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PORT=${PLUGIN_DATASTORE_PORTS[0]}
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_ADDR=172.17.0.1
#E
#E the following will be set on the linked application by default:
#E
#E ${PLUGIN_DEFAULT_ALIAS}_URL=${PLUGIN_SCHEME}://lolipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lolipop:${PLUGIN_DATASTORE_PORTS[0]}/lolipop
#E ${PLUGIN_DEFAULT_ALIAS}_URL=${PLUGIN_SCHEME}://lollipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lollipop:${PLUGIN_DATASTORE_PORTS[0]}/lollipop
#E
#E the host exposed here only works internally in docker containers.
#E if you want your container to be reachable from outside, you should
@@ -34,10 +34,10 @@ service-link-cmd() {
#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_VARIABLE}_DATABASE_SCHEME=${PLUGIN_SCHEME}2
#E dokku $PLUGIN_COMMAND_PREFIX:link lolipop playground
#E dokku $PLUGIN_COMMAND_PREFIX:link lollipop playground
#E this will cause ${PLUGIN_DEFAULT_ALIAS}_URL to be set as:
#E
#E ${PLUGIN_SCHEME}2://lolipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lolipop:${PLUGIN_DATASTORE_PORTS[0]}/lolipop
#E ${PLUGIN_SCHEME}2://lollipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lollipop:${PLUGIN_DATASTORE_PORTS[0]}/lollipop
#A service, service to run command against
#A app, app to run command against
#F -a|--alias "BLUE_DATABASE", an alternative alias to use for linking to an app via environment variable

View File

@@ -6,8 +6,8 @@ source "$PLUGIN_BASE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-linked-cmd() {
#E here we check if the lolipop $PLUGIN_COMMAND_PREFIX service is linked to the 'playground' app.
#E dokku $PLUGIN_COMMAND_PREFIX:linked lolipop playground
#E here we check if the lollipop $PLUGIN_COMMAND_PREFIX service is linked to the 'playground' app.
#E dokku $PLUGIN_COMMAND_PREFIX:linked lollipop playground
#A service, service to run command against
#A app, app to run command against
declare desc="check if the $PLUGIN_SERVICE service is linked to an app"

View File

@@ -6,8 +6,8 @@ source "$PLUGIN_BASE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-links-cmd() {
#E list all apps linked to the 'lolipop' $PLUGIN_COMMAND_PREFIX service.
#E dokku $PLUGIN_COMMAND_PREFIX:links lolipop
#E list all apps linked to the 'lollipop' $PLUGIN_COMMAND_PREFIX service.
#E dokku $PLUGIN_COMMAND_PREFIX:links lollipop
#A service, service to run command against
declare desc="list all apps linked to the $PLUGIN_SERVICE service"
local cmd="$PLUGIN_COMMAND_PREFIX:links" argv=("$@")

View File

@@ -7,19 +7,21 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-logs-cmd() {
#E you can tail logs for a particular service:
#E dokku $PLUGIN_COMMAND_PREFIX:logs lolipop
#E dokku $PLUGIN_COMMAND_PREFIX:logs lollipop
#E by default, logs will not be tailed, but you can do this with the --tail flag:
#E dokku $PLUGIN_COMMAND_PREFIX:logs lolipop --tail
#E dokku $PLUGIN_COMMAND_PREFIX:logs lollipop --tail
#E the default tail setting is to show all logs, but an initial count can also be specified
#E dokku $PLUGIN_COMMAND_PREFIX:logs lollipop --tail 5
#A service, service to run command against
#F -t|--tail, do not stop when end of the logs are reached and wait for additional output
#F -t|--tail [<tail-num>], do not stop when end of the logs are reached and wait for additional output
declare desc="print the most recent log(s) for this service"
local cmd="$PLUGIN_COMMAND_PREFIX:logs" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" TAIL_FLAG="$2"
declare SERVICE="$1" TAIL_FLAG="$2" TAIL_NUM_OPTIONAL="${3:-all}"
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
verify_service_name "$SERVICE"
service_logs "$SERVICE" "$TAIL_FLAG"
service_logs "$SERVICE" "$TAIL_FLAG" "$TAIL_NUM_OPTIONAL"
}
service-logs-cmd "$@"

22
subcommands/pause Executable file
View File

@@ -0,0 +1,22 @@
#!/usr/bin/env bash
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-pause-cmd() {
#E pause the running container for the service
#E dokku $PLUGIN_COMMAND_PREFIX:pause lollipop
#A service, service to run command against
declare desc="pause a running $PLUGIN_SERVICE service"
local cmd="$PLUGIN_COMMAND_PREFIX:pause" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1"
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
verify_service_name "$SERVICE"
service_pause "$SERVICE"
}
service-pause-cmd "$@"

View File

@@ -20,7 +20,7 @@ service-promote-cmd() {
#E
#E ${PLUGIN_DEFAULT_ALIAS}_URL=${PLUGIN_SCHEME}://other_service:ANOTHER_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-other-service:${PLUGIN_DATASTORE_PORTS[0]}/other_service
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_BLUE_URL=${PLUGIN_SCHEME}://other_service:ANOTHER_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-other-service:${PLUGIN_DATASTORE_PORTS[0]}/other_service
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_SILVER_URL=${PLUGIN_SCHEME}://lolipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lolipop:${PLUGIN_DATASTORE_PORTS[0]}/lolipop
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_SILVER_URL=${PLUGIN_SCHEME}://lollipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lollipop:${PLUGIN_DATASTORE_PORTS[0]}/lollipop
#A service, service to run command against
#A app, app to run command against
declare desc="promote service <service> as ${PLUGIN_DEFAULT_ALIAS}_URL in <app>"

View File

@@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-restart-cmd() {
#E restart the service
#E dokku $PLUGIN_COMMAND_PREFIX:restart lolipop
#E dokku $PLUGIN_COMMAND_PREFIX:restart lollipop
#A service, service to run command against
declare desc="graceful shutdown and restart of the $PLUGIN_SERVICE service container"
local cmd="$PLUGIN_COMMAND_PREFIX:restart" argv=("$@")
@@ -16,7 +16,7 @@ service-restart-cmd() {
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
verify_service_name "$SERVICE"
service_stop "$SERVICE"
service_pause "$SERVICE"
service_start "$SERVICE"
dokku_log_info1 "Please call dokku ps:restart on all linked apps"
}

View File

@@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-start-cmd() {
#E start the service
#E dokku $PLUGIN_COMMAND_PREFIX:start lolipop
#E dokku $PLUGIN_COMMAND_PREFIX:start lollipop
#A service, service to run command against
declare desc="start a previously stopped $PLUGIN_SERVICE service"
local cmd="$PLUGIN_COMMAND_PREFIX:start" argv=("$@")

View File

@@ -6,8 +6,8 @@ source "$PLUGIN_BASE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-stop-cmd() {
#E stop the service and the running container
#E dokku $PLUGIN_COMMAND_PREFIX:stop lolipop
#E stop the service and removes the running container
#E dokku $PLUGIN_COMMAND_PREFIX:stop lollipop
#A service, service to run command against
declare desc="stop a running $PLUGIN_SERVICE service"
local cmd="$PLUGIN_COMMAND_PREFIX:stop" argv=("$@")
@@ -16,7 +16,7 @@ service-stop-cmd() {
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
verify_service_name "$SERVICE"
service_stop "$SERVICE"
service_container_rm "$SERVICE"
}
service-stop-cmd "$@"

View File

@@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-unexpose-cmd() {
#E unexpose the service, removing access to it from the public interface (0.0.0.0)
#E dokku $PLUGIN_COMMAND_PREFIX:unexpose lolipop
#E dokku $PLUGIN_COMMAND_PREFIX:unexpose lollipop
#A service, service to run command against
declare desc="unexpose a previously exposed $PLUGIN_SERVICE service"
local cmd="$PLUGIN_COMMAND_PREFIX:unexpose" argv=("$@")

View File

@@ -8,7 +8,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-unlink-cmd() {
#E you can unlink a $PLUGIN_COMMAND_PREFIX service
#E > NOTE: this will restart your app and unset related environment variables
#E dokku $PLUGIN_COMMAND_PREFIX:unlink lolipop playground
#E dokku $PLUGIN_COMMAND_PREFIX:unlink lollipop playground
#A service, service to run command against
#A app, app to run command against
declare desc="unlink the $PLUGIN_SERVICE service from the app"

View File

@@ -8,12 +8,14 @@ source "$PLUGIN_AVAILABLE_PATH/ps/functions"
service-upgrade-cmd() {
#E you can upgrade an existing service to a new image or image-version
#E dokku $PLUGIN_COMMAND_PREFIX:upgrade lolipop
#E dokku $PLUGIN_COMMAND_PREFIX:upgrade lollipop
#A service, service to run command against
#F -c|--config-options "--args --go=here", extra arguments to pass to the container create command
#F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
#F -i|--image IMAGE, the image name to start the service with
#F -I|--image-version IMAGE_VERSION, the image version to start the service with
#F -R|--restart-apps "true", whether to force an app restart
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
declare desc="upgrade service <service> to the specified versions"
local cmd="$PLUGIN_COMMAND_PREFIX:upgrade" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1
@@ -36,6 +38,8 @@ service-upgrade-cmd() {
return
fi
service_commit_config "$SERVICE"
dokku_log_info2 "Upgrading $SERVICE to $NEW_PLUGIN_IMAGE_TAG"
if [[ "$SERVICE_RESTART_APPS" == "true" ]]; then
dokku_log_info2 "Stopping all linked services"

View File

@@ -13,7 +13,7 @@ teardown() {
}
@test "($PLUGIN_COMMAND_PREFIX:hook:pre-delete) removes app from links file when destroying app" {
[[ -n $(< "$PLUGIN_DATA_ROOT/l/LINKS") ]]
[[ -n $(<"$PLUGIN_DATA_ROOT/l/LINKS") ]]
dokku --force apps:destroy my-app
[[ -z $(< "$PLUGIN_DATA_ROOT/l/LINKS") ]]
[[ -z $(<"$PLUGIN_DATA_ROOT/l/LINKS") ]]
}

View File

@@ -30,7 +30,7 @@ teardown() {
@test "($PLUGIN_COMMAND_PREFIX:clone) error when new service already exists" {
dokku "$PLUGIN_COMMAND_PREFIX:create" new_service
run dokku "$PLUGIN_COMMAND_PREFIX:clone" l new_service
assert_contains "${lines[*]}" "service new_service already exists"
assert_contains "${lines[*]}" "Invalid service name new_service"
assert_failure
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" new_service

View File

@@ -23,7 +23,7 @@ teardown() {
if [[ -n "$GITHUB_WORKFLOW" ]]; then
skip "No tty is available on Github Actions"
fi
export SSH_TTY=`tty`
export SSH_TTY=$(tty)
run dokku "$PLUGIN_COMMAND_PREFIX:export" l
echo "output: $output"
echo "status: $status"

View File

@@ -34,7 +34,7 @@ teardown() {
@test "($PLUGIN_COMMAND_PREFIX:import) success" {
skip "The fake dump is hard to work with in tests"
run dokku "$PLUGIN_COMMAND_PREFIX:import" l < "/tmp/fake.dump"
run dokku "$PLUGIN_COMMAND_PREFIX:import" l <"/tmp/fake.dump"
echo "output: $output"
echo "status: $status"
assert_success

View File

@@ -13,7 +13,6 @@ teardown() {
dokku --force apps:destroy my-app
}
@test "($PLUGIN_COMMAND_PREFIX:link) error when there are no arguments" {
run dokku "$PLUGIN_COMMAND_PREFIX:link"
echo "output: $output"

25
tests/service_pause.bats Executable file
View File

@@ -0,0 +1,25 @@
#!/usr/bin/env bats
load test_helper
setup() {
dokku "$PLUGIN_COMMAND_PREFIX:create" l
}
teardown() {
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
}
@test "($PLUGIN_COMMAND_PREFIX:pause) error when there are no arguments" {
run dokku "$PLUGIN_COMMAND_PREFIX:pause"
assert_contains "${lines[*]}" "Please specify a valid name for the service"
}
@test "($PLUGIN_COMMAND_PREFIX:pause) error when service does not exist" {
run dokku "$PLUGIN_COMMAND_PREFIX:pause" not_existing_service
assert_contains "${lines[*]}" "service not_existing_service does not exist"
}
@test "($PLUGIN_COMMAND_PREFIX:pause) success" {
run dokku "$PLUGIN_COMMAND_PREFIX:pause" l
assert_success
}

View File

@@ -23,4 +23,3 @@ teardown() {
run dokku "$PLUGIN_COMMAND_PREFIX:restart" l
assert_success
}

View File

@@ -23,4 +23,3 @@ teardown() {
run dokku "$PLUGIN_COMMAND_PREFIX:start" l
assert_success
}

View File

@@ -23,4 +23,3 @@ teardown() {
run dokku "$PLUGIN_COMMAND_PREFIX:stop" l
assert_success
}

View File

@@ -25,4 +25,3 @@ teardown() {
[[ ! -f $PLUGIN_DATA_ROOT/PORT ]]
assert_contains "${lines[*]}" "Service l unexposed"
}

View File

@@ -1,4 +1,4 @@
#!/usr/bin/env python
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
from __future__ import print_function
import argparse