Compare commits

...

316 Commits

Author SHA1 Message Date
Jose Diaz-Gonzalez
c3a6e3af3c Release 1.37.4
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2024-01-29 10:10:11 -05:00
Jose Diaz-Gonzalez
14c0a11f3a Merge pull request #221 from nerg4l/fix/make-ubuntu-arm64
fix: use correct repository on arm64 ubuntu image
2024-01-29 10:05:52 -05:00
Jose Diaz-Gonzalez
944329c818 Release 1.37.3
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2024-01-29 08:31:26 -05:00
Jose Diaz-Gonzalez
b942ff35f0 Merge pull request #231 from dokku/dependabot/docker/redis-7.2.4
chore(deps): bump redis from 7.2.3 to 7.2.4
2024-01-29 08:31:08 -05:00
dependabot[bot]
4425dc2f29 chore(deps): bump redis from 7.2.3 to 7.2.4
Bumps redis from 7.2.3 to 7.2.4.

---
updated-dependencies:
- dependency-name: redis
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-01-10 15:31:32 +00:00
Jose Diaz-Gonzalez
2295773982 Merge pull request #230 from dokku/dependabot/github_actions/actions/upload-artifact-4
chore(deps): bump actions/upload-artifact from 3 to 4
2023-12-19 00:23:44 -05:00
dependabot[bot]
20c92de6c7 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 15:20:29 +00:00
László GÖRÖG
d90f3bb02a Merge branch 'master' into fix/make-ubuntu-arm64 2023-12-10 10:22:06 +01:00
Jose Diaz-Gonzalez
78a1cb36ed Release 1.37.2
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-12-09 23:56:16 -05:00
Jose Diaz-Gonzalez
a30dd2e727 docs: update docs and generation script 2023-12-09 23:55:46 -05:00
Jose Diaz-Gonzalez
d52e58f623 Merge pull request #229 from dokku/dependabot/github_actions/actions/setup-python-5
chore(deps): bump actions/setup-python from 4 to 5
2023-12-09 13:53:44 -05:00
Jose Diaz-Gonzalez
eb46fc4ae0 Merge pull request #228 from dokku/dependabot/docker/redis-7.2.3
chore(deps): bump redis from 7.2.1 to 7.2.3
2023-12-09 13:53:34 -05:00
Jose Diaz-Gonzalez
99c812fc2f chore: fix typo 2023-12-09 13:51:12 -05:00
Jose Diaz-Gonzalez
0d75a8e46f chore: fix typo 2023-12-09 13:48:37 -05:00
dependabot[bot]
ea92f11ab6 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-06 15:16:41 +00:00
dependabot[bot]
61ed70c5df chore(deps): bump redis from 7.2.1 to 7.2.3
Bumps redis from 7.2.1 to 7.2.3.

---
updated-dependencies:
- dependency-name: redis
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-11-06 15:06:59 +00:00
Jose Diaz-Gonzalez
2c2042535a Release 1.37.1
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-09-09 22:41:22 -04:00
Jose Diaz-Gonzalez
c5139b9169 Release 1.37.0
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-09-09 22:40:00 -04:00
Jose Diaz-Gonzalez
28dbf6bcd9 Merge pull request #225 from dokku/dependabot/docker/redis-7.2.1
chore(deps): bump redis from 7.2.0 to 7.2.1
2023-09-09 22:35:18 -04:00
dependabot[bot]
c4a7504881 chore(deps): bump redis from 7.2.0 to 7.2.1
Bumps redis from 7.2.0 to 7.2.1.

---
updated-dependencies:
- dependency-name: redis
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-09-08 15:38:16 +00:00
Jose Diaz-Gonzalez
5bbbfd1cc9 Merge pull request #223 from dokku/dependabot/github_actions/actions/checkout-4
chore(deps): bump actions/checkout from 3 to 4
2023-09-06 23:45:02 -04:00
dependabot[bot]
1e2125c800 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 02:55:29 +00:00
Jose Diaz-Gonzalez
afe76f799a Merge pull request #224 from dokku/newer-ubuntu
feat: upgrade test suite from ubuntu 20.04 to 22.04
2023-09-06 22:54:43 -04:00
Jose Diaz-Gonzalez
648d137007 feat: upgrade test suite from ubuntu 20.04 to 22.04 2023-09-06 22:37:22 -04:00
Jose Diaz-Gonzalez
9a95ed8299 Release 1.36.0
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-08-17 19:57:06 -04:00
Jose Diaz-Gonzalez
f66c0d945e Merge pull request #222 from dokku/dependabot/docker/redis-7.2.0
chore(deps): bump redis from 7.0.12 to 7.2.0
2023-08-17 19:56:55 -04:00
dependabot[bot]
8a65d7c1cd chore(deps): bump redis from 7.0.12 to 7.2.0
Bumps redis from 7.0.12 to 7.2.0.

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

Signed-off-by: dependabot[bot] <support@github.com>
2023-08-17 15:58:01 +00:00
László GÖRÖG
3ad35ef009 fix: use correct repository on arm64 ubuntu image 2023-08-07 17:37:30 +02:00
Jose Diaz-Gonzalez
f8b3c5eb42 Release 1.35.0
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-07-11 16:50:04 -04:00
Jose Diaz-Gonzalez
62e24bdb71 Merge pull request #218 from dokku/dependabot/docker/redis-7.0.12
chore(deps): bump redis from 7.0.11 to 7.0.12
2023-07-11 16:49:48 -04:00
dependabot[bot]
d5a87c21f5 chore(deps): bump redis from 7.0.11 to 7.0.12
Bumps redis from 7.0.11 to 7.0.12.

---
updated-dependencies:
- dependency-name: redis
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-07-11 15:38:12 +00:00
Jose Diaz-Gonzalez
9776ebdf6a Release 1.34.0
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-05-28 01:00:06 -04:00
Jose Diaz-Gonzalez
7be49f9bbe Release 1.32.4
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-04-27 21:59:57 -04:00
josegonzalez
5aa50b86e5 Merge pull request #216 from dokku/dependabot/docker/redis-7.0.11
chore(deps): bump redis from 7.0.10 to 7.0.11
2023-04-27 21:59:46 -04:00
dependabot[bot]
6783620cd7 chore(deps): bump redis from 7.0.10 to 7.0.11
Bumps redis from 7.0.10 to 7.0.11.

---
updated-dependencies:
- dependency-name: redis
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-04-18 15:57:49 +00:00
Jose Diaz-Gonzalez
38278ab9d9 Release 1.32.3
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-03-21 16:16:27 -04:00
Jose Diaz-Gonzalez
e04200a99c Release 1.32.2
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-03-21 13:28:50 -04:00
josegonzalez
ea3781cd28 Merge pull request #215 from dokku/dependabot/docker/redis-7.0.10
chore(deps): bump redis from 7.0.9 to 7.0.10
2023-03-21 13:28:23 -04:00
dependabot[bot]
cf59cac18a chore(deps): bump redis from 7.0.9 to 7.0.10
Bumps redis from 7.0.9 to 7.0.10.

---
updated-dependencies:
- dependency-name: redis
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-03-21 16:02:35 +00:00
Jose Diaz-Gonzalez
e76a457c74 Release 1.32.1
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-03-19 05:30:41 -04:00
josegonzalez
8b653f74b0 Merge pull request #214 from dokku/dependabot/docker/redis-7.0.9
chore(deps): bump redis from 7.0.8 to 7.0.9
2023-03-19 05:30:31 -04:00
dependabot[bot]
57f7b138f4 chore(deps): bump redis from 7.0.8 to 7.0.9
Bumps redis from 7.0.8 to 7.0.9.

---
updated-dependencies:
- dependency-name: redis
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-03-01 16:00:16 +00:00
Jose Diaz-Gonzalez
a443bc7912 Release 1.32.0
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-02-25 22:13:23 -05:00
josegonzalez
b1d94ed87a Merge pull request #213 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:12:05 -05:00
Jose Diaz-Gonzalez
352794aa05 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
Jose Diaz-Gonzalez
2369ebf94a Release 1.31.0
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-02-25 02:23:31 -05:00
josegonzalez
ac78cb842c Merge pull request #211 from dokku/no-restart-link
Add ability to skip restarts on link and unlink
2023-02-25 02:13:18 -05:00
Jose Diaz-Gonzalez
a902165547 fix: update link docs to remove erroneous copy-paste 2023-02-25 01:50:30 -05:00
Jose Diaz-Gonzalez
dbaa985fe6 tests: link service before unlinking 2023-02-25 00:47:26 -05:00
Jose Diaz-Gonzalez
5e78f7d1e5 chore: remove extra newline 2023-02-21 00:49:18 -05:00
Jose Diaz-Gonzalez
b3747635b2 fix: update tests to properly handle case where app is not running 2023-02-21 00:48:23 -05:00
Jose Diaz-Gonzalez
3154beb12d fix: move arg-less flags to the front 2023-02-21 00:29:30 -05:00
Jose Diaz-Gonzalez
3cb6d2fe7b tests: add output/status and flesh out restart tests a bit more 2023-02-21 00:08:53 -05:00
Jose Diaz-Gonzalez
577d73e7f0 tests: add test for --no-restart to link tests 2023-02-20 23:51:28 -05:00
Jose Diaz-Gonzalez
6b39dea20e tests: add test for --no-restart to unlink tests 2023-02-20 23:47:03 -05:00
Jose Diaz-Gonzalez
ba0f46a8b5 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
673fc4c9bb 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
3c6b6e1c0f 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
9fd0ede9f3 Release 1.30.1
Some checks failed
tagged-release / tagged-release (push) Has been cancelled
2023-02-09 03:12:27 -05:00
Jose Diaz-Gonzalez
7fb98d7cfc fix: drop extra files from being included in release 2023-02-09 03:07:31 -05:00
josegonzalez
4da3491a6c Merge pull request #210 from dokku/auto-release-tags
feat: automatically create releases from tags
2023-02-09 03:03:10 -05:00
Jose Diaz-Gonzalez
79d204a682 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
9a6b80c837 Release 1.30.0 2023-02-09 00:47:48 -05:00
Jose Diaz-Gonzalez
75a091477b Release 1.29.0 2023-02-09 00:38:56 -05:00
josegonzalez
2a8489e2f8 Merge pull request #209 from dokku/alt-network-alias
feat: add network alias that is $SERVICE_NAME.$SERVICE_TYPE
2023-02-09 00:36:40 -05:00
Jose Diaz-Gonzalez
2965302171 fix: use network alias when linking to wait container 2023-02-08 23:59:22 -05:00
Jose Diaz-Gonzalez
c6f3b67509 fix: drop extra check and always use the same network alias 2023-02-08 18:30:12 -05:00
Jose Diaz-Gonzalez
7230fbfccd 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
b93710dbd2 tests: drop extra alias 2023-02-08 12:41:09 -05:00
Jose Diaz-Gonzalez
86f81e9981 tests: correct the app name in use 2023-02-08 12:24:20 -05:00
Jose Diaz-Gonzalez
331b5197da fix: use correct alias for non-initial-network connect calls 2023-02-08 12:08:26 -05:00
Jose Diaz-Gonzalez
1925d15ffb fix: always use the network alias 2023-02-08 12:06:57 -05:00
Jose Diaz-Gonzalez
c0e8b7afb8 fix: set correct alias for wait container when not using an initial network 2023-02-08 11:53:45 -05:00
Jose Diaz-Gonzalez
3aa2c03834 feat: use service name as hostname 2023-02-08 11:01:02 -05:00
Jose Diaz-Gonzalez
b664ce6411 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
ad2509d3ec Merge pull request #207 from dokku/network-flags
feat: add support for network related flags on create, clone, and upgrade
2023-02-08 10:26:07 -05:00
Jose Diaz-Gonzalez
f055182cca refactor: use actual database dump for redis import tests 2023-02-08 04:04:04 -05:00
Jose Diaz-Gonzalez
68b7e33a07 fix: remove old dump before writing it from the host 2023-02-08 03:12:31 -05:00
Jose Diaz-Gonzalez
8b9a03aa66 refactor: write rdb file outside of docker container command 2023-02-08 02:54:35 -05:00
Jose Diaz-Gonzalez
b845d6fb43 tests: ignore case where app is already deleted 2023-02-08 02:22:08 -05:00
Jose Diaz-Gonzalez
bba2f1384f 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
a4520a74e2 chore: drop trace from output 2023-02-08 01:46:00 -05:00
Jose Diaz-Gonzalez
8eb25a93d1 chore: remove extra newline 2023-02-08 01:44:22 -05:00
Jose Diaz-Gonzalez
c3b51a064d fix: correct imports 2023-02-08 01:42:07 -05:00
Jose Diaz-Gonzalez
61c0ad851f feat: add service container log output on failure to start 2023-02-08 01:21:00 -05:00
Jose Diaz-Gonzalez
2e241f9ae6 fix: add -N flag to getopts 2023-02-08 00:54:23 -05:00
Jose Diaz-Gonzalez
f6b6bd87f0 tests: fix :set tests 2023-02-08 00:41:10 -05:00
Jose Diaz-Gonzalez
e23f15ca7f tests: stop running workflows on push
Also remove unnecessary strategy block from jobs.
2023-02-08 00:38:21 -05:00
Jose Diaz-Gonzalez
8478b5cebe tests: also force destroy the lsa service 2023-02-08 00:26:56 -05:00
Jose Diaz-Gonzalez
0734692b2d tests: output the contents of the run command in tests 2023-02-08 00:26:32 -05:00
Jose Diaz-Gonzalez
09d58a815e docs: regenerate README 2023-02-08 00:13:39 -05:00
Jose Diaz-Gonzalez
43d0987322 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
059ece5173 fix: add missing source calls 2023-02-07 22:38:51 -05:00
Jose Diaz-Gonzalez
c0ab76da8b fix: ensure properties are setup on plugin install 2023-02-07 22:25:43 -05:00
josegonzalez
33c99f0425 Merge pull request #202 from dokku/191-network-support
Add custom network support
2023-02-07 22:10:23 -05:00
josegonzalez
1e33752ea0 chore: drop debugging code 2023-02-07 21:57:19 -05:00
josegonzalez
02b6c50bb2 chore: drop extra ls 2023-02-07 21:56:25 -05:00
Jose Diaz-Gonzalez
cdb062fed1 debug 2023-02-07 21:46:24 -05:00
josegonzalez
76a5fbd9cb feat: more debugging 2023-02-07 21:18:32 -05:00
josegonzalez
2f4d5dfe38 feat: add more debug information 2023-02-07 20:46:54 -05:00
Jose Diaz-Gonzalez
acaaaf586b refactor: use direct functions instead of subcommands 2023-02-07 20:30:48 -05:00
josegonzalez
49949f24cb debug: check why the commands are failing 2023-02-07 20:17:15 -05:00
Jose Diaz-Gonzalez
fe378009d8 feat: add network properties to :info output 2023-02-07 18:25:04 -05:00
Jose Diaz-Gonzalez
ab0d871347 docs: add example for multiple networks 2023-02-07 18:25:04 -05:00
Jose Diaz-Gonzalez
c0a393a7af feat: add ability to set multiple, comma-delimited post-create and post-start networks 2023-02-07 18:25:04 -05:00
Jose Diaz-Gonzalez
ea2a23b0b9 feat: add support for attaching to networks after service container creation and start 2023-02-07 18:25:04 -05:00
Jose Diaz-Gonzalez
ddfbbd6694 refactor: directly write out the cid file when creating the service container 2023-02-07 18:25:04 -05:00
Jose Diaz-Gonzalez
cd13edd30d fix: correct error message for valid/invalid properties 2023-02-07 18:25:04 -05:00
Jose Diaz-Gonzalez
1d6654943b fix: actually call the :set function and ensure we write properties to the correct namespace 2023-02-07 18:25:04 -05:00
Jose Diaz-Gonzalez
1a942e0484 fix: correct issue with checking if the service container is ready when using an initial-network 2023-02-07 18:25:04 -05:00
Jose Diaz-Gonzalez
b6ccd491fd 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:25:04 -05:00
josegonzalez
fbc5380a12 Merge pull request #206 from dokku/dependabot/github_actions/actions/checkout-3
chore(deps): bump actions/checkout from 2 to 3
2023-02-07 18:16:02 -05:00
josegonzalez
de6f3d36d1 Merge pull request #205 from dokku/dependabot/github_actions/actions/setup-python-4
chore(deps): bump actions/setup-python from 2 to 4
2023-02-07 18:15:56 -05:00
josegonzalez
bfef36d1a6 Merge pull request #204 from dokku/dependabot/github_actions/actions/upload-artifact-3
chore(deps): bump actions/upload-artifact from 2 to 3
2023-02-07 17:57:16 -05:00
dependabot[bot]
85302b5040 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:02:22 +00:00
dependabot[bot]
09ca02a1ad 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 22:02:19 +00:00
dependabot[bot]
1de6476ff2 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 22:02:15 +00:00
Jose Diaz-Gonzalez
1acb937676 feat: upgrade github actions automatically 2023-02-07 17:01:15 -05:00
josegonzalez
3f22a06649 Merge pull request #203 from dokku/upgrade-test-os
feat: upgrade test os to ubuntu 20.04
2023-02-07 16:50:49 -05:00
Jose Diaz-Gonzalez
2bcbae8915 feat: upgrade test os to ubuntu 20.04 2023-02-07 16:19:10 -05:00
Jose Diaz-Gonzalez
14ac26d1fc Release 1.28.0 2023-02-07 08:19:56 -05:00
josegonzalez
5679ded638 Merge pull request #201 from dokku/fix-upgrades
fix: properly support new image and image-version values during plugin upgrades
2023-02-07 07:13:48 -05:00
Jose Diaz-Gonzalez
0f569b158c 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
1948c216ff Merge pull request #198 from dokku/update-docker-commands
Update docker commands to use DOCKER_BIN
2023-02-07 04:47:06 -05:00
Jose Diaz-Gonzalez
646356d086 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
b50752d009 refactor: use namespaced docker commands for interacting with the docker binary 2023-02-07 03:39:42 -05:00
Jose Diaz-Gonzalez
b22abfd8e5 refactor: namespace all docker commands in common-functions 2023-02-07 03:31:50 -05:00
Jose Diaz-Gonzalez
84566e66ff Release 1.27.2 2023-02-07 02:47:01 -05:00
Jose Diaz-Gonzalez
649ea35cb9 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:36 -05:00
Jose Diaz-Gonzalez
1e6c12d4e2 Release 1.27.1 2023-01-28 16:34:56 -05:00
Jose Diaz-Gonzalez
b7c9c101b5 docs: update the ci workflow badge
Refs https://github.com/badges/shields/issues/8671
2023-01-28 16:32:52 -05:00
Jose Diaz-Gonzalez
6338ac02e7 Release 1.27.0 2023-01-28 15:56:47 -05:00
Jose Diaz-Gonzalez
6c1308171e docs: update readme 2023-01-28 15:56:07 -05:00
josegonzalez
febb1c7e13 Merge pull request #197 from dokku/dependabot/docker/redis-7.0.8
chore(deps): bump redis from 7.0.7 to 7.0.8
2023-01-18 12:36:07 -05:00
dependabot[bot]
37fa14fd16 chore(deps): bump redis from 7.0.7 to 7.0.8
Bumps redis from 7.0.7 to 7.0.8.

---
updated-dependencies:
- dependency-name: redis
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-01-18 15:01:42 +00:00
josegonzalez
17b4ffc0b0 Merge pull request #190 from dokku/5468-dokku-lib-host-root
feat: respect DOKKU_LIB_HOST_ROOT for mounted data volumes
2022-12-27 00:16:45 -05:00
Jose Diaz-Gonzalez
470e3506ec 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
a9d7909ab5 Release 1.26.2 2022-12-26 19:14:42 -05:00
Jose Diaz-Gonzalez
28f14c8d10 chore: update readme 2022-12-26 19:14:39 -05:00
Jose Diaz-Gonzalez
32a4978593 Release 1.26.1 2022-12-26 19:14:15 -05:00
josegonzalez
e3c62b8e52 Merge pull request #187 from dokku/dependabot/docker/redis-7.0.7
chore(deps): bump redis from 7.0.5 to 7.0.7
2022-12-26 19:14:08 -05:00
Jose Diaz-Gonzalez
a0ea546461 Release 1.26.0 2022-12-26 19:02:32 -05:00
josegonzalez
ba2e12f95e Merge pull request #188 from dokku/pause-stop-rm
Add :pause subcommand and make :stop subcommand actually remove the container
2022-12-26 18:44:49 -05:00
Jose Diaz-Gonzalez
9ef9985d4a feat: add :pause subcommand and make :stop subcommand actually remove the container 2022-12-26 17:39:50 -05:00
Jose Diaz-Gonzalez
478fd1276a docs: update readme 2022-12-26 17:27:30 -05:00
dependabot[bot]
865322510f chore(deps): bump redis from 7.0.5 to 7.0.7
Bumps redis from 7.0.5 to 7.0.7.

---
updated-dependencies:
- dependency-name: redis
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-12-19 15:03:37 +00:00
Jose Diaz-Gonzalez
b4f514458f Release 1.25.0 2022-10-12 01:28:24 -04:00
Jose Diaz-Gonzalez
945c04b564 Merge pull request #183 from dokku/dependabot/docker/redis-7.0.5
chore(deps): bump redis from 7.0.2 to 7.0.5
2022-10-11 21:46:30 -07:00
Jose Diaz-Gonzalez
10069c3344 Merge pull request #184 from dokku/arm-support
Update all related images to add arm/arm64 support
2022-10-11 21:45:54 -07:00
Jose Diaz-Gonzalez
66554c22d6 feat: update all related images to add arm/arm64 support 2022-10-11 23:59:25 -04:00
dependabot[bot]
271cdc0bcf chore(deps): bump redis from 7.0.2 to 7.0.5
Bumps redis from 7.0.2 to 7.0.5.

---
updated-dependencies:
- dependency-name: redis
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-09-23 15:15:16 +00:00
Jose Diaz-Gonzalez
51aaa2eefa Release 1.24.0 2022-07-25 01:31:20 -04:00
Jose Diaz-Gonzalez
523e4f813a 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
cc5f8e117e Release 1.23.0 2022-07-25 01:17:30 -04:00
Jose Diaz-Gonzalez
725ec8ff59 chore: run shfmt 2022-07-25 01:15:32 -04:00
Jose Diaz-Gonzalez
a5b9bd6089 Merge pull request #182 from dokku/filter-services
fix: refactor how services are filtered
2022-07-25 01:12:13 -04:00
Jose Diaz-Gonzalez
5f6c09dfaf fix: update clone test 2022-07-25 00:37:11 -04:00
Jose Diaz-Gonzalez
6214fd1096 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
cfbe99cb77 fix: move warning below service name verification 2022-07-19 01:34:22 -04:00
Jose Diaz-Gonzalez
b7528a6f1c Release 1.22.0 2022-07-10 15:31:07 -04:00
Jose Diaz-Gonzalez
9c72f9a8e0 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
9cfaec41ea Release 1.21.1 2022-07-07 03:08:09 -04:00
Jose Diaz-Gonzalez
e9e46256e9 fix: ensure we respect the file path for service links 2022-07-07 03:07:37 -04:00
Jose Diaz-Gonzalez
b1a0266f93 Release 1.21.0 2022-07-07 03:04:27 -04:00
Jose Diaz-Gonzalez
099764aa40 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
dae1a32275 Release 1.20.3 2022-07-06 01:49:06 -04:00
Jose Diaz-Gonzalez
9e5bf61dc0 fix: ensure the new service does not exist when cloning an existing service 2022-07-06 01:47:31 -04:00
Jose Diaz-Gonzalez
e8416285d2 Release 1.20.2 2022-07-06 01:38:21 -04:00
Jose Diaz-Gonzalez
7e1301d6d4 fix: ensure we check if the service exists before entering it 2022-07-06 01:36:40 -04:00
Jose Diaz-Gonzalez
dacc0c2236 Release 1.20.1 2022-07-05 22:15:43 -04:00
Jose Diaz-Gonzalez
7992ce90e2 Merge pull request #179 from dokku/dependabot/docker/redis-7.0.2
chore(deps): bump redis from 7.0.0 to 7.0.2
2022-07-05 22:14:25 -04:00
dependabot[bot]
5ff5d82ef8 chore(deps): bump redis from 7.0.0 to 7.0.2
Bumps redis from 7.0.0 to 7.0.2.

---
updated-dependencies:
- dependency-name: redis
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-06-14 15:09:28 +00:00
Jose Diaz-Gonzalez
28af22d5ee Release 1.20.0 2022-05-29 16:17:24 -04:00
Jose Diaz-Gonzalez
0bcf1a2e32 Merge pull request #177 from dokku/dependabot/docker/redis-7.0.0
chore(deps): bump redis from 6.2.6 to 7.0.0
2022-05-29 16:17:01 -04:00
dependabot[bot]
4b4f28a7db chore(deps): bump redis from 6.2.6 to 7.0.0
Bumps redis from 6.2.6 to 7.0.0.

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

Signed-off-by: dependabot[bot] <support@github.com>
2022-04-28 15:12:49 +00:00
Jose Diaz-Gonzalez
b9071721c0 Release 1.19.2 2022-02-03 10:31:17 -05:00
Jose Diaz-Gonzalez
93415ced00 fix: always chown the image files 2022-02-03 10:30:27 -05:00
Jose Diaz-Gonzalez
ac4fee6acb docs: clarify unit for container memory limit 2022-01-22 04:31:53 -05:00
Jose Diaz-Gonzalez
43348c4297 Release 1.19.1 2022-01-22 04:24:39 -05:00
Jose Diaz-Gonzalez
60d46920d4 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
3dce1632fd Release 1.19.0 2021-12-25 16:50:21 -05:00
Jose Diaz-Gonzalez
8c89467123 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
Jose Diaz-Gonzalez
134442bd73 Release 1.18.0 2021-10-26 22:28:10 -04:00
Jose Diaz-Gonzalez
88e6d790e1 feat: allow tailing a specific number of log lines 2021-10-26 22:27:15 -04:00
Jose Diaz-Gonzalez
29f1f3dd3d Release 1.17.1 2021-10-24 05:17:55 -04:00
Jose Diaz-Gonzalez
93dbdc4da5 fix: silence config-options error when there are no config-options set 2021-10-24 05:08:30 -04:00
Jose Diaz-Gonzalez
bd5ae9442d Release 1.17.0 2021-10-23 19:34:11 -04:00
Jose Diaz-Gonzalez
cd18e9f4a3 feat: allow quiet header for :info command 2021-10-23 19:33:19 -04:00
Jose Diaz-Gonzalez
c2aff1a5a3 Release 1.16.2 2021-10-07 11:23:30 -04:00
Jose Diaz-Gonzalez
48277db27f Merge pull request #169 from dokku/dependabot/docker/redis-6.2.6
chore(deps): bump redis from 6.2.5 to 6.2.6
2021-10-07 11:23:02 -04:00
dependabot[bot]
f9bac907df chore(deps): bump redis from 6.2.5 to 6.2.6
Bumps redis from 6.2.5 to 6.2.6.

---
updated-dependencies:
- dependency-name: redis
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-10-06 15:11:34 +00:00
Jose Diaz-Gonzalez
258eb2fea8 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:59 -04:00
Jose Diaz-Gonzalez
943f93227b Release 1.16.1 2021-09-13 04:34:12 -04:00
Jose Diaz-Gonzalez
2e76628c88 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:27:29 -04:00
Jose Diaz-Gonzalez
b2cbea7508 Release 1.16.0 2021-09-13 03:34:12 -04:00
Jose Diaz-Gonzalez
f132d89425 docs: use a 'standard' name for the data dump 2021-09-13 03:25:06 -04:00
Jose Diaz-Gonzalez
ba85668e26 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:24 -04:00
Jose Diaz-Gonzalez
7e73273ad3 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:42 -04:00
Jose Diaz-Gonzalez
8d23856729 docs: add folder for supplementary documentation 2021-09-13 01:23:26 -04:00
Jose Diaz-Gonzalez
ced8d9a050 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:20 -04:00
Jose Diaz-Gonzalez
6885913479 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
d9a8bc3357 feat: allow setting shm-size on created containers
Refs dokku/dokku-postgres#188
Closes dokku/dokku-postgres#201
2021-09-13 00:46:49 -04:00
Jose Diaz-Gonzalez
943f90f4b8 fix: properly handle unlink on promoted service 2021-09-13 00:04:28 -04:00
Jose Diaz-Gonzalez
386a97d68d 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
cb5aa08986 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
9cb2f75469 docs: make tense in command descriptions more consistent 2021-09-12 22:37:15 -04:00
Jose Diaz-Gonzalez
b186895205 chore: drop extra print in readme generator 2021-09-12 22:33:06 -04:00
Jose Diaz-Gonzalez
653e1e0ec5 dev: add file (for linting) and nano (for in-container editing) to devcontainer 2021-09-12 22:20:42 -04:00
Jose Diaz-Gonzalez
2b7b1cc1da fix: use updated python shebang 2021-09-12 22:18:01 -04:00
Jose Diaz-Gonzalez
720ddea579 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
658e04df6f fix: allow non-english characters in :connect shell
Closes dokku/dokku-mysql#116
2021-09-12 08:24:53 -04:00
Jose Diaz-Gonzalez
9b6d6430fb feat: add the ability to constrain memory on service start/clone
Refs dokku/dokku-redis#86
2021-09-12 07:43:03 -04:00
Jose Diaz-Gonzalez
5ce48afd51 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:56 -04:00
Jose Diaz-Gonzalez
17a640e764 docs: translate single-quotes into backticks 2021-09-12 07:01:59 -04:00
Jose Diaz-Gonzalez
3aed82c9d7 docs: document how to restore a backup 2021-09-12 06:59:50 -04:00
Jose Diaz-Gonzalez
65e92bdd75 Release 1.15.1 2021-09-12 04:54:50 -04:00
Jose Diaz-Gonzalez
ec9b0049cf dev: add convenience copy-file bin and fix data path used by plugin 2021-09-12 03:28:57 -04:00
Jose Diaz-Gonzalez
3418f4d76e dev: make devcontainer setup plugin agnostic 2021-09-12 02:39:18 -04:00
Jose Diaz-Gonzalez
2e0e2db647 chore: show a better error message when the image is missing
Refs dokku/dokku-clickhouse#4
2021-09-12 00:54:24 -04:00
Jose Diaz-Gonzalez
5b0dd26c73 dev: mount the service directory from the host to ensure tests can pass inside of a docker container 2021-09-12 00:53:13 -04:00
Jose Diaz-Gonzalez
c259f0fb97 fix: copy any existing templates and drop unnecessary interactivity 2021-09-12 00:40:42 -04:00
Jose Diaz-Gonzalez
8f8c9f2a2c fix: use correct path 2021-09-11 23:45:01 -04:00
Jose Diaz-Gonzalez
4c71d0b4c5 fix: copy templates if they exist 2021-09-11 23:18:29 -04:00
Jose Diaz-Gonzalez
be18a78f36 feat: add devcontainer support
This should make it possible to run tests locally in a lighter way than pulling up a full VM.
2021-09-11 21:06:06 -04:00
Jose Diaz-Gonzalez
99daa0f86f docs: regenerate readme 2021-09-11 18:16:29 -04:00
Jose Diaz-Gonzalez
0d501c6f8d Merge pull request #166 from dokku/dependabot/docker/redis-6.2.5
chore(deps): bump redis from 6.2.4 to 6.2.5
2021-09-11 18:11:40 -04:00
Jose Diaz-Gonzalez
a30b33ecc6 chore: drop references to circleci, libera, travis-ci 2021-09-11 17:57:22 -04:00
dependabot[bot]
71316e85d3 chore(deps): bump redis from 6.2.4 to 6.2.5
Bumps redis from 6.2.4 to 6.2.5.

---
updated-dependencies:
- dependency-name: redis
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-07-23 15:07:50 +00:00
Jose Diaz-Gonzalez
2082f89ac1 Release 1.15.0 2021-07-12 01:04:11 -04:00
Jose Diaz-Gonzalez
902112cc75 Merge pull request #164 from dokku/dependabot/docker/redis-6.2.4
chore(deps): bump redis from 5.0.7 to 6.2.4
2021-07-12 01:02:43 -04:00
dependabot[bot]
18c4fbc79e chore(deps): bump redis from 5.0.7 to 6.2.4
Bumps redis from 5.0.7 to 6.2.4.

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

Signed-off-by: dependabot[bot] <support@github.com>
2021-06-02 06:24:43 +00:00
Jose Diaz-Gonzalez
3a8b4511c4 tests: refactor tests to ignore readme generation for Dockerfile changes
Ideally we can trigger a readme update on merge in the future. For now, this will work well.
2021-04-26 11:43:13 -04:00
Jose Diaz-Gonzalez
2dfcc76d26 chore: gitignore bootstrap file and minor cleanup of ci 2021-04-25 02:54:07 -04:00
Jose Diaz-Gonzalez
071afd4a31 Merge pull request #161 from dokku/github-actions-attempt
tests: migrate to github actions
2021-04-25 01:07:10 -04:00
Jose Diaz-Gonzalez
04541a0fc6 tests: skip tests that require tty for github actions 2021-04-25 00:35:43 -04:00
Jose Diaz-Gonzalez
fea5aa6724 docs: regenerate readme 2021-04-24 14:09:33 -04:00
Jose Diaz-Gonzalez
f48f67f67b tests: drop copying of test results
Bats will now output the results on stdout so no need to copy results anywhere.
2021-04-24 14:05:47 -04:00
Jose Diaz-Gonzalez
8fda23f91c tests: fix job name 2021-04-24 14:04:39 -04:00
Jose Diaz-Gonzalez
14ec6fd833 tests: split tests to version and tag 2021-04-24 14:03:02 -04:00
Jose Diaz-Gonzalez
dafc9c7a2d chore: update min dokku version and only test push on master branch 2021-04-24 13:57:19 -04:00
Jose Diaz-Gonzalez
21df3ee116 tests: migrate to github actions 2021-04-24 02:20:30 -04:00
Jose Diaz-Gonzalez
98cabcce0b Release 1.14.0 2021-04-24 00:32:25 -04:00
Jose Diaz-Gonzalez
f09a65e55f feat: add dependabot config to all repositories 2021-04-24 00:10:34 -04:00
Jose Diaz-Gonzalez
71c828eabd Merge pull request #159 from dokku/dockerfile-update
Pull image from Dockerfile
2021-04-23 23:55:48 -04:00
Jose Diaz-Gonzalez
9eca41dcd5 tests: refactor source again 2021-02-26 00:45:09 -05:00
Jose Diaz-Gonzalez
6f392df029 tests: fix path to Dockerfile when sourcing config for tests 2021-02-26 00:27:52 -05:00
Jose Diaz-Gonzalez
aa8c6489ee docs: handle image and version correctly 2021-02-26 00:11:16 -05:00
Jose Diaz-Gonzalez
f1629b8b51 refactor: move base image reference to Dockerfile
This will allow us to take advantage of automatic update software to auto-pull new versions when they are released to docker hub.
2021-02-25 23:16:23 -05:00
Jose Diaz-Gonzalez
18ce6d43b5 tests: use dash instead of underscore 2021-02-25 20:32:57 -05:00
Jose Diaz-Gonzalez
bb2ba3807a feat: add plugin trigger for service creation and deletion 2021-02-25 19:54:59 -05:00
Jose Diaz-Gonzalez
d2eecef68a refactor: use pre/post triggers for service-action naming
This is a bit more clear as the links aren't always idempotent and may have errors - this allows users to reconcile at what point a link may have failed so that they can take further action.
2021-02-25 16:05:25 -05:00
Jose Diaz-Gonzalez
9e0d948de7 feat: add service-action plugin trigger for link/unlink
This can be used to track in alternate systems when a service is linked/unlinked from an app by implementing the custom trigger.
2021-02-25 15:58:31 -05:00
Jose Diaz-Gonzalez
90ab3a1191 Release 1.13.0 2021-02-02 21:50:08 -05:00
Jose Diaz-Gonzalez
23681960bf Merge pull request #157 from gyfis/patch-1
Don't fill $SERVICE as username in REDIS_URL
2021-02-02 21:49:47 -05:00
Jose Diaz-Gonzalez
b8b97f0cb4 Release 1.12.6 2021-01-17 21:16:36 -05:00
Jose Diaz-Gonzalez
70c98338b0 fix: do not shadow TMPDIR variable
This enables usage of the plugin with libpam-tmpdir.

Refs dokku/dokku#3149
2021-01-17 21:02:28 -05:00
Tomas Hromada
872ed9c540 Merge branch 'patch-1' of https://github.com/gyfis/dokku-redis into patch-1 2020-11-22 09:00:53 +01:00
Tomas Hromada
c85770a873 💄 README.md from bin/generate 2020-11-22 09:00:44 +01:00
Tomáš Hromada
facd80f5bc 💄 Remove last empty line from README 2020-11-22 08:13:04 +01:00
Tomas Hromada
bc5985881a purge mentions of the faux-username from the codebase 2020-11-21 21:17:55 +01:00
Tomáš Hromada
4170c0b993 Don't fill $SERVICE as username in service_url()
The URL generated by this plugin is invalid, but since Redis on versions 5 and lower didn't have a notion of usernames, it pretty much went unnoticed. 

Let's fix this by not setting the $SERVICE as the username in the service_url returned by this plugin.

I believe that clients ignore the username (otherwise the Redis connection wouldn't go through), so this should be a non-breaking change.

Fixes #155
2020-11-21 20:53:49 +01:00
Jose Diaz-Gonzalez
ca69e6f79d fix: correct image link 2020-09-27 12:38:54 -04:00
Jose Diaz-Gonzalez
ca6b3b8815 Merge pull request #151 from dokku/configurable-config
fix: allow config directory to be configurable
2020-05-16 12:57:10 -04:00
Jose Diaz-Gonzalez
e43904641b fix: allow config directory to be configurable
For postgres, the config directory doesn't actually exist, so adding this configurability allows the plugin's info command to report correctly.
2020-05-16 02:49:34 -04:00
Jose Diaz-Gonzalez
6d19569e82 Release 1.12.5 2020-05-15 00:59:58 -04:00
Jose Diaz-Gonzalez
01a1668867 fix: respect the TMPDIR environment variable
Refs dokku/dokku-redis#143
2020-05-15 00:57:21 -04:00
Jose Diaz-Gonzalez
f2c531bb5e Release 1.12.4 2020-05-15 00:54:38 -04:00
Jose Diaz-Gonzalez
2fd7152866 docs: correct help output
Refs dokku/dokku-postgres#197
2020-05-15 00:40:25 -04:00
Jose Diaz-Gonzalez
f9d5735c6c docs: correct casing/quoting on sentences 2020-05-15 00:34:38 -04:00
Jose Diaz-Gonzalez
6497135ae8 chore: run black 2020-05-14 23:57:49 -04:00
Jose Diaz-Gonzalez
adc1b724d3 docs: document all flags in readme 2020-05-14 23:37:57 -04:00
Jose Diaz-Gonzalez
b421d681af docs: make the gpg passphrase a bit more clear 2020-05-14 23:33:01 -04:00
Jose Diaz-Gonzalez
1e43387487 Release 1.12.3 2020-05-14 23:00:57 -04:00
Jose Diaz-Gonzalez
7a003dea68 chore: update copyright date 2020-05-14 22:57:39 -04:00
Jose Diaz-Gonzalez
0aefafed16 docs: switch build shield to circleci 2020-04-05 20:41:00 -04:00
Jose Diaz-Gonzalez
2f72b26396 tests: use circleci 2.1 2020-04-05 20:40:20 -04:00
Jose Diaz-Gonzalez
75efb47a97 Release 1.12.2 2020-04-04 22:28:01 -04:00
Jose Diaz-Gonzalez
3d4258c794 fix: store the correct path 2020-04-04 22:25:11 -04:00
Jose Diaz-Gonzalez
4c194bf734 Release 1.12.1 2020-04-04 21:50:44 -04:00
Jose Diaz-Gonzalez
53968775f6 tests: drop travisci usage 2020-04-04 21:44:00 -04:00
Jose Diaz-Gonzalez
9589ad3924 tests: store test results for usage in circleci 2020-04-04 21:41:43 -04:00
Jose Diaz-Gonzalez
5093de6bd9 feat: enable circleci 2020-04-04 21:27:54 -04:00
Jose Diaz-Gonzalez
565dba9801 feat: speed up tests by dropping dhparam generation 2020-04-04 21:27:43 -04:00
Jose Diaz-Gonzalez
81cca3b12b fix: use python3 for generating the readme 2020-04-04 16:47:36 -04:00
Jose Diaz-Gonzalez
2d07341518 docs: drop unimpemented commands from readme and reorganize 2020-04-04 16:43:31 -04:00
Jose Diaz-Gonzalez
18f925d9f4 feat: autogenerate readme from command help 2020-04-04 16:20:35 -04:00
Jose Diaz-Gonzalez
a4e1f43905 fix: correct issue where help output for info flag implied multiple flags 2020-04-04 16:18:22 -04:00
Jose Diaz-Gonzalez
a6f3ea4552 feat: update shellcheck excludes 2020-04-04 13:38:33 -04:00
Jose Diaz-Gonzalez
138bcd3fe1 feat: add xunit-reader to output xunit files in human readable format 2020-04-04 13:37:51 -04:00
Jose Diaz-Gonzalez
da6676efb8 feat: parameterize xunit-to-github version 2020-04-04 13:37:04 -04:00
Jose Diaz-Gonzalez
3a7564c401 fix: use non-deprecated method of fetching docker-options 2020-04-04 13:36:27 -04:00
Jose Diaz-Gonzalez
2d820a7c1c feat: upgrade shfmt 2020-04-04 13:35:52 -04:00
Jose Diaz-Gonzalez
ba4024d202 Release 1.12.0 2020-03-31 01:38:34 -04:00
Jose Diaz-Gonzalez
34cbc30f63 feat: upgrade tertiary container images 2020-03-30 20:12:18 -04:00
Jose Diaz-Gonzalez
9ace27266c feat: move all image names to config file
This allows us to more quickly update the image versions in use for tertiary images.
2020-03-30 20:09:04 -04:00
Jose Diaz-Gonzalez
d2185f2144 feat: add service-specific header to info call 2020-03-20 15:59:03 -04:00
Jose Diaz-Gonzalez
6feb270037 fix: correct test case for :list command 2020-03-20 14:58:06 -04:00
Jose Diaz-Gonzalez
62484924e6 fix: ignore the keyfile install for tests 2020-03-20 11:14:27 -04:00
Jose Diaz-Gonzalez
b9740bffcd fix: correct shellcheck issue 2020-03-20 11:05:44 -04:00
Jose Diaz-Gonzalez
3c4267fbb9 feat: update travis setup
- Use ubuntu bionic
- Upgrade tested version of dokku
2020-03-20 10:58:25 -04:00
Jose Diaz-Gonzalez
fb1b189aea Release 1.11.1 2020-03-06 10:20:27 -05:00
Jose Diaz-Gonzalez
e216b97c23 fix: correct service title 2020-03-06 10:19:43 -05:00
Jose Diaz-Gonzalez
0c210e64f3 Release 1.11.0 2020-03-03 16:05:40 -05:00
Jose Diaz-Gonzalez
bc9874bc49 refactor: drop full info from :list command
This can be fetched from :info if necessary, and slows down the list quite a bit.
2020-03-03 16:02:51 -05:00
Jose Diaz-Gonzalez
b7cfbd37b4 fix: speed up service_status by reducing container status calls 2020-03-03 15:57:21 -05:00
Jose Diaz-Gonzalez
0ecf4f7cfd Release 1.10.4 2019-12-27 16:57:56 -05:00
Jose Diaz-Gonzalez
3bfcb5bc2c chore: update dokku/wait version 2019-12-27 16:57:13 -05:00
Jose Diaz-Gonzalez
0fe6933897 Release 1.10.3 2019-12-27 16:56:17 -05:00
Jose Diaz-Gonzalez
0cec2f2119 chore: update dokku/ambassador version 2019-12-27 16:55:26 -05:00
Jose Diaz-Gonzalez
3dcf263b56 Release 1.10.2 2019-12-27 16:54:21 -05:00
Jose Diaz-Gonzalez
233b03e7ca chore: update dokku/s3backup version 2019-12-27 16:53:23 -05:00
Jose Diaz-Gonzalez
9bc7830c0c Release 1.10.1 2019-11-22 19:17:09 -05:00
Jose Diaz-Gonzalez
150591eb75 feat: update patch release of redis 2019-11-22 19:16:55 -05:00
Jose Diaz-Gonzalez
417311e9fb Release 1.10.0 2019-09-19 15:29:17 -04:00
Jose Diaz-Gonzalez
6fe12abbb5 Merge pull request #139 from plotly/11839-modify-SAVE-call
Modify export command to use BGSAVE.
2019-09-19 15:28:54 -04:00
V. Anastassiou
068145b46e Modify export command to use BGSAVE. 2019-09-19 13:40:28 -04:00
82 changed files with 3054 additions and 685 deletions

24
.devcontainer/20_init_plugin Executable file
View File

@@ -0,0 +1,24 @@
#!/bin/bash
set -eo pipefail
log-info() {
declare desc="Log info formatter"
echo " $*" 1>&2
}
log-fail() {
declare desc="Log fail formatter"
echo "! $*" 1>&2
exit 1
}
main() {
dokku plugin:install
# built in the Dockerfile
PLUGIN_NAME="$(source /tmp/.env && echo "$PLUGIN_NAME")"
PLUGIN_VARIABLE="$(source /tmp/.env && echo "$PLUGIN_VARIABLE")"
echo "export ${PLUGIN_VARIABLE}_HOST_ROOT=${SERVICE_HOST_ROOT}/$PLUGIN_NAME" >/etc/default/dokku
}
main "$@"

26
.devcontainer/Dockerfile Normal file
View File

@@ -0,0 +1,26 @@
FROM dokku/dokku:latest
RUN apt-get update
RUN apt-get install --no-install-recommends -y build-essential file nano && \
apt-get clean autoclean && \
apt-get autoremove --yes && \
rm -rf /var/lib/apt/lists/* && \
mkdir -p /mnt/dokku/home/dokku /mnt/dokku/var/lib/dokku/config /mnt/dokku/var/lib/dokku/data /mnt/dokku/var/lib/dokku/services && \
chown -R dokku:dokku /mnt/dokku/home/dokku /mnt/dokku/var/lib/dokku/config /mnt/dokku/var/lib/dokku/data /mnt/dokku/var/lib/dokku/services && \
echo "dokku.me" > /home/dokku/VHOST
ADD https://raw.githubusercontent.com/dokku/dokku/master/tests/dhparam.pem /mnt/dokku/etc/nginx/dhparam.pem
COPY .devcontainer/20_init_plugin /etc/my_init.d/20_init_plugin
COPY .devcontainer/bin/ /usr/local/bin/
COPY . .
RUN source /tmp/config && \
echo "export ${PLUGIN_DISABLE_PULL_VARIABLE}=true" > /tmp/.env && \
echo "export PLUGIN_NAME=${PLUGIN_COMMAND_PREFIX}" >> /tmp/.env && \
echo "export PLUGIN_VARIABLE=${PLUGIN_VARIABLE}" >> /tmp/.env
RUN source /tmp/.env && \
dokku plugin:install file:///tmp --name $PLUGIN_NAME && \
make ci-dependencies

8
.devcontainer/bin/copy-file Executable file
View File

@@ -0,0 +1,8 @@
#!/usr/bin/env bash
main() {
PLUGIN_NAME="$(source /tmp/.env && echo "$PLUGIN_NAME")"
cp "$1" "/var/lib/dokku/plugins/enabled/$PLUGIN_NAME/$1"
}
main "$@"

View File

@@ -0,0 +1,16 @@
{
"build": {
"dockerfile": "Dockerfile",
"context": ".."
},
"containerEnv": {
"SERVICE_HOST_ROOT": "${localWorkspaceFolder}/tmp/data"
},
"initializeCommand": ["mkdir", "-p", "tmp/data"],
"mounts": [
"source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind",
"source=${localWorkspaceFolder}/tmp/data/,target=/var/lib/dokku/services/,type=bind"
],
"overrideCommand": false,
"runArgs": ["--init"]
}

12
.github/dependabot.yml vendored Normal file
View File

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

100
.github/workflows/ci.yml vendored Normal file
View File

@@ -0,0 +1,100 @@
---
name: CI
# yamllint disable-line rule:truthy
on:
pull_request:
branches:
- '*'
push:
branches:
- master
concurrency:
group: build-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
jobs:
unit-tests-master:
name: unit-tests
runs-on: ubuntu-22.04
env:
DOKKU_VERSION: master
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: '3.7.x'
- run: make setup
- run: sudo sysctl -w vm.max_map_count=262144
- run: |
git fetch -q origin master
changed=$(git --no-pager diff --name-only $GITHUB_SHA..origin/master)
if [ $changed = "Dockerfile" ]; then
echo "Please run 'make generate' to update the image version in the README.md"
else
make generate
if ! git diff --quiet README.md; then
echo "Please run 'make generate'"
git status --short
git --no-pager diff README.md
exit 1
fi
fi
- run: make test
- uses: actions/upload-artifact@v4
if: failure()
with:
name: tmp/test-results
path: test-results
unit-tests-0_19_0:
name: unit-tests-0.19.0
runs-on: ubuntu-22.04
env:
DOKKU_TAG: v0.19.0
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: '3.7.x'
- run: make setup
- run: sudo sysctl -w vm.max_map_count=262144
- run: |
git fetch -q origin master
changed=$(git --no-pager diff --name-only $GITHUB_SHA..origin/master)
if [ $changed = "Dockerfile" ]; then
echo "Please run 'make generate' to update the image version in the README.md"
else
make generate
if ! git diff --quiet README.md; then
echo "Please run 'make generate'"
git status --short
git --no-pager diff README.md
exit 1
fi
fi
- run: make test
- uses: actions/upload-artifact@v4
if: failure()
with:
name: tmp/test-results
path: 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

1
.gitignore vendored
View File

@@ -1,2 +1,3 @@
/tmp /tmp
.vagrant .vagrant
bootstrap.sh

View File

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

1
Dockerfile Normal file
View File

@@ -0,0 +1 @@
FROM redis:7.2.4

View File

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

View File

@@ -1,5 +1,10 @@
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
XUNIT_TO_GITHUB_VERSION = 0.3.0
XUNIT_READER_VERSION = 0.1.0
bats: bats:
ifeq ($(SYSTEM_NAME),darwin) ifeq ($(SYSTEM_NAME),darwin)
@@ -7,7 +12,7 @@ ifneq ($(shell bats --version >/dev/null 2>&1 ; echo $$?),0)
brew install bats-core brew install bats-core
endif endif
else else
git clone https://github.com/josegonzalez/bats-core.git /tmp/bats git clone https://github.com/bats-core/bats-core.git /tmp/bats
cd /tmp/bats && sudo ./install.sh /usr/local cd /tmp/bats && sudo ./install.sh /usr/local
rm -rf /tmp/bats rm -rf /tmp/bats
endif endif
@@ -17,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
@@ -28,7 +37,7 @@ ifneq ($(shell shfmt --version >/dev/null 2>&1 ; echo $$?),0)
ifeq ($(shfmt),Darwin) ifeq ($(shfmt),Darwin)
brew install shfmt brew install shfmt
else else
wget -qO /tmp/shfmt https://github.com/mvdan/sh/releases/download/v2.6.2/shfmt_v2.6.2_linux_amd64 wget -qO /tmp/shfmt https://github.com/mvdan/sh/releases/download/v$(SHFMT_VERSION)/shfmt_v$(SHFMT_VERSION)_linux_amd64
chmod +x /tmp/shfmt chmod +x /tmp/shfmt
sudo mv /tmp/shfmt /usr/local/bin/shfmt sudo mv /tmp/shfmt /usr/local/bin/shfmt
endif endif
@@ -59,13 +68,13 @@ unit-tests:
@echo running unit tests... @echo running unit tests...
@mkdir -p tmp/test-results/bats @mkdir -p tmp/test-results/bats
@cd tests && echo "executing tests: $(shell cd tests ; ls *.bats | xargs)" @cd tests && echo "executing tests: $(shell cd tests ; ls *.bats | xargs)"
cd tests && bats --formatter bats-format-junit -e -T -o ../tmp/test-results/bats *.bats cd tests && bats --report-formatter junit --timing -o ../tmp/test-results/bats *.bats
tmp/xunit-to-github: tmp/xunit-reader:
mkdir -p tmp mkdir -p tmp
curl -o tmp/xunit-to-github.tgz -sL https://github.com/josegonzalez/go-xunit-to-github/releases/download/v0.3.0/xunit-to-github_0.3.0_$(SYSTEM_NAME)_$(HARDWARE).tgz curl -o tmp/xunit-reader.tgz -sL https://github.com/josegonzalez/go-xunit-reader/releases/download/v$(XUNIT_READER_VERSION)/xunit-reader_$(XUNIT_READER_VERSION)_$(SYSTEM_NAME)_$(HARDWARE).tgz
tar xf tmp/xunit-to-github.tgz -C tmp tar xf tmp/xunit-reader.tgz -C tmp
chmod +x tmp/xunit-to-github chmod +x tmp/xunit-reader
setup: setup:
bash tests/setup.sh bash tests/setup.sh
@@ -73,11 +82,17 @@ setup:
test: lint unit-tests test: lint unit-tests
report: tmp/xunit-to-github report: tmp/xunit-reader
ifdef TRAVIS_REPO_SLUG tmp/xunit-reader -p 'tmp/test-results/bats/*.xml'
ifdef GITHUB_ACCESS_TOKEN tmp/xunit-reader -p 'tmp/test-results/shellcheck/*.xml'
ifneq ($(TRAVIS_PULL_REQUEST),false)
tmp/xunit-to-github --skip-ok --job-url "$(TRAVIS_JOB_WEB_URL)" --pull-request-id "$(TRAVIS_PULL_REQUEST)" --repository-slug "$(TRAVIS_REPO_SLUG)" --title "DOKKU_VERSION=$(DOKKU_VERSION)" tmp/test-results/bats tmp/test-results/shellcheck .PHONY: clean
endif clean:
endif rm -f README.md
endif
.PHONY: generate
generate: clean README.md
.PHONY: README.md
README.md:
bin/generate

877
README.md
View File

@@ -1,235 +1,746 @@
# dokku redis [![Build Status](https://img.shields.io/travis/dokku/dokku-redis.svg?branch=master "Build Status")](https://travis-ci.org/dokku/dokku-redis) [![IRC Network](https://img.shields.io/badge/irc-freenode-blue.svg "IRC Freenode")](https://webchat.freenode.net/?channels=dokku) # dokku redis [![Build Status](https://img.shields.io/github/actions/workflow/status/dokku/dokku-redis/ci.yml?branch=master&style=flat-square "Build Status")](https://github.com/dokku/dokku-redis/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 redis plugin for dokku. Currently defaults to installing [redis 5.0.5](https://hub.docker.com/_/redis/). Official redis plugin for dokku. Currently defaults to installing [redis 7.2.4](https://hub.docker.com/_/redis/).
## requirements ## Requirements
- dokku 0.12.x+ - dokku 0.19.x+
- docker 1.8.x - docker 1.8.x
## installation ## Installation
```shell ```shell
# on 0.12.x+ # on 0.19.x+
sudo dokku plugin:install https://github.com/dokku/dokku-redis.git redis sudo dokku plugin:install https://github.com/dokku/dokku-redis.git redis
``` ```
## commands ## Commands
``` ```
redis:app-links <app> List all redis service links for a given app redis:app-links <app> # list all redis service links for a given app
redis:backup <name> <bucket> (--use-iam) Create a backup of the redis service to an existing s3 bucket redis:backup <service> <bucket-name> [--use-iam] # create a backup of the redis service to an existing s3 bucket
redis:backup-auth <name> <aws_access_key_id> <aws_secret_access_key> (<aws_default_region>) (<aws_signature_version>) (<endpoint_url>) Sets up authentication for backups on the redis service redis: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 redis service
redis:backup-deauth <name> Removes backup authentication for the redis service redis:backup-deauth <service> # remove backup authentication for the redis service
redis:backup-schedule <name> <schedule> <bucket> Schedules a backup of the redis service redis:backup-schedule <service> <schedule> <bucket-name> [--use-iam] # schedule a backup of the redis service
redis:backup-schedule-cat <name> Cat the contents of the configured backup cronfile for the service redis:backup-schedule-cat <service> # cat the contents of the configured backup cronfile for the service
redis:backup-set-encryption <name> <passphrase> Set a GPG passphrase for backups redis:backup-set-encryption <service> <passphrase> # set encryption for all future backups of redis service
redis:backup-unschedule <name> Unschedules the backup of the redis service redis:backup-unschedule <service> # unschedule the backup of the redis service
redis:backup-unset-encryption <name> Removes backup encryption for future backups of the redis service redis:backup-unset-encryption <service> # unset encryption for future backups of the redis service
redis:clone <name> <new-name> Create container <new-name> then copy data from <name> into <new-name> redis:clone <service> <new-service> [--clone-flags...] # create container <new-name> then copy data from <name> into <new-name>
redis:connect <name> Connect via redis-cli to a redis service redis:connect <service> # connect to the service via the redis connection tool
redis:create <name> Create a redis service with environment variables redis:create <service> [--create-flags...] # create a redis service
redis:destroy <name> Delete the service, delete the data and stop its container if there are no links left redis:destroy <service> [-f|--force] # delete the redis service/data/container if there are no links left
redis:enter <name> [command] Enter or run a command in a running redis service container redis:enter <service> # enter or run a command in a running redis service container
redis:exists <service> Check if the redis service exists redis:exists <service> # check if the redis service exists
redis:export <name> > <file> Export a dump of the redis service database redis:export <service> # export a dump of the redis service database
redis:expose <name> [port] Expose a redis service on custom port if provided (random port otherwise) redis:expose <service> <ports...> # expose a redis service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)
redis:import <name> <file> Import a dump into the redis service database redis:import <service> # import a dump into the redis service database
redis:info <name> Print the connection information redis:info <service> [--single-info-flag] # print the service information
redis:link <name> <app> Link the redis service to the app redis:link <service> <app> [--link-flags...] # link the redis service to the app
redis:linked <name> <app> Check if the redis service is linked to an app redis:linked <service> <app> # check if the redis service is linked to an app
redis:list List all redis services redis:links <service> # list all apps linked to the redis service
redis:logs <name> [-t] Print the most recent log(s) for this service redis:list # list all redis services
redis:promote <name> <app> Promote service <name> as REDIS_URL in <app> redis:logs <service> [-t|--tail] <tail-num-optional> # print the most recent log(s) for this service
redis:restart <name> Graceful shutdown and restart of the redis service container redis:pause <service> # pause a running redis service
redis:start <name> Start a previously stopped redis service redis:promote <service> <app> # promote service <service> as REDIS_URL in <app>
redis:stop <name> Stop a running redis service redis:restart <service> # graceful shutdown and restart of the redis service container
redis:unexpose <name> Unexpose a previously exposed redis service redis:set <service> <key> <value> # set or clear a property for a service
redis:unlink <name> <app> Unlink the redis service from the app redis:start <service> # start a previously stopped redis service
redis:upgrade <name> Upgrade service <service> to the specified version redis:stop <service> # stop a running redis service
redis:unexpose <service> # unexpose a previously exposed redis service
redis:unlink <service> <app> # unlink the redis service from the app
redis:upgrade <service> [--upgrade-flags...] # upgrade service <service> to the specified versions
``` ```
## usage ## Usage
Help for any commands can be displayed by specifying the command as an argument to redis:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `redis:help` command for any undocumented commands.
### Basic Usage
### create a redis service
```shell ```shell
# create a redis service named lolipop # usage
dokku redis:create lolipop dokku redis:create <service> [--create-flags...]
```
# you can also specify the image and image flags:
# version to use for the service
# it *must* be compatible with the - `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: `None`)
# official redis image - `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with
- `-i|--image IMAGE`: the image name to start the service with
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
- `-p|--password PASSWORD`: override the user-level service password
- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation
- `-r|--root-password PASSWORD`: override the root-level service password
- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start
- `-s|--shm-size SHM_SIZE`: override shared memory size for redis docker container
Create a redis service named lollipop:
```shell
dokku redis:create lollipop
```
You can also specify the image and image version to use for the service. It *must* be compatible with the redis image.
```shell
export REDIS_IMAGE="redis" export REDIS_IMAGE="redis"
export REDIS_IMAGE_VERSION="2.8.21" export REDIS_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
dokku redis:create lolipop dokku redis:create lollipop
```
# you can also specify custom environment You can also specify custom environment variables to start the redis service in semicolon-separated form.
# variables to start the redis service
# in semi-colon separated form ```shell
export REDIS_CUSTOM_ENV="USER=alpha;HOST=beta" export REDIS_CUSTOM_ENV="USER=alpha;HOST=beta"
dokku redis:create lolipop dokku redis:create lollipop
```
# get connection information as follows ### print the service information
dokku redis:info lolipop
# you can also retrieve a specific piece of service info via flags ```shell
dokku redis:info lolipop --config-dir # usage
dokku redis:info lolipop --data-dir dokku redis:info <service> [--single-info-flag]
dokku redis:info lolipop --dsn ```
dokku redis:info lolipop --exposed-ports
dokku redis:info lolipop --id
dokku redis:info lolipop --internal-ip
dokku redis:info lolipop --links
dokku redis:info lolipop --service-root
dokku redis:info lolipop --status
dokku redis:info lolipop --version
# a bash prompt can be opened against a running service flags:
# filesystem changes will not be saved to disk
dokku redis:enter lolipop
# you may also run a command directly against the service - `--config-dir`: show the service configuration directory
# filesystem changes will not be saved to disk - `--data-dir`: show the service data directory
dokku redis:enter lolipop ls -lah / - `--dsn`: show the service DSN
- `--exposed-ports`: show service exposed ports
- `--id`: show the service container id
- `--internal-ip`: show the service internal ip
- `--initial-network`: show the initial network being connected to
- `--links`: show the service app links
- `--post-create-network`: show the networks to attach to after service container creation
- `--post-start-network`: show the networks to attach to after service container start
- `--service-root`: show the service root directory
- `--status`: show the service running status
- `--version`: show the service image version
# a redis service can be linked to a Get connection information as follows:
# container this will use native docker
# links via the docker-options plugin
# here we link it to our 'playground' app
# NOTE: this will restart your app
dokku redis:link lolipop playground
# the following environment variables will be set automatically by docker (not ```shell
# on the app itself, so they wont be listed when calling dokku config) dokku redis:info lollipop
# ```
# DOKKU_REDIS_LOLIPOP_NAME=/lolipop/DATABASE
# DOKKU_REDIS_LOLIPOP_PORT=tcp://172.17.0.1:6379
# DOKKU_REDIS_LOLIPOP_PORT_6379_TCP=tcp://172.17.0.1:6379
# DOKKU_REDIS_LOLIPOP_PORT_6379_TCP_PROTO=tcp
# DOKKU_REDIS_LOLIPOP_PORT_6379_TCP_PORT=6379
# DOKKU_REDIS_LOLIPOP_PORT_6379_TCP_ADDR=172.17.0.1
#
# and the following will be set on the linked application by default
#
# REDIS_URL=redis://lolipop:SOME_PASSWORD@dokku-redis-lolipop:6379
#
# NOTE: the host exposed here only works internally in docker containers. If
# you want your container to be reachable from outside, you should use `expose`.
# another service can be linked to your app You can also retrieve a specific piece of service info via flags:
```shell
dokku redis:info lollipop --config-dir
dokku redis:info lollipop --data-dir
dokku redis:info lollipop --dsn
dokku redis:info lollipop --exposed-ports
dokku redis:info lollipop --id
dokku redis:info lollipop --internal-ip
dokku redis:info lollipop --initial-network
dokku redis:info lollipop --links
dokku redis:info lollipop --post-create-network
dokku redis:info lollipop --post-start-network
dokku redis:info lollipop --service-root
dokku redis:info lollipop --status
dokku redis:info lollipop --version
```
### list all redis services
```shell
# usage
dokku redis:list
```
List all services:
```shell
dokku redis:list
```
### print the most recent log(s) for this service
```shell
# usage
dokku redis:logs <service> [-t|--tail] <tail-num-optional>
```
flags:
- `-t|--tail [<tail-num>]`: do not stop when end of the logs are reached and wait for additional output
You can tail logs for a particular service:
```shell
dokku redis:logs lollipop
```
By default, logs will not be tailed, but you can do this with the --tail flag:
```shell
dokku redis:logs lollipop --tail
```
The default tail setting is to show all logs, but an initial count can also be specified:
```shell
dokku redis:logs lollipop --tail 5
```
### link the redis service to the app
```shell
# usage
dokku redis:link <service> <app> [--link-flags...]
```
flags:
- `-a|--alias "BLUE_DATABASE"`: an alternative alias to use for linking to an app via environment variable
- `-q|--querystring "pool=5"`: ampersand delimited querystring arguments to append to the service link
- `-n|--no-restart "false"`: whether or not to restart the app on link (default: true)
A redis service can be linked to a container. This will use native docker links via the docker-options plugin. Here we link it to our `playground` app.
> NOTE: this will restart your app
```shell
dokku redis:link lollipop playground
```
The following environment variables will be set automatically by docker (not on the app itself, so they wont be listed when calling dokku config):
```
DOKKU_REDIS_LOLLIPOP_NAME=/lollipop/DATABASE
DOKKU_REDIS_LOLLIPOP_PORT=tcp://172.17.0.1:6379
DOKKU_REDIS_LOLLIPOP_PORT_6379_TCP=tcp://172.17.0.1:6379
DOKKU_REDIS_LOLLIPOP_PORT_6379_TCP_PROTO=tcp
DOKKU_REDIS_LOLLIPOP_PORT_6379_TCP_PORT=6379
DOKKU_REDIS_LOLLIPOP_PORT_6379_TCP_ADDR=172.17.0.1
```
The following will be set on the linked application by default:
```
REDIS_URL=redis://:SOME_PASSWORD@dokku-redis-lollipop:6379
```
The host exposed here only works internally in docker containers. If you want your container to be reachable from outside, you should use the `expose` subcommand. Another service can be linked to your app:
```shell
dokku redis:link other_service playground dokku redis:link other_service playground
# since REDIS_URL is already in use, another environment variable will be
# generated automatically
#
# DOKKU_REDIS_BLUE_URL=redis://other_service:ANOTHER_PASSWORD@dokku-redis-other-service:6379
# you can then promote the new service to be the primary one
# NOTE: this will restart your app
dokku redis:promote other_service playground
# this will replace REDIS_URL with the url from other_service and generate
# another environment variable to hold the previous value if necessary.
# you could end up with the following for example:
#
# REDIS_URL=redis://other_service:ANOTHER_PASSWORD@dokku-redis-other-service:6379
# DOKKU_REDIS_BLUE_URL=redis://other_service:ANOTHER_PASSWORD@dokku-redis-other-service:6379
# DOKKU_REDIS_SILVER_URL=redis://lolipop:SOME_PASSWORD@dokku-redis-lolipop:6379/lolipop
# you can also unlink a redis service
# NOTE: this will restart your app and unset related environment variables
dokku redis:unlink lolipop playground
# you can tail logs for a particular service
dokku redis:logs lolipop
dokku redis:logs lolipop -t # to tail
# you can dump the database
dokku redis:export lolipop > lolipop.rdb
# you can import a dump
dokku redis:import lolipop < database.rdb
# you can clone an existing database to a new one
dokku redis:clone lolipop new_database
# finally, you can destroy the container
dokku redis:destroy lolipop
``` ```
## Changing database adapter It is possible to change the protocol for `REDIS_URL` by setting the environment variable `REDIS_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's possible to change the protocol for REDIS_URL by setting ```shell
the environment variable REDIS_DATABASE_SCHEME on the app:
```
dokku config:set playground REDIS_DATABASE_SCHEME=redis2 dokku config:set playground REDIS_DATABASE_SCHEME=redis2
dokku redis:link lolipop playground dokku redis:link lollipop playground
``` ```
Will cause REDIS_URL to be set as This will cause `REDIS_URL` to be set as:
redis2://lolipop:SOME_PASSWORD@dokku-redis-lolipop:6379/lolipop
CAUTION: Changing REDIS_DATABASE_SCHEME after linking will cause dokku to ```
believe the redis is not linked when attempting to use `dokku redis:unlink` redis2://:SOME_PASSWORD@dokku-redis-lollipop:6379
or `dokku redis:promote`. ```
You should be able to fix this by
- Changing REDIS_URL manually to the new value. ### unlink the redis service from the app
OR ```shell
# usage
dokku redis:unlink <service> <app>
```
- Set REDIS_DATABASE_SCHEME back to its original setting flags:
- Unlink the service
- Change REDIS_DATABASE_SCHEME to the desired setting
- Relink the service
## Backups - `-n|--no-restart "false"`: whether or not to restart the app on unlink (default: true)
You can unlink a redis service:
> NOTE: this will restart your app and unset related environment variables
```shell
dokku redis:unlink lollipop playground
```
### set or clear a property for a service
```shell
# usage
dokku redis:set <service> <key> <value>
```
Set the network to attach after the service container is started:
```shell
dokku redis:set lollipop post-create-network custom-network
```
Set multiple networks:
```shell
dokku redis:set lollipop post-create-network custom-network,other-network
```
Unset the post-create-network value:
```shell
dokku redis:set lollipop post-create-network
```
### Service Lifecycle
The lifecycle of each service can be managed through the following commands:
### connect to the service via the redis connection tool
```shell
# usage
dokku redis:connect <service>
```
Connect to the service via the redis connection tool:
> NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098
```shell
dokku redis:connect lollipop
```
### enter or run a command in a running redis service container
```shell
# usage
dokku redis:enter <service>
```
A bash prompt can be opened against a running service. Filesystem changes will not be saved to disk.
> NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098
```shell
dokku redis:enter lollipop
```
You may also run a command directly against the service. Filesystem changes will not be saved to disk.
```shell
dokku redis:enter lollipop touch /tmp/test
```
### expose a redis service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)
```shell
# usage
dokku redis:expose <service> <ports...>
```
Expose the service on the service's normal ports, allowing access to it from the public interface (`0.0.0.0`):
```shell
dokku redis:expose lollipop 6379
```
Expose the service on the service's normal ports, with the first on a specified ip adddress (127.0.0.1):
```shell
dokku redis:expose lollipop 127.0.0.1:6379
```
### unexpose a previously exposed redis service
```shell
# usage
dokku redis:unexpose <service>
```
Unexpose the service, removing access to it from the public interface (`0.0.0.0`):
```shell
dokku redis:unexpose lollipop
```
### promote service <service> as REDIS_URL in <app>
```shell
# usage
dokku redis:promote <service> <app>
```
If you have a redis service linked to an app and try to link another redis service another link environment variable will be generated automatically:
```
DOKKU_REDIS_BLUE_URL=redis://:ANOTHER_PASSWORD@dokku-redis-other-service:6379/other_service
```
You can promote the new service to be the primary one:
> NOTE: this will restart your app
```shell
dokku redis:promote other_service playground
```
This will replace `REDIS_URL` with the url from other_service and generate another environment variable to hold the previous value if necessary. You could end up with the following for example:
```
REDIS_URL=redis://:ANOTHER_PASSWORD@dokku-redis-other-service:6379/other_service
DOKKU_REDIS_BLUE_URL=redis://:ANOTHER_PASSWORD@dokku-redis-other-service:6379/other_service
DOKKU_REDIS_SILVER_URL=redis://:SOME_PASSWORD@dokku-redis-lollipop:6379/lollipop
```
### start a previously stopped redis service
```shell
# usage
dokku redis:start <service>
```
Start the service:
```shell
dokku redis:start lollipop
```
### stop a running redis service
```shell
# usage
dokku redis:stop <service>
```
Stop the service and removes the running container:
```shell
dokku redis:stop lollipop
```
### pause a running redis service
```shell
# usage
dokku redis:pause <service>
```
Pause the running container for the service:
```shell
dokku redis:pause lollipop
```
### graceful shutdown and restart of the redis service container
```shell
# usage
dokku redis:restart <service>
```
Restart the service:
```shell
dokku redis:restart lollipop
```
### upgrade service <service> to the specified versions
```shell
# usage
dokku redis:upgrade <service> [--upgrade-flags...]
```
flags:
- `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: `None`)
- `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with
- `-i|--image IMAGE`: the image name to start the service with
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation
- `-R|--restart-apps "true"`: whether or not to force an app restart (default: false)
- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start
- `-s|--shm-size SHM_SIZE`: override shared memory size for redis docker container
You can upgrade an existing service to a new image or image-version:
```shell
dokku redis:upgrade lollipop
```
### Service Automation
Service scripting can be executed using the following commands:
### list all redis service links for a given app
```shell
# usage
dokku redis:app-links <app>
```
List all redis services that are linked to the `playground` app.
```shell
dokku redis:app-links playground
```
### create container <new-name> then copy data from <name> into <new-name>
```shell
# usage
dokku redis:clone <service> <new-service> [--clone-flags...]
```
flags:
- `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: `None`)
- `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with
- `-i|--image IMAGE`: the image name to start the service with
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
- `-p|--password PASSWORD`: override the user-level service password
- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation
- `-r|--root-password PASSWORD`: override the root-level service password
- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start
- `-s|--shm-size SHM_SIZE`: override shared memory size for redis docker container
You can clone an existing service to a new one:
```shell
dokku redis:clone lollipop lollipop-2
```
### check if the redis service exists
```shell
# usage
dokku redis:exists <service>
```
Here we check if the lollipop redis service exists.
```shell
dokku redis:exists lollipop
```
### check if the redis service is linked to an app
```shell
# usage
dokku redis:linked <service> <app>
```
Here we check if the lollipop redis service is linked to the `playground` app.
```shell
dokku redis:linked lollipop playground
```
### list all apps linked to the redis service
```shell
# usage
dokku redis:links <service>
```
List all apps linked to the `lollipop` redis service.
```shell
dokku redis:links lollipop
```
### Data Management
The underlying service data can be imported and exported with the following commands:
### import a dump into the redis service database
```shell
# usage
dokku redis:import <service>
```
Import a datastore dump:
```shell
dokku redis:import lollipop < data.dump
```
### export a dump of the redis service database
```shell
# usage
dokku redis:export <service>
```
By default, datastore output is exported to stdout:
```shell
dokku redis:export lollipop
```
You can redirect this output to a file:
```shell
dokku redis:export lollipop > data.dump
```
### Backups
Datastore backups are supported via AWS S3 and S3 compatible services like [minio](https://github.com/minio/minio). Datastore backups are supported via AWS S3 and S3 compatible services like [minio](https://github.com/minio/minio).
You may skip the `backup-auth` step if your dokku install is running within EC2 You may skip the `backup-auth` step if your dokku install is running within EC2 and has access to the bucket via an IAM profile. In that case, use the `--use-iam` option with the `backup` command.
and has access to the bucket via an IAM profile. In that case, use the `--use-iam`
option with the `backup` command.
Backups can be performed using the backup commands: Backups can be performed using the backup commands:
``` ### set up authentication for backups on the redis service
# setup s3 backup authentication
dokku redis:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
# remove s3 authentication ```shell
dokku redis:backup-deauth lolipop # usage
dokku redis:backup-auth <service> <aws-access-key-id> <aws-secret-access-key> <aws-default-region> <aws-signature-version> <endpoint-url>
# backup the `lolipop` service to the `BUCKET_NAME` bucket on AWS
dokku redis:backup lolipop BUCKET_NAME
# schedule a backup
# CRON_SCHEDULE is a crontab expression, eg. "0 3 * * *" for each day at 3am
dokku redis:backup-schedule lolipop CRON_SCHEDULE BUCKET_NAME
# cat the contents of the configured backup cronfile for the service
dokku redis:backup-schedule-cat lolipop
# remove the scheduled backup from cron
dokku redis:backup-unschedule lolipop
``` ```
Backup auth can also be set up for different regions, signature versions and endpoints (e.g. for minio): Setup s3 backup authentication:
``` ```shell
# setup s3 backup authentication with different region dokku redis:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
dokku redis:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
# setup s3 backup authentication with different signature version and endpoint
dokku redis:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL
# more specific example for minio auth
dokku redis:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
``` ```
## Disabling `docker pull` calls Setup s3 backup authentication with different region:
If you wish to disable the `docker pull` calls that the plugin triggers, you may set the `REDIS_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. ```shell
dokku redis:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
```
Please ensure the proper images are in place when `docker pull` is disabled. Setup s3 backup authentication with different signature version and endpoint:
```shell
dokku redis:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL
```
More specific example for minio auth:
```shell
dokku redis:backup-auth lollipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
```
### remove backup authentication for the redis service
```shell
# usage
dokku redis:backup-deauth <service>
```
Remove s3 authentication:
```shell
dokku redis:backup-deauth lollipop
```
### create a backup of the redis service to an existing s3 bucket
```shell
# usage
dokku redis:backup <service> <bucket-name> [--use-iam]
```
flags:
- `-u|--use-iam`: use the IAM profile associated with the current server
Backup the `lollipop` service to the `my-s3-bucket` bucket on `AWS`:`
```shell
dokku redis:backup lollipop my-s3-bucket --use-iam
```
Restore a backup file (assuming it was extracted via `tar -xf backup.tgz`):
```shell
dokku redis:import lollipop < backup-folder/export
```
### set encryption for all future backups of redis service
```shell
# usage
dokku redis:backup-set-encryption <service> <passphrase>
```
Set the GPG-compatible passphrase for encrypting backups for backups:
```shell
dokku redis:backup-set-encryption lollipop
```
### unset encryption for future backups of the redis service
```shell
# usage
dokku redis:backup-unset-encryption <service>
```
Unset the `GPG` encryption passphrase for backups:
```shell
dokku redis:backup-unset-encryption lollipop
```
### schedule a backup of the redis service
```shell
# usage
dokku redis:backup-schedule <service> <schedule> <bucket-name> [--use-iam]
```
flags:
- `-u|--use-iam`: use the IAM profile associated with the current server
Schedule a backup:
> 'schedule' is a crontab expression, eg. "0 3 * * *" for each day at 3am
```shell
dokku redis:backup-schedule lollipop "0 3 * * *" my-s3-bucket
```
Schedule a backup and authenticate via iam:
```shell
dokku redis:backup-schedule lollipop "0 3 * * *" my-s3-bucket --use-iam
```
### cat the contents of the configured backup cronfile for the service
```shell
# usage
dokku redis:backup-schedule-cat <service>
```
Cat the contents of the configured backup cronfile for the service:
```shell
dokku redis:backup-schedule-cat lollipop
```
### unschedule the backup of the redis service
```shell
# usage
dokku redis:backup-unschedule <service>
```
Remove the scheduled backup from cron:
```shell
dokku redis:backup-unschedule lollipop
```
### Disabling `docker image pull` calls
If you wish to disable the `docker image pull` calls that the plugin triggers, you may set the `REDIS_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 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"

675
bin/generate Executable file
View File

@@ -0,0 +1,675 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
from __future__ import print_function
import os
import re
def compile(
service,
version,
variable,
alias,
image,
scheme,
ports,
sponsors,
options,
unimplemented,
dokku_version,
):
prefix = "\n\n".join(
[
header(service),
description(service, image, version),
]
)
if len(sponsors) > 0:
prefix += "\n\n"
prefix += sponsors_section(service, sponsors)
return (
"\n\n".join(
[
prefix,
requirements_section(dokku_version),
installation_section(service, dokku_version),
commands_section(
service, variable, alias, image, scheme, ports, unimplemented
),
usage_section(
service,
variable,
alias,
image,
scheme,
ports,
options,
unimplemented,
),
]
)
.replace("\n\n\n\n\n", "\n")
.replace("\n\n\n\n", "\n")
.replace("\n\n\n", "\n\n")
)
def header(service):
return " ".join(
[
f"# dokku {service}",
f'[![Build Status](https://img.shields.io/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)',
]
)
def description(service, full_image, version):
base = "_"
image = full_image
if "/" in full_image:
base = "r/" + full_image.split("/")[0]
image = full_image.split("/")[1]
return f"Official {service} plugin for dokku. Currently defaults to installing [{full_image} {version}](https://hub.docker.com/{base}/{image}/)."
def sponsors_section(service, sponsors):
if len(sponsors) == 0:
return ""
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])
return "\n".join(sponsor_data)
def requirements_section(dokku_version):
return "\n".join(
[
"## Requirements",
"",
f"- dokku {dokku_version}",
"- docker 1.8.x",
]
)
def installation_section(service, dokku_version):
return "\n".join(
[
"## Installation",
"",
"```shell",
f"# on {dokku_version}",
f"sudo dokku plugin:install https://github.com/dokku/dokku-{service}.git {service}",
"```",
]
)
def commands_section(service, variable, alias, image, scheme, ports, unimplemented):
content = [
"## Commands",
"",
"```",
]
subcommands = os.listdir("subcommands")
subcommands.sort()
command_list = []
descriptions = []
for filename in subcommands:
if filename in unimplemented:
continue
data = command_data(filename, service, variable, alias, image, scheme, ports)
description = data["description"]
arguments = data["arguments_string"]
command_list.append(f"{service}:{filename} {arguments}")
descriptions.append(description)
maxlen = max(map(len, command_list))
if maxlen > 50:
maxlen = 50
for command, description in zip(command_list, descriptions):
space_count = maxlen - len(command)
content.append("{0}{1} # {2}".format(command, " " * space_count, description))
content.append("```")
return "\n".join(content)
def usage_section(
service, variable, alias, image, scheme, ports, options, unimplemented
):
return "\n\n".join(
[
"## Usage",
f"Help for any commands can be displayed by specifying the command as an argument to {service}:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `{service}:help` command for any undocumented commands.",
usage_intro(
service, variable, alias, image, scheme, ports, options, unimplemented
),
usage_lifecycle(
service, variable, alias, image, scheme, ports, options, unimplemented
),
usage_automation(
service, variable, alias, image, scheme, ports, options, unimplemented
),
usage_data_management(
service, variable, alias, image, scheme, ports, options, unimplemented
),
usage_backup(
service, variable, alias, image, scheme, ports, options, unimplemented
),
usage_docker_pull(
service, variable, alias, image, scheme, ports, options, unimplemented
),
]
)
def usage_intro(service, variable, alias, image, scheme, ports, options, unimplemented):
commands = ["create", "info", "list", "logs", "link", "unlink", "set"]
content = ["### Basic Usage"]
return fetch_commands_content(
service,
variable,
alias,
image,
scheme,
ports,
options,
unimplemented,
commands,
content,
)
def usage_lifecycle(
service, variable, alias, image, scheme, ports, options, unimplemented
):
commands = [
"connect",
"enter",
"expose",
"unexpose",
"promote",
"start",
"stop",
"pause",
"restart",
"upgrade",
]
content = [
"### Service Lifecycle",
"",
"The lifecycle of each service can be managed through the following commands:",
"",
]
return fetch_commands_content(
service,
variable,
alias,
image,
scheme,
ports,
options,
unimplemented,
commands,
content,
)
def usage_automation(
service, variable, alias, image, scheme, ports, options, unimplemented
):
commands = ["app-links", "clone", "exists", "linked", "links"]
content = [
"### Service Automation",
"",
"Service scripting can be executed using the following commands:",
"",
]
return fetch_commands_content(
service,
variable,
alias,
image,
scheme,
ports,
options,
unimplemented,
commands,
content,
)
def usage_data_management(
service, variable, alias, image, scheme, ports, options, unimplemented
):
commands = ["import", "export"]
content = [
"### Data Management",
"",
"The underlying service data can be imported and exported with the following commands:",
"",
]
return fetch_commands_content(
service,
variable,
alias,
image,
scheme,
ports,
options,
unimplemented,
commands,
content,
)
def usage_backup(
service, variable, alias, image, scheme, ports, options, unimplemented
):
commands = [
"backup-auth",
"backup-deauth",
"backup",
"backup-set-encryption",
"backup-unset-encryption",
"backup-schedule",
"backup-schedule-cat",
"backup-unschedule",
]
content = [
"### Backups",
"",
"Datastore backups are supported via AWS S3 and S3 compatible services like [minio](https://github.com/minio/minio).",
"",
"You may skip the `backup-auth` step if your dokku install is running within EC2 and has access to the bucket via an IAM profile. In that case, use the `--use-iam` option with the `backup` command.",
"",
"Backups can be performed using the backup commands:",
"",
]
return fetch_commands_content(
service,
variable,
alias,
image,
scheme,
ports,
options,
unimplemented,
commands,
content,
)
def usage_docker_pull(
service, variable, alias, image, scheme, ports, options, unimplemented
):
service_prefix = service.upper()
return "\n".join(
[
"### Disabling `docker image pull` calls",
"",
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 image pull` is disabled.",
]
)
def fetch_commands_content(
service,
variable,
alias,
image,
scheme,
ports,
options,
unimplemented,
commands,
content,
):
i = 0
for command in commands:
output = command_help(
command,
service,
variable,
alias,
image,
scheme,
ports,
options,
unimplemented,
)
if output == "":
continue
content.append(output)
i += 1
if i == 0:
return ""
return "\n".join(content)
def parse_args(line):
line = line.strip()
arguments = []
for arg in re.findall("([A-Z_]+)", line):
arg = arg.replace("_", "-").lower()
if arg.endswith("optional-flag"):
arg = arg.replace("-optional-flag", "")
arguments.append(f"[--{arg}]")
elif arg.endswith("-flag"):
if arg == "info-flag":
arguments.append(f"[--single-info-flag]")
else:
arg = arg.replace("-flag", "")
first_letter = arg[0]
arguments.append(f"[-{first_letter}|--{arg}]")
elif arg.endswith("-flags-list"):
arg = arg.replace("-list", "")
arguments.append(f"[--{arg}...]")
elif arg.endswith("list"):
arg = arg.replace("-list", "")
arguments.append(f"<{arg}...>")
else:
arguments.append(f"<{arg}>")
return " ".join(arguments)
def command_help(
command, service, variable, alias, image, scheme, ports, options, unimplemented
):
if command in unimplemented:
return ""
data = command_data(command, service, variable, alias, image, scheme, ports)
content = [
f"### {data['description']}",
"",
"```shell",
"# usage",
f"dokku {service}:{command} {data['arguments_string']}".strip(),
"```",
]
# if len(data["arguments"]) > 0:
# content.append("")
# content.append("arguments:")
# content.append("")
# for argument in data["arguments"]:
# content.append(f"- {argument}")
if len(data["flags"]) > 0:
content.append("")
content.append("flags:")
content.append("")
for flag in data["flags"]:
if "--config-options" in flag and options != "":
flag = f"{flag} (default: `{options}`)"
content.append(f"- {flag}")
if len(data["examples"]) > 0:
content.append("")
content.append(data["examples"])
doc_file = os.path.join("docs", f"{command}.md")
if os.path.isfile(doc_file):
content.append("")
with open(doc_file) as f:
content.append(f.read())
return "\n" + "\n".join(content)
def command_data(command, service, variable, alias, image, scheme, ports):
description = None
arguments = []
arguments_string = ""
example_lines = []
flags = []
with open(os.path.join("subcommands", command)) as f:
for line in f.readlines():
line = line.strip()
line = line.replace("$PLUGIN_SERVICE", service)
line = line.replace("$PLUGIN_COMMAND_PREFIX", service)
line = line.replace("${PLUGIN_COMMAND_PREFIX}", service)
line = line.replace("${PLUGIN_VARIABLE}", variable)
line = line.replace("${PLUGIN_DEFAULT_ALIAS}", alias)
line = line.replace("${PLUGIN_IMAGE}", image)
line = line.replace("${PLUGIN_SCHEME}", scheme)
line = line.replace("${PLUGIN_DATASTORE_PORTS[0]}", ports[0])
line = line.replace("${PLUGIN_DATASTORE_PORTS[@]}", " ".join(ports))
if "declare desc" in line:
description = re.search('"(.+)"', line).group(1)
elif "$1" in line:
arguments_string = parse_args(line)
elif line.startswith("#A "):
argument = line.replace("#A ", "")
parts = [a.strip() for a in argument.split(",", 1)]
arguments.append(f"`{parts[0]}`: {parts[1]}")
elif line.startswith("#F "):
flag = line.replace("#F ", "")
parts = [a.strip() for a in flag.split(",", 1)]
flags.append(f"`{parts[0]}`: {parts[1]}")
elif line.startswith("#E "):
example_lines.append(line.replace("#E ", ""))
examples = []
sentence_lines = []
command_lines = []
codeblock_lines = []
blockquote_lines = []
for line in example_lines:
if line.startswith("export") or line.startswith("dokku"):
if len(blockquote_lines) > 0:
examples.append("\n" + process_blockquote(blockquote_lines))
blockquote_lines = []
if len(codeblock_lines) > 0:
examples.append("\n" + process_codeblock(codeblock_lines))
codeblock_lines = []
if len(sentence_lines) > 0:
examples.append("\n" + process_sentence(sentence_lines))
sentence_lines = []
command_lines.append(line)
elif line.startswith(" "):
if len(blockquote_lines) > 0:
examples.append("\n" + process_blockquote(blockquote_lines))
blockquote_lines = []
if len(command_lines) > 0:
examples.append("\n" + process_command(command_lines))
command_lines = []
if len(sentence_lines) > 0:
examples.append("\n" + process_sentence(sentence_lines))
sentence_lines = []
codeblock_lines.append(line.strip())
elif line.startswith(">"):
if len(codeblock_lines) > 0:
examples.append("\n" + process_codeblock(codeblock_lines))
codeblock_lines = []
if len(command_lines) > 0:
examples.append("\n" + process_command(command_lines))
command_lines = []
if len(sentence_lines) > 0:
examples.append("\n" + process_sentence(sentence_lines))
sentence_lines = []
blockquote_lines.append(line)
else:
if len(blockquote_lines) > 0:
examples.append("\n" + process_blockquote(blockquote_lines))
blockquote_lines = []
if len(codeblock_lines) > 0:
examples.append("\n" + process_codeblock(codeblock_lines))
codeblock_lines = []
if len(command_lines) > 0:
examples.append("\n" + process_command(command_lines))
command_lines = []
sentence_lines.append(line)
if len(blockquote_lines) > 0:
examples.append("\n" + process_blockquote(blockquote_lines))
blockquote_lines = []
if len(codeblock_lines) > 0:
examples.append("\n" + process_codeblock(codeblock_lines))
codeblock_lines = []
if len(command_lines) > 0:
examples.append("\n" + process_command(command_lines))
command_lines = []
if len(sentence_lines) > 0:
examples.append("\n" + process_sentence(sentence_lines))
sentence_lines = []
return {
"description": description,
"arguments_string": arguments_string,
"arguments": arguments,
"flags": flags,
"examples": "\n".join(examples).strip(),
}
def process_sentence(sentence_lines):
sentence_lines = " ".join(sentence_lines)
sentences = ". ".join(
upperfirst(i.strip()) for i in sentence_lines.split(". ")
).strip()
if not sentences.endswith(".") and not sentences.endswith(":"):
sentences += ":"
text = []
for sentence in sentences.split(". "):
parts = []
for word in sentence.strip().split(" "):
if word.isupper() and len(word) > 1:
for ending in [":", "."]:
if word.endswith(ending):
word = "`{0}`{1}".format(word[:-1], ending)
else:
word = "`{0}`".format(word)
parts.append(word)
text.append(" ".join(parts))
text = ". ".join(text)
# some cleanup
text = text.replace("(0.0.0.0)", "(`0.0.0.0`)")
text = text.replace("'", "`")
text = text.replace("`s", "'s")
text = text.replace("``", "`")
text = text.strip(" ")
return text
def upperfirst(x):
return x[:1].upper() + x[1:]
def process_blockquote(blockquote_lines):
return "\n".join(blockquote_lines)
def process_command(command_lines):
command_lines = "\n".join(command_lines)
return f"```shell\n{command_lines}\n```"
def process_codeblock(codeblock_lines):
codeblock_lines = "\n".join(codeblock_lines)
return f"```\n{codeblock_lines}\n```"
def main():
service = None
version = None
variable = None
image = None
alias = None
options = None
unimplemented = []
with open("Dockerfile") as f:
for line in f.readlines():
if "FROM " in line:
image, version = line.split(" ")[1].split(":")
image = image.strip()
version = version.strip()
with open("config") as f:
for line in f.readlines():
if "PLUGIN_COMMAND_PREFIX=" in line:
service = re.search('"(.+)"', line).group(1)
if "PLUGIN_DEFAULT_ALIAS=" in line:
alias = re.search('"(.+)"', line).group(1)
if "PLUGIN_VARIABLE=" in line:
variable = re.search('"(.+)"', line).group(1)
if "PLUGIN_SCHEME=" in line:
scheme = re.search('"(.+)"', line).group(1)
if "PLUGIN_DATASTORE_PORTS=" in line:
ports = re.search("\((.+)\)", line).group(1).split(" ")
if "PLUGIN_UNIMPLEMENTED_SUBCOMMANDS=" in line:
match = re.search("\((.+)\)", line)
if match is not None:
unimplemented = [s.strip('"') for s in match.group(1).split(" ")]
with open("config") as f:
for line in f.readlines():
if f"{variable}_CONFIG_OPTIONS" in line:
match = re.search('"(.+)"', line)
if match is not None:
options = match.group(1)
sponsors = []
with open("plugin.toml") as f:
for line in f.readlines():
if line.startswith("sponsors"):
sponsors = re.search('\[(["\w\s,_-]+)\]', line).group(1)
sponsors = [s.strip('"') for s in sponsors.split(",")]
text = compile(
service,
version,
variable,
alias,
image,
scheme,
ports,
sponsors,
options,
unimplemented,
"0.19.x+",
)
base_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
readme_file = os.path.join(base_path, "README.md")
with open(readme_file, "w") as f:
f.write(text + "\n")
if __name__ == "__main__":
main()

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

@@ -1,10 +1,91 @@
#!/usr/bin/env bash #!/usr/bin/env bash
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]} "
@@ -12,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
@@ -49,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
@@ -89,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
@@ -101,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"
@@ -119,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
docker exec -it "$ID" sh -c "$COMMAND" 2>/dev/null 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
@@ -136,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
@@ -153,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
@@ -169,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"
@@ -187,18 +279,18 @@ service_backup() {
dokku_log_fail "Provide AWS credentials or use the --use-iam flag" dokku_log_fail "Provide AWS credentials or use the --use-iam flag"
fi fi
TMPDIR=$(mktemp -d) BACKUP_TMPDIR=$(mktemp -d --tmpdir)
trap 'rm -rf "$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" >"${TMPDIR}/export") (service_export "$SERVICE" >"${BACKUP_TMPDIR}/export")
# Build parameter list for s3backup tool # Build parameter list for s3backup tool
BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e BUCKET_NAME=$BUCKET_NAME" BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e BUCKET_NAME=$BUCKET_NAME"
BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e BACKUP_NAME=${PLUGIN_COMMAND_PREFIX}-${SERVICE}" BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e BACKUP_NAME=${PLUGIN_COMMAND_PREFIX}-${SERVICE}"
BACKUP_PARAMETERS="$BACKUP_PARAMETERS -v ${TMPDIR}:/backup" BACKUP_PARAMETERS="$BACKUP_PARAMETERS -v ${BACKUP_TMPDIR}:/backup"
if [[ -f "$SERVICE_BACKUP_ROOT/AWS_DEFAULT_REGION" ]]; then if [[ -f "$SERVICE_BACKUP_ROOT/AWS_DEFAULT_REGION" ]]; then
BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e AWS_DEFAULT_REGION=$(cat "$SERVICE_BACKUP_ROOT/AWS_DEFAULT_REGION")" BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e AWS_DEFAULT_REGION=$(cat "$SERVICE_BACKUP_ROOT/AWS_DEFAULT_REGION")"
@@ -217,11 +309,62 @@ service_backup() {
fi fi
# shellcheck disable=SC2086 # shellcheck disable=SC2086
docker run --rm $BACKUP_PARAMETERS dokku/s3backup:0.10.0 "$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"
@@ -243,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/"
@@ -281,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/"
@@ -291,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}"
@@ -299,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/"
@@ -308,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"
@@ -362,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
@@ -373,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")
@@ -382,19 +545,23 @@ service_info() {
local flag key valid_flags local flag key valid_flags
local flag_map=( local flag_map=(
"--config-dir: ${SERVICE_ROOT}/config" "--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 "Container 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#*: }")"
@@ -412,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")
@@ -426,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")
@@ -452,9 +619,8 @@ service_link() {
fi fi
[[ -n $LINK ]] && dokku_log_fail "Already linked as $LINK" [[ -n $LINK ]] && dokku_log_fail "Already linked as $LINK"
touch "$LINKS_FILE" plugn trigger service-action pre-link "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
echo "$APP" >>"$LINKS_FILE" add_to_links_file "$SERVICE" "$APP"
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
@@ -464,11 +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}"
config_set "$APP" "${ALIAS}_URL=$SERVICE_URL" plugn trigger service-action post-link "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
if [[ "$DOKKU_GLOBAL_FLAGS" == *"--no-restart"* ]] || [[ "$SERVICE_RESTART_APPS" == "false" ]]; then
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"
@@ -480,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"
@@ -492,40 +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
dokku_log_warn "There are no $PLUGIN_SERVICE services"
else
LIST=""
if [[ -z "$DOKKU_QUIET_OUTPUT" ]]; then
LIST="NAME,VERSION,STATUS,EXPOSED PORTS,LINKS\n"
fi
for SERVICE in $SERVICES; do mapfile -t services < <(fn-services-list true)
LIST+="$SERVICE,$(service_version "$SERVICE"),$(service_status "$SERVICE"),$(service_exposed_ports "$SERVICE"),$(service_linked_apps "$SERVICE")\n" if [[ "${#services[@]}" -eq 0 ]] || [[ -z "$services" ]]; then
done dokku_log_warn "There are no $PLUGIN_SERVICE services"
printf "%b" "$LIST" | column -t -s, return
fi fi
dokku_log_info2_quiet "$PLUGIN_SERVICE services"
for service in "${services[@]}"; do
echo "${service}"
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() {
@@ -542,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^^}"
@@ -578,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#"?"}
;; ;;
@@ -590,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
;; ;;
@@ -599,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"
@@ -609,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"
@@ -619,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" dokku/ambassador:0.3.0 >/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")
@@ -724,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"
@@ -734,43 +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
is_container_status "$ID" "Dead" && echo "dead" && return 0 CONTAINER_STATUS=$("$DOCKER_BIN" container inspect -f "{{.State.Status}}" "$ID" 2>/dev/null || true)
is_container_status "$ID" "OOMKilled" && echo "oomkilled" && return 0
is_container_status "$ID" "Paused" && echo "paused" && return 0
is_container_status "$ID" "Restarting" && echo "restarting" && return 0
is_container_status "$ID" "Running" && echo "running" && return 0
CONTAINER_STATUS=$(docker inspect -f "{{.State.Status}}" "$CID" 2>/dev/null || true)
[[ -n "$CONTAINER_STATUS" ]] && echo "$CONTAINER_STATUS" && return 0 [[ -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")
@@ -779,6 +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 "$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
@@ -790,18 +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"
config_unset "$APP" "${LINK[*]}" plugn trigger service-action post-unlink "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
if [[ "$DOKKU_GLOBAL_FLAGS" == *"--no-restart"* ]] || [[ "$SERVICE_RESTART_APPS" == "false" ]]; then
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
@@ -810,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"
} }

16
config
View File

@@ -1,8 +1,10 @@
#!/usr/bin/env bash #!/usr/bin/env bash
export REDIS_IMAGE=${REDIS_IMAGE:="redis"} _DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
export REDIS_IMAGE_VERSION=${REDIS_IMAGE_VERSION:="5.0.5"} export REDIS_IMAGE=${REDIS_IMAGE:="$(awk -F '[ :]' '{print $2}' "${_DIR}/Dockerfile")"}
export REDIS_IMAGE_VERSION=${REDIS_IMAGE_VERSION:="$(awk -F '[ :]' '{print $3}' "${_DIR}/Dockerfile")"}
export REDIS_ROOT=${REDIS_ROOT:="$DOKKU_LIB_ROOT/services/redis"} export REDIS_ROOT=${REDIS_ROOT:="$DOKKU_LIB_ROOT/services/redis"}
export REDIS_HOST_ROOT=${REDIS_HOST_ROOT:=$REDIS_ROOT} export DOKKU_LIB_HOST_ROOT=${DOKKU_LIB_HOST_ROOT:=$DOKKU_LIB_ROOT}
export REDIS_HOST_ROOT=${REDIS_HOST_ROOT:="$DOKKU_LIB_HOST_ROOT/services/redis"}
export PLUGIN_UNIMPLEMENTED_SUBCOMMANDS=() export PLUGIN_UNIMPLEMENTED_SUBCOMMANDS=()
export PLUGIN_COMMAND_PREFIX="redis" export PLUGIN_COMMAND_PREFIX="redis"
@@ -21,6 +23,14 @@ export PLUGIN_SCHEME="redis"
export PLUGIN_SERVICE="Redis" export PLUGIN_SERVICE="Redis"
export PLUGIN_VARIABLE="REDIS" export PLUGIN_VARIABLE="REDIS"
export PLUGIN_BASE_PATH="$PLUGIN_PATH" export PLUGIN_BASE_PATH="$PLUGIN_PATH"
export PLUGIN_CONFIG_SUFFIX="config"
if [[ -n $DOKKU_API_VERSION ]]; then 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.34.1-uclibc"
export PLUGIN_AMBASSADOR_IMAGE="dokku/ambassador:0.5.0"
export PLUGIN_S3BACKUP_IMAGE="dokku/s3backup:0.14.0"
export PLUGIN_WAIT_IMAGE="dokku/wait:0.6.0"
export REDIS_CONFIG_OPTIONS=${REDIS_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.

140
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" redis-cli -a "$PASSWORD" "$DOCKER_BIN" container exec --env=LANG=C.UTF-8 --env=LC_ALL=C.UTF-8 -i $SERVICE_TTY_OPTS "$SERVICE_NAME" redis-cli -a "$PASSWORD"
} }
service_create() { service_create() {
@@ -33,22 +34,23 @@ 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 "$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"
mkdir -p "$SERVICE_ROOT/config" || dokku_log_fail "Unable to create service config directory" mkdir -p "$SERVICE_ROOT/$PLUGIN_CONFIG_SUFFIX" || dokku_log_fail "Unable to create service config directory"
touch "$LINKS_FILE" touch "$LINKS_FILE"
if [[ -z $REDIS_CONFIG_PATH ]]; then if [[ -z $REDIS_CONFIG_PATH ]]; then
curl -sSL "https://raw.githubusercontent.com/antirez/redis/${PLUGIN_IMAGE_VERSION:0:3}/redis.conf" >"$SERVICE_ROOT/config/redis.conf" || dokku_log_fail "Unable to download the default redis.conf to the config directory" curl -sSL "https://raw.githubusercontent.com/antirez/redis/${PLUGIN_IMAGE_VERSION:0:3}/redis.conf" >"$SERVICE_ROOT/$PLUGIN_CONFIG_SUFFIX/redis.conf" || dokku_log_fail "Unable to download the default redis.conf to the config directory"
else else
cp "$REDIS_CONFIG_PATH" "$SERVICE_ROOT/config/redis.conf" || dokku_log_fail "Unable to copy the ${REDIS_CONFIG_PATH} to the config directory" cp "$REDIS_CONFIG_PATH" "$SERVICE_ROOT/$PLUGIN_CONFIG_SUFFIX/redis.conf" || dokku_log_fail "Unable to copy the ${REDIS_CONFIG_PATH} to the config directory"
fi fi
PASSWORD=$(openssl rand -hex 32) PASSWORD=$(openssl rand -hex 32)
if [[ -n "$SERVICE_PASSWORD" ]]; then if [[ -n "$SERVICE_PASSWORD" ]]; then
@@ -57,17 +59,13 @@ service_create() {
fi fi
echo "$PASSWORD" >"$SERVICE_ROOT/PASSWORD" echo "$PASSWORD" >"$SERVICE_ROOT/PASSWORD"
chmod 640 "$SERVICE_ROOT/PASSWORD" chmod 640 "$SERVICE_ROOT/PASSWORD"
sed -i.bak "s/# requirepass.*/requirepass ${PASSWORD}/" "$SERVICE_ROOT/config/redis.conf" && rm "$SERVICE_ROOT/config/redis.conf.bak" sed -i.bak "s/# requirepass.*/requirepass ${PASSWORD}/" "$SERVICE_ROOT/$PLUGIN_CONFIG_SUFFIX/redis.conf" && rm "$SERVICE_ROOT/$PLUGIN_CONFIG_SUFFIX/redis.conf.bak"
[[ -n "$SERVICE_CUSTOM_ENV" ]] && REDIS_CUSTOM_ENV="$SERVICE_CUSTOM_ENV"
if [[ -n $REDIS_CUSTOM_ENV ]]; then
echo "$REDIS_CUSTOM_ENV" | tr ';' "\n" >"$SERVICE_ROOT/ENV"
else
echo "" >"$SERVICE_ROOT/ENV"
fi
service_commit_config "$SERVICE"
write_database_name "$SERVICE" write_database_name "$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 "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
} }
service_create_container() { service_create_container() {
@@ -76,11 +74,79 @@ service_create_container() {
local SERVICE_HOST_ROOT="$PLUGIN_DATA_HOST_ROOT/$SERVICE" local SERVICE_HOST_ROOT="$PLUGIN_DATA_HOST_ROOT/$SERVICE"
local SERVICE_NAME="$(get_service_name "$SERVICE")" local SERVICE_NAME="$(get_service_name "$SERVICE")"
ID=$(docker run --name "$SERVICE_NAME" -v "$SERVICE_HOST_ROOT/data:/data" -v "$SERVICE_HOST_ROOT/config:/usr/local/etc/redis" --env-file="$SERVICE_ROOT/ENV" -d --restart always --label dokku=service --label dokku.service=redis "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" redis-server /usr/local/etc/redis/redis.conf --bind 0.0.0.0) 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+=("--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/$PLUGIN_CONFIG_SUFFIX:/usr/local/etc/redis")
DOCKER_ARGS+=("--volume=$SERVICE_HOST_ROOT/data:/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" redis-server /usr/local/etc/redis/redis.conf --bind 0.0.0.0 $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" dokku/wait:0.4.0 -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_info2 "$PLUGIN_SERVICE container created: $SERVICE" dokku_log_info2 "$PLUGIN_SERVICE container created: $SERVICE"
service_info "$SERVICE" service_info "$SERVICE"
@@ -93,8 +159,16 @@ 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" bash -c "echo SAVE | redis-cli -a ${PASSWORD}" >/dev/null 2>&1 LASTSAVE1=$("$DOCKER_BIN" container exec "$SERVICE_NAME" bash -c "echo LASTSAVE | redis-cli -a ${PASSWORD}")
docker exec "$SERVICE_NAME" cat /data/dump.rdb "$DOCKER_BIN" container exec "$SERVICE_NAME" bash -c "echo BGSAVE | redis-cli -a ${PASSWORD}" >/dev/null 2>&1
LASTSAVE2=$("$DOCKER_BIN" container exec "$SERVICE_NAME" bash -c "echo LASTSAVE | redis-cli -a ${PASSWORD}")
until [[ "$LASTSAVE1" != "$LASTSAVE2" ]]; do
LASTSAVE2=$("$DOCKER_BIN" container exec "$SERVICE_NAME" bash -c "echo LASTSAVE | redis-cli -a ${PASSWORD}")
sleep 5
done
"$DOCKER_BIN" container exec "$SERVICE_NAME" cat /data/dump.rdb
status=$? status=$?
[[ -n $SSH_TTY ]] && stty opost [[ -n $SSH_TTY ]] && stty opost
exit $status exit $status
@@ -108,9 +182,11 @@ 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
dokku "$PLUGIN_COMMAND_PREFIX:stop" "$SERVICE" >/dev/null 2>&1 suppress_output service_container_rm "$SERVICE"
docker run --rm -i -v "$SERVICE_HOST_ROOT/data:/data" "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" bash -c "cat > /data/dump.rdb && chown redis: /data/dump.rdb" "$DOCKER_BIN" container run --rm -v "$SERVICE_HOST_ROOT/data:/data" "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" bash -c "rm -f /data/dump.rdb"
dokku "$PLUGIN_COMMAND_PREFIX:start" "$SERVICE" >/dev/null 2>&1 cat >"$SERVICE_HOST_ROOT/data/dump.rdb"
"$DOCKER_BIN" container run --rm -v "$SERVICE_HOST_ROOT/data:/data" "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" bash -c "chown redis: /data/dump.rdb"
suppress_output service_start "$SERVICE"
} }
service_start() { service_start() {
@@ -118,7 +194,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
@@ -129,16 +205,22 @@ 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
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"; then elif service_image_exists "$SERVICE"; then
service_create_container "$SERVICE" service_create_container "$SERVICE"
else else
dokku_log_verbose_quiet "Neither container nor valid configuration exists for $SERVICE" if ! service_image_exists "$SERVICE"; then
[[ -f "$SERVICE_ROOT/IMAGE" ]] && PLUGIN_IMAGE="$(cat "$SERVICE_ROOT/IMAGE")"
[[ -f "$SERVICE_ROOT/IMAGE_VERSION" ]] && PLUGIN_IMAGE_VERSION="$(cat "$SERVICE_ROOT/IMAGE_VERSION")"
dokku_log_verbose_quiet "Missing image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION for $SERVICE"
else
dokku_log_verbose_quiet "Neither container nor valid configuration exists for $SERVICE"
fi
fi fi
} }
@@ -146,5 +228,5 @@ service_url() {
local SERVICE="$1" local SERVICE="$1"
local PASSWORD="$(service_password "$SERVICE")" local PASSWORD="$(service_password "$SERVICE")"
local SERVICE_DNS_HOSTNAME="$(service_dns_hostname "$SERVICE")" local SERVICE_DNS_HOSTNAME="$(service_dns_hostname "$SERVICE")"
echo "$PLUGIN_SCHEME://$SERVICE:$PASSWORD@$SERVICE_DNS_HOSTNAME:${PLUGIN_DATASTORE_PORTS[0]}" echo "$PLUGIN_SCHEME://:$PASSWORD@$SERVICE_DNS_HOSTNAME:${PLUGIN_DATASTORE_PORTS[0]}"
} }

View File

@@ -76,10 +76,10 @@ fn-help-contents() {
fn-help-contents-subcommand() { fn-help-contents-subcommand() {
declare SUBCOMMAND="$1" FULL_OUTPUT="$2" declare SUBCOMMAND="$1" FULL_OUTPUT="$2"
local TMPDIR=$(mktemp -d) local HELP_TMPDIR=$(mktemp -d --tmpdir)
local UNCLEAN_FILE="${TMPDIR}/cmd-unclean" CLEAN_FILE="${TMPDIR}/cmd-clean" local UNCLEAN_FILE="${HELP_TMPDIR}/cmd-unclean" CLEAN_FILE="${HELP_TMPDIR}/cmd-clean"
local BOLD CMD_OUTPUT CYAN EXAMPLE LIGHT_GRAY NORMAL local BOLD CMD_OUTPUT CYAN EXAMPLE LIGHT_GRAY NORMAL
trap 'rm -rf "$TMPDIR" > /dev/null' RETURN INT TERM EXIT trap 'rm -rf "$HELP_TMPDIR" > /dev/null' RETURN INT TERM EXIT
rm -rf "$UNCLEAN_FILE" "$CLEAN_FILE" rm -rf "$UNCLEAN_FILE" "$CLEAN_FILE"
cat "$SUBCOMMAND_ROOT/$SUBCOMMAND" >"$UNCLEAN_FILE" cat "$SUBCOMMAND_ROOT/$SUBCOMMAND" >"$UNCLEAN_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
@@ -164,8 +164,8 @@ fn-help-list-example() {
# shellcheck disable=SC2034 # shellcheck disable=SC2034
declare desc="return $PLUGIN_COMMAND_PREFIX plugin help content" declare desc="return $PLUGIN_COMMAND_PREFIX plugin help content"
cat <<help_list cat <<help_list
NAME, VERSION, STATUS, EXPOSED PORTS, LINKS $PLUGIN_SERVICE services
service-name, $PLUGIN_COMMAND_PREFIX:$PLUGIN_IMAGE_VERSION, running, -, app-name service-name
help_list help_list
} }
@@ -191,7 +191,7 @@ fn-help-subcommand-args() {
if [[ "$arg" == *_FLAG ]]; then if [[ "$arg" == *_FLAG ]]; then
arg="${arg/_FLAG/}" arg="${arg/_FLAG/}"
if [[ $arg == "INFO" ]]; then if [[ $arg == "INFO" ]]; then
arg="SINGLE_INFO_FLAG..." arg="SINGLE_INFO_FLAG"
args+=" ${BLUE}[--${arg//_/-}]${NORMAL}" args+=" ${BLUE}[--${arg//_/-}]${NORMAL}"
else else
args+=" ${BLUE}[-${arg:0:1}|--${arg//_/-}]${NORMAL}" args+=" ${BLUE}[-${arg:0:1}|--${arg//_/-}]${NORMAL}"
@@ -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"

40
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,25 +10,26 @@ 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 "busybox:1.31.0-uclibc" pull-docker-image "$PLUGIN_BUSYBOX_IMAGE"
pull-docker-image "dokku/ambassador:0.3.0" pull-docker-image "$PLUGIN_AMBASSADOR_IMAGE"
pull-docker-image "dokku/s3backup:0.10.0" pull-docker-image "$PLUGIN_S3BACKUP_IMAGE"
pull-docker-image "dokku/wait:0.4.0" 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 redis service plugin" description = "dokku redis service plugin"
version = "1.9.1" version = "1.37.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 "$@"

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 a GPG passphrase for backups #E set the GPG-compatible passphrase for encrypting backups for backups
#E dokku $PLUGIN_COMMAND_PREFIX:backup-set-encryption lolipop #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 a GPG encryption key 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,13 +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 "$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/config:/config" busybox:1.31.0-uclibc 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"
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,11 +29,14 @@ 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
declare desc="print the connection information" declare desc="print the service information"
local cmd="$PLUGIN_COMMAND_PREFIX:info" argv=("$@") local cmd="$PLUGIN_COMMAND_PREFIX:info" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1 [[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" INFO_FLAG="$2" declare SERVICE="$1" INFO_FLAG="$2"

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,38 +10,39 @@ 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}://:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lollipop:${PLUGIN_DATASTORE_PORTS[0]}
#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
#E use the 'expose' subcommand. another service can be linked to your app: #E use the 'expose' subcommand. another service can be linked to your app:
#E dokku $PLUGIN_COMMAND_PREFIX:link other_service playground #E dokku $PLUGIN_COMMAND_PREFIX:link other_service playground
#E it is possible to change the protocol for ${PLUGIN_DEFAULT_ALIAS}_URL by setting the #E it is possible to change the protocol for ${PLUGIN_DEFAULT_ALIAS}_URL by setting the
#E environment variable ${PLUGIN_DEFAULT_ALIAS}_DATABASE_SCHEME on the app. doing so will #E environment variable ${PLUGIN_VARIABLE}_DATABASE_SCHEME on the app. doing so will
#E after linking will cause the plugin to think the service is not #E 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_DEFAULT_ALIAS}_DATABASE_SCHEME=${PLUGIN_SCHEME}2 #E dokku config:set playground ${PLUGIN_VARIABLE}_DATABASE_SCHEME=${PLUGIN_SCHEME}2
#E dokku $PLUGIN_COMMAND_PREFIX:link lolipop playground #E 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://:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lollipop:${PLUGIN_DATASTORE_PORTS[0]}
#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,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-promote-cmd() { service-promote-cmd() {
#E if you have a $PLUGIN_COMMAND_PREFIX service linked to an app and try to link another $PLUGIN_COMMAND_PREFIX service #E if you have a $PLUGIN_COMMAND_PREFIX service linked to an app and try to link another $PLUGIN_COMMAND_PREFIX service
#E another link environment variable will be generated automatically: #E another link environment variable will be generated automatically:
#E #E
#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}://:ANOTHER_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-other-service:${PLUGIN_DATASTORE_PORTS[0]}/other_service
#E #E
#E you can promote the new service to be the primary one #E you can promote the new service to be the primary one
#E > NOTE: this will restart your app #E > NOTE: this will restart your app
@@ -18,9 +18,9 @@ service-promote-cmd() {
#E another environment variable to hold the previous value if necessary. #E another environment variable to hold the previous value if necessary.
#E you could end up with the following for example: #E you could end up with the following for example:
#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}://: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}://: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}://: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

@@ -2,18 +2,19 @@
load test_helper 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

@@ -20,7 +20,10 @@ teardown() {
} }
@test "($PLUGIN_COMMAND_PREFIX:export) success with SSH_TTY" { @test "($PLUGIN_COMMAND_PREFIX:export) success with SSH_TTY" {
export SSH_TTY=`tty` if [[ -n "$GITHUB_WORKFLOW" ]]; then
skip "No tty is available on Github Actions"
fi
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]: 6379->4242" assert_contains "${lines[*]}" "exposed on port(s) [container->host]: 6379->4242"
} }

View File

@@ -3,7 +3,7 @@ load test_helper
setup() { setup() {
dokku "$PLUGIN_COMMAND_PREFIX:create" l dokku "$PLUGIN_COMMAND_PREFIX:create" l
echo "data" | tee "/tmp/fake.rdb" curl -o "/tmp/fake.rdb" https://raw.githubusercontent.com/sripathikrishnan/redis-rdb-tools/master/tests/dumps/dictionary.rdb
} }
teardown() { teardown() {
@@ -24,13 +24,16 @@ teardown() {
} }
@test "($PLUGIN_COMMAND_PREFIX:import) error when data is not provided" { @test "($PLUGIN_COMMAND_PREFIX:import) error when data is not provided" {
if [[ -n "$GITHUB_WORKFLOW" ]]; then
skip "No tty is available on Github Actions"
fi
run dokku "$PLUGIN_COMMAND_PREFIX:import" l run dokku "$PLUGIN_COMMAND_PREFIX:import" l
assert_contains "${lines[*]}" "No data provided on stdin" assert_contains "${lines[*]}" "No data provided on stdin"
assert_failure assert_failure
} }
@test "($PLUGIN_COMMAND_PREFIX:import) success" { @test "($PLUGIN_COMMAND_PREFIX:import) success" {
run dokku "$PLUGIN_COMMAND_PREFIX:import" l < "/tmp/fake.rdb" run dokku "$PLUGIN_COMMAND_PREFIX:import" l <"/tmp/fake.rdb"
echo "output: $output" echo "output: $output"
echo "status: $status" echo "status: $status"
assert_success assert_success

View File

@@ -22,21 +22,21 @@ teardown() {
@test "($PLUGIN_COMMAND_PREFIX:info) success" { @test "($PLUGIN_COMMAND_PREFIX:info) success" {
run dokku "$PLUGIN_COMMAND_PREFIX:info" l run dokku "$PLUGIN_COMMAND_PREFIX:info" l
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")" password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
assert_contains "${lines[*]}" "redis://l:$password@dokku-redis-l:6379" assert_contains "${lines[*]}" "redis://:$password@dokku-redis-l:6379"
} }
@test "($PLUGIN_COMMAND_PREFIX:info) replaces underscores by dash in hostname" { @test "($PLUGIN_COMMAND_PREFIX:info) replaces underscores by dash in hostname" {
dokku "$PLUGIN_COMMAND_PREFIX:create" test_with_underscores dokku "$PLUGIN_COMMAND_PREFIX:create" test_with_underscores
run dokku "$PLUGIN_COMMAND_PREFIX:info" test_with_underscores run dokku "$PLUGIN_COMMAND_PREFIX:info" test_with_underscores
password="$(sudo cat "$PLUGIN_DATA_ROOT/test_with_underscores/PASSWORD")" password="$(sudo cat "$PLUGIN_DATA_ROOT/test_with_underscores/PASSWORD")"
assert_contains "${lines[*]}" "redis://test_with_underscores:$password@dokku-redis-test-with-underscores:6379" assert_contains "${lines[*]}" "redis://:$password@dokku-redis-test-with-underscores:6379"
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" test_with_underscores dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" test_with_underscores
} }
@test "($PLUGIN_COMMAND_PREFIX:info) success with flag" { @test "($PLUGIN_COMMAND_PREFIX:info) success with flag" {
run dokku "$PLUGIN_COMMAND_PREFIX:info" l --dsn run dokku "$PLUGIN_COMMAND_PREFIX:info" l --dsn
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")" password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
assert_output "redis://l:$password@dokku-redis-l:6379" assert_output "redis://:$password@dokku-redis-l:6379"
run dokku "$PLUGIN_COMMAND_PREFIX:info" l --config-dir run dokku "$PLUGIN_COMMAND_PREFIX:info" l --config-dir
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"
@@ -39,7 +38,7 @@ teardown() {
} }
@test "($PLUGIN_COMMAND_PREFIX:link) error when the service does not exist" { @test "($PLUGIN_COMMAND_PREFIX:link) error when the service does not exist" {
run dokku "$PLUGIN_COMMAND_PREFIX:link" not_existing_service my_app run dokku "$PLUGIN_COMMAND_PREFIX:link" not_existing_service my-app
echo "output: $output" echo "output: $output"
echo "status: $status" echo "status: $status"
assert_contains "${lines[*]}" "service not_existing_service does not exist" assert_contains "${lines[*]}" "service not_existing_service 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 REDIS_URL" assert_contains "${lines[*]}" "Already linked as REDIS_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 REDIS_URL to app" { @test "($PLUGIN_COMMAND_PREFIX:link) exports REDIS_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 REDIS_URL) url=$(dokku config:get my-app REDIS_URL)
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")" password="$(sudo cat "$PLUGIN_DATA_ROOT/ls/PASSWORD")"
assert_contains "$url" "redis://l:$password@dokku-redis-l:6379" assert_contains "$url" "redis://:$password@dokku-redis-ls:6379"
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 REDIS_URL already in use" { @test "($PLUGIN_COMMAND_PREFIX:link) generates an alternate config url when REDIS_URL already in use" {
dokku config:set my_app REDIS_URL=redis://host:6379 dokku config:set my-app REDIS_URL=redis://host:6379
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_REDIS_AQUA_URL" assert_contains "${lines[*]}" "DOKKU_REDIS_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_REDIS_BLACK_URL" assert_contains "${lines[*]}" "DOKKU_REDIS_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 my_app run dokku docker-options:report my-app
assert_contains "${lines[*]}" "--link dokku.redis.l:dokku-redis-l" assert_contains "${lines[*]}" "--link dokku.redis.ls:dokku-redis-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 REDIS_DATABASE_SCHEME variable" { @test "($PLUGIN_COMMAND_PREFIX:link) uses apps REDIS_DATABASE_SCHEME variable" {
dokku config:set my_app REDIS_DATABASE_SCHEME=redis2 dokku config:set my-app REDIS_DATABASE_SCHEME=redis2
dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
url=$(dokku config:get my_app REDIS_URL) url=$(dokku config:get my-app REDIS_URL)
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")" password="$(sudo cat "$PLUGIN_DATA_ROOT/ls/PASSWORD")"
assert_contains "$url" "redis2://l:$password@dokku-redis-l:6379" assert_contains "$url" "redis2://:$password@dokku-redis-ls:6379"
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 REDIS_URL) url=$(dokku config:get my-app REDIS_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" "redis://l:$password@dokku-redis-l:6379" assert_contains "$url" "redis://:$password@dokku-redis-ls:6379"
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
} }

View File

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

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

@@ -3,14 +3,14 @@ load test_helper
setup() { setup() {
dokku "$PLUGIN_COMMAND_PREFIX:create" l dokku "$PLUGIN_COMMAND_PREFIX:create" l
dokku apps:create my_app dokku apps:create my-app
dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
} }
teardown() { teardown() {
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
dokku --force apps:destroy my_app dokku --force apps:destroy my-app
} }
@test "($PLUGIN_COMMAND_PREFIX:promote) error when there are no arguments" { @test "($PLUGIN_COMMAND_PREFIX:promote) error when there are no arguments" {
@@ -29,35 +29,35 @@ teardown() {
} }
@test "($PLUGIN_COMMAND_PREFIX:promote) error when the service does not exist" { @test "($PLUGIN_COMMAND_PREFIX:promote) error when the service does not exist" {
run dokku "$PLUGIN_COMMAND_PREFIX:promote" not_existing_service my_app run dokku "$PLUGIN_COMMAND_PREFIX:promote" not_existing_service my-app
assert_contains "${lines[*]}" "service not_existing_service does not exist" assert_contains "${lines[*]}" "service not_existing_service does not exist"
} }
@test "($PLUGIN_COMMAND_PREFIX:promote) error when the service is already promoted" { @test "($PLUGIN_COMMAND_PREFIX:promote) error when the service is already promoted" {
run dokku "$PLUGIN_COMMAND_PREFIX:promote" l my_app run dokku "$PLUGIN_COMMAND_PREFIX:promote" l my-app
assert_contains "${lines[*]}" "already promoted as REDIS_URL" assert_contains "${lines[*]}" "already promoted as REDIS_URL"
} }
@test "($PLUGIN_COMMAND_PREFIX:promote) changes REDIS_URL" { @test "($PLUGIN_COMMAND_PREFIX:promote) changes REDIS_URL" {
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")" password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
dokku config:set my_app "REDIS_URL=redis://u:p@host:6379/db" "DOKKU_REDIS_BLUE_URL=redis://l:$password@dokku-redis-l:6379" dokku config:set my-app "REDIS_URL=redis://:p@host:6379/db" "DOKKU_REDIS_BLUE_URL=redis://:$password@dokku-redis-l:6379"
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my_app dokku "$PLUGIN_COMMAND_PREFIX:promote" l my-app
url=$(dokku config:get my_app REDIS_URL) url=$(dokku config:get my-app REDIS_URL)
assert_equal "$url" "redis://l:$password@dokku-redis-l:6379" assert_equal "$url" "redis://:$password@dokku-redis-l:6379"
} }
@test "($PLUGIN_COMMAND_PREFIX:promote) creates new config url when needed" { @test "($PLUGIN_COMMAND_PREFIX:promote) creates new config url when needed" {
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")" password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
dokku config:set my_app "REDIS_URL=redis://u:p@host:6379/db" "DOKKU_REDIS_BLUE_URL=redis://l:$password@dokku-redis-l:6379" dokku config:set my-app "REDIS_URL=redis://:p@host:6379/db" "DOKKU_REDIS_BLUE_URL=redis://:$password@dokku-redis-l:6379"
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my_app dokku "$PLUGIN_COMMAND_PREFIX:promote" l my-app
run dokku config my_app run dokku config my-app
assert_contains "${lines[*]}" "DOKKU_REDIS_" assert_contains "${lines[*]}" "DOKKU_REDIS_"
} }
@test "($PLUGIN_COMMAND_PREFIX:promote) uses REDIS_DATABASE_SCHEME variable" { @test "($PLUGIN_COMMAND_PREFIX:promote) uses REDIS_DATABASE_SCHEME variable" {
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")" password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
dokku config:set my_app "REDIS_DATABASE_SCHEME=redis2" "REDIS_URL=redis://u:p@host:6379" "DOKKU_REDIS_BLUE_URL=redis2://l:$password@dokku-redis-l:6379" dokku config:set my-app "REDIS_DATABASE_SCHEME=redis2" "REDIS_URL=redis://:p@host:6379" "DOKKU_REDIS_BLUE_URL=redis2://:$password@dokku-redis-l:6379"
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my_app dokku "$PLUGIN_COMMAND_PREFIX:promote" l my-app
url=$(dokku config:get my_app REDIS_URL) url=$(dokku config:get my-app REDIS_URL)
assert_equal "$url" "redis2://l:$password@dokku-redis-l:6379" assert_equal "$url" "redis2://:$password@dokku-redis-l:6379"
} }

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

@@ -2,13 +2,13 @@
load test_helper 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
} }
@test "($PLUGIN_COMMAND_PREFIX:unlink) error when there are no arguments" { @test "($PLUGIN_COMMAND_PREFIX:unlink) error when there are no arguments" {
@@ -17,37 +17,61 @@ 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"
} }
@test "($PLUGIN_COMMAND_PREFIX:unlink) error when the service does not exist" { @test "($PLUGIN_COMMAND_PREFIX:unlink) error when the service does not exist" {
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" not_existing_service my_app run dokku "$PLUGIN_COMMAND_PREFIX:unlink" not_existing_service my-app
assert_contains "${lines[*]}" "service not_existing_service does not exist" assert_contains "${lines[*]}" "service not_existing_service does not exist"
} }
@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)
assert_equal "$options" "$check_value" assert_equal "$options" "$check_value"
} }
@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 REDIS_URL || true) config=$(dokku config:get my-app REDIS_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

@@ -2,9 +2,13 @@
set -eo pipefail set -eo pipefail
[[ $TRACE ]] && set -x [[ $TRACE ]] && set -x
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 762E3157 sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 762E3157
echo "deb http://nginx.org/packages/ubuntu `lsb_release -cs` nginx" | sudo tee /etc/apt/sources.list.d/nginx.list echo "deb http://nginx.org/packages/ubuntu $(lsb_release -cs) nginx" | sudo tee /etc/apt/sources.list.d/nginx.list
curl -fsSL https://nginx.org/keys/nginx_signing.key | sudo apt-key add - curl -fsSL https://nginx.org/keys/nginx_signing.key | sudo apt-key add -
sudo mkdir -p /etc/nginx
sudo curl https://raw.githubusercontent.com/dokku/dokku/master/tests/dhparam.pem -o /etc/nginx/dhparam.pem
echo "dokku dokku/skip_key_file boolean true" | sudo debconf-set-selections
wget https://raw.githubusercontent.com/dokku/dokku/master/bootstrap.sh wget https://raw.githubusercontent.com/dokku/dokku/master/bootstrap.sh
if [[ "$DOKKU_VERSION" == "master" ]]; then if [[ "$DOKKU_VERSION" == "master" ]]; then
sudo bash bootstrap.sh sudo bash bootstrap.sh
@@ -15,12 +19,15 @@ echo "Dokku version $DOKKU_VERSION"
export DOKKU_LIB_ROOT="/var/lib/dokku" export DOKKU_LIB_ROOT="/var/lib/dokku"
export DOKKU_PLUGINS_ROOT="$DOKKU_LIB_ROOT/plugins/available" export DOKKU_PLUGINS_ROOT="$DOKKU_LIB_ROOT/plugins/available"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config" pushd "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")" >/dev/null
source "config"
popd >/dev/null
sudo rm -rf "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX" sudo rm -rf "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX"
sudo mkdir -p "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX" "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/subcommands" "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/scripts" sudo mkdir -p "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX" "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/subcommands" "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/scripts" "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/templates"
sudo find ./ -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX" \; sudo find ./ -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX" \;
[[ -d "./scripts" ]] && sudo find ./scripts -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/scripts" \; [[ -d "./scripts" ]] && sudo find ./scripts -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/scripts" \;
[[ -d "./subcommands" ]] && sudo find ./subcommands -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/subcommands" \; [[ -d "./subcommands" ]] && sudo find ./subcommands -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/subcommands" \;
[[ -d "./templates" ]] && sudo find ./templates -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/templates" \;
sudo mkdir -p "$PLUGIN_CONFIG_ROOT" "$PLUGIN_DATA_ROOT" sudo mkdir -p "$PLUGIN_CONFIG_ROOT" "$PLUGIN_DATA_ROOT"
sudo dokku plugin:enable "$PLUGIN_COMMAND_PREFIX" sudo dokku plugin:enable "$PLUGIN_COMMAND_PREFIX"
sudo dokku plugin:install sudo dokku plugin:install

View File

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

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"
}