Compare commits

...

211 Commits

Author SHA1 Message Date
Jose Diaz-Gonzalez
13e46bafcf Release 1.36.4
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2024-03-06 02:09:58 -05:00
Jose Diaz-Gonzalez
10fa2ebd35 Merge pull request #313 from dokku/dependabot/docker/postgres-16.2
chore(deps): bump postgres from 16.1 to 16.2
2024-03-06 02:09:48 -05:00
dependabot[bot]
151176e142 chore(deps): bump postgres from 16.1 to 16.2
Bumps postgres from 16.1 to 16.2.

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

Signed-off-by: dependabot[bot] <support@github.com>
2024-02-13 02:11:05 +00:00
Jose Diaz-Gonzalez
1110b7a560 Release 1.36.3
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2024-01-29 10:10:07 -05:00
Jose Diaz-Gonzalez
e907c8c218 fix: use correct repository on arm64 ubuntu image 2024-01-29 10:09:17 -05:00
Jose Diaz-Gonzalez
09a7cb820b Release 1.36.2
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2024-01-29 10:07:05 -05:00
Jose Diaz-Gonzalez
d6976a5290 Merge pull request #312 from dokku/dependabot/github_actions/actions/upload-artifact-4
chore(deps): bump actions/upload-artifact from 3 to 4
2023-12-19 00:25:07 -05:00
dependabot[bot]
453e4993b9 chore(deps): bump actions/upload-artifact from 3 to 4
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 3 to 4.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/v3...v4)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-12-15 03:02:33 +00:00
Jose Diaz-Gonzalez
3bac8ed944 Release 1.36.1
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-12-09 23:56:11 -05:00
Jose Diaz-Gonzalez
d956ded91c docs: update docs and generation script 2023-12-09 23:55:46 -05:00
Jose Diaz-Gonzalez
2fd010d955 chore: fix typo 2023-12-09 13:51:12 -05:00
Jose Diaz-Gonzalez
b2eb07f839 chore: fix typo 2023-12-09 13:48:47 -05:00
Jose Diaz-Gonzalez
f8c688cce0 Merge pull request #307 from dokku/dependabot/docker/postgres-16.1
chore(deps): bump postgres from 16.0 to 16.1
2023-12-09 13:48:01 -05:00
Jose Diaz-Gonzalez
f6817bdb3a Merge pull request #310 from dokku/dependabot/github_actions/actions/setup-python-5
chore(deps): bump actions/setup-python from 4 to 5
2023-12-09 13:47:50 -05:00
dependabot[bot]
46eac4e22c chore(deps): bump actions/setup-python from 4 to 5
Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4 to 5.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](https://github.com/actions/setup-python/compare/v4...v5)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-12-07 02:13:56 +00:00
dependabot[bot]
9263eb6505 chore(deps): bump postgres from 16.0 to 16.1
Bumps postgres from 16.0 to 16.1.

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

Signed-off-by: dependabot[bot] <support@github.com>
2023-11-15 02:11:29 +00:00
Jose Diaz-Gonzalez
fb0bcb4921 Release 1.36.0
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-10-04 10:43:01 -04:00
Jose Diaz-Gonzalez
c587d70c49 Merge pull request #304 from dokku/dependabot/docker/postgres-16.0
chore(deps): bump postgres from 15.4 to 16.0
2023-10-04 10:42:36 -04:00
dependabot[bot]
b7f22a3904 chore(deps): bump postgres from 15.4 to 16.0
Bumps postgres from 15.4 to 16.0.

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

Signed-off-by: dependabot[bot] <support@github.com>
2023-09-18 02:35:00 +00:00
Jose Diaz-Gonzalez
777fc95818 Release 1.35.0
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-09-09 22:39:55 -04:00
Jose Diaz-Gonzalez
9bf3b5bb58 Merge pull request #302 from dokku/dependabot/github_actions/actions/checkout-4
chore(deps): bump actions/checkout from 3 to 4
2023-09-07 00:03:19 -04:00
dependabot[bot]
daea399ffd chore(deps): bump actions/checkout from 3 to 4
Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v3...v4)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-09-07 03:15:45 +00:00
Jose Diaz-Gonzalez
b81b8d7a00 Merge pull request #303 from dokku/newer-ubuntu
feat: upgrade test suite from ubuntu 20.04 to 22.04
2023-09-06 23:15:25 -04:00
Jose Diaz-Gonzalez
4557c96858 feat: upgrade test suite from ubuntu 20.04 to 22.04 2023-09-06 22:37:21 -04:00
Jose Diaz-Gonzalez
201eac3809 Release 1.34.2
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-08-20 12:27:33 -04:00
Jose Diaz-Gonzalez
965696813b Merge pull request #301 from danielfornarini/fix/postgres-create-with-docker
Fix postgres:create when running inside a docker container
2023-08-20 12:27:22 -04:00
Jose Diaz-Gonzalez
3a676c2549 Release 1.34.1
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-08-16 22:36:09 -04:00
Jose Diaz-Gonzalez
11fef8aec9 Merge pull request #300 from dokku/dependabot/docker/postgres-15.4
chore(deps): bump postgres from 15.3 to 15.4
2023-08-16 22:35:55 -04:00
Piero Dotti
23c11bfddd fix(service_create_container): using SERVICE_ROOT instead of SERVICE_HOST_ROOT when creating the ssl certs
Since the script create_ssl_certs.sh is executed from inside the container, the directory is not the host one, but the container one.
2023-08-16 14:16:58 +02:00
dependabot[bot]
1af6da45e9 chore(deps): bump postgres from 15.3 to 15.4
Bumps postgres from 15.3 to 15.4.

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

Signed-off-by: dependabot[bot] <support@github.com>
2023-08-14 02:41:35 +00:00
Jose Diaz-Gonzalez
bfc0f18759 Release 1.34.0
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-05-28 01:00:01 -04:00
Jose Diaz-Gonzalez
9df82c58da Release 1.33.2
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-05-27 22:34:06 -04:00
josegonzalez
ee2d2f10f7 Merge pull request #260 from erickedji/master
fix: create ssl certs outside container
2023-05-27 22:33:27 -04:00
josegonzalez
9f3d24ca9f Merge branch 'master' into master 2023-05-27 19:45:41 -04:00
Jose Diaz-Gonzalez
6128801308 Release 1.33.1
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-05-13 12:42:31 -04:00
josegonzalez
8edb644d11 Merge pull request #293 from dokku/dependabot/docker/postgres-15.3
chore(deps): bump postgres from 15.2 to 15.3
2023-05-13 12:42:15 -04:00
dependabot[bot]
3181bb114e chore(deps): bump postgres from 15.2 to 15.3
Bumps postgres from 15.2 to 15.3.

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

Signed-off-by: dependabot[bot] <support@github.com>
2023-05-12 02:57:10 +00:00
Jose Diaz-Gonzalez
b722939dbb Release 1.33.0
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-03-19 05:31:06 -04:00
josegonzalez
7b7da09a76 Merge pull request #286 from dokku/dependabot/docker/postgres-15.2
chore(deps): bump postgres from 14.5 to 15.2
2023-03-19 05:30:51 -04:00
Jose Diaz-Gonzalez
17f3ce2188 Release 1.32.0
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-02-25 22:13:17 -05:00
josegonzalez
746b276202 Merge pull request #288 from dokku/error-when-link-exists
Show an error when an ambassador container already exists but we don't have expose configuration
2023-02-25 22:11:57 -05:00
Jose Diaz-Gonzalez
bbc7b0fc71 fix: show an error when an ambassador container already exists but we don't have expose configuration
Closes dokku/dokku-redis#200
2023-02-25 20:10:37 -05:00
dependabot[bot]
f9e5067aa8 chore(deps): bump postgres from 14.5 to 15.2
Bumps postgres from 14.5 to 15.2.

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

Signed-off-by: dependabot[bot] <support@github.com>
2023-02-25 07:24:28 +00:00
Jose Diaz-Gonzalez
c4b69d2e17 Release 1.31.0
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-02-25 02:23:25 -05:00
josegonzalez
70265e03a7 Merge pull request #287 from dokku/no-restart-link
Add ability to skip restarts on link and unlink
2023-02-25 02:13:12 -05:00
Jose Diaz-Gonzalez
5500dc41e7 fix: update link docs to remove erroneous copy-paste 2023-02-25 01:50:30 -05:00
Jose Diaz-Gonzalez
5e951257ce tests: link service before unlinking 2023-02-25 00:47:25 -05:00
Jose Diaz-Gonzalez
f4e66990c5 chore: remove extra newline 2023-02-21 00:49:17 -05:00
Jose Diaz-Gonzalez
bceebc1e9c fix: update tests to properly handle case where app is not running 2023-02-21 00:48:22 -05:00
Jose Diaz-Gonzalez
6accb9cbda fix: move arg-less flags to the front 2023-02-21 00:29:30 -05:00
Jose Diaz-Gonzalez
a925fe66de tests: add output/status and flesh out restart tests a bit more 2023-02-21 00:08:53 -05:00
Jose Diaz-Gonzalez
3a03ed7b92 tests: add test for --no-restart to link tests 2023-02-20 23:51:27 -05:00
Jose Diaz-Gonzalez
16fa2b1189 tests: add test for --no-restart to unlink tests 2023-02-20 23:47:03 -05:00
Jose Diaz-Gonzalez
afb21619f6 chore: make all the service names used in the service_unlink tests the same 2023-02-20 23:40:09 -05:00
Jose Diaz-Gonzalez
fb5c34158b chore: make all the service names used in the service_link tests the same 2023-02-20 23:35:12 -05:00
Jose Diaz-Gonzalez
ad22989894 feat: add ability to skip restarts on link and unlink
Refs dokku/dokku-redis#192
2023-02-20 23:26:44 -05:00
Jose Diaz-Gonzalez
d68fee775d Release 1.30.1
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-02-09 03:12:21 -05:00
Jose Diaz-Gonzalez
7922f0582f fix: drop extra files from being included in release 2023-02-09 03:07:31 -05:00
josegonzalez
60869897f0 Merge pull request #284 from dokku/auto-release-tags
feat: automatically create releases from tags
2023-02-09 03:03:08 -05:00
Jose Diaz-Gonzalez
df8f917a04 feat: automatically create releases from tags
This will also include release notes, allowing downstream consumers of plugins to better understand what the release includes.
2023-02-09 03:00:43 -05:00
Jose Diaz-Gonzalez
81cb9b79c5 Release 1.30.0 2023-02-09 00:47:42 -05:00
Jose Diaz-Gonzalez
5ed828bc2d Release 1.28.0 2023-02-09 00:38:49 -05:00
josegonzalez
3c7450b9ce Merge pull request #283 from dokku/alt-network-alias
feat: add network alias that is $SERVICE_NAME.$SERVICE_TYPE
2023-02-09 00:36:27 -05:00
Jose Diaz-Gonzalez
a1090e23dc fix: use network alias when linking to wait container 2023-02-08 23:59:22 -05:00
Jose Diaz-Gonzalez
09f022086a fix: drop extra check and always use the same network alias 2023-02-08 18:30:12 -05:00
Jose Diaz-Gonzalez
5479a2b0c9 refactor: use the same network alias as is used when running :link command
This allows for some degree of parity as the network will now resolve the same for both linked and networked containers.
2023-02-08 17:08:08 -05:00
Jose Diaz-Gonzalez
f68b22116d tests: drop extra alias 2023-02-08 12:41:09 -05:00
Jose Diaz-Gonzalez
768c7ede8d tests: correct the app name in use 2023-02-08 12:24:20 -05:00
Jose Diaz-Gonzalez
91ff698a68 fix: use correct alias for non-initial-network connect calls 2023-02-08 12:08:26 -05:00
Jose Diaz-Gonzalez
00bc6ea144 fix: always use the network alias 2023-02-08 12:06:57 -05:00
Jose Diaz-Gonzalez
44fe34fdfa fix: set correct alias for wait container when not using an initial network 2023-02-08 11:53:45 -05:00
Jose Diaz-Gonzalez
a88e34088d feat: use service name as hostname 2023-02-08 11:01:02 -05:00
Jose Diaz-Gonzalez
18cd825539 feat: add network alias that is $SERVICE_NAME.$SERVICE_TYPE
This alias is in addition to the existing dokku.$SERVICE_TYPE.$SERVICE_NAME network alias that is derived from the hostname.
2023-02-08 11:00:01 -05:00
josegonzalez
e7efcfee63 Merge pull request #282 from dokku/network-flags
feat: add support for network related flags on create, clone, and upgrade
2023-02-08 10:25:57 -05:00
Jose Diaz-Gonzalez
1637ce5f25 tests: ignore case where app is already deleted 2023-02-08 02:22:08 -05:00
Jose Diaz-Gonzalez
530dcdbb31 tests: fix issue where the test app wasn't being removed on test teardown 2023-02-08 02:12:32 -05:00
Jose Diaz-Gonzalez
3b2774a8cc chore: remove extra newline 2023-02-08 01:44:22 -05:00
Jose Diaz-Gonzalez
6dc8e57024 fix: correct imports 2023-02-08 01:42:07 -05:00
Jose Diaz-Gonzalez
07065e9a06 feat: add service container log output on failure to start 2023-02-08 01:21:00 -05:00
Jose Diaz-Gonzalez
ebb5112055 fix: add -N flag to getopts 2023-02-08 00:54:23 -05:00
Jose Diaz-Gonzalez
49e4e4ec23 tests: fix :set tests 2023-02-08 00:41:10 -05:00
Jose Diaz-Gonzalez
9b8ab5667b tests: stop running workflows on push
Also remove unnecessary strategy block from jobs.
2023-02-08 00:38:21 -05:00
Jose Diaz-Gonzalez
c2e2b8af62 tests: also force destroy the lsa service 2023-02-08 00:26:56 -05:00
Jose Diaz-Gonzalez
412f92ddea tests: output the contents of the run command in tests 2023-02-08 00:26:32 -05:00
Jose Diaz-Gonzalez
7f4f4d4782 docs: regenerate README 2023-02-08 00:13:39 -05:00
Jose Diaz-Gonzalez
934d054471 feat: add support for network related flags on create, clone, and upgrade
Also add some tests to cover all the network-related functionality.
2023-02-08 00:03:25 -05:00
Jose Diaz-Gonzalez
d5e9a12d59 fix: add missing source calls 2023-02-07 22:38:51 -05:00
Jose Diaz-Gonzalez
ae5be9ff96 fix: ensure properties are setup on plugin install 2023-02-07 22:25:43 -05:00
Jose Diaz-Gonzalez
f101842fe1 fix: suppress output only if there are no errors 2023-02-07 22:22:24 -05:00
josegonzalez
27e8af869a Merge pull request #277 from dokku/191-network-support
Add custom network support
2023-02-07 19:52:13 -05:00
Jose Diaz-Gonzalez
01242f6f88 feat: add network properties to :info output 2023-02-07 18:34:30 -05:00
Jose Diaz-Gonzalez
b482b2ed8c docs: add example for multiple networks 2023-02-07 18:34:30 -05:00
Jose Diaz-Gonzalez
36cd07ec8b feat: add ability to set multiple, comma-delimited post-create and post-start networks 2023-02-07 18:34:30 -05:00
Jose Diaz-Gonzalez
ae0d21180a feat: add support for attaching to networks after service container creation and start 2023-02-07 18:34:30 -05:00
Jose Diaz-Gonzalez
9a8b835a19 refactor: directly write out the cid file when creating the service container 2023-02-07 18:34:30 -05:00
Jose Diaz-Gonzalez
46ad657eaa fix: correct error message for valid/invalid properties 2023-02-07 18:34:30 -05:00
Jose Diaz-Gonzalez
e041442ffd fix: actually call the :set function and ensure we write properties to the correct namespace 2023-02-07 18:34:30 -05:00
Jose Diaz-Gonzalez
ad9b22837a fix: correct issue with checking if the service container is ready when using an initial-network 2023-02-07 18:34:30 -05:00
Jose Diaz-Gonzalez
434cca5aeb feat: add support for specifying an initial-network property
This network is the network that is associated with the container on creation. If specified, then the bridge network is not attached to the service.

Only a single initial network can be specified at this time.
2023-02-07 18:34:30 -05:00
josegonzalez
45c1b1047b Merge pull request #281 from dokku/dependabot/github_actions/actions/upload-artifact-3
chore(deps): bump actions/upload-artifact from 2 to 3
2023-02-07 18:33:44 -05:00
dependabot[bot]
450648d241 chore(deps): bump actions/upload-artifact from 2 to 3
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 2 to 3.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/v2...v3)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-02-07 23:31:31 +00:00
josegonzalez
a253155e43 Merge pull request #280 from dokku/dependabot/github_actions/actions/setup-python-4
chore(deps): bump actions/setup-python from 2 to 4
2023-02-07 18:14:26 -05:00
josegonzalez
5e5cb373de Merge pull request #279 from dokku/dependabot/github_actions/actions/checkout-3
chore(deps): bump actions/checkout from 2 to 3
2023-02-07 18:14:18 -05:00
dependabot[bot]
db224a5879 chore(deps): bump actions/setup-python from 2 to 4
Bumps [actions/setup-python](https://github.com/actions/setup-python) from 2 to 4.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](https://github.com/actions/setup-python/compare/v2...v4)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-02-07 23:04:08 +00:00
dependabot[bot]
11584397b1 chore(deps): bump actions/checkout from 2 to 3
Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v2...v3)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-02-07 22:59:03 +00:00
Jose Diaz-Gonzalez
8b04d4d434 feat: upgrade github actions automatically 2023-02-07 17:01:15 -05:00
josegonzalez
3d9fc52c78 Merge pull request #278 from dokku/upgrade-test-os
feat: upgrade test os to ubuntu 20.04
2023-02-07 16:51:17 -05:00
Jose Diaz-Gonzalez
31c2c9724d feat: upgrade test os to ubuntu 20.04 2023-02-07 16:19:10 -05:00
Jose Diaz-Gonzalez
1aae1afe5c Release 1.27.0 2023-02-07 08:19:49 -05:00
josegonzalez
3288779806 Merge pull request #276 from dokku/fix-upgrades
fix: properly support new image and image-version values during plugin upgrades
2023-02-07 07:13:59 -05:00
Jose Diaz-Gonzalez
428e95ef08 fix: properly support new image and image-version values during plugin upgrades
Closes dokku/dokku-mongo#143
Closes dokku/dokku-redis#193
Closes dokku/dokku-redis#195
2023-02-07 06:53:40 -05:00
josegonzalez
0bd701736f Merge pull request #275 from dokku/update-docker-commands
Update docker commands to use DOCKER_BIN
2023-02-07 04:46:22 -05:00
Jose Diaz-Gonzalez
03e4c519f1 refactor: use DOCKER_BIN env var instead of calling docker directly
This will allow us to alias the docker binary with podman for most actions - other than updating running containers.
2023-02-07 03:53:08 -05:00
Jose Diaz-Gonzalez
0c04ad8dcb refactor: use namespaced docker commands for interacting with the docker binary 2023-02-07 03:39:42 -05:00
Jose Diaz-Gonzalez
13eeed1582 refactor: namespace all docker commands in common-functions 2023-02-07 03:31:50 -05:00
Jose Diaz-Gonzalez
b1cc1c7914 Release 1.26.2 2023-02-07 02:46:53 -05:00
Jose Diaz-Gonzalez
8701fe04e2 fix: pull the new docker image when upgrading a service if DOCKER_IMAGE_PULL is not disabled
Refs dokku/dokku-clickhouse#51
2023-02-07 02:45:35 -05:00
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
Komlan KEDJI
09926fbecd fix: create ssl certs outside container
This enables support for alpine-based images like timescaledb (no bash/openssl).

Fixes #153
Fixes timescale/timescaledb-docker#99
2022-09-04 09:37:10 +00: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
77 changed files with 1880 additions and 562 deletions

View File

@@ -18,7 +18,7 @@ main() {
# built in the Dockerfile # built in the Dockerfile
PLUGIN_NAME="$(source /tmp/.env && echo "$PLUGIN_NAME")" PLUGIN_NAME="$(source /tmp/.env && echo "$PLUGIN_NAME")"
PLUGIN_VARIABLE="$(source /tmp/.env && echo "$PLUGIN_VARIABLE")" 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 FROM dokku/dokku:latest
RUN apt-get update 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 clean autoclean && \
apt-get autoremove --yes && \ apt-get autoremove --yes && \
rm -rf /var/lib/apt/lists/* && \ rm -rf /var/lib/apt/lists/* && \

View File

@@ -1,6 +1,12 @@
---
version: 2 version: 2
updates: updates:
- package-ecosystem: "docker" - package-ecosystem: "docker"
directory: "/" directory: "/"
schedule: schedule:
interval: "daily" interval: "daily"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: daily
open-pull-requests-limit: 10

View File

@@ -10,21 +10,23 @@ on:
branches: branches:
- master - master
concurrency:
group: build-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
jobs: jobs:
unit-tests-master: unit-tests-master:
name: unit-tests name: unit-tests
runs-on: ubuntu-18.04 runs-on: ubuntu-22.04
strategy:
fail-fast: true
env: env:
DOKKU_VERSION: master DOKKU_VERSION: master
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v4
with: with:
fetch-depth: 0 fetch-depth: 0
- uses: actions/setup-python@v2 - uses: actions/setup-python@v5
with: with:
python-version: '3.7.x' python-version: '3.7.x'
@@ -49,7 +51,7 @@ jobs:
- run: make test - run: make test
- uses: actions/upload-artifact@v2 - uses: actions/upload-artifact@v4
if: failure() if: failure()
with: with:
name: tmp/test-results name: tmp/test-results
@@ -57,18 +59,16 @@ jobs:
unit-tests-0_19_0: unit-tests-0_19_0:
name: unit-tests-0.19.0 name: unit-tests-0.19.0
runs-on: ubuntu-18.04 runs-on: ubuntu-22.04
strategy:
fail-fast: true
env: env:
DOKKU_TAG: v0.19.0 DOKKU_TAG: v0.19.0
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v4
with: with:
fetch-depth: 0 fetch-depth: 0
- uses: actions/setup-python@v2 - uses: actions/setup-python@v5
with: with:
python-version: '3.7.x' python-version: '3.7.x'
@@ -93,7 +93,7 @@ jobs:
- run: make test - run: make test
- uses: actions/upload-artifact@v2 - uses: actions/upload-artifact@v4
if: failure() if: failure()
with: with:
name: tmp/test-results name: tmp/test-results

19
.github/workflows/tagged-release.yml vendored Normal file
View File

@@ -0,0 +1,19 @@
---
name: "tagged-release"
# yamllint disable-line rule:truthy
on:
push:
tags:
- '*'
jobs:
tagged-release:
name: tagged-release
runs-on: ubuntu-22.04
steps:
- uses: "marvinpinto/action-automatic-releases@v1.2.1"
with:
repo_token: "${{ secrets.GITHUB_TOKEN }}"
prerelease: false

View File

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

View File

@@ -1,5 +1,6 @@
HARDWARE = $(shell uname -m) HARDWARE = $(shell uname -m)
SYSTEM_NAME = $(shell uname -s | tr '[:upper:]' '[:lower:]') SYSTEM_NAME = $(shell uname -s | tr '[:upper:]' '[:lower:]')
ARCH = $(shell dpkg --print-architecture)
SHFMT_VERSION = 3.0.2 SHFMT_VERSION = 3.0.2
XUNIT_TO_GITHUB_VERSION = 0.3.0 XUNIT_TO_GITHUB_VERSION = 0.3.0
XUNIT_READER_VERSION = 0.1.0 XUNIT_READER_VERSION = 0.1.0
@@ -21,7 +22,11 @@ ifneq ($(shell shellcheck --version >/dev/null 2>&1 ; echo $$?),0)
ifeq ($(SYSTEM_NAME),darwin) ifeq ($(SYSTEM_NAME),darwin)
brew install shellcheck brew install shellcheck
else else
sudo add-apt-repository 'deb http://archive.ubuntu.com/ubuntu trusty-backports main restricted universe multiverse' ifeq ($(ARCH),arm64)
sudo add-apt-repository 'deb http://ports.ubuntu.com/ubuntu-ports jammy-backports main restricted universe multiverse'
else
sudo add-apt-repository 'deb http://archive.ubuntu.com/ubuntu jammy-backports main restricted universe multiverse'
endif
sudo rm -rf /var/lib/apt/lists/* && sudo apt-get clean sudo rm -rf /var/lib/apt/lists/* && sudo apt-get clean
sudo apt-get update -qq && sudo apt-get install -qq -y shellcheck sudo apt-get update -qq && sudo apt-get install -qq -y shellcheck
endif endif

333
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 16.2](https://hub.docker.com/_/postgres/).
## Requirements ## 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: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 <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> # sets up authentication for backups on the postgres service postgres:backup-auth <service> <aws-access-key-id> <aws-secret-access-key> <aws-default-region> <aws-signature-version> <endpoint-url> # set up authentication for backups on the postgres service
postgres:backup-deauth <service> # removes backup authentication for the postgres service postgres:backup-deauth <service> # remove backup authentication for the postgres service
postgres:backup-schedule <service> <schedule> <bucket-name> [--use-iam] # schedules a backup of 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-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-set-encryption <service> <passphrase> # set encryption for all future backups of postgres service
postgres:backup-unschedule <service> # unschedules the backup of the postgres service postgres:backup-unschedule <service> # unschedule the backup of the postgres service
postgres:backup-unset-encryption <service> # unsets encryption for future backups 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: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:connect <service> # connect to the service via the postgres connection tool
postgres:create <service> [--create-flags...] # create a postgres service postgres:create <service> [--create-flags...] # create a postgres service
@@ -33,16 +33,18 @@ postgres:destroy <service> [-f|--force] # delete the postgres service
postgres:enter <service> # enter or run a command in a running postgres service container postgres:enter <service> # enter or run a command in a running postgres service container
postgres:exists <service> # check if the postgres service exists postgres:exists <service> # check if the postgres service exists
postgres:export <service> # export a dump of the postgres service database 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:import <service> # import a dump into the postgres service database
postgres:info <service> [--single-info-flag] # print the service information postgres:info <service> [--single-info-flag] # print the service information
postgres:link <service> <app> [--link-flags...] # link the postgres service to the app 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: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:links <service> # list all apps linked to the postgres service
postgres:list # list all postgres services 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:promote <service> <app> # promote service <service> as DATABASE_URL in <app>
postgres:restart <service> # graceful shutdown and restart of the postgres service container postgres:restart <service> # graceful shutdown and restart of the postgres service container
postgres:set <service> <key> <value> # set or clear a property for a service
postgres:start <service> # start a previously stopped postgres service postgres:start <service> # start a previously stopped postgres service
postgres:stop <service> # stop a running postgres service postgres:stop <service> # stop a running postgres service
postgres:unexpose <service> # unexpose a previously exposed postgres service postgres:unexpose <service> # unexpose a previously exposed postgres service
@@ -52,7 +54,7 @@ postgres:upgrade <service> [--upgrade-flags...] # upgrade service <service> t
## Usage ## Usage
Help for any commands can be displayed by specifying the command as an argument to postgres:help. Please consult the `postgres:help` command for any undocumented commands. 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 ### Basic Usage
@@ -65,31 +67,43 @@ dokku postgres:create <service> [--create-flags...]
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 - `-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 IMAGE`: the image name to start the service with
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with - `-I|--image-version IMAGE_VERSION`: the image version to start the service with
- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
- `-p|--password PASSWORD`: override the user-level service password - `-p|--password PASSWORD`: override the user-level service password
- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation
- `-r|--root-password PASSWORD`: override the root-level service password - `-r|--root-password PASSWORD`: override the root-level service password
- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start
- `-s|--shm-size SHM_SIZE`: override shared memory size for postgres docker container
Create a postgres service named lolipop: Create a postgres service named lollipop:
```shell ```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 ```shell
export DATABASE_IMAGE="postgres" export POSTGRES_IMAGE="postgres"
export DATABASE_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}" export POSTGRES_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
dokku postgres:create lolipop 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 semicolon-separated form.
```shell ```shell
export DATABASE_CUSTOM_ENV="USER=alpha;HOST=beta" export POSTGRES_CUSTOM_ENV="USER=alpha;HOST=beta"
dokku postgres:create lolipop dokku postgres:create lollipop
```
Official Postgres "$DOCKER_BIN" image ls 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 ### print the service information
@@ -107,7 +121,10 @@ flags:
- `--exposed-ports`: show service exposed ports - `--exposed-ports`: show service exposed ports
- `--id`: show the service container id - `--id`: show the service container id
- `--internal-ip`: show the service internal ip - `--internal-ip`: show the service internal ip
- `--initial-network`: show the initial network being connected to
- `--links`: show the service app links - `--links`: show the service app links
- `--post-create-network`: show the networks to attach to after service container creation
- `--post-start-network`: show the networks to attach to after service container start
- `--service-root`: show the service root directory - `--service-root`: show the service root directory
- `--status`: show the service running status - `--status`: show the service running status
- `--version`: show the service image version - `--version`: show the service image version
@@ -115,29 +132,32 @@ flags:
Get connection information as follows: Get connection information as follows:
```shell ```shell
dokku postgres:info lolipop dokku postgres:info lollipop
``` ```
You can also retrieve a specific piece of service info via flags: You can also retrieve a specific piece of service info via flags:
```shell ```shell
dokku postgres:info lolipop --config-dir dokku postgres:info lollipop --config-dir
dokku postgres:info lolipop --data-dir dokku postgres:info lollipop --data-dir
dokku postgres:info lolipop --dsn dokku postgres:info lollipop --dsn
dokku postgres:info lolipop --exposed-ports dokku postgres:info lollipop --exposed-ports
dokku postgres:info lolipop --id dokku postgres:info lollipop --id
dokku postgres:info lolipop --internal-ip dokku postgres:info lollipop --internal-ip
dokku postgres:info lolipop --links dokku postgres:info lollipop --initial-network
dokku postgres:info lolipop --service-root dokku postgres:info lollipop --links
dokku postgres:info lolipop --status dokku postgres:info lollipop --post-create-network
dokku postgres:info lolipop --version dokku postgres:info lollipop --post-start-network
dokku postgres:info lollipop --service-root
dokku postgres:info lollipop --status
dokku postgres:info lollipop --version
``` ```
### list all postgres services ### list all postgres services
```shell ```shell
# usage # usage
dokku postgres:list dokku postgres:list
``` ```
List all services: List all services:
@@ -150,23 +170,29 @@ dokku postgres:list
```shell ```shell
# usage # usage
dokku postgres:logs <service> [-t|--tail] dokku postgres:logs <service> [-t|--tail] <tail-num-optional>
``` ```
flags: 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: You can tail logs for a particular service:
```shell ```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: By default, logs will not be tailed, but you can do this with the --tail flag:
```shell ```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 ### link the postgres service to the app
@@ -180,49 +206,50 @@ flags:
- `-a|--alias "BLUE_DATABASE"`: an alternative alias to use for linking to an app via environment variable - `-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 - `-q|--querystring "pool=5"`: ampersand delimited querystring arguments to append to the service link
- `-n|--no-restart "false"`: whether or not to restart the app on link (default: true)
A 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 > NOTE: this will restart your app
```shell ```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): 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_POSTGRES_LOLLIPOP_NAME=/lollipop/DATABASE
DOKKU_DATABASE_LOLIPOP_PORT=tcp://172.17.0.1:5432 DOKKU_POSTGRES_LOLLIPOP_PORT=tcp://172.17.0.1:5432
DOKKU_DATABASE_LOLIPOP_PORT_5432_TCP=tcp://172.17.0.1:5432 DOKKU_POSTGRES_LOLLIPOP_PORT_5432_TCP=tcp://172.17.0.1:5432
DOKKU_DATABASE_LOLIPOP_PORT_5432_TCP_PROTO=tcp DOKKU_POSTGRES_LOLLIPOP_PORT_5432_TCP_PROTO=tcp
DOKKU_DATABASE_LOLIPOP_PORT_5432_TCP_PORT=5432 DOKKU_POSTGRES_LOLLIPOP_PORT_5432_TCP_PORT=5432
DOKKU_DATABASE_LOLIPOP_PORT_5432_TCP_ADDR=172.17.0.1 DOKKU_POSTGRES_LOLLIPOP_PORT_5432_TCP_ADDR=172.17.0.1
``` ```
The following will be set on the linked application by default: 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 ```shell
dokku postgres:link other_service playground 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 ```shell
dokku config:set playground POSTGRES_DATABASE_SCHEME=postgres2 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: 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 ### unlink the postgres service from the app
@@ -232,12 +259,41 @@ postgres2://lolipop:SOME_PASSWORD@dokku-postgres-lolipop:5432/lolipop
dokku postgres:unlink <service> <app> dokku postgres:unlink <service> <app>
``` ```
flags:
- `-n|--no-restart "false"`: whether or not to restart the app on unlink (default: true)
You can unlink a postgres service: You can unlink a postgres service:
> NOTE: this will restart your app and unset related environment variables > NOTE: this will restart your app and unset related environment variables
```shell ```shell
dokku postgres:unlink lolipop playground dokku postgres:unlink lollipop playground
```
### set or clear a property for a service
```shell
# usage
dokku postgres:set <service> <key> <value>
```
Set the network to attach after the service container is started:
```shell
dokku postgres:set lollipop post-create-network custom-network
```
Set multiple networks:
```shell
dokku postgres:set lollipop post-create-network custom-network,other-network
```
Unset the post-create-network value:
```shell
dokku postgres:set lollipop post-create-network
``` ```
### Service Lifecycle ### Service Lifecycle
@@ -253,8 +309,10 @@ dokku postgres:connect <service>
Connect to the service via the postgres connection tool: 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 ```shell
dokku postgres:connect lolipop dokku postgres:connect lollipop
``` ```
### enter or run a command in a running postgres service container ### enter or run a command in a running postgres service container
@@ -264,19 +322,21 @@ dokku postgres:connect lolipop
dokku postgres:enter <service> 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 ```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 ```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 ```shell
# usage # usage
@@ -286,7 +346,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`): Expose the service on the service's normal ports, allowing access to it from the public interface (`0.0.0.0`):
```shell ```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 ### unexpose a previously exposed postgres service
@@ -299,7 +365,7 @@ dokku postgres:unexpose <service>
Unexpose the service, removing access to it from the public interface (`0.0.0.0`): Unexpose the service, removing access to it from the public interface (`0.0.0.0`):
```shell ```shell
dokku postgres:unexpose lolipop dokku postgres:unexpose lollipop
``` ```
### promote service <service> as DATABASE_URL in <app> ### promote service <service> as DATABASE_URL in <app>
@@ -328,7 +394,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 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_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 ### start a previously stopped postgres service
@@ -341,7 +407,7 @@ dokku postgres:start <service>
Start the service: Start the service:
```shell ```shell
dokku postgres:start lolipop dokku postgres:start lollipop
``` ```
### stop a running postgres service ### stop a running postgres service
@@ -351,10 +417,23 @@ dokku postgres:start lolipop
dokku postgres:stop <service> dokku postgres:stop <service>
``` ```
Stop the service and the running container: Stop the service and removes the running container:
```shell ```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 ### graceful shutdown and restart of the postgres service container
@@ -367,7 +446,7 @@ dokku postgres:restart <service>
Restart the service: Restart the service:
```shell ```shell
dokku postgres:restart lolipop dokku postgres:restart lollipop
``` ```
### upgrade service <service> to the specified versions ### upgrade service <service> to the specified versions
@@ -379,15 +458,51 @@ dokku postgres:upgrade <service> [--upgrade-flags...]
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 - `-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 IMAGE`: the image name to start the service with
- `-I|--image-version IMAGE_VERSION`: the image version 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 - `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation
- `-R|--restart-apps "true"`: whether or not to force an app restart (default: false)
- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start
- `-s|--shm-size SHM_SIZE`: override shared memory size for postgres docker container
You can upgrade an existing service to a new image or image-version: You can upgrade an existing service to a new image or image-version:
```shell ```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 ### Service Automation
@@ -401,7 +516,7 @@ Service scripting can be executed using the following commands:
dokku postgres:app-links <app> 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 ```shell
dokku postgres:app-links playground dokku postgres:app-links playground
@@ -416,16 +531,22 @@ dokku postgres:clone <service> <new-service> [--clone-flags...]
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 - `-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 IMAGE`: the image name to start the service with
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with - `-I|--image-version IMAGE_VERSION`: the image version to start the service with
- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
- `-p|--password PASSWORD`: override the user-level service password - `-p|--password PASSWORD`: override the user-level service password
- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation
- `-r|--root-password PASSWORD`: override the root-level service password - `-r|--root-password PASSWORD`: override the root-level service password
- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start
- `-s|--shm-size SHM_SIZE`: override shared memory size for postgres docker container
You can clone an existing service to a new one: You can clone an existing service to a new one:
```shell ```shell
dokku postgres:clone lolipop lolipop-2 dokku postgres:clone lollipop lollipop-2
``` ```
### check if the postgres service exists ### check if the postgres service exists
@@ -435,10 +556,10 @@ dokku postgres:clone lolipop lolipop-2
dokku postgres:exists <service> dokku postgres:exists <service>
``` ```
Here we check if the lolipop postgres service exists. Here we check if the lollipop postgres service exists.
```shell ```shell
dokku postgres:exists lolipop dokku postgres:exists lollipop
``` ```
### check if the postgres service is linked to an app ### check if the postgres service is linked to an app
@@ -448,10 +569,10 @@ dokku postgres:exists lolipop
dokku postgres:linked <service> <app> 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 ```shell
dokku postgres:linked lolipop playground dokku postgres:linked lollipop playground
``` ```
### list all apps linked to the postgres service ### list all apps linked to the postgres service
@@ -461,10 +582,10 @@ dokku postgres:linked lolipop playground
dokku postgres:links <service> dokku postgres:links <service>
``` ```
List all apps linked to the 'lolipop' postgres service. List all apps linked to the `lollipop` postgres service.
```shell ```shell
dokku postgres:links lolipop dokku postgres:links lollipop
``` ```
### Data Management ### Data Management
@@ -481,7 +602,7 @@ dokku postgres:import <service>
Import a datastore dump: Import a datastore dump:
```shell ```shell
dokku postgres:import lolipop < database.dump dokku postgres:import lollipop < data.dump
``` ```
### export a dump of the postgres service database ### export a dump of the postgres service database
@@ -494,13 +615,19 @@ dokku postgres:export <service>
By default, datastore output is exported to stdout: By default, datastore output is exported to stdout:
```shell ```shell
dokku postgres:export lolipop dokku postgres:export lollipop
``` ```
You can redirect this output to a file: You can redirect this output to a file:
```shell ```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 ### Backups
@@ -511,7 +638,7 @@ You may skip the `backup-auth` step if your dokku install is running within EC2
Backups can be performed using the backup commands: 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 ```shell
# usage # usage
@@ -521,28 +648,28 @@ dokku postgres:backup-auth <service> <aws-access-key-id> <aws-secret-access-key>
Setup s3 backup authentication: Setup s3 backup authentication:
```shell ```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: Setup s3 backup authentication with different region:
```shell ```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: Setup s3 backup authentication with different signature version and endpoint:
```shell ```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: More specific example for minio auth:
```shell ```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 ```shell
# usage # usage
@@ -552,10 +679,10 @@ dokku postgres:backup-deauth <service>
Remove s3 authentication: Remove s3 authentication:
```shell ```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 ```shell
# usage # usage
@@ -566,13 +693,19 @@ flags:
- `-u|--use-iam`: use the IAM profile associated with the current server - `-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 ```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 ```shell
# usage # usage
@@ -582,10 +715,10 @@ dokku postgres:backup-set-encryption <service> <passphrase>
Set the GPG-compatible passphrase for encrypting backups for backups: Set the GPG-compatible passphrase for encrypting backups for backups:
```shell ```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 ```shell
# usage # usage
@@ -595,10 +728,10 @@ dokku postgres:backup-unset-encryption <service>
Unset the `GPG` encryption passphrase for backups: Unset the `GPG` encryption passphrase for backups:
```shell ```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 ```shell
# usage # usage
@@ -614,13 +747,13 @@ Schedule a backup:
> 'schedule' is a crontab expression, eg. "0 3 * * *" for each day at 3am > 'schedule' is a crontab expression, eg. "0 3 * * *" for each day at 3am
```shell ```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: Schedule a backup and authenticate via iam:
```shell ```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 ### cat the contents of the configured backup cronfile for the service
@@ -633,10 +766,10 @@ dokku postgres:backup-schedule-cat <service>
Cat the contents of the configured backup cronfile for the service: Cat the contents of the configured backup cronfile for the service:
```shell ```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 ```shell
# usage # usage
@@ -646,11 +779,11 @@ dokku postgres:backup-unschedule <service>
Remove the scheduled backup from cron: Remove the scheduled backup from cron:
```shell ```shell
dokku postgres:backup-unschedule lolipop dokku postgres:backup-unschedule lollipop
``` ```
### Disabling `docker pull` calls ### Disabling `docker image pull` calls
If you wish to disable the `docker pull` calls that the plugin triggers, you may set the `POSTGRES_DISABLE_PULL` environment variable to `true`. Once disabled, you will need to pull the service image you wish to deploy as shown in the `stderr` output. If you wish to disable the `docker image pull` calls that the plugin triggers, you may set the `POSTGRES_DISABLE_PULL` environment variable to `true`. Once disabled, you will need to pull the service image you wish to deploy as shown in the `stderr` output.
Please ensure the proper images are in place when `docker pull` is disabled. Please ensure the proper images are in place when `docker image pull` is disabled.

2
Vagrantfile vendored
View File

@@ -1,7 +1,7 @@
# -*- mode: ruby -*- # -*- mode: ruby -*-
# vi: set ft=ruby : # vi: set ft=ruby :
BOX_NAME = ENV["BOX_NAME"] || "bento/ubuntu-18.04" BOX_NAME = ENV["BOX_NAME"] || "bento/ubuntu-22.04"
BOX_MEMORY = ENV["BOX_MEMORY"] || "2048" BOX_MEMORY = ENV["BOX_MEMORY"] || "2048"
DOKKU_VERSION = "master" DOKKU_VERSION = "master"

View File

@@ -1,15 +1,30 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
from __future__ import print_function from __future__ import print_function
import os import os
import re import re
def compile(service, version, variable, alias, image, scheme, ports, sponsors, unimplemented, dokku_version): def compile(
prefix = "\n\n".join([ service,
header(service), version,
description(service, image, version), variable,
]) alias,
image,
scheme,
ports,
sponsors,
options,
unimplemented,
dokku_version,
):
prefix = "\n\n".join(
[
header(service),
description(service, image, version),
]
)
if len(sponsors) > 0: if len(sponsors) > 0:
prefix += "\n\n" prefix += "\n\n"
@@ -21,8 +36,19 @@ def compile(service, version, variable, alias, image, scheme, ports, sponsors, u
prefix, prefix,
requirements_section(dokku_version), requirements_section(dokku_version),
installation_section(service, dokku_version), installation_section(service, dokku_version),
commands_section(service, variable, alias, image, scheme, ports, unimplemented), commands_section(
usage_section(service, variable, alias, image, scheme, ports, unimplemented), service, variable, alias, image, scheme, ports, unimplemented
),
usage_section(
service,
variable,
alias,
image,
scheme,
ports,
options,
unimplemented,
),
] ]
) )
.replace("\n\n\n\n\n", "\n") .replace("\n\n\n\n\n", "\n")
@@ -35,7 +61,7 @@ def header(service):
return " ".join( return " ".join(
[ [
f"# dokku {service}", 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)', f'[![IRC Network](https://img.shields.io/badge/irc-libera-blue.svg?style=flat-square "IRC Libera")](https://webchat.libera.chat/?channels=dokku)',
] ]
) )
@@ -55,17 +81,25 @@ def sponsors_section(service, sponsors):
if len(sponsors) == 0: if len(sponsors) == 0:
return "" return ""
sponsor_data = ["## Sponsors", "", f"The {service} plugin was generously sponsored by the following:", ""] sponsor_data = [
"## Sponsors",
"",
f"The {service} plugin was generously sponsored by the following:",
"",
]
sponsor_data.extend([f"- [{s}](https://github.com/{s})" for s in sponsors]) sponsor_data.extend([f"- [{s}](https://github.com/{s})" for s in sponsors])
return "\n".join( return "\n".join(sponsor_data)
sponsor_data
)
def requirements_section(dokku_version): def requirements_section(dokku_version):
return "\n".join( return "\n".join(
["## Requirements", "", f"- dokku {dokku_version}", "- docker 1.8.x",] [
"## Requirements",
"",
f"- dokku {dokku_version}",
"- docker 1.8.x",
]
) )
@@ -115,31 +149,56 @@ def commands_section(service, variable, alias, image, scheme, ports, unimplement
return "\n".join(content) 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( return "\n\n".join(
[ [
"## Usage", "## 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.", 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, unimplemented), usage_intro(
usage_lifecycle(service, variable, alias, image, scheme, ports, unimplemented), service, variable, alias, image, scheme, ports, options, unimplemented
usage_automation(service, variable, alias, image, scheme, ports, unimplemented), ),
usage_data_management(service, variable, alias, image, scheme, ports, unimplemented), usage_lifecycle(
usage_backup(service, variable, alias, image, scheme, ports, unimplemented), service, variable, alias, image, scheme, ports, options, unimplemented
usage_docker_pull(service, variable, alias, image, scheme, ports, 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"] commands = ["create", "info", "list", "logs", "link", "unlink", "set"]
content = ["### Basic Usage"] content = ["### Basic Usage"]
return fetch_commands_content( 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 = [ commands = [
"connect", "connect",
"enter", "enter",
@@ -148,6 +207,7 @@ def usage_lifecycle(service, variable, alias, image, scheme, ports, unimplemente
"promote", "promote",
"start", "start",
"stop", "stop",
"pause",
"restart", "restart",
"upgrade", "upgrade",
] ]
@@ -159,11 +219,22 @@ def usage_lifecycle(service, variable, alias, image, scheme, ports, unimplemente
] ]
return fetch_commands_content( 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"] commands = ["app-links", "clone", "exists", "linked", "links"]
content = [ content = [
"### Service Automation", "### Service Automation",
@@ -173,11 +244,22 @@ def usage_automation(service, variable, alias, image, scheme, ports, unimplement
] ]
return fetch_commands_content( 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"] commands = ["import", "export"]
content = [ content = [
"### Data Management", "### Data Management",
@@ -187,11 +269,22 @@ def usage_data_management(service, variable, alias, image, scheme, ports, unimpl
] ]
return fetch_commands_content( 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 = [ commands = [
"backup-auth", "backup-auth",
"backup-deauth", "backup-deauth",
@@ -214,29 +307,59 @@ def usage_backup(service, variable, alias, image, scheme, ports, unimplemented):
] ]
return fetch_commands_content( 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() service_prefix = service.upper()
return "\n".join( return "\n".join(
[ [
"### Disabling `docker pull` calls", "### Disabling `docker image pull` calls",
"", "",
f"If you wish to disable the `docker pull` calls that the plugin triggers, you may set the `{service_prefix}_DISABLE_PULL` environment variable to `true`. Once disabled, you will need to pull the service image you wish to deploy as shown in the `stderr` output.", f"If you wish to disable the `docker image pull` calls that the plugin triggers, you may set the `{service_prefix}_DISABLE_PULL` environment variable to `true`. Once disabled, you will need to pull the service image you wish to deploy as shown in the `stderr` output.",
"", "",
"Please ensure the proper images are in place when `docker pull` is disabled.", "Please ensure the proper images are in place when `docker image pull` is disabled.",
] ]
) )
def fetch_commands_content( 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 i = 0
for command in commands: 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 == "": if output == "":
continue continue
content.append(output) content.append(output)
@@ -274,7 +397,9 @@ def parse_args(line):
return " ".join(arguments) 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: if command in unimplemented:
return "" return ""
@@ -284,7 +409,7 @@ def command_help(command, service, variable, alias, image, scheme, ports, unimpl
"", "",
"```shell", "```shell",
"# usage", "# usage",
f"dokku {service}:{command} {data['arguments_string']}", f"dokku {service}:{command} {data['arguments_string']}".strip(),
"```", "```",
] ]
@@ -300,12 +425,20 @@ def command_help(command, service, variable, alias, image, scheme, ports, unimpl
content.append("flags:") content.append("flags:")
content.append("") content.append("")
for flag in data["flags"]: for flag in data["flags"]:
if "--config-options" in flag and options != "":
flag = f"{flag} (default: `{options}`)"
content.append(f"- {flag}") content.append(f"- {flag}")
if len(data["examples"]) > 0: if len(data["examples"]) > 0:
content.append("") content.append("")
content.append(data["examples"]) 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) return "\n" + "\n".join(content)
@@ -423,28 +556,32 @@ def command_data(command, service, variable, alias, image, scheme, ports):
def process_sentence(sentence_lines): def process_sentence(sentence_lines):
sentence_lines = " ".join(sentence_lines) sentence_lines = " ".join(sentence_lines)
sentences = ". ".join( sentences = ". ".join(
upperfirst(i.strip()) for i in sentence_lines.split(".") upperfirst(i.strip()) for i in sentence_lines.split(". ")
).strip() ).strip()
if not sentences.endswith(".") and not sentences.endswith(":"): if not sentences.endswith(".") and not sentences.endswith(":"):
sentences += ":" sentences += ":"
text = [] text = []
for sentence in sentences.split("."): for sentence in sentences.split(". "):
parts = [] parts = []
for word in sentence.strip().split(" "): for word in sentence.strip().split(" "):
if word.isupper() and len(word) > 1: if word.isupper() and len(word) > 1:
for ending in [':', '.']: for ending in [":", "."]:
if word.endswith(ending): if word.endswith(ending):
word = '`{0}`{1}'.format(word[:-1], ending) word = "`{0}`{1}".format(word[:-1], ending)
else: else:
word = '`{0}`'.format(word) word = "`{0}`".format(word)
parts.append(word) parts.append(word)
text.append(" ".join(parts)) text.append(" ".join(parts))
text = ". ".join(text) text = ". ".join(text)
# some cleanup # 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 return text
@@ -473,14 +610,15 @@ def main():
variable = None variable = None
image = None image = None
alias = None alias = None
options = None
unimplemented = [] unimplemented = []
with open("Dockerfile") as f: with open("Dockerfile") as f:
for line in f.readlines(): for line in f.readlines():
if "FROM " in line: if "FROM " in line:
image, version = line.split(" ")[1].split(":") image, version = line.split(" ")[1].split(":")
image = image.strip() image = image.strip()
version = version.strip() version = version.strip()
with open("config") as f: with open("config") as f:
for line in f.readlines(): for line in f.readlines():
@@ -499,14 +637,33 @@ def main():
if match is not None: if match is not None:
unimplemented = [s.strip('"') for s in match.group(1).split(" ")] 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 = [] sponsors = []
with open("plugin.toml") as f: with open("plugin.toml") as f:
for line in f.readlines(): for line in f.readlines():
if line.startswith("sponsors"): if line.startswith("sponsors"):
sponsors = re.search("\[([\"\w\s,_-]+)\]", line).group(1) sponsors = re.search('\[(["\w\s,_-]+)\]', line).group(1)
sponsors = [s.strip("\"") for s in sponsors.split(",")] 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__))) base_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
readme_file = os.path.join(base_path, "README.md") readme_file = os.path.join(base_path, "README.md")

View File

@@ -1,7 +1,8 @@
#!/usr/bin/env bash #!/usr/bin/env bash
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config" 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" [[ " 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 set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x

View File

@@ -2,10 +2,90 @@
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config" source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/property-functions"
source "$PLUGIN_AVAILABLE_PATH/config/functions" 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 2>&1 || 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() { docker_ports_options() {
declare desc="Exports a list of exposed ports" declare desc="export a list of exposed ports"
declare PORTS=("$@") declare PORTS=("$@")
for ((i = 0; i < ${#PLUGIN_DATASTORE_PORTS[@]}; i++)); do for ((i = 0; i < ${#PLUGIN_DATASTORE_PORTS[@]}; i++)); do
echo -n "-p ${PORTS[i]}:${PLUGIN_DATASTORE_PORTS[i]} " echo -n "-p ${PORTS[i]}:${PLUGIN_DATASTORE_PORTS[i]} "
@@ -13,25 +93,25 @@ docker_ports_options() {
} }
get_container_ip() { 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" declare CONTAINER_ID="$1"
docker inspect --format '{{ .NetworkSettings.IPAddress }}' "$CONTAINER_ID" 2>/dev/null "$DOCKER_BIN" container inspect --format '{{ .NetworkSettings.IPAddress }}' "$CONTAINER_ID" 2>/dev/null
} }
get_database_name() { get_database_name() {
declare desc="Retrieves a sanitized database name" declare desc="retrieve a sanitized database name"
declare SERVICE="$1" declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
if [[ ! -f "$SERVICE_ROOT/DATABASE_NAME" ]]; then if [[ ! -f "$SERVICE_ROOT/DATABASE_NAME" ]]; then
echo "$SERVICE" > "$SERVICE_ROOT/DATABASE_NAME" echo "$SERVICE" >"$SERVICE_ROOT/DATABASE_NAME"
fi fi
cat "$SERVICE_ROOT/DATABASE_NAME" cat "$SERVICE_ROOT/DATABASE_NAME"
} }
get_random_ports() { get_random_ports() {
declare desc="Retrieves N random ports" declare desc="retrieve N random ports"
declare iterations="${1:-1}" declare iterations="${1:-1}"
for ((i = 0; i < iterations; i++)); do for ((i = 0; i < iterations; i++)); do
local port=$RANDOM local port=$RANDOM
@@ -50,22 +130,31 @@ get_random_ports() {
} }
get_service_name() { get_service_name() {
declare desc="Retrieves a docker service label" declare desc="retrieve a docker service label"
declare SERVICE="$1" declare SERVICE="$1"
echo "dokku.${PLUGIN_COMMAND_PREFIX}.$SERVICE" echo "dokku.${PLUGIN_COMMAND_PREFIX}.$SERVICE"
} }
get_url_from_config() { 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" declare EXISTING_CONFIG="$1" CONFIG_VAR="$2"
echo "$EXISTING_CONFIG" | grep "$CONFIG_VAR" | sed "s/$CONFIG_VAR:\s*//" | xargs 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() { 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" declare CID="$1" STATUS="$2"
local TEMPLATE="{{.State.$STATUS}}" local TEMPLATE="{{.State.$STATUS}}"
local CONTAINER_STATUS=$(docker inspect -f "$TEMPLATE" "$CID" 2>/dev/null || true) local CONTAINER_STATUS=$("$DOCKER_BIN" container inspect -f "$TEMPLATE" "$CID" 2>/dev/null || true)
if [[ "$CONTAINER_STATUS" == "true" ]]; then if [[ "$CONTAINER_STATUS" == "true" ]]; then
return 0 return 0
@@ -90,7 +179,7 @@ is_implemented_command() {
} }
is_valid_service_name() { is_valid_service_name() {
declare desc="Validates a service name" declare desc="validate a service name"
declare SERVICE="$1" declare SERVICE="$1"
[[ -z "$SERVICE" ]] && return 1 [[ -z "$SERVICE" ]] && return 1
@@ -102,7 +191,7 @@ is_valid_service_name() {
} }
remove_from_links_file() { 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" declare SERVICE="$1" APP="$2"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local LINKS_FILE="$SERVICE_ROOT/LINKS" local LINKS_FILE="$SERVICE_ROOT/LINKS"
@@ -120,7 +209,7 @@ retry-docker-command() {
local i=0 success=false local i=0 success=false
until [ $i -ge 100 ]; do until [ $i -ge 100 ]; do
set +e set +e
suppress_output docker exec "$ID" sh -c "$COMMAND" suppress_output "$DOCKER_BIN" container exec "$ID" sh -c "$COMMAND"
exit_code=$? exit_code=$?
set -e set -e
if [[ "$exit_code" == 0 ]]; then if [[ "$exit_code" == 0 ]]; then
@@ -137,7 +226,7 @@ retry-docker-command() {
} }
service_alternative_alias() { 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" declare EXISTING_CONFIG="$1"
local COLORS=(AQUA BLACK BLUE FUCHSIA GRAY GREEN LIME MAROON NAVY OLIVE PURPLE RED SILVER TEAL WHITE YELLOW) local COLORS=(AQUA BLACK BLUE FUCHSIA GRAY GREEN LIME MAROON NAVY OLIVE PURPLE RED SILVER TEAL WHITE YELLOW)
local ALIAS local ALIAS
@@ -154,14 +243,16 @@ service_alternative_alias() {
} }
service_app_links() { 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" declare APP="$1"
local SERVICE LINKED_APP local LINKED_APP SERVICE SERVICE_ROOT
pushd "$PLUGIN_DATA_ROOT" >/dev/null for SERVICE in $(fn-services-list true); do
for SERVICE in *; do [[ -n "$SERVICE" ]] || continue
[[ -f "$SERVICE/LINKS" ]] || continue
for LINKED_APP in $(<"$SERVICE/LINKS"); do SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
[[ -f "$SERVICE_ROOT/LINKS" ]] || continue
for LINKED_APP in $(<"$SERVICE_ROOT/LINKS"); do
if [[ "$LINKED_APP" == "$APP" ]]; then if [[ "$LINKED_APP" == "$APP" ]]; then
echo "$SERVICE" echo "$SERVICE"
fi fi
@@ -170,7 +261,7 @@ service_app_links() {
} }
service_backup() { 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" declare SERVICE="$1" BUCKET_NAME="$2" USE_IAM_OPTIONAL_FLAG="$3"
local SERVICE_BACKUP_ROOT="$PLUGIN_DATA_ROOT/$SERVICE/backup" local SERVICE_BACKUP_ROOT="$PLUGIN_DATA_ROOT/$SERVICE/backup"
local BACKUP_ENCRYPTION_CONFIG_ROOT="$PLUGIN_DATA_ROOT/$SERVICE/backup-encryption" local BACKUP_ENCRYPTION_CONFIG_ROOT="$PLUGIN_DATA_ROOT/$SERVICE/backup-encryption"
@@ -191,7 +282,7 @@ service_backup() {
BACKUP_TMPDIR=$(mktemp -d --tmpdir) BACKUP_TMPDIR=$(mktemp -d --tmpdir)
trap 'rm -rf "$BACKUP_TMPDIR" > /dev/null' RETURN INT TERM EXIT trap 'rm -rf "$BACKUP_TMPDIR" > /dev/null' RETURN INT TERM EXIT
docker inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist" "$DOCKER_BIN" container inspect "$ID" >/dev/null 2>&1 || dokku_log_fail "Service container does not exist"
is_container_status "$ID" "Running" || dokku_log_fail "Service container is not running" is_container_status "$ID" "Running" || dokku_log_fail "Service container is not running"
(service_export "$SERVICE" >"${BACKUP_TMPDIR}/export") (service_export "$SERVICE" >"${BACKUP_TMPDIR}/export")
@@ -218,11 +309,62 @@ service_backup() {
fi fi
# shellcheck disable=SC2086 # shellcheck disable=SC2086
docker run --rm $BACKUP_PARAMETERS "$PLUGIN_S3BACKUP_IMAGE" "$DOCKER_BIN" container 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
if [[ -n "$SERVICE_INITIAL_NETWORK" ]]; then
fn-plugin-property-write "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "initial-network" "$SERVICE_INITIAL_NETWORK"
fi
if [[ -n "$SERVICE_POST_CREATE_NETWORK" ]]; then
fn-plugin-property-write "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-create-network" "$SERVICE_POST_CREATE_NETWORK"
fi
if [[ -n "$SERVICE_POST_START_NETWORK" ]]; then
fn-plugin-property-write "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-start-network" "$SERVICE_POST_START_NETWORK"
fi
} }
service_backup_auth() { 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" 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" local SERVICE_BACKUP_ROOT="$PLUGIN_DATA_ROOT/$SERVICE/backup"
@@ -244,7 +386,7 @@ service_backup_auth() {
} }
service_backup_deauth() { service_backup_deauth() {
declare desc="Removes authentication" declare desc="remove authentication"
declare SERVICE="$1" declare SERVICE="$1"
local SERVICE_ROOT="${PLUGIN_DATA_ROOT}/${SERVICE}" local SERVICE_ROOT="${PLUGIN_DATA_ROOT}/${SERVICE}"
local SERVICE_BACKUP_ROOT="${SERVICE_ROOT}/backup/" local SERVICE_BACKUP_ROOT="${SERVICE_ROOT}/backup/"
@@ -282,7 +424,7 @@ service_backup_schedule_cat() {
} }
service_backup_set_encryption() { service_backup_set_encryption() {
declare desc="Sets up backup encryption" declare desc="set up backup encryption"
declare SERVICE="$1" ENCRYPTION_KEY="$2" declare SERVICE="$1" ENCRYPTION_KEY="$2"
local SERVICE_ROOT="${PLUGIN_DATA_ROOT}/${SERVICE}" local SERVICE_ROOT="${PLUGIN_DATA_ROOT}/${SERVICE}"
local SERVICE_BACKUP_ENCRYPTION_ROOT="${SERVICE_ROOT}/backup-encryption/" local SERVICE_BACKUP_ENCRYPTION_ROOT="${SERVICE_ROOT}/backup-encryption/"
@@ -292,7 +434,7 @@ service_backup_set_encryption() {
} }
service_backup_unschedule() { service_backup_unschedule() {
declare desc="unschedules the backup of the service" declare desc="unschedule the backup of the service"
declare SERVICE="$1" declare SERVICE="$1"
local CRON_FILE="/etc/cron.d/dokku-${PLUGIN_COMMAND_PREFIX}-${SERVICE}" local CRON_FILE="/etc/cron.d/dokku-${PLUGIN_COMMAND_PREFIX}-${SERVICE}"
@@ -300,7 +442,7 @@ service_backup_unschedule() {
} }
service_backup_unset_encryption() { service_backup_unset_encryption() {
declare desc="Removes backup encryption" declare desc="remove backup encryption"
declare SERVICE="$1" declare SERVICE="$1"
local SERVICE_ROOT="${PLUGIN_DATA_ROOT}/${SERVICE}" local SERVICE_ROOT="${PLUGIN_DATA_ROOT}/${SERVICE}"
local SERVICE_BACKUP_ENCRYPTION_ROOT="${SERVICE_ROOT}/backup-encryption/" local SERVICE_BACKUP_ENCRYPTION_ROOT="${SERVICE_ROOT}/backup-encryption/"
@@ -309,49 +451,57 @@ service_backup_unset_encryption() {
} }
service_container_rm() { 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" declare SERVICE="$1"
local SERVICE_NAME="$(get_service_name "$SERVICE")" local SERVICE_NAME="$(get_service_name "$SERVICE")"
local ID local ID
service_stop "$SERVICE" service_pause "$SERVICE"
ID=$(docker ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$") || true
# this may be 'true' in tests... # this may be 'true' in tests...
if [[ -z "$ID" ]] || [[ "$ID" == "true" ]]; then if [[ -z "$ID" ]] || [[ "$ID" == "true" ]]; then
return 0 return 0
fi fi
dokku_log_verbose_quiet "Removing container" dokku_log_verbose_quiet "Removing container"
docker update --restart=no "$SERVICE_NAME" >/dev/null 2>&1 "$DOCKER_BIN" container update --restart=no "$SERVICE_NAME" >/dev/null 2>&1
if ! docker rm "$SERVICE_NAME" >/dev/null 2>&1; then if ! "$DOCKER_BIN" container rm "$SERVICE_NAME" >/dev/null 2>&1; then
dokku_log_fail "Unable to remove container for service $SERVICE" dokku_log_fail "Unable to remove container for service $SERVICE"
fi fi
} }
service_dns_hostname() { service_dns_hostname() {
declare desc="Retrieves the alias of a service" declare desc="retrieve the alias of a service"
declare SERVICE="$1" declare SERVICE="$1"
local SERVICE_NAME="$(get_service_name "$SERVICE")" local SERVICE_NAME="$(get_service_name "$SERVICE")"
echo "$SERVICE_NAME" | tr ._ - echo "$SERVICE_NAME" | tr ._ -
} }
service_enter() { 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 declare SERVICE="$1" && shift 1
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local ID="$(cat "$SERVICE_ROOT/ID")" local ID="$(cat "$SERVICE_ROOT/ID")"
docker inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist" "$DOCKER_BIN" container inspect "$ID" >/dev/null 2>&1 || dokku_log_fail "Service container does not exist"
is_container_status "$ID" "Running" || dokku_log_fail "Service container is not running" is_container_status "$ID" "Running" || dokku_log_fail "Service container is not running"
local EXEC_CMD="" local EXEC_CMD=""
has_tty && local DOKKU_RUN_OPTS+=" -i -t" has_tty && local DOKKU_RUN_OPTS+=" -i -t"
# shellcheck disable=SC2086 # shellcheck disable=SC2086
docker exec $DOKKU_RUN_OPTS $ID $EXEC_CMD "${@:-/bin/bash}" "$DOCKER_BIN" container 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() { service_exposed_ports() {
declare desc="Lists exposed ports for a service" declare desc="list exposed ports for a service"
declare SERVICE="$1" declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local PORT_FILE="$SERVICE_ROOT/PORT" local PORT_FILE="$SERVICE_ROOT/PORT"
@@ -363,10 +513,22 @@ service_exposed_ports() {
} }
service_image_exists() { service_image_exists() {
declare desc="Checks if the current image exists" declare desc="check if the current image exists"
local IMAGE="$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" declare SERVICE="$1" PLUGIN_IMAGE="${2:-$PLUGIN_IMAGE}" PLUGIN_IMAGE_VERSION="${3:-$PLUGIN_IMAGE_VERSION}"
local plugin_image="$PLUGIN_IMAGE"
local plugin_image_version="$PLUGIN_IMAGE_VERSION"
if [[ "$(docker images -q "$IMAGE" 2>/dev/null)" == "" ]]; then if [[ -z "$PLUGIN_IMAGE" ]] && [[ -f "$SERVICE_ROOT/IMAGE" ]]; then
plugin_image="$(cat "$SERVICE_ROOT/IMAGE")"
fi
if [[ -z "$PLUGIN_IMAGE_VERSION" ]] && [[ -f "$SERVICE_ROOT/IMAGE_VERSION" ]]; then
plugin_image_version="$(cat "$SERVICE_ROOT/IMAGE_VERSION")"
fi
local IMAGE="$plugin_image:$plugin_image_version"
if [[ "$("$DOCKER_BIN" image ls -q "$IMAGE" 2>/dev/null)" == "" ]]; then
return 1 return 1
fi fi
@@ -374,7 +536,7 @@ service_image_exists() {
} }
service_info() { service_info() {
declare desc="Retrieves information about a given service" declare desc="retrieve information about a given service"
declare SERVICE="$1" INFO_FLAG="$2" declare SERVICE="$1" INFO_FLAG="$2"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local SERVICE_URL=$(service_url "$SERVICE") local SERVICE_URL=$(service_url "$SERVICE")
@@ -384,18 +546,22 @@ service_info() {
local flag_map=( local flag_map=(
"--config-dir: ${SERVICE_ROOT}/${PLUGIN_CONFIG_SUFFIX}" "--config-dir: ${SERVICE_ROOT}/${PLUGIN_CONFIG_SUFFIX}"
"--config-options: $(cat "$SERVICE_ROOT/CONFIG_OPTIONS" 2>/dev/null || true)"
"--data-dir: ${SERVICE_ROOT}/data" "--data-dir: ${SERVICE_ROOT}/data"
"--dsn: ${SERVICE_URL}" "--dsn: ${SERVICE_URL}"
"--exposed-ports: $(service_exposed_ports "$SERVICE")" "--exposed-ports: $(service_exposed_ports "$SERVICE")"
"--id: ${SERVICE_CONTAINER_ID}" "--id: ${SERVICE_CONTAINER_ID}"
"--internal-ip: $(get_container_ip "${SERVICE_CONTAINER_ID}")" "--internal-ip: $(get_container_ip "${SERVICE_CONTAINER_ID}")"
"--initial-network: $(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "initial-network")"
"--links: $(service_linked_apps "$SERVICE")" "--links: $(service_linked_apps "$SERVICE")"
"--post-create-network: $(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-create-network")"
"--post-start-network: $(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-start-network")"
"--service-root: ${SERVICE_ROOT}" "--service-root: ${SERVICE_ROOT}"
"--status: $(service_status "$SERVICE")" "--status: $(service_status "$SERVICE")"
"--version: $(service_version "$SERVICE")" "--version: $(service_version "$SERVICE")"
) )
if [[ -z "$INFO_FLAG" ]]; then 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 for flag in "${flag_map[@]}"; do
key="$(echo "${flag#--}" | cut -f1 -d' ' | tr - ' ')" key="$(echo "${flag#--}" | cut -f1 -d' ' | tr - ' ')"
dokku_log_verbose "$(printf "%-20s %-25s" "${key^}" "${flag#*: }")" dokku_log_verbose "$(printf "%-20s %-25s" "${key^}" "${flag#*: }")"
@@ -413,7 +579,7 @@ service_info() {
} }
service_is_linked() { service_is_linked() {
declare desc="Links a service to an application" declare desc="link a service to an application"
declare SERVICE="$1" APP="$2" declare SERVICE="$1" APP="$2"
update_plugin_scheme_for_app "$APP" update_plugin_scheme_for_app "$APP"
local SERVICE_URL=$(service_url "$SERVICE") local SERVICE_URL=$(service_url "$SERVICE")
@@ -427,7 +593,7 @@ service_is_linked() {
} }
service_link() { service_link() {
declare desc="Links a service to an application" declare desc="link a service to an application"
declare SERVICE="$1" APP="$2" declare SERVICE="$1" APP="$2"
update_plugin_scheme_for_app "$APP" update_plugin_scheme_for_app "$APP"
local SERVICE_URL=$(service_url "$SERVICE") local SERVICE_URL=$(service_url "$SERVICE")
@@ -453,10 +619,8 @@ service_link() {
fi fi
[[ -n $LINK ]] && dokku_log_fail "Already linked as $LINK" [[ -n $LINK ]] && dokku_log_fail "Already linked as $LINK"
plugn trigger service-action pre-link "$SERVICE" "$APP" plugn trigger service-action pre-link "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
touch "$LINKS_FILE" add_to_links_file "$SERVICE" "$APP"
echo "$APP" >>"$LINKS_FILE"
sort "$LINKS_FILE" -u -o "$LINKS_FILE"
if declare -f -F add_passed_docker_option >/dev/null; then if declare -f -F add_passed_docker_option >/dev/null; then
# shellcheck disable=SC2034 # shellcheck disable=SC2034
@@ -466,13 +630,18 @@ service_link() {
dokku docker-options:add "$APP" build,deploy,run "--link $SERVICE_NAME:$SERVICE_DNS_HOSTNAME" dokku docker-options:add "$APP" build,deploy,run "--link $SERVICE_NAME:$SERVICE_DNS_HOSTNAME"
fi fi
[[ -n "$SERVICE_QUERYSTRING" ]] && SERVICE_URL="${SERVICE_URL}?${SERVICE_QUERYSTRING}" [[ -n "$SERVICE_QUERYSTRING" ]] && SERVICE_URL="${SERVICE_URL}?${SERVICE_QUERYSTRING}"
plugn trigger service-action post-link "$SERVICE" "$APP" plugn trigger service-action post-link "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
config_set "$APP" "${ALIAS}_URL=$SERVICE_URL" if [[ "$DOKKU_GLOBAL_FLAGS" == *"--no-restart"* ]] || [[ "$SERVICE_RESTART_APPS" == "false" ]]; then
plugn trigger service-action post-link-complete "$SERVICE" "$APP" config_set --no-restart "$APP" "${ALIAS}_URL=$SERVICE_URL"
dokku_log_verbose "Skipping restart of linked app"
else
config_set "$APP" "${ALIAS}_URL=$SERVICE_URL"
fi
plugn trigger service-action post-link-complete "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
} }
service_linked_apps() { 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" declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local LINKS_FILE="$SERVICE_ROOT/LINKS" local LINKS_FILE="$SERVICE_ROOT/LINKS"
@@ -484,7 +653,7 @@ service_linked_apps() {
} }
service_links() { service_links() {
declare desc="Lists all apps linked to a service" declare desc="list all apps linked to a service"
declare SERVICE="$1" declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local LINKS_FILE="$SERVICE_ROOT/LINKS" local LINKS_FILE="$SERVICE_ROOT/LINKS"
@@ -496,37 +665,37 @@ service_links() {
} }
service_list() { service_list() {
declare desc="Lists all services and their status" declare desc="list all services and their status"
local SERVICES=$(ls "$PLUGIN_DATA_ROOT" 2>/dev/null)
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" dokku_log_warn "There are no $PLUGIN_SERVICE services"
return return
fi fi
dokku_log_info2_quiet "$PLUGIN_SERVICE services" dokku_log_info2_quiet "$PLUGIN_SERVICE services"
for SERVICE in $SERVICES; do for service in "${services[@]}"; do
echo "$SERVICE" echo "${service}"
done done
} }
service_logs() { service_logs() {
declare desc="Displays logs for a service" declare desc="display logs for a service"
declare SERVICE="$1" TAIL_FLAG="$2" declare SERVICE="$1" TAIL_FLAG="$2" TAIL_COUNT="$3"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local ID=$(cat "$SERVICE_ROOT/ID") local ID=$(cat "$SERVICE_ROOT/ID")
local RE_INTEGER='^[0-9]+$' local RE_INTEGER='^[0-9]+$'
DOKKU_LOGS_ARGS="--tail 100" DOKKU_LOGS_ARGS="--tail $TAIL_COUNT"
if [[ "$TAIL_FLAG" == "-t" ]] || [[ "$TAIL_FLAG" == "--tail" ]]; then if [[ "$TAIL_FLAG" == "-t" ]] || [[ "$TAIL_FLAG" == "--tail" ]]; then
DOKKU_LOGS_ARGS="--follow" DOKKU_LOGS_ARGS+=" --follow"
fi fi
docker inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist" "$DOCKER_BIN" container inspect "$ID" >/dev/null 2>&1 || dokku_log_fail "Service container does not exist"
is_container_status "$ID" "Running" || dokku_log_warn "Service logs may not be output as service is not running" is_container_status "$ID" "Running" || dokku_log_warn "Service logs may not be output as service is not running"
# shellcheck disable=SC2086 # shellcheck disable=SC2086
docker logs $DOKKU_LOGS_ARGS "$ID" 2>&1 "$DOCKER_BIN" container logs $DOKKU_LOGS_ARGS "$ID" 2>&1
} }
service_parse_args() { service_parse_args() {
@@ -543,19 +712,24 @@ service_parse_args() {
"--custom-env") set -- "$@" "-C" ;; "--custom-env") set -- "$@" "-C" ;;
"--database") set -- "$@" "-d" ;; "--database") set -- "$@" "-d" ;;
"--image-version") set -- "$@" "-I" ;; "--image-version") set -- "$@" "-I" ;;
"--initial-network") set -- "$@" "-N" ;;
"--image") set -- "$@" "-i" ;; "--image") set -- "$@" "-i" ;;
"--memory") set -- "$@" "-m" ;; "--memory") set -- "$@" "-m" ;;
"--no-restart") set -- "$@" "-n" ;;
"--password") set -- "$@" "-p" ;; "--password") set -- "$@" "-p" ;;
"--post-create-network") set -- "$@" "-P" ;;
"--post-start-network") set -- "$@" "-S" ;;
"--querystring") set -- "$@" "-q" ;; "--querystring") set -- "$@" "-q" ;;
"--restart-apps") set -- "$@" "-R" ;; "--restart-apps") set -- "$@" "-R" ;;
"--root-password") set -- "$@" "-r" ;; "--root-password") set -- "$@" "-r" ;;
"--shm-size") set -- "$@" "-s" ;;
"--user") set -- "$@" "-u" ;; "--user") set -- "$@" "-u" ;;
*) set -- "$@" "$arg" ;; *) set -- "$@" "$arg" ;;
esac esac
done done
OPTIND=1 OPTIND=1
while getopts "a:c:C:d:i:I:m:p:q:R:r:u:" opt; do while getopts "na:c:C:d:i:I:m:n:N:p:P:q:R:r:s:S:u:" opt; do
case "$opt" in case "$opt" in
a) a)
SERVICE_ALIAS="${OPTARG^^}" SERVICE_ALIAS="${OPTARG^^}"
@@ -579,9 +753,18 @@ service_parse_args() {
m) m)
export SERVICE_MEMORY=$OPTARG export SERVICE_MEMORY=$OPTARG
;; ;;
n)
export SERVICE_RESTART_APPS=false
;;
N)
export SERVICE_INITIAL_NETWORK=$OPTARG
;;
p) p)
export SERVICE_PASSWORD=$OPTARG export SERVICE_PASSWORD=$OPTARG
;; ;;
P)
export SERVICE_POST_CREATE_NETWORK=$OPTARG
;;
q) q)
export SERVICE_QUERYSTRING=${OPTARG#"?"} export SERVICE_QUERYSTRING=${OPTARG#"?"}
;; ;;
@@ -591,6 +774,12 @@ service_parse_args() {
r) r)
export SERVICE_ROOT_PASSWORD=$OPTARG export SERVICE_ROOT_PASSWORD=$OPTARG
;; ;;
s)
export SERVICE_SHM_SIZE=$OPTARG
;;
S)
export SERVICE_POST_START_NETWORK=$OPTARG
;;
u) u)
export SERVICE_USER=$OPTARG export SERVICE_USER=$OPTARG
;; ;;
@@ -600,7 +789,7 @@ service_parse_args() {
} }
service_password() { service_password() {
declare desc="Fetch the password for a service" declare desc="fetch the password for a service"
declare SERVICE="$1" declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local PASSWORD_FILE="$SERVICE_ROOT/PASSWORD" local PASSWORD_FILE="$SERVICE_ROOT/PASSWORD"
@@ -610,7 +799,7 @@ service_password() {
} }
service_root_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" declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local PASSWORD_FILE="$SERVICE_ROOT/ROOTPASSWORD" local PASSWORD_FILE="$SERVICE_ROOT/ROOTPASSWORD"
@@ -620,84 +809,83 @@ service_root_password() {
} }
service_port_expose() { service_port_expose() {
declare desc="Wrapper for exposing service ports" declare desc="wrapper for exposing service ports"
declare SERVICE="$1" declare SERVICE="$1" PORTS=(${@:2})
service_start "$SERVICE" "true"
service_port_unpause "$SERVICE" "true" "${@:2}"
}
service_port_pause() {
declare desc="Pauses service exposure"
declare SERVICE="$1" LOG_FAIL="$2"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local EXPOSED_NAME="$(get_service_name "$SERVICE").ambassador"
local PORT_FILE="$SERVICE_ROOT/PORT"
if [[ "$LOG_FAIL" == "true" ]]; then
[[ ! -f "$PORT_FILE" ]] && dokku_log_fail "Service not exposed"
else
[[ ! -f "$PORT_FILE" ]] && return 0
fi
local GREP_NAME="^/${EXPOSED_NAME}$"
local CONTAINER_NAME="$(docker ps -f name="$GREP_NAME" --format "{{.Names}}")"
if [[ -z "$CONTAINER_NAME" ]]; then
if [[ "$LOG_FAIL" == "true" ]]; then
dokku_log_info1 "Service $SERVICE unexposed"
fi
return
fi
docker stop "$EXPOSED_NAME" >/dev/null 2>&1 || true
docker rm "$EXPOSED_NAME" >/dev/null 2>&1 || true
if [[ "$LOG_FAIL" == "true" ]]; then
dokku_log_info1 "Service $SERVICE unexposed"
fi
}
service_port_unexpose() {
declare desc="Wrapper for pausing exposed service ports"
declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local PORT_FILE="$SERVICE_ROOT/PORT" local PORT_FILE="$SERVICE_ROOT/PORT"
service_port_pause "$SERVICE" "true"
rm -rf "$PORT_FILE"
}
service_port_unpause() {
declare desc="Starts service exposure"
declare SERVICE="$1" LOG_FAIL="$2"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local SERVICE_NAME="$(get_service_name "$SERVICE")" local SERVICE_NAME="$(get_service_name "$SERVICE")"
local EXPOSED_NAME="${SERVICE_NAME}.ambassador" local EXPOSED_NAME="$SERVICE_NAME.ambassador"
local PORT_FILE="$SERVICE_ROOT/PORT"
# shellcheck disable=SC2068 if [[ ${#PORTS[@]} -eq 0 ]]; then
local PORTS=(${@:3}) # shellcheck disable=SC2206
# shellcheck disable=SC2068 PORTS=(${PORTS[@]:-$(get_random_ports ${#PLUGIN_DATASTORE_PORTS[@]})})
PORTS=(${PORTS[@]:-$(get_random_ports ${#PLUGIN_DATASTORE_PORTS[@]})}) fi
local ID=$(cat "$SERVICE_ROOT/ID")
[[ "${#PORTS[@]}" != "${#PLUGIN_DATASTORE_PORTS[@]}" ]] && dokku_log_fail "${#PLUGIN_DATASTORE_PORTS[@]} ports to be exposed need to be provided in the following order: ${PLUGIN_DATASTORE_PORTS[*]}" [[ "${#PORTS[@]}" != "${#PLUGIN_DATASTORE_PORTS[@]}" ]] && dokku_log_fail "${#PLUGIN_DATASTORE_PORTS[@]} ports to be exposed need to be provided in the following order: ${PLUGIN_DATASTORE_PORTS[*]}"
if [[ "$LOG_FAIL" == "true" ]]; then if [[ -s "$PORT_FILE" ]]; then
[[ -f "$PORT_FILE" ]] && PORTS=($(cat "$PORT_FILE")) && dokku_log_fail "Service $SERVICE already exposed on port(s) ${PORTS[*]}" # shellcheck disable=SC2207
else
[[ ! -f "$PORT_FILE" ]] && return 0
PORTS=($(cat "$PORT_FILE")) PORTS=($(cat "$PORT_FILE"))
dokku_log_fail "Service $SERVICE already exposed on port(s) ${PORTS[*]}"
fi
if "$DOCKER_BIN" container inspect "$EXPOSED_NAME" >/dev/null 2>&1; then
dokku_log_warn "Service $SERVICE has an untracked expose container, removing"
"$DOCKER_BIN" container stop "$EXPOSED_NAME" >/dev/null 2>&1 || true
suppress_output "$DOCKER_BIN" container rm "$EXPOSED_NAME"
fi fi
echo "${PORTS[@]}" >"$PORT_FILE" echo "${PORTS[@]}" >"$PORT_FILE"
# shellcheck disable=SC2046 service_start "$SERVICE" "true"
docker run -d --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" --name "$EXPOSED_NAME" $(docker_ports_options "${PORTS[@]}") --restart always --label dokku=ambassador --label "dokku.ambassador=$PLUGIN_COMMAND_PREFIX" "$PLUGIN_AMBASSADOR_IMAGE" >/dev/null service_port_reconcile_status "$SERVICE"
if [[ "$LOG_FAIL" == "true" ]]; then dokku_log_info1 "Service $SERVICE exposed on port(s) [container->host]: $(service_exposed_ports "$SERVICE")"
dokku_log_info1 "Service $SERVICE exposed on port(s) [container->host]: $(service_exposed_ports "$SERVICE")" }
service_port_unexpose() {
declare desc="wrapper for pausing exposed service ports"
declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local PORT_FILE="$SERVICE_ROOT/PORT"
rm -rf "$PORT_FILE"
service_port_reconcile_status "$SERVICE"
dokku_log_info1 "Service $SERVICE unexposed"
}
service_port_reconcile_status() {
declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local PORT_FILE="$SERVICE_ROOT/PORT"
local SERVICE_NAME="$(get_service_name "$SERVICE")"
local EXPOSED_NAME="$SERVICE_NAME.ambassador"
if [[ ! -s "$PORT_FILE" ]]; then
if "$DOCKER_BIN" container inspect "$EXPOSED_NAME" >/dev/null 2>&1; then
"$DOCKER_BIN" container stop "$EXPOSED_NAME" >/dev/null 2>&1 || true
suppress_output "$DOCKER_BIN" container rm "$EXPOSED_NAME"
return $?
fi
return
fi fi
if is_container_status "$EXPOSED_NAME" "Running"; then
return
fi
if "$DOCKER_BIN" container inspect "$EXPOSED_NAME" >/dev/null 2>&1; then
suppress_output "$DOCKER_BIN" container start "$EXPOSED_NAME"
return $?
fi
# shellcheck disable=SC2207
PORTS=($(cat "$PORT_FILE"))
# shellcheck disable=SC2046
"$DOCKER_BIN" container run -d --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" --name "$EXPOSED_NAME" $(docker_ports_options "${PORTS[@]}") --restart always --label dokku=ambassador --label "dokku.ambassador=$PLUGIN_COMMAND_PREFIX" "$PLUGIN_AMBASSADOR_IMAGE" >/dev/null
} }
service_promote() { 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" declare SERVICE="$1" APP="$2"
local PLUGIN_DEFAULT_CONFIG_VAR="${PLUGIN_DEFAULT_ALIAS}_URL" local PLUGIN_DEFAULT_CONFIG_VAR="${PLUGIN_DEFAULT_ALIAS}_URL"
local EXISTING_CONFIG=$(config_all "$APP") local EXISTING_CONFIG=$(config_all "$APP")
@@ -725,7 +913,7 @@ service_promote() {
} }
service_set_alias() { 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" declare SERVICE="$1" ALIAS="$2"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local ALIAS_FILE="$SERVICE_ROOT/ALIAS" local ALIAS_FILE="$SERVICE_ROOT/ALIAS"
@@ -735,37 +923,39 @@ service_set_alias() {
} }
service_status() { service_status() {
declare desc="Displays the status of a service" declare desc="display the status of a service"
declare SERVICE="$1" declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local ID="$(cat "$SERVICE_ROOT/ID")" local ID="$(cat "$SERVICE_ROOT/ID")"
local CONTAINER_STATUS local CONTAINER_STATUS
CONTAINER_STATUS=$(docker inspect -f "{{.State.Status}}" "$ID" 2>/dev/null || true) CONTAINER_STATUS=$("$DOCKER_BIN" container inspect -f "{{.State.Status}}" "$ID" 2>/dev/null || true)
[[ -n "$CONTAINER_STATUS" ]] && echo "$CONTAINER_STATUS" && return 0 [[ -n "$CONTAINER_STATUS" ]] && echo "$CONTAINER_STATUS" && return 0
echo "missing" && return 0 echo "missing" && return 0
} }
service_stop() { service_pause() {
declare desc="Stops a running service" declare desc="pause a running service"
declare SERVICE="$1" declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local SERVICE_NAME="$(get_service_name "$SERVICE")" local SERVICE_NAME="$(get_service_name "$SERVICE")"
local ID=$(docker ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true local ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$") || 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 if [[ -n $ID ]]; then
dokku_log_info2_quiet "Stopping container" dokku_log_info2_quiet "Pausing container"
docker stop "$SERVICE_NAME" >/dev/null "$DOCKER_BIN" container stop "$SERVICE_NAME" >/dev/null
service_port_pause "$SERVICE" if "$DOCKER_BIN" container inspect "$ID" >/dev/null 2>&1; then
dokku_log_verbose_quiet "Container stopped" "$DOCKER_BIN" container stop "$SERVICE_NAME.ambassador" >/dev/null 2>&1 || true
fi
dokku_log_verbose_quiet "Container paused"
else else
dokku_log_verbose_quiet "No container exists for $SERVICE" dokku_log_verbose_quiet "No container exists for $SERVICE"
fi fi
} }
service_unlink() { service_unlink() {
declare desc="Unlinks an application from a service" declare desc="unlink an application from a service"
declare SERVICE="$1" APP="$2" declare SERVICE="$1" APP="$2"
update_plugin_scheme_for_app "$APP" update_plugin_scheme_for_app "$APP"
local SERVICE_URL=$(service_url "$SERVICE") local SERVICE_URL=$(service_url "$SERVICE")
@@ -774,7 +964,7 @@ service_unlink() {
local SERVICE_DNS_HOSTNAME=$(service_dns_hostname "$SERVICE") local SERVICE_DNS_HOSTNAME=$(service_dns_hostname "$SERVICE")
local LINK=($(echo "$EXISTING_CONFIG" | grep "$SERVICE_URL" | cut -d: -f1)) || true 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" remove_from_links_file "$SERVICE" "$APP"
if declare -f -F add_passed_docker_option >/dev/null; then if declare -f -F add_passed_docker_option >/dev/null; then
@@ -786,20 +976,25 @@ service_unlink() {
fi fi
[[ -z ${LINK[*]} ]] && dokku_log_fail "Not linked to app $APP" [[ -z ${LINK[*]} ]] && dokku_log_fail "Not linked to app $APP"
plugn trigger service-action post-unlink "$SERVICE" "$APP" plugn trigger service-action post-unlink "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
config_unset "$APP" "${LINK[*]}" if [[ "$DOKKU_GLOBAL_FLAGS" == *"--no-restart"* ]] || [[ "$SERVICE_RESTART_APPS" == "false" ]]; then
plugn trigger service-action post-unlink-complete "$SERVICE" "$APP" config_unset --no-restart "$APP" "${LINK[@]}"
dokku_log_verbose "Skipping restart of linked app"
else
config_unset "$APP" "${LINK[@]}"
fi
plugn trigger service-action post-unlink-complete "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
} }
service_version() { service_version() {
declare desc="Displays the running version for an image" declare desc="display the running version for an image"
declare SERVICE="$1" declare SERVICE="$1"
local SERVICE_NAME="$(get_service_name "$SERVICE")" local SERVICE_NAME="$(get_service_name "$SERVICE")"
docker inspect -f '{{.Config.Image}}' "$SERVICE_NAME" 2>/dev/null || true "$DOCKER_BIN" container inspect -f '{{.Config.Image}}' "$SERVICE_NAME" 2>/dev/null || true
} }
update_plugin_scheme_for_app() { update_plugin_scheme_for_app() {
declare desc="Retrieves the updated plugin scheme" declare desc="retrieve the updated plugin scheme"
declare APP="$1" declare APP="$1"
local DATABASE_SCHEME local DATABASE_SCHEME
@@ -808,19 +1003,31 @@ update_plugin_scheme_for_app() {
} }
verify_service_name() { verify_service_name() {
declare desc="Verifies that a service exists" declare desc="verify that a service exists"
declare SERVICE="$1" declare SERVICE="$@"
[[ -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" 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 return 0
} }
write_database_name() { write_database_name() {
declare desc="Writes a sanitized database name" declare desc="write a sanitized database name"
declare SERVICE="$1" declare SERVICE="$1"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
# some datastores do not like special characters in database names # some datastores do not like special characters in database names
# so we need to normalize them out # 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=${POSTGRES_IMAGE:="$(awk -F '[ :]' '{print $2}' "${_DIR}/Dockerfile")"}
export POSTGRES_IMAGE_VERSION=${POSTGRES_IMAGE_VERSION:="$(awk -F '[ :]' '{print $3}' "${_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_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_UNIMPLEMENTED_SUBCOMMANDS=()
export PLUGIN_COMMAND_PREFIX="postgres" export PLUGIN_COMMAND_PREFIX="postgres"
@@ -27,7 +28,9 @@ if [[ -n $DOKKU_API_VERSION ]]; then
export PLUGIN_BASE_PATH="$PLUGIN_ENABLED_PATH" export PLUGIN_BASE_PATH="$PLUGIN_ENABLED_PATH"
fi fi
export PLUGIN_BUSYBOX_IMAGE="busybox:1.31.1-uclibc" export PLUGIN_BUSYBOX_IMAGE="busybox:1.34.1-uclibc"
export PLUGIN_AMBASSADOR_IMAGE="dokku/ambassador:0.3.3" export PLUGIN_AMBASSADOR_IMAGE="dokku/ambassador:0.5.0"
export PLUGIN_S3BACKUP_IMAGE="dokku/s3backup:0.10.3" export PLUGIN_S3BACKUP_IMAGE="dokku/s3backup:0.14.0"
export PLUGIN_WAIT_IMAGE="dokku/wait:0.4.3" 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_BIN" image ls 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
```

124
functions
View File

@@ -3,7 +3,8 @@ source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions" source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$PLUGIN_CORE_AVAILABLE_PATH/common/property-functions"
source "$PLUGIN_AVAILABLE_PATH/config/functions" source "$PLUGIN_AVAILABLE_PATH/config/functions"
if [[ -f "$PLUGIN_AVAILABLE_PATH/docker-options/functions" ]]; then if [[ -f "$PLUGIN_AVAILABLE_PATH/docker-options/functions" ]]; then
source "$PLUGIN_AVAILABLE_PATH/docker-options/functions" source "$PLUGIN_AVAILABLE_PATH/docker-options/functions"
@@ -17,7 +18,7 @@ service_connect() {
local SERVICE_TTY_OPTS local SERVICE_TTY_OPTS
has_tty && SERVICE_TTY_OPTS="-t" has_tty && SERVICE_TTY_OPTS="-t"
docker exec -i $SERVICE_TTY_OPTS "$SERVICE_NAME" psql -h localhost -U postgres "$DATABASE_NAME" "$DOCKER_BIN" container 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() { service_create() {
@@ -33,14 +34,14 @@ service_create() {
if ! service_image_exists "$SERVICE"; then if ! service_image_exists "$SERVICE"; then
if [[ "$PLUGIN_DISABLE_PULL" == "true" ]]; then if [[ "$PLUGIN_DISABLE_PULL" == "true" ]]; then
dokku_log_warn "${PLUGIN_DISABLE_PULL_VARIABLE} environment variable detected. Not running pull command." 1>&2 dokku_log_warn "${PLUGIN_DISABLE_PULL_VARIABLE} environment variable detected. Not running pull command." 1>&2
dokku_log_warn " docker pull ${IMAGE}" 1>&2 dokku_log_warn " docker image pull ${IMAGE}" 1>&2
dokku_log_warn "$PLUGIN_SERVICE service creation failed" dokku_log_warn "$PLUGIN_SERVICE service creation failed"
exit 1 exit 1
fi fi
docker pull "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" || dokku_log_fail "$PLUGIN_SERVICE image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION pull failed" "$DOCKER_BIN" image pull "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" || dokku_log_fail "$PLUGIN_SERVICE image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION pull failed"
fi 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" || dokku_log_fail "Unable to create service directory"
mkdir -p "$SERVICE_ROOT/data" || dokku_log_fail "Unable to create service data directory" mkdir -p "$SERVICE_ROOT/data" || dokku_log_fail "Unable to create service data directory"
touch "$LINKS_FILE" touch "$LINKS_FILE"
@@ -53,17 +54,11 @@ service_create() {
echo "$PASSWORD" >"$SERVICE_ROOT/PASSWORD" echo "$PASSWORD" >"$SERVICE_ROOT/PASSWORD"
chmod 640 "$SERVICE_ROOT/PASSWORD" chmod 640 "$SERVICE_ROOT/PASSWORD"
[[ -n "$SERVICE_CUSTOM_ENV" ]] && POSTGRES_CUSTOM_ENV="$SERVICE_CUSTOM_ENV" service_commit_config "$SERVICE"
if [[ -n $POSTGRES_CUSTOM_ENV ]]; then
echo "$POSTGRES_CUSTOM_ENV" | tr ';' "\n" >"$SERVICE_ROOT/ENV"
else
echo "" >"$SERVICE_ROOT/ENV"
fi
write_database_name "$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" 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() { service_create_container() {
@@ -75,22 +70,91 @@ service_create_container() {
local DATABASE_NAME="$(get_database_name "$SERVICE")" local DATABASE_NAME="$(get_database_name "$SERVICE")"
local PREVIOUS_ID 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
echo "$ID" >"$SERVICE_ROOT/ID" export CONFIG_OPTIONS="$(cat "$SERVICE_ROOT/CONFIG_OPTIONS")"
fi
local network_alias="$(service_dns_hostname "$SERVICE")"
rm -f "$SERVICE_ROOT/ID"
declare -a DOCKER_ARGS
DOCKER_ARGS=()
DOCKER_ARGS+=("--cidfile=$SERVICE_ROOT/ID")
DOCKER_ARGS+=("--env-file=$SERVICE_ROOT/ENV")
DOCKER_ARGS+=("--env=POSTGRES_PASSWORD=$PASSWORD")
DOCKER_ARGS+=("--hostname=$SERVICE_NAME")
DOCKER_ARGS+=("--label=dokku.service=$PLUGIN_COMMAND_PREFIX")
DOCKER_ARGS+=("--label=dokku=service")
DOCKER_ARGS+=("--name=$SERVICE_NAME")
DOCKER_ARGS+=("--restart=always")
DOCKER_ARGS+=("--volume=$SERVICE_HOST_ROOT/data:/var/lib/postgresql/data")
declare -a LINK_CONTAINER_DOCKER_ARGS
LINK_CONTAINER_DOCKER_ARGS=()
LINK_CONTAINER_DOCKER_ARGS+=("--rm")
LINK_CONTAINER_DOCKER_ARGS+=("--link")
LINK_CONTAINER_DOCKER_ARGS+=("$SERVICE_NAME:$network_alias")
[[ -f "$SERVICE_ROOT/SERVICE_MEMORY" ]] && SERVICE_MEMORY="$(cat "$SERVICE_ROOT/SERVICE_MEMORY")"
if [[ -n "$SERVICE_MEMORY" ]]; then
DOCKER_ARGS+=("--memory=${SERVICE_MEMORY}m")
fi
[[ -f "$SERVICE_ROOT/SHM_SIZE" ]] && SERVICE_SHM_SIZE="$(cat "$SERVICE_ROOT/SHM_SIZE")"
if [[ -n "$SERVICE_SHM_SIZE" ]]; then
DOCKER_ARGS+=("--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")"
local network="$(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "initial-network")"
if [[ -n "$network" ]]; then
DOCKER_ARGS+=("--network=${network}")
DOCKER_ARGS+=("--network-alias=${network_alias}")
LINK_CONTAINER_DOCKER_ARGS+=("--network=${network}")
fi
# shellcheck disable=SC2086
suppress_output "$DOCKER_BIN" container create "${DOCKER_ARGS[@]}" "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" $CONFIG_OPTIONS
if [[ -n "$(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-create-network")" ]]; then
dokku_log_verbose_quiet "Connecting to networks after container create"
while read -r line || [[ -n "$line" ]]; do
dokku_log_verbose_quiet "- $line"
"$DOCKER_BIN" network connect --alias "$network_alias" "$line" "$SERVICE_NAME"
done < <(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-create-network" | tr "," "\n")
fi
suppress_output "$DOCKER_BIN" container start "$(cat "$SERVICE_ROOT/ID")"
service_port_reconcile_status "$SERVICE"
if [[ -n "$(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-start-network")" ]]; then
dokku_log_verbose_quiet "Connecting to networks after container start"
while read -r line || [[ -n "$line" ]]; do
dokku_log_verbose_quiet "- $line"
"$DOCKER_BIN" network connect --alias "$network_alias" "$line" "$SERVICE_NAME"
done < <(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-start-network" | tr "," "\n")
fi
dokku_log_verbose_quiet "Waiting for container to be ready" dokku_log_verbose_quiet "Waiting for container to be ready"
docker run --rm --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" "$PLUGIN_WAIT_IMAGE" -p "$PLUGIN_DATASTORE_WAIT_PORT" >/dev/null if ! suppress_output "$DOCKER_BIN" container run "${LINK_CONTAINER_DOCKER_ARGS[@]}" "$PLUGIN_WAIT_IMAGE" -c "$network_alias:$PLUGIN_DATASTORE_WAIT_PORT"; then
dokku_log_info2_quiet "Start of $SERVICE container output"
dokku_container_log_verbose_quiet "$SERVICE_NAME"
dokku_log_info2_quiet "End of $SERVICE container output"
return 1
fi
dokku_log_verbose_quiet "Creating container database" dokku_log_verbose_quiet "Creating container database"
docker exec "$SERVICE_NAME" su - postgres -c "createdb -E utf8 $DATABASE_NAME" 2>/dev/null || dokku_log_verbose_quiet 'Already exists' "$DOCKER_BIN" container 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" 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 "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/scripts/create_ssl_certs.sh" "$SERVICE_ROOT" &>/dev/null
"$DOCKER_BIN" container run --rm -i -v "$SERVICE_HOST_ROOT/data:/var/lib/postgresql/data" -v "$SERVICE_HOST_ROOT/certs:/var/lib/postgresql/certs" "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" bash -s <"$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/scripts/enable_ssl.sh" &>/dev/null
rm -rf "$SERVICE_HOST_ROOT/certs"
PREVIOUS_ID=$(docker ps -aq --no-trunc --filter "status=exited" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true suppress_output "$DOCKER_BIN" container start "$(cat "$SERVICE_ROOT/ID")"
docker start "$PREVIOUS_ID" >/dev/null service_port_reconcile_status "$SERVICE"
service_port_unpause "$SERVICE"
dokku_log_info2 "$PLUGIN_SERVICE container created: $SERVICE" dokku_log_info2 "$PLUGIN_SERVICE container created: $SERVICE"
service_info "$SERVICE" service_info "$SERVICE"
@@ -104,7 +168,7 @@ service_export() {
local PASSWORD="$(service_password "$SERVICE")" local PASSWORD="$(service_password "$SERVICE")"
[[ -n $SSH_TTY ]] && stty -opost [[ -n $SSH_TTY ]] && stty -opost
docker exec "$SERVICE_NAME" env PGPASSWORD="$PASSWORD" pg_dump -Fc --no-acl --no-owner -h localhost -U postgres -w "$DATABASE_NAME" "$DOCKER_BIN" container exec "$SERVICE_NAME" env PGPASSWORD="$PASSWORD" pg_dump -Fc --no-acl --no-owner -h localhost -U postgres -w "$DATABASE_NAME"
status=$? status=$?
[[ -n $SSH_TTY ]] && stty opost [[ -n $SSH_TTY ]] && stty opost
exit $status exit $status
@@ -121,7 +185,7 @@ service_import() {
if [[ -t 0 ]]; then if [[ -t 0 ]]; then
dokku_log_fail "No data provided on stdin." dokku_log_fail "No data provided on stdin."
fi fi
docker exec -i "$SERVICE_NAME" env PGPASSWORD="$PASSWORD" pg_restore -h localhost -cO --if-exists -d "$DATABASE_NAME" -U postgres -w "$DOCKER_BIN" container exec -i "$SERVICE_NAME" env PGPASSWORD="$PASSWORD" pg_restore -h localhost -cO --if-exists -d "$DATABASE_NAME" -U postgres -w
} }
service_start() { service_start() {
@@ -129,7 +193,7 @@ service_start() {
local QUIET="$2" local QUIET="$2"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local SERVICE_NAME="$(get_service_name "$SERVICE")" local SERVICE_NAME="$(get_service_name "$SERVICE")"
local ID=$(docker ps -aq --no-trunc --filter "status=running" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true local ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "status=running" --filter "name=^/$SERVICE_NAME$") || true
if [[ -n $ID ]]; then if [[ -n $ID ]]; then
[[ -z $QUIET ]] && dokku_log_warn "Service is already started" [[ -z $QUIET ]] && dokku_log_warn "Service is already started"
if [[ ! -f "$SERVICE_ROOT/ID" ]] || [[ "$(cat "$SERVICE_ROOT/ID")" != "$ID" ]]; then if [[ ! -f "$SERVICE_ROOT/ID" ]] || [[ "$(cat "$SERVICE_ROOT/ID")" != "$ID" ]]; then
@@ -140,17 +204,19 @@ service_start() {
fi fi
dokku_log_info2_quiet "Starting container" dokku_log_info2_quiet "Starting container"
local PREVIOUS_ID=$(docker ps -aq --no-trunc --filter "status=exited" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true local PREVIOUS_ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "status=exited" --filter "name=^/$SERVICE_NAME$") || true
local PASSWORD="$(service_password "$SERVICE")" local PASSWORD="$(service_password "$SERVICE")"
if [[ -n $PREVIOUS_ID ]]; then if [[ -n $PREVIOUS_ID ]]; then
docker start "$PREVIOUS_ID" >/dev/null "$DOCKER_BIN" container start "$PREVIOUS_ID" >/dev/null
service_port_unpause "$SERVICE" service_port_reconcile_status "$SERVICE"
dokku_log_info2 "Container started" dokku_log_info2 "Container started"
elif service_image_exists "$SERVICE" && [[ -n "$PASSWORD" ]]; then elif service_image_exists "$SERVICE" && [[ -n "$PASSWORD" ]]; then
service_create_container "$SERVICE" service_create_container "$SERVICE"
else else
if ! service_image_exists "$SERVICE"; then 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" dokku_log_verbose_quiet "Missing image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION for $SERVICE"
else else
dokku_log_verbose_quiet "Neither container nor valid configuration exists for $SERVICE" 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() { 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 if [[ -n "$DOKKU_NO_COLOR" ]] || [[ "$TERM" == "unknown" ]] || [[ "$TERM" == "dumb" ]]; then
return return
@@ -151,7 +151,7 @@ fn-help-fancy-tput() {
} }
fn-help-fancy-color() { 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 if [[ -n "$DOKKU_NO_COLOR" ]] || [[ "$TERM" == "unknown" ]] || [[ "$TERM" == "dumb" ]]; then
return return
@@ -202,6 +202,9 @@ fn-help-subcommand-args() {
elif [[ "$arg" == *_LIST ]]; then elif [[ "$arg" == *_LIST ]]; then
arg=${arg%_*} arg=${arg%_*}
args+=" <${arg//_/-}...>" args+=" <${arg//_/-}...>"
elif [[ "$arg" == *_OPTIONAL ]]; then
argName="${arg/_OPTIONAL/}"
args+=" [<${argName//_/-}>]"
else else
args+=" <${arg//_/-}>" args+=" <${arg//_/-}>"
fi fi
@@ -309,7 +312,7 @@ fn-help-subcommand-sanitize() {
} }
_fn-help-apply-shell-expansion() { _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 data="$1"
declare delimiter="__apply_shell_expansion_delimiter__" declare delimiter="__apply_shell_expansion_delimiter__"
declare command="cat <<$delimiter"$'\n'"$data"$'\n'"$delimiter" declare command="cat <<$delimiter"$'\n'"$data"$'\n'"$delimiter"

32
install
View File

@@ -1,5 +1,7 @@
#!/usr/bin/env bash #!/usr/bin/env bash
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config" source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
source "$PLUGIN_CORE_AVAILABLE_PATH/common/property-functions"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
@@ -8,14 +10,15 @@ plugin-install() {
declare IMAGE="$1" declare IMAGE="$1"
if [[ "$PLUGIN_DISABLE_PULL" == "true" ]]; then if [[ "$PLUGIN_DISABLE_PULL" == "true" ]]; then
echo " ! ${PLUGIN_DISABLE_PULL_VARIABLE} environment variable detected. Not running pull command." 1>&2 echo " ! ${PLUGIN_DISABLE_PULL_VARIABLE} environment variable detected. Not running pull command." 1>&2
echo " ! docker pull ${IMAGE}" 1>&2 echo " ! docker image pull ${IMAGE}" 1>&2
return return
fi fi
if [[ "$(docker images -q "${IMAGE}" 2>/dev/null)" == "" ]]; then if [[ "$("$DOCKER_BIN" image ls -q "${IMAGE}" 2>/dev/null)" == "" ]]; then
docker pull "${IMAGE}" "$DOCKER_BIN" image pull "${IMAGE}"
fi fi
} }
fn-plugin-property-setup "$PLUGIN_COMMAND_PREFIX"
pull-docker-image "${PLUGIN_IMAGE}:${PLUGIN_IMAGE_VERSION}" pull-docker-image "${PLUGIN_IMAGE}:${PLUGIN_IMAGE_VERSION}"
pull-docker-image "$PLUGIN_BUSYBOX_IMAGE" pull-docker-image "$PLUGIN_BUSYBOX_IMAGE"
pull-docker-image "$PLUGIN_AMBASSADOR_IMAGE" pull-docker-image "$PLUGIN_AMBASSADOR_IMAGE"
@@ -23,10 +26,10 @@ plugin-install() {
pull-docker-image "$PLUGIN_WAIT_IMAGE" pull-docker-image "$PLUGIN_WAIT_IMAGE"
mkdir -p "$PLUGIN_DATA_ROOT" || echo "Failed to create $PLUGIN_SERVICE data directory" 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" 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}*" rm -f "/etc/sudoers.d/dokku-${PLUGIN_COMMAND_PREFIX}*"
_SUDOERS_FILE="/etc/sudoers.d/dokku-${PLUGIN_COMMAND_PREFIX}" _SUDOERS_FILE="/etc/sudoers.d/dokku-${PLUGIN_COMMAND_PREFIX}"
@@ -42,6 +45,25 @@ plugin-install() {
EOL EOL
chmod 0440 "$_SUDOERS_FILE" 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 "$@" plugin-install "$@"

View File

@@ -1,4 +1,4 @@
[plugin] [plugin]
description = "dokku postgres service plugin" description = "dokku postgres service plugin"
version = "1.13.0" version = "1.36.4"
[plugin.config] [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 #!/usr/bin/env bash
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config" 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 set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $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" APP="$1"
pushd "$PLUGIN_DATA_ROOT" >/dev/null for SERVICE in $(fn-services-list false); do
for SERVICE in *; do [[ -n "$SERVICE" ]] || continue
dokku_log_verbose_quiet "Unlinking from $SERVICE" dokku_log_verbose_quiet "Unlinking from $SERVICE"
remove_from_links_file "$(basename "$SERVICE")" "$APP" remove_from_links_file "$(basename "$SERVICE")" "$APP"
done 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 "$@"

9
scripts/create_ssl_certs.sh Executable file
View File

@@ -0,0 +1,9 @@
#!/bin/sh
set -e
postgres_service_dir="$1"
cd "$postgres_service_dir"
mkdir certs && cd certs
openssl req -new -newkey rsa:4096 -x509 -days 365000 -nodes -out server.crt -keyout server.key -batch

View File

@@ -1,7 +1,12 @@
#!/bin/bash #!/bin/sh
pushd /var/lib/postgresql/data >/dev/null
openssl req -new -newkey rsa:4096 -x509 -nodes -out server.crt -keyout server.key -batch set -e
cd /var/lib/postgresql/data
cp ../certs/* .
chown postgres:postgres server.key
chmod 600 server.key chmod 600 server.key
sed -i "s/^#ssl = off/ssl = on/" postgresql.conf sed -i "s/^#ssl = off/ssl = on/" postgresql.conf
sed -i "s/^#ssl_ciphers =.*/ssl_ciphers = 'AES256+EECDH:AES256+EDH'/" postgresql.conf sed -i "s/^#ssl_ciphers =.*/ssl_ciphers = 'AES256+EECDH:AES256+EDH'/" postgresql.conf
popd >/dev/null

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

@@ -2,7 +2,7 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-app-links-cmd() { service-app-links-cmd() {

View File

@@ -2,16 +2,18 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-backup-cmd() { service-backup-cmd() {
#E backup the 'lolipop' service to the 'my-s3-bucket' bucket on AWS #E backup the 'lollipop' service to the 'my-s3-bucket' bucket on AWS
#E dokku $PLUGIN_COMMAND_PREFIX:backup lolipop my-s3-bucket --use-iam #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 #F -u|--use-iam, use the IAM profile associated with the current server
#A service, service to run command against #A service, service to run command against
#A bucket-name, name of the s3 bucket to upload backups to #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=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:backup" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1 [[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" BUCKET_NAME="$2" USE_IAM_OPTIONAL_FLAG="$3" declare SERVICE="$1" BUCKET_NAME="$2" USE_IAM_OPTIONAL_FLAG="$3"

View File

@@ -2,25 +2,25 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-backup-auth-cmd() { service-backup-auth-cmd() {
#E setup s3 backup authentication #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 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 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 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 service, service to run command against
#A access-key-id, an amazon AWS_ACCESS_KEY_ID #A access-key-id, an amazon AWS_ACCESS_KEY_ID
#A aws-secret-access-key, an amazon AWS_SECRET_ACCESS_KEY #A aws-secret-access-key, an amazon AWS_SECRET_ACCESS_KEY
#A aws-default-region, (optional) a valid amazon S3 region #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 aws-signature-version, (optional) the AWS signature version to use when signing S3 requests
#A endpoint-url, (optional) an aws endpoint to upload to #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=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:backup-auth" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1 [[ ${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" 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

@@ -2,14 +2,14 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-backup-deauth-cmd() { service-backup-deauth-cmd() {
#E remove s3 authentication #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 #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=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:backup-deauth" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1 [[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" declare SERVICE="$1"

View File

@@ -2,20 +2,20 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-backup-schedule-cmd() { service-backup-schedule-cmd() {
#E schedule a backup #E schedule a backup
#E > 'schedule' is a crontab expression, eg. "0 3 * * *" for each day at 3am #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 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 #F -u|--use-iam, use the IAM profile associated with the current server
#A service, service to run command against #A service, service to run command against
#A schedule, a cron schedule to run backups on #A schedule, a cron schedule to run backups on
#A bucket-name, name of the s3 bucket to upload backups to #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=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:backup-schedule" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1 [[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" SCHEDULE="$2" BUCKET_NAME="$3" USE_IAM_OPTIONAL_FLAG="$4" declare SERVICE="$1" SCHEDULE="$2" BUCKET_NAME="$3" USE_IAM_OPTIONAL_FLAG="$4"

View File

@@ -2,12 +2,12 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-backup-schedule-cat-cmd() { service-backup-schedule-cat-cmd() {
#E cat the contents of the configured backup cronfile for the service #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 #A service, service to run command against
declare desc="cat the contents of the configured backup cronfile for the service" declare desc="cat the contents of the configured backup cronfile for the service"
local cmd="$PLUGIN_COMMAND_PREFIX:backup-schedule-cat" argv=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:backup-schedule-cat" argv=("$@")

View File

@@ -2,15 +2,15 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-backup-set-encryption-cmd() { service-backup-set-encryption-cmd() {
#E set the GPG-compatible passphrase for encrypting backups for backups #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 service, service to run command against
#A passphrase, a GPG-compatible passphrase #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=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:backup-set-encryption" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1 [[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" PASSPHRASE="$2" declare SERVICE="$1" PASSPHRASE="$2"

View File

@@ -2,14 +2,14 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-backup-unschedule-cmd() { service-backup-unschedule-cmd() {
#E remove the scheduled backup from cron #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 #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=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:backup-unschedule" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1 [[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" declare SERVICE="$1"

View File

@@ -2,14 +2,14 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-backup-unset-encryption-cmd() { service-backup-unset-encryption-cmd() {
#E unset the GPG encryption passphrase for backups #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 #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=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:backup-unset-encryption" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1 [[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" declare SERVICE="$1"

View File

@@ -2,19 +2,25 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-clone-cmd() { service-clone-cmd() {
#E you can clone an existing service to a new one #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 service, service to run command against
#A new-service, name of new service #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 -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 IMAGE, the image name to start the service with
#F -I|--image-version IMAGE_VERSION, the image version 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 -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to
#F -p|--password PASSWORD, override the user-level service password #F -p|--password PASSWORD, override the user-level service password
#F -P|--post-create-network NETWORKS, a comma-separated list of networks to attach the service container to after service creation
#F -r|--root-password PASSWORD, override the root-level service password #F -r|--root-password PASSWORD, override the root-level service password
#F -S|--post-start-network NETWORKS, a comma-separated list of networks to attach the service container to after service start
#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>" declare desc="create container <new-name> then copy data from <name> into <new-name>"
local cmd="$PLUGIN_COMMAND_PREFIX:clone" argv=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:clone" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1 [[ ${argv[0]} == "$cmd" ]] && shift 1
@@ -24,6 +30,9 @@ service-clone-cmd() {
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service" [[ -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" [[ -z "$NEW_SERVICE" ]] && dokku_log_fail "Please specify a name for the new service"
verify_service_name "$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 SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local ID="$(cat "$SERVICE_ROOT/ID")" local ID="$(cat "$SERVICE_ROOT/ID")"

View File

@@ -2,12 +2,13 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-connect-cmd() { service-connect-cmd() {
#E connect to the service via the $PLUGIN_COMMAND_PREFIX connection tool #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 #A service, service to run command against
declare desc="connect to the service via the $PLUGIN_COMMAND_PREFIX connection tool" declare desc="connect to the service via the $PLUGIN_COMMAND_PREFIX connection tool"
local cmd="$PLUGIN_COMMAND_PREFIX:connect" argv=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:connect" argv=("$@")

View File

@@ -2,27 +2,33 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-create-cmd() { service-create-cmd() {
#E create a $PLUGIN_COMMAND_PREFIX service named lolipop #E create a $PLUGIN_COMMAND_PREFIX service named lollipop
#E dokku $PLUGIN_COMMAND_PREFIX:create lolipop #E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
#E you can also specify the image and image version to use for the service. #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 it *must* be compatible with the ${PLUGIN_IMAGE} image.
#E export ${PLUGIN_DEFAULT_ALIAS}_IMAGE="${PLUGIN_IMAGE}" #E export ${PLUGIN_VARIABLE}_IMAGE="${PLUGIN_IMAGE}"
#E export ${PLUGIN_DEFAULT_ALIAS}_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}" #E export ${PLUGIN_VARIABLE}_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
#E dokku $PLUGIN_COMMAND_PREFIX:create lolipop #E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
#E you can also specify custom environment variables to start #E you can also specify custom environment variables to start
#E the ${PLUGIN_COMMAND_PREFIX} service in semi-colon separated form. #E the ${PLUGIN_COMMAND_PREFIX} service in semicolon-separated form.
#E export ${PLUGIN_DEFAULT_ALIAS}_CUSTOM_ENV="USER=alpha;HOST=beta" #E export ${PLUGIN_VARIABLE}_CUSTOM_ENV="USER=alpha;HOST=beta"
#E dokku $PLUGIN_COMMAND_PREFIX:create lolipop #E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
#A service, service to run command against #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 -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 IMAGE, the image name to start the service with
#F -I|--image-version IMAGE_VERSION, the image version 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 -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to
#F -p|--password PASSWORD, override the user-level service password #F -p|--password PASSWORD, override the user-level service password
#F -P|--post-create-network NETWORKS, a comma-separated list of networks to attach the service container to after service creation
#F -r|--root-password PASSWORD, override the root-level service password #F -r|--root-password PASSWORD, override the root-level service password
#F -S|--post-start-network NETWORKS, a comma-separated list of networks to attach the service container to after service start
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
declare desc="create a $PLUGIN_SERVICE service" declare desc="create a $PLUGIN_SERVICE service"
local cmd="$PLUGIN_COMMAND_PREFIX:create" argv=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:create" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1 [[ ${argv[0]} == "$cmd" ]] && shift 1

View File

@@ -2,12 +2,12 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-destroy-cmd() { service-destroy-cmd() {
#E destroy the service, it's data, and the running container #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 #A service, service to run command against
#F -f|--force, force destroy without asking for confirmation #F -f|--force, force destroy without asking for confirmation
declare desc="delete the $PLUGIN_SERVICE service/data/container if there are no links left" declare desc="delete the $PLUGIN_SERVICE service/data/container if there are no links left"
@@ -41,15 +41,17 @@ service-destroy-cmd() {
fi fi
dokku_log_info2_quiet "Deleting $SERVICE" 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_backup_unschedule "$SERVICE"
service_container_rm "$SERVICE" service_container_rm "$SERVICE"
dokku_log_verbose_quiet "Removing data" dokku_log_verbose_quiet "Removing data"
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 "$DOCKER_BIN" container 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" rm -rf "$SERVICE_ROOT"
plugn trigger service-action post-delete "$SERVICE" fn-plugin-property-destroy "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
plugn trigger service-action post-delete "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
dokku_log_info2 "$PLUGIN_SERVICE container deleted: $SERVICE" dokku_log_info2 "$PLUGIN_SERVICE container deleted: $SERVICE"
} }

View File

@@ -2,22 +2,24 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-enter-cmd() { service-enter-cmd() {
#E a bash prompt can be opened against a running service. #E a bash prompt can be opened against a running service.
#E filesystem changes will not be saved to disk. #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 you may also run a command directly against the service.
#E filesystem changes will not be saved to disk. #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 #A service, service to run command against
declare desc="enter or run a command in a running $PLUGIN_SERVICE service container" declare desc="enter or run a command in a running $PLUGIN_SERVICE service container"
local cmd="$PLUGIN_COMMAND_PREFIX:enter" argv=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:enter" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1 [[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" declare SERVICE="$1"
verify_service_name "$SERVICE"
dokku_log_info1_quiet "Filesystem changes may not persist after container restarts" dokku_log_info1_quiet "Filesystem changes may not persist after container restarts"
service_enter "$SERVICE" "${@:2}" service_enter "$SERVICE" "${@:2}"
} }

View File

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

View File

@@ -2,14 +2,14 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-export-cmd() { service-export-cmd() {
#E by default, datastore output is exported to stdout #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 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 #A service, service to run command against
declare desc="export a dump of the $PLUGIN_SERVICE service database" declare desc="export a dump of the $PLUGIN_SERVICE service database"
local cmd="$PLUGIN_COMMAND_PREFIX:export" argv=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:export" argv=("$@")

View File

@@ -2,15 +2,17 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-expose-cmd() { 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 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 service, service to run command against
#A ports, a list of ports to run 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=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:expose" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1 [[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" PORTS_LIST=("${@:2}") declare SERVICE="$1" PORTS_LIST=("${@:2}")

View File

@@ -2,12 +2,12 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-import-cmd() { service-import-cmd() {
#E import a datastore dump #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 #A service, service to run command against
declare desc="import a dump into the $PLUGIN_SERVICE service database" declare desc="import a dump into the $PLUGIN_SERVICE service database"
local cmd="$PLUGIN_COMMAND_PREFIX:import" argv=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:import" argv=("$@")

View File

@@ -2,23 +2,26 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-info-cmd() { service-info-cmd() {
#E get connection information as follows: #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 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 lollipop --config-dir
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --data-dir #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --data-dir
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --dsn #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --dsn
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --exposed-ports #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --exposed-ports
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --id #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --id
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --internal-ip #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --internal-ip
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --links #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --initial-network
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --service-root #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --links
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --status #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --post-create-network
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --version #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --post-start-network
#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 #A service, service to run command against
#F --config-dir, show the service configuration directory #F --config-dir, show the service configuration directory
#F --data-dir, show the service data directory #F --data-dir, show the service data directory
@@ -26,7 +29,10 @@ service-info-cmd() {
#F --exposed-ports, show service exposed ports #F --exposed-ports, show service exposed ports
#F --id, show the service container id #F --id, show the service container id
#F --internal-ip, show the service internal ip #F --internal-ip, show the service internal ip
#F --initial-network, show the initial network being connected to
#F --links, show the service app links #F --links, show the service app links
#F --post-create-network, show the networks to attach to after service container creation
#F --post-start-network, show the networks to attach to after service container start
#F --service-root, show the service root directory #F --service-root, show the service root directory
#F --status, show the service running status #F --status, show the service running status
#F --version, show the service image version #F --version, show the service image version

View File

@@ -2,7 +2,7 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-link-cmd() { service-link-cmd() {
@@ -10,20 +10,20 @@ service-link-cmd() {
#E this will use native docker links via the docker-options plugin. #E this will use native docker links via the docker-options plugin.
#E here we link it to our 'playground' app. #E here we link it to our 'playground' app.
#E > NOTE: this will restart your 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 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 (not on the app itself, so they wont be listed when calling dokku config):
#E #E
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_NAME=/lolipop/DATABASE #E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_NAME=/lollipop/DATABASE
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]} #E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_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_VARIABLE}_LOLLIPOP_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_VARIABLE}_LOLLIPOP_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_VARIABLE}_LOLLIPOP_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_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_ADDR=172.17.0.1
#E #E
#E the following will be set on the linked application by default: #E the following will be set on the linked application by default:
#E #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
#E the host exposed here only works internally in docker containers. #E the host exposed here only works internally in docker containers.
#E if you want your container to be reachable from outside, you should #E if you want your container to be reachable from outside, you should
@@ -34,14 +34,15 @@ service-link-cmd() {
#E after linking will cause the plugin to think the service is not #E after linking will cause the plugin to think the service is not
#E linked, and we advise you to unlink before proceeding. #E linked, and we advise you to unlink before proceeding.
#E dokku config:set playground ${PLUGIN_VARIABLE}_DATABASE_SCHEME=${PLUGIN_SCHEME}2 #E dokku config:set playground ${PLUGIN_VARIABLE}_DATABASE_SCHEME=${PLUGIN_SCHEME}2
#E dokku $PLUGIN_COMMAND_PREFIX:link lolipop playground #E dokku $PLUGIN_COMMAND_PREFIX:link lollipop playground
#E this will cause ${PLUGIN_DEFAULT_ALIAS}_URL to be set as: #E this will cause ${PLUGIN_DEFAULT_ALIAS}_URL to be set as:
#E #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 service, service to run command against
#A app, app 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 #F -a|--alias "BLUE_DATABASE", an alternative alias to use for linking to an app via environment variable
#F -q|--querystring "pool=5", ampersand delimited querystring arguments to append to the service link #F -q|--querystring "pool=5", ampersand delimited querystring arguments to append to the service link
#F -n|--no-restart "false", whether or not to restart the app on link (default: true)
declare desc="link the $PLUGIN_SERVICE service to the app" declare desc="link the $PLUGIN_SERVICE service to the app"
local cmd="$PLUGIN_COMMAND_PREFIX:link" argv=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:link" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1 [[ ${argv[0]} == "$cmd" ]] && shift 1

View File

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

View File

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

View File

@@ -2,7 +2,7 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-list-cmd() { service-list-cmd() {

View File

@@ -2,24 +2,26 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-logs-cmd() { service-logs-cmd() {
#E you can tail logs for a particular service: #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 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 #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" declare desc="print the most recent log(s) for this service"
local cmd="$PLUGIN_COMMAND_PREFIX:logs" argv=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:logs" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1 [[ ${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" [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
verify_service_name "$SERVICE" verify_service_name "$SERVICE"
service_logs "$SERVICE" "$TAIL_FLAG" service_logs "$SERVICE" "$TAIL_FLAG" "$TAIL_NUM_OPTIONAL"
} }
service-logs-cmd "$@" 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_CORE_AVAILABLE_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

@@ -2,7 +2,7 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-promote-cmd() { service-promote-cmd() {
@@ -20,7 +20,7 @@ service-promote-cmd() {
#E #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 ${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}_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 service, service to run command against
#A app, app to run command against #A app, app to run command against
declare desc="promote service <service> as ${PLUGIN_DEFAULT_ALIAS}_URL in <app>" declare desc="promote service <service> as ${PLUGIN_DEFAULT_ALIAS}_URL in <app>"

View File

@@ -2,12 +2,12 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-restart-cmd() { service-restart-cmd() {
#E restart the service #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 #A service, service to run command against
declare desc="graceful shutdown and restart of the $PLUGIN_SERVICE service container" declare desc="graceful shutdown and restart of the $PLUGIN_SERVICE service container"
local cmd="$PLUGIN_COMMAND_PREFIX:restart" argv=("$@") 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" [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
verify_service_name "$SERVICE" verify_service_name "$SERVICE"
service_stop "$SERVICE" service_pause "$SERVICE"
service_start "$SERVICE" service_start "$SERVICE"
dokku_log_info1 "Please call dokku ps:restart on all linked apps" dokku_log_info1 "Please call dokku ps:restart on all linked apps"
} }

45
subcommands/set Executable file
View File

@@ -0,0 +1,45 @@
#!/usr/bin/env bash
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$PLUGIN_CORE_AVAILABLE_PATH/common/property-functions"
source "$(cd "$(dirname "$(dirname "${BASH_SOURCE[0]}")")" && pwd)/common-functions"
service-set-cmd() {
#E set the network to attach after the service container is started
#E dokku $PLUGIN_COMMAND_PREFIX:set lollipop post-create-network custom-network
#E set multiple networks
#E dokku $PLUGIN_COMMAND_PREFIX:set lollipop post-create-network custom-network,other-network
#E unset the post-create-network value
#E dokku $PLUGIN_COMMAND_PREFIX:set lollipop post-create-network
#A service, service to run command against
#A key, property name to set
#A value, optional property value to set or empty to unset key
declare desc="set or clear a property for a service"
local cmd="$PLUGIN_COMMAND_PREFIX:set" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" KEY="$2" VALUE="$3"
local VALID_KEYS=("initial-network" "post-create-network" "post-start-network")
verify_service_name "$SERVICE"
[[ -z "$KEY" ]] && dokku_log_fail "No key specified"
if ! fn-in-array "$KEY" "${VALID_KEYS[@]}"; then
dokku_log_fail "Invalid key specified, valid keys include: initial-network, post-create-network, post-start-network"
fi
if [[ -n "$VALUE" ]]; then
dokku_log_info2_quiet "Setting ${KEY} to ${VALUE}"
fn-plugin-property-write "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$KEY" "$VALUE"
else
dokku_log_info2_quiet "Unsetting ${KEY}"
if [[ "$KEY" == "rev-env-var" ]]; then
fn-plugin-property-write "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$KEY" "$VALUE"
else
fn-plugin-property-delete "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$KEY"
fi
fi
}
service-set-cmd "$@"

View File

@@ -2,12 +2,12 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-start-cmd() { service-start-cmd() {
#E start the service #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 #A service, service to run command against
declare desc="start a previously stopped $PLUGIN_SERVICE service" declare desc="start a previously stopped $PLUGIN_SERVICE service"
local cmd="$PLUGIN_COMMAND_PREFIX:start" argv=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:start" argv=("$@")

View File

@@ -2,12 +2,12 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-stop-cmd() { service-stop-cmd() {
#E stop the service and the running container #E stop the service and removes the running container
#E dokku $PLUGIN_COMMAND_PREFIX:stop lolipop #E dokku $PLUGIN_COMMAND_PREFIX:stop lollipop
#A service, service to run command against #A service, service to run command against
declare desc="stop a running $PLUGIN_SERVICE service" declare desc="stop a running $PLUGIN_SERVICE service"
local cmd="$PLUGIN_COMMAND_PREFIX:stop" argv=("$@") 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" [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
verify_service_name "$SERVICE" verify_service_name "$SERVICE"
service_stop "$SERVICE" service_container_rm "$SERVICE"
} }
service-stop-cmd "$@" service-stop-cmd "$@"

View File

@@ -2,12 +2,12 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-unexpose-cmd() { service-unexpose-cmd() {
#E unexpose the service, removing access to it from the public interface (0.0.0.0) #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 #A service, service to run command against
declare desc="unexpose a previously exposed $PLUGIN_SERVICE service" declare desc="unexpose a previously exposed $PLUGIN_SERVICE service"
local cmd="$PLUGIN_COMMAND_PREFIX:unexpose" argv=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:unexpose" argv=("$@")

View File

@@ -2,15 +2,16 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-unlink-cmd() { service-unlink-cmd() {
#E you can unlink a $PLUGIN_COMMAND_PREFIX service #E you can unlink a $PLUGIN_COMMAND_PREFIX service
#E > NOTE: this will restart your app and unset related environment variables #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 service, service to run command against
#A app, app to run command against #A app, app to run command against
#F -n|--no-restart "false", whether or not to restart the app on unlink (default: true)
declare desc="unlink the $PLUGIN_SERVICE service from the app" declare desc="unlink the $PLUGIN_SERVICE service from the app"
local cmd="$PLUGIN_COMMAND_PREFIX:unlink" argv=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:unlink" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1 [[ ${argv[0]} == "$cmd" ]] && shift 1

View File

@@ -2,18 +2,23 @@
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions" source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
source "$PLUGIN_AVAILABLE_PATH/ps/functions" source "$PLUGIN_AVAILABLE_PATH/ps/functions"
service-upgrade-cmd() { service-upgrade-cmd() {
#E you can upgrade an existing service to a new image or image-version #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 #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 -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 IMAGE, the image name to start the service with
#F -I|--image-version IMAGE_VERSION, the image version 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 -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to
#F -P|--post-create-network NETWORKS, a comma-separated list of networks to attach the service container to after service creation
#F -R|--restart-apps "true", whether or not to force an app restart (default: false)
#F -S|--post-start-network NETWORKS, a comma-separated list of networks to attach the service container to after service start
#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" declare desc="upgrade service <service> to the specified versions"
local cmd="$PLUGIN_COMMAND_PREFIX:upgrade" argv=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:upgrade" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1 [[ ${argv[0]} == "$cmd" ]] && shift 1
@@ -26,8 +31,14 @@ service-upgrade-cmd() {
service_parse_args "${@:2}" service_parse_args "${@:2}"
if ! service_image_exists "$SERVICE"; then if ! service_image_exists "$SERVICE" "$PLUGIN_IMAGE" "$PLUGIN_IMAGE_VERSION"; then
dokku_log_fail "Unable to proceed with upgrade, image ${PLUGIN_IMAGE}:${PLUGIN_IMAGE_VERSION} does not exist" if [[ "$PLUGIN_DISABLE_PULL" == "true" ]]; then
dokku_log_warn "${PLUGIN_DISABLE_PULL_VARIABLE} environment variable detected. Not running pull command." 1>&2
dokku_log_warn " docker image pull ${IMAGE}" 1>&2
dokku_log_warn "$PLUGIN_SERVICE service $SERVICE upgrade failed"
exit 1
fi
"$DOCKER_BIN" image pull "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" || dokku_log_fail "$PLUGIN_SERVICE image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION pull failed"
fi fi
local NEW_PLUGIN_IMAGE_TAG="$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" local NEW_PLUGIN_IMAGE_TAG="$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION"
@@ -36,6 +47,8 @@ service-upgrade-cmd() {
return return
fi fi
service_commit_config "$SERVICE"
dokku_log_info2 "Upgrading $SERVICE to $NEW_PLUGIN_IMAGE_TAG" dokku_log_info2 "Upgrading $SERVICE to $NEW_PLUGIN_IMAGE_TAG"
if [[ "$SERVICE_RESTART_APPS" == "true" ]]; then if [[ "$SERVICE_RESTART_APPS" == "true" ]]; then
dokku_log_info2 "Stopping all linked services" dokku_log_info2 "Stopping all linked services"

View File

@@ -3,17 +3,18 @@ load test_helper
setup() { setup() {
dokku apps:create my-app dokku apps:create my-app
dokku "$PLUGIN_COMMAND_PREFIX:create" l dokku "$PLUGIN_COMMAND_PREFIX:create" ls
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app >&2 dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app >&2
} }
teardown() { teardown() {
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app >&2 dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app >&2
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" ls
dokku --force apps:destroy my-app || true
} }
@test "($PLUGIN_COMMAND_PREFIX:hook:pre-delete) removes app from links file when destroying app" { @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/ls/LINKS") ]]
dokku --force apps:destroy my-app dokku --force apps:destroy my-app
[[ -z $(< "$PLUGIN_DATA_ROOT/l/LINKS") ]] [[ -z $(<"$PLUGIN_DATA_ROOT/ls/LINKS") ]]
} }

289
tests/link_networks.bats Executable file
View File

@@ -0,0 +1,289 @@
#!/usr/bin/env bats
load test_helper
setup() {
dokku "$PLUGIN_COMMAND_PREFIX:create" ls
dokku network:create custom-network
}
teardown() {
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" ls || true
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" lsa || true
dokku network:destroy --force custom-network
}
@test "($PLUGIN_COMMAND_PREFIX:set) set initial-network" {
run dokku "$PLUGIN_COMMAND_PREFIX:set" ls initial-network custom-network
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:info" ls --initial-network
echo "output: $output"
echo "status: $status"
assert_output "custom-network"
assert_success
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains bridge
assert_output_contains custom-network 0
run dokku "$PLUGIN_COMMAND_PREFIX:stop" ls
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:start" ls
echo "output: $output"
echo "status: $status"
assert_success
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains bridge 0
assert_output_contains custom-network
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.Aliases}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains "alias:dokku.$PLUGIN_COMMAND_PREFIX.ls"
assert_output_contains "alias:dokku-$PLUGIN_COMMAND_PREFIX-ls"
run dokku "$PLUGIN_COMMAND_PREFIX:set" ls initial-network
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:info" ls --initial-network
echo "output: $output"
echo "status: $status"
assert_output ""
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:stop" ls
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:start" ls
echo "output: $output"
echo "status: $status"
assert_success
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains bridge
assert_output_contains custom-network 0
}
@test "($PLUGIN_COMMAND_PREFIX:set) set post-create-network" {
run dokku "$PLUGIN_COMMAND_PREFIX:set" ls post-create-network custom-network
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:info" ls --post-create-network
echo "output: $output"
echo "status: $status"
assert_output "custom-network"
assert_success
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains bridge
assert_output_contains custom-network 0
run dokku "$PLUGIN_COMMAND_PREFIX:stop" ls
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:start" ls
echo "output: $output"
echo "status: $status"
assert_success
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains custom-network
assert_output_contains bridge
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.Aliases}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains "alias:dokku.$PLUGIN_COMMAND_PREFIX.ls"
assert_output_contains "alias:dokku-$PLUGIN_COMMAND_PREFIX-ls"
run dokku "$PLUGIN_COMMAND_PREFIX:set" ls post-create-network
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:info" ls --post-create-network
echo "output: $output"
echo "status: $status"
assert_output ""
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:stop" ls
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:start" ls
echo "output: $output"
echo "status: $status"
assert_success
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains bridge
assert_output_contains custom-network 0
}
@test "($PLUGIN_COMMAND_PREFIX:set) set an post-start-network" {
run dokku "$PLUGIN_COMMAND_PREFIX:set" ls post-start-network custom-network
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:info" ls --post-start-network
echo "output: $output"
echo "status: $status"
assert_output "custom-network"
assert_success
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains bridge
assert_output_contains custom-network 0
run dokku "$PLUGIN_COMMAND_PREFIX:stop" ls
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:start" ls
echo "output: $output"
echo "status: $status"
assert_success
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains bridge
assert_output_contains custom-network
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.Aliases}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains "alias:dokku.$PLUGIN_COMMAND_PREFIX.ls"
assert_output_contains "alias:dokku-$PLUGIN_COMMAND_PREFIX-ls"
run dokku "$PLUGIN_COMMAND_PREFIX:set" ls post-start-network
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:info" ls --post-start-network
echo "output: $output"
echo "status: $status"
assert_output ""
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:stop" ls
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:start" ls
echo "output: $output"
echo "status: $status"
assert_success
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains bridge
assert_output_contains custom-network 0
}
@test "($PLUGIN_COMMAND_PREFIX:create) flags" {
run dokku "$PLUGIN_COMMAND_PREFIX:create" lsa --initial-network custom-network
echo "output: $output"
echo "status: $status"
assert_success
run docker inspect "dokku.$PLUGIN_COMMAND_PREFIX.lsa" -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains bridge 0
assert_output_contains custom-network
run dokku "$PLUGIN_COMMAND_PREFIX:destroy" lsa --force
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:create" lsa --post-create-network custom-network
echo "output: $output"
echo "status: $status"
assert_success
run docker inspect "dokku.$PLUGIN_COMMAND_PREFIX.lsa" -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains bridge
assert_output_contains custom-network
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.lsa -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.Aliases}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains "alias:dokku.$PLUGIN_COMMAND_PREFIX.lsa"
assert_output_contains "alias:dokku-$PLUGIN_COMMAND_PREFIX-lsa"
run dokku "$PLUGIN_COMMAND_PREFIX:destroy" lsa --force
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:create" lsa --post-start-network custom-network
echo "output: $output"
echo "status: $status"
assert_success
run docker inspect "dokku.$PLUGIN_COMMAND_PREFIX.lsa" -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains bridge
assert_output_contains custom-network
run dokku "$PLUGIN_COMMAND_PREFIX:destroy" lsa --force
echo "output: $output"
echo "status: $status"
assert_success
}

View File

@@ -30,7 +30,7 @@ teardown() {
@test "($PLUGIN_COMMAND_PREFIX:clone) error when new service already exists" { @test "($PLUGIN_COMMAND_PREFIX:clone) error when new service already exists" {
dokku "$PLUGIN_COMMAND_PREFIX:create" new_service dokku "$PLUGIN_COMMAND_PREFIX:create" new_service
run dokku "$PLUGIN_COMMAND_PREFIX:clone" l 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 assert_failure
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" new_service dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" new_service

View File

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

View File

@@ -2,29 +2,65 @@
load test_helper load test_helper
setup() { setup() {
dokku "$PLUGIN_COMMAND_PREFIX:create" l dokku "$PLUGIN_COMMAND_PREFIX:create" ls
} }
teardown() { teardown() {
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" ls
} }
@test "($PLUGIN_COMMAND_PREFIX:expose) error when there are no arguments" { @test "($PLUGIN_COMMAND_PREFIX:expose) error when there are no arguments" {
run dokku "$PLUGIN_COMMAND_PREFIX:expose" run dokku "$PLUGIN_COMMAND_PREFIX:expose"
echo "output: $output"
echo "status: $status"
assert_failure
assert_contains "${lines[*]}" "Please specify a valid name for the service" assert_contains "${lines[*]}" "Please specify a valid name for the service"
} }
@test "($PLUGIN_COMMAND_PREFIX:expose) error when service does not exist" { @test "($PLUGIN_COMMAND_PREFIX:expose) error when service does not exist" {
run dokku "$PLUGIN_COMMAND_PREFIX:expose" not_existing_service run dokku "$PLUGIN_COMMAND_PREFIX:expose" not_existing_service
echo "output: $output"
echo "status: $status"
assert_failure
assert_contains "${lines[*]}" "service not_existing_service does not exist" assert_contains "${lines[*]}" "service not_existing_service does not exist"
} }
@test "($PLUGIN_COMMAND_PREFIX:expose) error when already exposed" {
run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls
echo "output: $output"
echo "status: $status"
assert_failure
assert_contains "${lines[*]}" "Service ls already exposed on port(s)"
run sudo rm "$PLUGIN_DATA_ROOT/ls/PORT"
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls
echo "output: $output"
echo "status: $status"
assert_success
assert_contains "${lines[*]}" "Service ls has an untracked expose container, removing"
}
@test "($PLUGIN_COMMAND_PREFIX:expose) success when not providing custom ports" { @test "($PLUGIN_COMMAND_PREFIX:expose) success when not providing custom ports" {
run dokku "$PLUGIN_COMMAND_PREFIX:expose" l run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls
echo "output: $output"
echo "status: $status"
assert_success
[[ "${lines[*]}" =~ exposed\ on\ port\(s\)\ \[container\-\>host\]\:\ [[:digit:]]+ ]] [[ "${lines[*]}" =~ exposed\ on\ port\(s\)\ \[container\-\>host\]\:\ [[:digit:]]+ ]]
} }
@test "($PLUGIN_COMMAND_PREFIX:expose) success when providing custom ports" { @test "($PLUGIN_COMMAND_PREFIX:expose) success when providing custom ports" {
run dokku "$PLUGIN_COMMAND_PREFIX:expose" l 4242 run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls 4242
echo "output: $output"
echo "status: $status"
assert_success
assert_contains "${lines[*]}" "exposed on port(s) [container->host]: 5432->4242" assert_contains "${lines[*]}" "exposed on port(s) [container->host]: 5432->4242"
} }

View File

@@ -34,7 +34,7 @@ teardown() {
@test "($PLUGIN_COMMAND_PREFIX:import) success" { @test "($PLUGIN_COMMAND_PREFIX:import) success" {
skip "The fake dump is hard to work with in tests" 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 "output: $output"
echo "status: $status" echo "status: $status"
assert_success assert_success

View File

@@ -2,18 +2,17 @@
load test_helper load test_helper
setup() { setup() {
dokku "$PLUGIN_COMMAND_PREFIX:create" l dokku "$PLUGIN_COMMAND_PREFIX:create" ls
dokku "$PLUGIN_COMMAND_PREFIX:create" m dokku "$PLUGIN_COMMAND_PREFIX:create" ms
dokku apps:create my-app dokku apps:create my-app
} }
teardown() { teardown() {
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" m dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" ms
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" ls
dokku --force apps:destroy my-app dokku --force apps:destroy my-app
} }
@test "($PLUGIN_COMMAND_PREFIX:link) error when there are no arguments" { @test "($PLUGIN_COMMAND_PREFIX:link) error when there are no arguments" {
run dokku "$PLUGIN_COMMAND_PREFIX:link" run dokku "$PLUGIN_COMMAND_PREFIX:link"
echo "output: $output" echo "output: $output"
@@ -23,7 +22,7 @@ teardown() {
} }
@test "($PLUGIN_COMMAND_PREFIX:link) error when the app argument is missing" { @test "($PLUGIN_COMMAND_PREFIX:link) error when the app argument is missing" {
run dokku "$PLUGIN_COMMAND_PREFIX:link" l run dokku "$PLUGIN_COMMAND_PREFIX:link" ls
echo "output: $output" echo "output: $output"
echo "status: $status" echo "status: $status"
assert_contains "${lines[*]}" "Please specify an app to run the command on" assert_contains "${lines[*]}" "Please specify an app to run the command on"
@@ -31,7 +30,7 @@ teardown() {
} }
@test "($PLUGIN_COMMAND_PREFIX:link) error when the app does not exist" { @test "($PLUGIN_COMMAND_PREFIX:link) error when the app does not exist" {
run dokku "$PLUGIN_COMMAND_PREFIX:link" l not_existing_app run dokku "$PLUGIN_COMMAND_PREFIX:link" ls not_existing_app
echo "output: $output" echo "output: $output"
echo "status: $status" echo "status: $status"
assert_contains "${lines[*]}" "App not_existing_app does not exist" assert_contains "${lines[*]}" "App not_existing_app does not exist"
@@ -47,73 +46,97 @@ teardown() {
} }
@test "($PLUGIN_COMMAND_PREFIX:link) error when the service is already linked to app" { @test "($PLUGIN_COMMAND_PREFIX:link) error when the service is already linked to app" {
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
run dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
echo "output: $output" echo "output: $output"
echo "status: $status" echo "status: $status"
assert_contains "${lines[*]}" "Already linked as DATABASE_URL" assert_contains "${lines[*]}" "Already linked as DATABASE_URL"
assert_failure assert_failure
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
} }
@test "($PLUGIN_COMMAND_PREFIX:link) exports DATABASE_URL to app" { @test "($PLUGIN_COMMAND_PREFIX:link) exports DATABASE_URL to app" {
run dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
echo "output: $output" echo "output: $output"
echo "status: $status" echo "status: $status"
url=$(dokku config:get my-app DATABASE_URL) url=$(dokku config:get my-app DATABASE_URL)
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")" password="$(sudo cat "$PLUGIN_DATA_ROOT/ls/PASSWORD")"
assert_contains "$url" "postgres://postgres:$password@dokku-postgres-l:5432/l" assert_contains "$url" "postgres://postgres:$password@dokku-postgres-ls:5432/ls"
assert_success assert_success
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
} }
@test "($PLUGIN_COMMAND_PREFIX:link) generates an alternate config url when DATABASE_URL already in use" { @test "($PLUGIN_COMMAND_PREFIX:link) generates an alternate config url when DATABASE_URL already in use" {
dokku config:set my-app DATABASE_URL=postgres://user:pass@host:5432/db dokku config:set my-app DATABASE_URL=postgres://user:pass@host:5432/db
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
run dokku config my-app run dokku config my-app
assert_contains "${lines[*]}" "DOKKU_POSTGRES_AQUA_URL" assert_contains "${lines[*]}" "DOKKU_POSTGRES_AQUA_URL"
assert_success assert_success
dokku "$PLUGIN_COMMAND_PREFIX:link" m my-app dokku "$PLUGIN_COMMAND_PREFIX:link" ms my-app
run dokku config my-app run dokku config my-app
assert_contains "${lines[*]}" "DOKKU_POSTGRES_BLACK_URL" assert_contains "${lines[*]}" "DOKKU_POSTGRES_BLACK_URL"
assert_success assert_success
dokku "$PLUGIN_COMMAND_PREFIX:unlink" m my-app dokku "$PLUGIN_COMMAND_PREFIX:unlink" ms my-app
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
} }
@test "($PLUGIN_COMMAND_PREFIX:link) links to app with docker-options" { @test "($PLUGIN_COMMAND_PREFIX:link) links to app with docker-options" {
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
run dokku docker-options:report my-app run dokku docker-options:report my-app
assert_contains "${lines[*]}" "--link dokku.postgres.l:dokku-postgres-l" assert_contains "${lines[*]}" "--link dokku.postgres.ls:dokku-postgres-ls"
assert_success assert_success
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
} }
@test "($PLUGIN_COMMAND_PREFIX:link) uses apps POSTGRES_DATABASE_SCHEME variable" { @test "($PLUGIN_COMMAND_PREFIX:link) uses apps POSTGRES_DATABASE_SCHEME variable" {
dokku config:set my-app POSTGRES_DATABASE_SCHEME=postgres2 dokku config:set my-app POSTGRES_DATABASE_SCHEME=postgres2
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
url=$(dokku config:get my-app DATABASE_URL) url=$(dokku config:get my-app DATABASE_URL)
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")" password="$(sudo cat "$PLUGIN_DATA_ROOT/ls/PASSWORD")"
assert_contains "$url" "postgres2://postgres:$password@dokku-postgres-l:5432/l" assert_contains "$url" "postgres2://postgres:$password@dokku-postgres-ls:5432/ls"
assert_success assert_success
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
} }
@test "($PLUGIN_COMMAND_PREFIX:link) adds a querystring" { @test "($PLUGIN_COMMAND_PREFIX:link) adds a querystring" {
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app --querystring "pool=5" dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app --querystring "pool=5"
url=$(dokku config:get my-app DATABASE_URL) url=$(dokku config:get my-app DATABASE_URL)
assert_contains "$url" "?pool=5" assert_contains "$url" "?pool=5"
assert_success assert_success
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
} }
@test "($PLUGIN_COMMAND_PREFIX:link) uses a specified config url when alias is specified" { @test "($PLUGIN_COMMAND_PREFIX:link) uses a specified config url when alias is specified" {
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app --alias "ALIAS" dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app --alias "ALIAS"
url=$(dokku config:get my-app ALIAS_URL) url=$(dokku config:get my-app ALIAS_URL)
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")" password="$(sudo cat "$PLUGIN_DATA_ROOT/ls/PASSWORD")"
assert_contains "$url" "postgres://postgres:$password@dokku-postgres-l:5432/l" assert_contains "$url" "postgres://postgres:$password@dokku-postgres-ls:5432/ls"
assert_success
dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
}
@test "($PLUGIN_COMMAND_PREFIX:link) respects --no-restart" {
run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
echo "output: $output"
echo "status: $status"
assert_output_contains "Skipping restart of linked app" 0
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app --no-restart
echo "output: $output"
echo "status: $status"
assert_output_contains "Skipping restart of linked app"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
echo "output: $output"
echo "status: $status"
assert_success assert_success
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
} }

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 run dokku "$PLUGIN_COMMAND_PREFIX:restart" l
assert_success assert_success
} }

View File

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

View File

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

View File

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

View File

@@ -3,11 +3,11 @@ load test_helper
setup() { setup() {
dokku apps:create my-app dokku apps:create my-app
dokku "$PLUGIN_COMMAND_PREFIX:create" l dokku "$PLUGIN_COMMAND_PREFIX:create" ls
} }
teardown() { teardown() {
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" ls
dokku --force apps:destroy my-app dokku --force apps:destroy my-app
} }
@@ -17,12 +17,12 @@ teardown() {
} }
@test "($PLUGIN_COMMAND_PREFIX:unlink) error when the app argument is missing" { @test "($PLUGIN_COMMAND_PREFIX:unlink) error when the app argument is missing" {
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" l run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls
assert_contains "${lines[*]}" "Please specify an app to run the command on" assert_contains "${lines[*]}" "Please specify an app to run the command on"
} }
@test "($PLUGIN_COMMAND_PREFIX:unlink) error when the app does not exist" { @test "($PLUGIN_COMMAND_PREFIX:unlink) error when the app does not exist" {
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" l not_existing_app run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls not_existing_app
assert_contains "${lines[*]}" "App not_existing_app does not exist" assert_contains "${lines[*]}" "App not_existing_app does not exist"
} }
@@ -32,13 +32,13 @@ teardown() {
} }
@test "($PLUGIN_COMMAND_PREFIX:unlink) error when service not linked to app" { @test "($PLUGIN_COMMAND_PREFIX:unlink) error when service not linked to app" {
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
assert_contains "${lines[*]}" "Not linked to app my-app" assert_contains "${lines[*]}" "Not linked to app my-app"
} }
@test "($PLUGIN_COMMAND_PREFIX:unlink) removes link from docker-options" { @test "($PLUGIN_COMMAND_PREFIX:unlink) removes link from docker-options" {
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app >&2 dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app >&2
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
check_value="Docker options build: Docker options deploy: --restart=on-failure:10 Docker options run:" check_value="Docker options build: Docker options deploy: --restart=on-failure:10 Docker options run:"
options=$(dokku --quiet docker-options:report my-app | xargs) options=$(dokku --quiet docker-options:report my-app | xargs)
@@ -46,8 +46,32 @@ teardown() {
} }
@test "($PLUGIN_COMMAND_PREFIX:unlink) unsets config url from app" { @test "($PLUGIN_COMMAND_PREFIX:unlink) unsets config url from app" {
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app >&2 dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app >&2
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
config=$(dokku config:get my-app DATABASE_URL || true) config=$(dokku config:get my-app DATABASE_URL || true)
assert_equal "$config" "" assert_equal "$config" ""
} }
@test "($PLUGIN_COMMAND_PREFIX:unlink) respects --no-restart" {
run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
echo "output: $output"
echo "status: $status"
assert_output_contains "Skipping restart of linked app" 0
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
echo "output: $output"
echo "status: $status"
assert_success
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app --no-restart
echo "output: $output"
echo "status: $status"
assert_output_contains "Skipping restart of linked app"
assert_success
}

View File

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

View File

@@ -70,3 +70,17 @@ assert_output() {
fi fi
assert_equal "$expected" "$output" assert_equal "$expected" "$output"
} }
# ShellCheck doesn't know about $output from Bats
# shellcheck disable=SC2154
assert_output_contains() {
local input="$output"
local expected="$1"
local count="${2:-1}"
local found=0
until [ "${input/$expected/}" = "$input" ]; do
input="${input/$expected/}"
found=$((found + 1))
done
assert_equal "$count" "$found"
}