Compare commits
247 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
32fdea93fd | ||
|
|
42f07d10a8 | ||
|
|
5e3cf5fab4 | ||
|
|
4174b7e617 | ||
|
|
e4f475b31b | ||
|
|
615db75c3d | ||
|
|
2af9cb0203 | ||
|
|
6bfd8040a2 | ||
|
|
b2e1a78073 | ||
|
|
8b002c7a7c | ||
|
|
7ca7c20ef8 | ||
|
|
36b5a80263 | ||
|
|
5855d1bdd5 | ||
|
|
b8a8b139f9 | ||
|
|
0d84637c85 | ||
|
|
d72138aad3 | ||
|
|
3ab20b0b4f | ||
|
|
9e6d072531 | ||
|
|
254c68c326 | ||
|
|
0387c2d30b | ||
|
|
4cef2b9207 | ||
|
|
7a17f22d6c | ||
|
|
535f40143d | ||
|
|
952036bbaa | ||
|
|
1b37774e05 | ||
|
|
db78a92687 | ||
|
|
6d948290e7 | ||
|
|
1afdffef8d | ||
|
|
38bfaea286 | ||
|
|
e85d96b3a1 | ||
|
|
0657f47442 | ||
|
|
2b4ff03bff | ||
|
|
2c7a655c87 | ||
|
|
0334a62202 | ||
|
|
2c2c003a96 | ||
|
|
8699bd9c45 | ||
|
|
25ab99a4e2 | ||
|
|
a182961848 | ||
|
|
409cfc06c0 | ||
|
|
754f87ba99 | ||
|
|
cc7478c656 | ||
|
|
a03a6d996a | ||
|
|
c18722af2b | ||
|
|
4d6536b924 | ||
|
|
b2dab2649e | ||
|
|
6582f0c633 | ||
|
|
b794db26f8 | ||
|
|
e9512ae4d5 | ||
|
|
76d535358b | ||
|
|
b58b3ebce7 | ||
|
|
f7a2e6c866 | ||
|
|
c2774ac51f | ||
|
|
28b28e51f4 | ||
|
|
ad13120ef9 | ||
|
|
ec45752306 | ||
|
|
63535f934d | ||
|
|
0be882b8a4 | ||
|
|
0769fd1fd3 | ||
|
|
ab1e14b986 | ||
|
|
5aea44f11c | ||
|
|
832a8045d5 | ||
|
|
d25e6e6483 | ||
|
|
f309f16c7b | ||
|
|
1a0f6815ca | ||
|
|
76cfd9a091 | ||
|
|
4e808c6ff9 | ||
|
|
9974da1abe | ||
|
|
e414eaccec | ||
|
|
6f1ad4c20e | ||
|
|
b7030307ef | ||
|
|
34f02b6aa4 | ||
|
|
fc7ddc3e2a | ||
|
|
9ab0660b14 | ||
|
|
56f688e8aa | ||
|
|
ba24332367 | ||
|
|
5fd0ca4be7 | ||
|
|
d7ed80f5f2 | ||
|
|
e5f7c9edf2 | ||
|
|
0dd6e10b6c | ||
|
|
60a95a7c4c | ||
|
|
2cc04faf19 | ||
|
|
b335d9c73a | ||
|
|
89981da556 | ||
|
|
caa7430508 | ||
|
|
32fa047fe7 | ||
|
|
b29cc0879b | ||
|
|
ea5c07b867 | ||
|
|
5a3e19701d | ||
|
|
188fdd8ac4 | ||
|
|
e9182acbd8 | ||
|
|
47c6bb0b2a | ||
|
|
119eddaea1 | ||
|
|
377c8ffbdc | ||
|
|
f92dd171b4 | ||
|
|
d422bc5811 | ||
|
|
5964e1394b | ||
|
|
dfbde56138 | ||
|
|
6adca89611 | ||
|
|
78b51e2cf3 | ||
|
|
cd562537a6 | ||
|
|
b85e992da6 | ||
|
|
60f600e29a | ||
|
|
5ce14c0221 | ||
|
|
3b86072e76 | ||
|
|
dccd7e7f89 | ||
|
|
856e0eec4b | ||
|
|
e5862de232 | ||
|
|
91415946b7 | ||
|
|
d8c2656a32 | ||
|
|
ad0e0f69f4 | ||
|
|
f93699221b | ||
|
|
feb832109c | ||
|
|
89f080cb51 | ||
|
|
91bf720861 | ||
|
|
ea74d1da3e | ||
|
|
4dc758d7e6 | ||
|
|
b87837b2f1 | ||
|
|
1a0eca9f9a | ||
|
|
7f4c06d6c0 | ||
|
|
355952eb1f | ||
|
|
a5fbfe1e7a | ||
|
|
cec13103ba | ||
|
|
da72857cad | ||
|
|
ce1cae9241 | ||
|
|
f1bc0b0b3e | ||
|
|
97139fbe1d | ||
|
|
edc0c474c9 | ||
|
|
98e902b572 | ||
|
|
0f54621a98 | ||
|
|
211e384565 | ||
|
|
4819e34bd5 | ||
|
|
c7f511c5f2 | ||
|
|
fcbf0ef22c | ||
|
|
2a6a5d99e1 | ||
|
|
7d4cf380bb | ||
|
|
fb522d1bd8 | ||
|
|
5b13bedbd6 | ||
|
|
f65790c5d6 | ||
|
|
93dd4fecbb | ||
|
|
0317711a5b | ||
|
|
4867906243 | ||
|
|
7d49483472 | ||
|
|
7faec70ef2 | ||
|
|
aa3d21b4ae | ||
|
|
67dd094d58 | ||
|
|
b414ca165a | ||
|
|
028d82517f | ||
|
|
8852c3fc03 | ||
|
|
095be6dbaf | ||
|
|
a9fcde1404 | ||
|
|
b3efd6ef80 | ||
|
|
2e0a9b6c6e | ||
|
|
4b6ca068e7 | ||
|
|
7a3e380c24 | ||
|
|
b56616cdc7 | ||
|
|
6c2e96b37e | ||
|
|
d668c50abb | ||
|
|
c4c9f88c94 | ||
|
|
a5c60c2b07 | ||
|
|
589d28730f | ||
|
|
be5d09776a | ||
|
|
c105f97ed5 | ||
|
|
dc72b8ac33 | ||
|
|
33fbe15fc6 | ||
|
|
181a1a18fa | ||
|
|
b74cb9cc9f | ||
|
|
5a541fc340 | ||
|
|
9eb26d8601 | ||
|
|
0e64cfbe75 | ||
|
|
1e878536f5 | ||
|
|
0d0ff5f5ee | ||
|
|
118e43a792 | ||
|
|
db9ff186a2 | ||
|
|
6dedbfba45 | ||
|
|
623d125e83 | ||
|
|
9fa9b4a975 | ||
|
|
1edb82305b | ||
|
|
077f7e47f1 | ||
|
|
371c35667b | ||
|
|
e394039652 | ||
|
|
ec4e5b4a43 | ||
|
|
233a261a3f | ||
|
|
fe3d4d6329 | ||
|
|
195a96de65 | ||
|
|
52f95594c0 | ||
|
|
0f9e567ead | ||
|
|
8cec429b0e | ||
|
|
c94658ea09 | ||
|
|
6ed6db2b3f | ||
|
|
354309feec | ||
|
|
26a1948e50 | ||
|
|
28a8a0f84e | ||
|
|
11435f7452 | ||
|
|
f2a802819f | ||
|
|
1465f6f3ca | ||
|
|
c276507d3b | ||
|
|
98edfb9bb2 | ||
|
|
c32f4e92a1 | ||
|
|
1542a9556f | ||
|
|
4948e2b91d | ||
|
|
621e018999 | ||
|
|
3641c2dc76 | ||
|
|
86a032a32f | ||
|
|
b68ae2d0bd | ||
|
|
30b033ee9d | ||
|
|
9fac5a4ad4 | ||
|
|
73a8ccc085 | ||
|
|
c05aa74a3e | ||
|
|
d112144293 | ||
|
|
30de0727ab | ||
|
|
8823baf480 | ||
|
|
d470ade7a7 | ||
|
|
66e8279dca | ||
|
|
969a9cdcb0 | ||
|
|
5620147f89 | ||
|
|
dda9ed6d55 | ||
|
|
76e0d5fd87 | ||
|
|
7382058ecb | ||
|
|
0a8d599965 | ||
|
|
21cc07bd48 | ||
|
|
902545bdb4 | ||
|
|
ea3cd5ef30 | ||
|
|
9010e1551f | ||
|
|
c05c47187a | ||
|
|
9ee6c3c5cf | ||
|
|
a391fa88dc | ||
|
|
59d285f2f1 | ||
|
|
e6810fa7e0 | ||
|
|
3eaa1dc5cd | ||
|
|
6de1077806 | ||
|
|
3020346caa | ||
|
|
57554f6288 | ||
|
|
eb8ea7d8a6 | ||
|
|
b94af2bf3a | ||
|
|
d143bb48b0 | ||
|
|
e78cc9bd36 | ||
|
|
f30db928fb | ||
|
|
b15dcbf1c4 | ||
|
|
0cb8bd5f9a | ||
|
|
603a0c6e80 | ||
|
|
ad62febd59 | ||
|
|
7b5ed48a5f | ||
|
|
527b3bc54b | ||
|
|
a66c040cbc | ||
|
|
a2b1fbb737 | ||
|
|
d28412ee32 | ||
|
|
8bb81a3084 |
24
.devcontainer/20_init_plugin
Executable file
24
.devcontainer/20_init_plugin
Executable 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
26
.devcontainer/Dockerfile
Normal 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
8
.devcontainer/bin/copy-file
Executable 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 "$@"
|
||||||
16
.devcontainer/devcontainer.json
Normal file
16
.devcontainer/devcontainer.json
Normal 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"]
|
||||||
|
}
|
||||||
6
.github/dependabot.yml
vendored
Normal file
6
.github/dependabot.yml
vendored
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
version: 2
|
||||||
|
updates:
|
||||||
|
- package-ecosystem: "docker"
|
||||||
|
directory: "/"
|
||||||
|
schedule:
|
||||||
|
interval: "daily"
|
||||||
57
.github/labels.yml
vendored
Normal file
57
.github/labels.yml
vendored
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
labels:
|
||||||
|
- name: bc-break
|
||||||
|
color: eb6420
|
||||||
|
- name: blocks release
|
||||||
|
color: "000000"
|
||||||
|
- name: 'difficulty: easy'
|
||||||
|
color: c5def5
|
||||||
|
- name: 'difficulty: hard'
|
||||||
|
color: e99695
|
||||||
|
- name: 'difficulty: medium'
|
||||||
|
color: fef2c0
|
||||||
|
- name: hacktoberfest
|
||||||
|
color: b0581d
|
||||||
|
- name: 'needs: documentation'
|
||||||
|
color: c2e0c6
|
||||||
|
- name: 'needs: more info'
|
||||||
|
color: c2e0c6
|
||||||
|
- name: 'needs: rebase'
|
||||||
|
color: c2e0c6
|
||||||
|
- name: 'needs: tests'
|
||||||
|
color: c2e0c6
|
||||||
|
- name: 'status: duplicate'
|
||||||
|
color: cccccc
|
||||||
|
- name: 'status: fix-provided'
|
||||||
|
color: c5def5
|
||||||
|
- name: 'status: future'
|
||||||
|
color: c5def5
|
||||||
|
- name: 'status: has plan'
|
||||||
|
color: c5def5
|
||||||
|
- name: 'status: invalid'
|
||||||
|
color: cccccc
|
||||||
|
- name: 'status: merge for next minor'
|
||||||
|
color: c5def5
|
||||||
|
- name: 'status: merge for next patch'
|
||||||
|
color: c5def5
|
||||||
|
- name: 'status: wontfix'
|
||||||
|
color: cccccc
|
||||||
|
- name: 'type: bug'
|
||||||
|
color: e01b1b
|
||||||
|
- name: 'type: documentation'
|
||||||
|
color: 0052cc
|
||||||
|
- name: 'type: enhancement'
|
||||||
|
color: 09ab3c
|
||||||
|
- name: 'type: question'
|
||||||
|
color: cc317c
|
||||||
|
- name: 'type: refactor'
|
||||||
|
color: 0052cc
|
||||||
|
- name: 'type: rfc'
|
||||||
|
color: 0052cc
|
||||||
|
- name: 'type: roadmap'
|
||||||
|
color: 0052cc
|
||||||
|
- name: 'type: service'
|
||||||
|
color: "5319e7"
|
||||||
|
- name: 'type: support'
|
||||||
|
color: cc317c
|
||||||
|
- name: 'type: tests'
|
||||||
|
color: 0052cc
|
||||||
100
.github/workflows/ci.yml
vendored
Normal file
100
.github/workflows/ci.yml
vendored
Normal file
@@ -0,0 +1,100 @@
|
|||||||
|
---
|
||||||
|
name: CI
|
||||||
|
|
||||||
|
# yamllint disable-line rule:truthy
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- '*'
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
unit-tests-master:
|
||||||
|
name: unit-tests
|
||||||
|
runs-on: ubuntu-18.04
|
||||||
|
strategy:
|
||||||
|
fail-fast: true
|
||||||
|
env:
|
||||||
|
DOKKU_VERSION: master
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- uses: actions/setup-python@v2
|
||||||
|
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@v2
|
||||||
|
if: failure()
|
||||||
|
with:
|
||||||
|
name: tmp/test-results
|
||||||
|
path: test-results
|
||||||
|
|
||||||
|
unit-tests-0_19_0:
|
||||||
|
name: unit-tests-0.19.0
|
||||||
|
runs-on: ubuntu-18.04
|
||||||
|
strategy:
|
||||||
|
fail-fast: true
|
||||||
|
env:
|
||||||
|
DOKKU_TAG: v0.19.0
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- uses: actions/setup-python@v2
|
||||||
|
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@v2
|
||||||
|
if: failure()
|
||||||
|
with:
|
||||||
|
name: tmp/test-results
|
||||||
|
path: test-results
|
||||||
6
.gitignore
vendored
6
.gitignore
vendored
@@ -1,5 +1,3 @@
|
|||||||
tests/dokku
|
/tmp
|
||||||
tests/fixtures
|
|
||||||
tests/bin/plugn
|
|
||||||
tests/bin/readlink
|
|
||||||
.vagrant
|
.vagrant
|
||||||
|
bootstrap.sh
|
||||||
|
|||||||
10
.travis.yml
10
.travis.yml
@@ -1,10 +0,0 @@
|
|||||||
sudo: required
|
|
||||||
dist: trusty
|
|
||||||
language: bash
|
|
||||||
env:
|
|
||||||
- DOKKU_VERSION=master DOKKU_SYSTEM_GROUP=travis DOKKU_SYSTEM_USER=travis
|
|
||||||
- DOKKU_VERSION=v0.7.0 DOKKU_SYSTEM_GROUP=travis DOKKU_SYSTEM_USER=travis
|
|
||||||
- DOKKU_VERSION=v0.6.0 DOKKU_SYSTEM_GROUP=travis DOKKU_SYSTEM_USER=travis
|
|
||||||
- DOKKU_VERSION=v0.5.0 DOKKU_SYSTEM_GROUP=travis DOKKU_SYSTEM_USER=travis
|
|
||||||
- DOKKU_VERSION=v0.4.0 DOKKU_SYSTEM_GROUP=travis DOKKU_SYSTEM_USER=travis
|
|
||||||
script: make test
|
|
||||||
1
Dockerfile
Normal file
1
Dockerfile
Normal file
@@ -0,0 +1 @@
|
|||||||
|
FROM postgres:13.4
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
Copyright (C) 2015 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:
|
||||||
|
|
||||||
|
|||||||
78
Makefile
78
Makefile
@@ -1,22 +1,40 @@
|
|||||||
|
HARDWARE = $(shell uname -m)
|
||||||
|
SYSTEM_NAME = $(shell uname -s | tr '[:upper:]' '[:lower:]')
|
||||||
|
SHFMT_VERSION = 3.0.2
|
||||||
|
XUNIT_TO_GITHUB_VERSION = 0.3.0
|
||||||
|
XUNIT_READER_VERSION = 0.1.0
|
||||||
|
|
||||||
|
|
||||||
|
bats:
|
||||||
|
ifeq ($(SYSTEM_NAME),darwin)
|
||||||
|
ifneq ($(shell bats --version >/dev/null 2>&1 ; echo $$?),0)
|
||||||
|
brew install bats-core
|
||||||
|
endif
|
||||||
|
else
|
||||||
|
git clone https://github.com/bats-core/bats-core.git /tmp/bats
|
||||||
|
cd /tmp/bats && sudo ./install.sh /usr/local
|
||||||
|
rm -rf /tmp/bats
|
||||||
|
endif
|
||||||
|
|
||||||
shellcheck:
|
shellcheck:
|
||||||
ifeq ($(shell shellcheck > /dev/null 2>&1 ; echo $$?),127)
|
ifneq ($(shell shellcheck --version >/dev/null 2>&1 ; echo $$?),0)
|
||||||
ifeq ($(shell uname),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'
|
sudo add-apt-repository 'deb http://archive.ubuntu.com/ubuntu trusty-backports main restricted universe multiverse'
|
||||||
|
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
|
||||||
endif
|
endif
|
||||||
|
|
||||||
bats:
|
shfmt:
|
||||||
ifeq ($(shell bats > /dev/null 2>&1 ; echo $$?),127)
|
ifneq ($(shell shfmt --version >/dev/null 2>&1 ; echo $$?),0)
|
||||||
ifeq ($(shell uname),Darwin)
|
ifeq ($(shfmt),Darwin)
|
||||||
git clone https://github.com/sstephenson/bats.git /tmp/bats
|
brew install shfmt
|
||||||
cd /tmp/bats && sudo ./install.sh /usr/local
|
|
||||||
rm -rf /tmp/bats
|
|
||||||
else
|
else
|
||||||
sudo add-apt-repository ppa:duggan/bats --yes
|
wget -qO /tmp/shfmt https://github.com/mvdan/sh/releases/download/v$(SHFMT_VERSION)/shfmt_v$(SHFMT_VERSION)_linux_amd64
|
||||||
sudo apt-get update -qq && sudo apt-get install -qq -y bats
|
chmod +x /tmp/shfmt
|
||||||
|
sudo mv /tmp/shfmt /usr/local/bin/shfmt
|
||||||
endif
|
endif
|
||||||
endif
|
endif
|
||||||
|
|
||||||
@@ -30,20 +48,46 @@ endif
|
|||||||
|
|
||||||
ci-dependencies: shellcheck bats readlink
|
ci-dependencies: shellcheck bats readlink
|
||||||
|
|
||||||
lint:
|
lint-setup:
|
||||||
|
@mkdir -p tmp/test-results/shellcheck tmp/shellcheck
|
||||||
|
@find . -not -path '*/\.*' -type f | xargs file | grep text | awk -F ':' '{ print $$1 }' | xargs head -n1 | egrep -B1 "bash" | grep "==>" | awk '{ print $$2 }' > tmp/shellcheck/test-files
|
||||||
|
@cat tests/shellcheck-exclude | sed -n -e '/^# SC/p' | cut -d' ' -f2 | paste -d, -s - > tmp/shellcheck/exclude
|
||||||
|
|
||||||
|
lint: lint-setup
|
||||||
# these are disabled due to their expansive existence in the codebase. we should clean it up though
|
# these are disabled due to their expansive existence in the codebase. we should clean it up though
|
||||||
# SC1090: Can't follow non-constant source. Use a directive to specify location.
|
@cat tests/shellcheck-exclude | sed -n -e '/^# SC/p'
|
||||||
# SC2034: Variable appears unused. Verify it or export it.
|
|
||||||
# SC2155: Declare and assign separately to avoid masking return values.
|
|
||||||
@echo linting...
|
@echo linting...
|
||||||
@$(QUIET) find ./ -maxdepth 1 -not -path '*/\.*' | xargs file | egrep "shell|bash" | awk '{ print $$1 }' | sed 's/://g' | xargs shellcheck -e SC1090,SC2034,SC2155
|
@cat tmp/shellcheck/test-files | xargs shellcheck -e $(shell cat tmp/shellcheck/exclude) | tests/shellcheck-to-junit --output tmp/test-results/shellcheck/results.xml --files tmp/shellcheck/test-files --exclude $(shell cat tmp/shellcheck/exclude)
|
||||||
|
|
||||||
unit-tests:
|
unit-tests:
|
||||||
@echo running unit tests...
|
@echo running unit tests...
|
||||||
@$(QUIET) bats tests
|
@mkdir -p tmp/test-results/bats
|
||||||
|
@cd tests && echo "executing tests: $(shell cd tests ; ls *.bats | xargs)"
|
||||||
|
cd tests && bats --report-formatter junit --timing -o ../tmp/test-results/bats *.bats
|
||||||
|
|
||||||
|
tmp/xunit-reader:
|
||||||
|
mkdir -p tmp
|
||||||
|
curl -o tmp/xunit-reader.tgz -sL https://github.com/josegonzalez/go-xunit-reader/releases/download/v$(XUNIT_READER_VERSION)/xunit-reader_$(XUNIT_READER_VERSION)_$(SYSTEM_NAME)_$(HARDWARE).tgz
|
||||||
|
tar xf tmp/xunit-reader.tgz -C tmp
|
||||||
|
chmod +x tmp/xunit-reader
|
||||||
|
|
||||||
setup:
|
setup:
|
||||||
bash tests/setup.sh
|
bash tests/setup.sh
|
||||||
$(MAKE) ci-dependencies
|
$(MAKE) ci-dependencies
|
||||||
|
|
||||||
test: setup lint unit-tests
|
test: lint unit-tests
|
||||||
|
|
||||||
|
report: tmp/xunit-reader
|
||||||
|
tmp/xunit-reader -p 'tmp/test-results/bats/*.xml'
|
||||||
|
tmp/xunit-reader -p 'tmp/test-results/shellcheck/*.xml'
|
||||||
|
|
||||||
|
.PHONY: clean
|
||||||
|
clean:
|
||||||
|
rm -f README.md
|
||||||
|
|
||||||
|
.PHONY: generate
|
||||||
|
generate: clean README.md
|
||||||
|
|
||||||
|
.PHONY: README.md
|
||||||
|
README.md:
|
||||||
|
bin/generate
|
||||||
|
|||||||
880
README.md
880
README.md
@@ -1,278 +1,722 @@
|
|||||||
# dokku postgres [](https://travis-ci.org/dokku/dokku-postgres) [](https://webchat.freenode.net/?channels=dokku)
|
# dokku postgres [](https://github.com/dokku/dokku-postgres/actions/workflows/ci.yml?query=branch%3Amaster) [](https://webchat.libera.chat/?channels=dokku)
|
||||||
|
|
||||||
Official postgres plugin for dokku. Currently defaults to installing [postgres 10.2](https://hub.docker.com/_/postgres/).
|
Official postgres plugin for dokku. Currently defaults to installing [postgres 13.4](https://hub.docker.com/_/postgres/).
|
||||||
|
|
||||||
## requirements
|
## Requirements
|
||||||
|
|
||||||
- dokku 0.4.x+
|
- dokku 0.19.x+
|
||||||
- docker 1.8.x
|
- docker 1.8.x
|
||||||
|
|
||||||
## installation
|
## Installation
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
# on 0.4.x+
|
# on 0.19.x+
|
||||||
sudo dokku plugin:install https://github.com/dokku/dokku-postgres.git postgres
|
sudo dokku plugin:install https://github.com/dokku/dokku-postgres.git postgres
|
||||||
```
|
```
|
||||||
|
|
||||||
## commands
|
## Commands
|
||||||
|
|
||||||
```
|
```
|
||||||
postgres:backup <name> <bucket> (--use-iam) Create a backup of the postgres service to an existing s3 bucket
|
postgres:app-links <app> # list all postgres service links for a given app
|
||||||
postgres:backup-auth <name> <aws_access_key_id> <aws_secret_access_key> (<aws_default_region>) (<aws_signature_version>) (<endpoint_url>) Sets up authentication for backups on the postgres service
|
postgres:backup <service> <bucket-name> [--use-iam] # create a backup of the postgres service to an existing s3 bucket
|
||||||
postgres:backup-deauth <name> Removes backup authentication for the postgres service
|
postgres:backup-auth <service> <aws-access-key-id> <aws-secret-access-key> <aws-default-region> <aws-signature-version> <endpoint-url> # set up authentication for backups on the postgres service
|
||||||
postgres:backup-schedule <name> <schedule> <bucket> Schedules a backup of the postgres service
|
postgres:backup-deauth <service> # remove backup authentication for the postgres service
|
||||||
postgres:backup-schedule-cat <name> Show the backup schedule for the service
|
postgres:backup-schedule <service> <schedule> <bucket-name> [--use-iam] # schedule a backup of the postgres service
|
||||||
postgres:backup-set-encryption <name> <encryption_key> Sets up GPG encryption for future backups of the postgres service
|
postgres:backup-schedule-cat <service> # cat the contents of the configured backup cronfile for the service
|
||||||
postgres:backup-unschedule <name> Unschedules the backup of the postgres service
|
postgres:backup-set-encryption <service> <passphrase> # set encryption for all future backups of postgres service
|
||||||
postgres:backup-unset-encryption <name> Removes backup encryption for future backups of the postgres service
|
postgres:backup-unschedule <service> # unschedule the backup of the postgres service
|
||||||
postgres:clone <name> <new-name> Create container <new-name> then copy data from <name> into <new-name>
|
postgres:backup-unset-encryption <service> # unset encryption for future backups of the postgres service
|
||||||
postgres:connect <name> Connect via psql to a postgres service
|
postgres:clone <service> <new-service> [--clone-flags...] # create container <new-name> then copy data from <name> into <new-name>
|
||||||
postgres:create <name> Create a postgres service with environment variables
|
postgres:connect <service> # connect to the service via the postgres connection tool
|
||||||
postgres:destroy <name> Delete the service, delete the data and stop its container if there are no links left
|
postgres:create <service> [--create-flags...] # create a postgres service
|
||||||
postgres:enter <name> [command] Enter or run a command in a running postgres service container
|
postgres:destroy <service> [-f|--force] # delete the postgres service/data/container if there are no links left
|
||||||
postgres:exists <service> Check if the postgres service exists
|
postgres:enter <service> # enter or run a command in a running postgres service container
|
||||||
postgres:export <name> > <file> Export a dump of the postgres service database
|
postgres:exists <service> # check if the postgres service exists
|
||||||
postgres:expose <name> [port] Expose a postgres service on custom port if provided (random port otherwise)
|
postgres:export <service> # export a dump of the postgres service database
|
||||||
postgres:import <name> < <file> Import a dump into the postgres service database
|
postgres:expose <service> <ports...> # expose a postgres service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)
|
||||||
postgres:info <name> Print the connection information
|
postgres:import <service> # import a dump into the postgres service database
|
||||||
postgres:link <name> <app> Link the postgres service to the app
|
postgres:info <service> [--single-info-flag] # print the service information
|
||||||
postgres:linked <name> <app> Check if the postgres service is linked to an app
|
postgres:link <service> <app> [--link-flags...] # link the postgres service to the app
|
||||||
postgres:list List all postgres services
|
postgres:linked <service> <app> # check if the postgres service is linked to an app
|
||||||
postgres:logs <name> [-t] Print the most recent log(s) for this service
|
postgres:links <service> # list all apps linked to the postgres service
|
||||||
postgres:promote <name> <app> Promote service <name> as DATABASE_URL in <app>
|
postgres:list # list all postgres services
|
||||||
postgres:restart <name> Graceful shutdown and restart of the postgres service container
|
postgres:logs <service> [-t|--tail] # print the most recent log(s) for this service
|
||||||
postgres:start <name> Start a previously stopped postgres service
|
postgres:promote <service> <app> # promote service <service> as DATABASE_URL in <app>
|
||||||
postgres:stop <name> Stop a running postgres service
|
postgres:restart <service> # graceful shutdown and restart of the postgres service container
|
||||||
postgres:unexpose <name> Unexpose a previously exposed postgres service
|
postgres:start <service> # start a previously stopped postgres service
|
||||||
postgres:unlink <name> <app> Unlink the postgres service from the app
|
postgres:stop <service> # stop a running postgres service
|
||||||
|
postgres:unexpose <service> # unexpose a previously exposed postgres service
|
||||||
|
postgres:unlink <service> <app> # unlink the postgres service from the app
|
||||||
|
postgres:upgrade <service> [--upgrade-flags...] # upgrade service <service> to the specified versions
|
||||||
```
|
```
|
||||||
|
|
||||||
## usage
|
## Usage
|
||||||
|
|
||||||
|
Help for any commands can be displayed by specifying the command as an argument to postgres:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `postgres:help` command for any undocumented commands.
|
||||||
|
|
||||||
|
### Basic Usage
|
||||||
|
|
||||||
|
### create a postgres service
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
# create a postgres service named lolipop
|
# usage
|
||||||
dokku postgres:create lolipop
|
dokku postgres:create <service> [--create-flags...]
|
||||||
|
```
|
||||||
|
|
||||||
# you can also specify the image and image
|
flags:
|
||||||
# version to use for the service
|
|
||||||
# it *must* be compatible with the
|
- `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: `None`)
|
||||||
# official postgres 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 (default: unlimited)
|
||||||
|
- `-p|--password PASSWORD`: override the user-level service password
|
||||||
|
- `-r|--root-password PASSWORD`: override the root-level service password
|
||||||
|
- `-s|--shm-size SHM_SIZE`: override shared memory size for postgres docker container
|
||||||
|
|
||||||
|
Create a postgres service named lollipop:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:create lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also specify the image and image version to use for the service. It *must* be compatible with the postgres image.
|
||||||
|
|
||||||
|
```shell
|
||||||
export POSTGRES_IMAGE="postgres"
|
export POSTGRES_IMAGE="postgres"
|
||||||
export POSTGRES_IMAGE_VERSION="10.2"
|
export POSTGRES_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
|
||||||
dokku postgres:create lolipop
|
dokku postgres:create lollipop
|
||||||
|
```
|
||||||
|
|
||||||
# you can also specify custom environment
|
You can also specify custom environment variables to start the postgres service in semi-colon separated form.
|
||||||
# variables to start the postgres service
|
|
||||||
# in semi-colon separated form
|
```shell
|
||||||
export POSTGRES_CUSTOM_ENV="USER=alpha;HOST=beta"
|
export POSTGRES_CUSTOM_ENV="USER=alpha;HOST=beta"
|
||||||
dokku postgres:create lolipop
|
dokku postgres:create lollipop
|
||||||
|
```
|
||||||
|
|
||||||
# get connection information as follows
|
Official Postgres docker images does not include postgis extension (amongst others). The following example creates a new postgres service using `postgis/postgis:13-3.1` image, which includes the `postgis` extension.
|
||||||
dokku postgres:info lolipop
|
|
||||||
|
|
||||||
# you can also retrieve a specific piece of service info via flags
|
```shell
|
||||||
dokku postgres:info lolipop --data-dir
|
dokku postgres:create postgis-database --image "postgis/postgis" --image-version "13-3.1"
|
||||||
dokku postgres:info lolipop --dsn
|
```
|
||||||
dokku postgres:info lolipop --exposed-ports
|
|
||||||
dokku postgres:info lolipop --id
|
|
||||||
dokku postgres:info lolipop --internal-ip
|
|
||||||
dokku postgres:info lolipop --links
|
|
||||||
dokku postgres:info lolipop --service-root
|
|
||||||
dokku postgres:info lolipop --status
|
|
||||||
dokku postgres:info lolipop --version
|
|
||||||
|
|
||||||
# a bash prompt can be opened against a running service
|
### print the service information
|
||||||
# filesystem changes will not be saved to disk
|
|
||||||
dokku postgres:enter lolipop
|
|
||||||
|
|
||||||
# you may also run a command directly against the service
|
```shell
|
||||||
# filesystem changes will not be saved to disk
|
# usage
|
||||||
dokku postgres:enter lolipop ls -lah /
|
dokku postgres:info <service> [--single-info-flag]
|
||||||
|
```
|
||||||
|
|
||||||
# a postgres service can be linked to a
|
flags:
|
||||||
# container this will use native docker
|
|
||||||
# links via the docker-options plugin
|
|
||||||
# here we link it to our 'playground' app
|
|
||||||
# NOTE: this will restart your app
|
|
||||||
dokku postgres:link lolipop playground
|
|
||||||
|
|
||||||
# the following environment variables will be set automatically by docker (not
|
- `--config-dir`: show the service configuration directory
|
||||||
# on the app itself, so they won’t be listed when calling dokku config)
|
- `--data-dir`: show the service data directory
|
||||||
#
|
- `--dsn`: show the service DSN
|
||||||
# DOKKU_POSTGRES_LOLIPOP_NAME=/lolipop/DATABASE
|
- `--exposed-ports`: show service exposed ports
|
||||||
# DOKKU_POSTGRES_LOLIPOP_PORT=tcp://172.17.0.1:5432
|
- `--id`: show the service container id
|
||||||
# DOKKU_POSTGRES_LOLIPOP_PORT_5432_TCP=tcp://172.17.0.1:5432
|
- `--internal-ip`: show the service internal ip
|
||||||
# DOKKU_POSTGRES_LOLIPOP_PORT_5432_TCP_PROTO=tcp
|
- `--links`: show the service app links
|
||||||
# DOKKU_POSTGRES_LOLIPOP_PORT_5432_TCP_PORT=5432
|
- `--service-root`: show the service root directory
|
||||||
# DOKKU_POSTGRES_LOLIPOP_PORT_5432_TCP_ADDR=172.17.0.1
|
- `--status`: show the service running status
|
||||||
#
|
- `--version`: show the service image version
|
||||||
# and the following will be set on the linked application by default
|
|
||||||
#
|
|
||||||
# DATABASE_URL=postgres://postgres:SOME_PASSWORD@dokku-postgres-lolipop:5432/lolipop
|
|
||||||
#
|
|
||||||
# NOTE: the host exposed here only works internally in docker containers. If
|
|
||||||
# you want your container to be reachable from outside, you should use `expose`.
|
|
||||||
|
|
||||||
# another service can be linked to your app
|
Get connection information as follows:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:info lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also retrieve a specific piece of service info via flags:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:info lollipop --config-dir
|
||||||
|
dokku postgres:info lollipop --data-dir
|
||||||
|
dokku postgres:info lollipop --dsn
|
||||||
|
dokku postgres:info lollipop --exposed-ports
|
||||||
|
dokku postgres:info lollipop --id
|
||||||
|
dokku postgres:info lollipop --internal-ip
|
||||||
|
dokku postgres:info lollipop --links
|
||||||
|
dokku postgres:info lollipop --service-root
|
||||||
|
dokku postgres:info lollipop --status
|
||||||
|
dokku postgres:info lollipop --version
|
||||||
|
```
|
||||||
|
|
||||||
|
### list all postgres services
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:list
|
||||||
|
```
|
||||||
|
|
||||||
|
List all services:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:list
|
||||||
|
```
|
||||||
|
|
||||||
|
### print the most recent log(s) for this service
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:logs <service> [-t|--tail]
|
||||||
|
```
|
||||||
|
|
||||||
|
flags:
|
||||||
|
|
||||||
|
- `-t|--tail`: do not stop when end of the logs are reached and wait for additional output
|
||||||
|
|
||||||
|
You can tail logs for a particular service:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:logs lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
By default, logs will not be tailed, but you can do this with the --tail flag:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:logs lollipop --tail
|
||||||
|
```
|
||||||
|
|
||||||
|
### link the postgres service to the app
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:link <service> <app> [--link-flags...]
|
||||||
|
```
|
||||||
|
|
||||||
|
flags:
|
||||||
|
|
||||||
|
- `-a|--alias "BLUE_DATABASE"`: an alternative alias to use for linking to an app via environment variable
|
||||||
|
- `-q|--querystring "pool=5"`: ampersand delimited querystring arguments to append to the service link
|
||||||
|
|
||||||
|
A postgres service can be linked to a container. This will use native docker links via the docker-options plugin. Here we link it to our `playground` app.
|
||||||
|
|
||||||
|
> NOTE: this will restart your app
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:link lollipop playground
|
||||||
|
```
|
||||||
|
|
||||||
|
The following environment variables will be set automatically by docker (not on the app itself, so they won’t be listed when calling dokku config):
|
||||||
|
|
||||||
|
```
|
||||||
|
DOKKU_POSTGRES_LOLLIPOP_NAME=/lollipop/DATABASE
|
||||||
|
DOKKU_POSTGRES_LOLLIPOP_PORT=tcp://172.17.0.1:5432
|
||||||
|
DOKKU_POSTGRES_LOLLIPOP_PORT_5432_TCP=tcp://172.17.0.1:5432
|
||||||
|
DOKKU_POSTGRES_LOLLIPOP_PORT_5432_TCP_PROTO=tcp
|
||||||
|
DOKKU_POSTGRES_LOLLIPOP_PORT_5432_TCP_PORT=5432
|
||||||
|
DOKKU_POSTGRES_LOLLIPOP_PORT_5432_TCP_ADDR=172.17.0.1
|
||||||
|
```
|
||||||
|
|
||||||
|
The following will be set on the linked application by default:
|
||||||
|
|
||||||
|
```
|
||||||
|
DATABASE_URL=postgres://lollipop:SOME_PASSWORD@dokku-postgres-lollipop:5432/lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
The host exposed here only works internally in docker containers. If you want your container to be reachable from outside, you should use the `expose` subcommand. Another service can be linked to your app:
|
||||||
|
|
||||||
|
```shell
|
||||||
dokku postgres:link other_service playground
|
dokku postgres:link other_service playground
|
||||||
|
|
||||||
# since DATABASE_URL is already in use, another environment variable will be
|
|
||||||
# generated automatically
|
|
||||||
#
|
|
||||||
# DOKKU_POSTGRES_BLUE_URL=postgres://postgres:ANOTHER_PASSWORD@dokku-postgres-other_service:5432/other_service
|
|
||||||
|
|
||||||
# you can then promote the new service to be the primary one
|
|
||||||
# NOTE: this will restart your app
|
|
||||||
dokku postgres:promote other_service playground
|
|
||||||
|
|
||||||
# this will replace DATABASE_URL with the url from other_service and generate
|
|
||||||
# another environment variable to hold the previous value if necessary.
|
|
||||||
# you could end up with the following for example:
|
|
||||||
#
|
|
||||||
# DATABASE_URL=postgres://postgres:ANOTHER_PASSWORD@dokku-postgres-other_service:5432/other_service
|
|
||||||
# DOKKU_POSTGRES_BLUE_URL=postgres://postgres:ANOTHER_PASSWORD@dokku-postgres-other_service:5432/other_service
|
|
||||||
# DOKKU_POSTGRES_SILVER_URL=postgres://postgres:SOME_PASSWORD@dokku-postgres-lolipop:5432/lolipop
|
|
||||||
|
|
||||||
# you can also unlink a postgres service
|
|
||||||
# NOTE: this will restart your app and unset related environment variables
|
|
||||||
dokku postgres:unlink lolipop playground
|
|
||||||
|
|
||||||
# you can tail logs for a particular service
|
|
||||||
dokku postgres:logs lolipop
|
|
||||||
dokku postgres:logs lolipop -t # to tail
|
|
||||||
|
|
||||||
# you can dump the database
|
|
||||||
dokku postgres:export lolipop > lolipop.dump
|
|
||||||
|
|
||||||
# you can import a dump
|
|
||||||
dokku postgres:import lolipop < database.dump
|
|
||||||
|
|
||||||
# you can clone an existing database to a new one
|
|
||||||
dokku postgres:clone lolipop new_database
|
|
||||||
|
|
||||||
# finally, you can destroy the container
|
|
||||||
dokku postgres:destroy lolipop
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Changing database adapter
|
It is possible to change the protocol for `DATABASE_URL` by setting the environment variable `POSTGRES_DATABASE_SCHEME` on the app. Doing so will after linking will cause the plugin to think the service is not linked, and we advise you to unlink before proceeding.
|
||||||
|
|
||||||
It's possible to change the protocol for DATABASE_URL by setting
|
```shell
|
||||||
the environment variable POSTGRES_DATABASE_SCHEME on the app:
|
|
||||||
|
|
||||||
```
|
|
||||||
dokku config:set playground POSTGRES_DATABASE_SCHEME=postgres2
|
dokku config:set playground POSTGRES_DATABASE_SCHEME=postgres2
|
||||||
dokku postgres:link lolipop playground
|
dokku postgres:link lollipop playground
|
||||||
```
|
```
|
||||||
|
|
||||||
Will cause DATABASE_URL to be set as
|
This will cause `DATABASE_URL` to be set as:
|
||||||
postgres2://postgres:SOME_PASSWORD@dokku-postgres-lolipop:5432/lolipop
|
|
||||||
|
|
||||||
CAUTION: Changing POSTGRES_DATABASE_SCHEME after linking will cause dokku to
|
```
|
||||||
believe the postgres is not linked when attempting to use `dokku postgres:unlink`
|
postgres2://lollipop:SOME_PASSWORD@dokku-postgres-lollipop:5432/lollipop
|
||||||
or `dokku postgres:promote`.
|
```
|
||||||
You should be able to fix this by
|
|
||||||
|
|
||||||
- Changing DATABASE_URL manually to the new value.
|
### unlink the postgres service from the app
|
||||||
|
|
||||||
OR
|
|
||||||
|
|
||||||
- Set POSTGRES_DATABASE_SCHEME back to its original setting
|
|
||||||
- Unlink the service
|
|
||||||
- Change POSTGRES_DATABASE_SCHEME to the desired setting
|
|
||||||
- Relink the service
|
|
||||||
|
|
||||||
## upgrade/downgrade
|
|
||||||
|
|
||||||
At the moment a database can’t be upgraded (or downgraded) inplace. Instead a clone has to be made, like this:
|
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
# Our original DB using PG 9.5
|
# usage
|
||||||
$ dokku postgres:create db9.5
|
dokku postgres:unlink <service> <app>
|
||||||
|
|
||||||
# Migrate it like this for example
|
|
||||||
$ POSTGRES_IMAGE_VERSION=9.6 dokku postgres:clone db9.5 db9.6
|
|
||||||
|
|
||||||
# If it was linked to an application, first link the new DB
|
|
||||||
$ dokku postgres:link db9.6 my_app
|
|
||||||
# Then unlink the old one
|
|
||||||
$ dokku postgres:unlink db9.5 my_app
|
|
||||||
|
|
||||||
# And last, destroy the old container
|
|
||||||
$ dokku postgres:destroy db9.5
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Configuration
|
You can unlink a postgres service:
|
||||||
|
|
||||||
If you wish to tune the postgres instances various .conf files, you can find them by using the postgres:info command.
|
> NOTE: this will restart your app and unset related environment variables
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
dokku postgres:info lolipop
|
dokku postgres:unlink lollipop playground
|
||||||
# or
|
|
||||||
dokku postgres:info lolipop --data-dir
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Backups
|
### Service Lifecycle
|
||||||
|
|
||||||
|
The lifecycle of each service can be managed through the following commands:
|
||||||
|
|
||||||
|
### connect to the service via the postgres connection tool
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:connect <service>
|
||||||
|
```
|
||||||
|
|
||||||
|
Connect to the service via the postgres connection tool:
|
||||||
|
|
||||||
|
> NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:connect lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
### enter or run a command in a running postgres service container
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:enter <service>
|
||||||
|
```
|
||||||
|
|
||||||
|
A bash prompt can be opened against a running service. Filesystem changes will not be saved to disk.
|
||||||
|
|
||||||
|
> NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:enter lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
You may also run a command directly against the service. Filesystem changes will not be saved to disk.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:enter lollipop touch /tmp/test
|
||||||
|
```
|
||||||
|
|
||||||
|
### expose a postgres service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:expose <service> <ports...>
|
||||||
|
```
|
||||||
|
|
||||||
|
Expose the service on the service's normal ports, allowing access to it from the public interface (`0.0.0.0`):
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:expose lollipop 5432
|
||||||
|
```
|
||||||
|
|
||||||
|
Expose the service on the service's normal ports, with the first on a specified ip adddress (127.0.0.1):
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:expose lollipop 127.0.0.1:5432
|
||||||
|
```
|
||||||
|
|
||||||
|
### unexpose a previously exposed postgres service
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:unexpose <service>
|
||||||
|
```
|
||||||
|
|
||||||
|
Unexpose the service, removing access to it from the public interface (`0.0.0.0`):
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:unexpose lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
### promote service <service> as DATABASE_URL in <app>
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:promote <service> <app>
|
||||||
|
```
|
||||||
|
|
||||||
|
If you have a postgres service linked to an app and try to link another postgres service another link environment variable will be generated automatically:
|
||||||
|
|
||||||
|
```
|
||||||
|
DOKKU_DATABASE_BLUE_URL=postgres://other_service:ANOTHER_PASSWORD@dokku-postgres-other-service:5432/other_service
|
||||||
|
```
|
||||||
|
|
||||||
|
You can promote the new service to be the primary one:
|
||||||
|
|
||||||
|
> NOTE: this will restart your app
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:promote other_service playground
|
||||||
|
```
|
||||||
|
|
||||||
|
This will replace `DATABASE_URL` with the url from other_service and generate another environment variable to hold the previous value if necessary. You could end up with the following for example:
|
||||||
|
|
||||||
|
```
|
||||||
|
DATABASE_URL=postgres://other_service:ANOTHER_PASSWORD@dokku-postgres-other-service:5432/other_service
|
||||||
|
DOKKU_DATABASE_BLUE_URL=postgres://other_service:ANOTHER_PASSWORD@dokku-postgres-other-service:5432/other_service
|
||||||
|
DOKKU_DATABASE_SILVER_URL=postgres://lollipop:SOME_PASSWORD@dokku-postgres-lollipop:5432/lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
### start a previously stopped postgres service
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:start <service>
|
||||||
|
```
|
||||||
|
|
||||||
|
Start the service:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:start lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
### stop a running postgres service
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:stop <service>
|
||||||
|
```
|
||||||
|
|
||||||
|
Stop the service and the running container:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:stop lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
### graceful shutdown and restart of the postgres service container
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:restart <service>
|
||||||
|
```
|
||||||
|
|
||||||
|
Restart the service:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:restart lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
### upgrade service <service> to the specified versions
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:upgrade <service> [--upgrade-flags...]
|
||||||
|
```
|
||||||
|
|
||||||
|
flags:
|
||||||
|
|
||||||
|
- `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: `None`)
|
||||||
|
- `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with
|
||||||
|
- `-i|--image IMAGE`: the image name to start the service with
|
||||||
|
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
|
||||||
|
- `-R|--restart-apps "true"`: whether to force an app restart
|
||||||
|
- `-s|--shm-size SHM_SIZE`: override shared memory size for postgres docker container
|
||||||
|
|
||||||
|
You can upgrade an existing service to a new image or image-version:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:upgrade lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
Postgres does not handle upgrading data for major versions automatically (eg. 11 => 12). Upgrades should be done manually. Users are encouraged to upgrade to the latest minor release for their postgres version before performing a major upgrade.
|
||||||
|
|
||||||
|
While there are many ways to upgrade a postgres database, for safety purposes, it is recommended that an upgrade is performed by exporting the data from an existing database and importing it into a new database. This also allows testing to ensure that applications interact with the database correctly after the upgrade, and can be used in a staging environment.
|
||||||
|
|
||||||
|
The following is an example of how to upgrade a postgres database named `lollipop-11` from 11.13 to 12.8.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# stop any linked apps
|
||||||
|
dokku ps:stop linked-app
|
||||||
|
|
||||||
|
# export the database contents
|
||||||
|
dokku postgres:export lollipop-11 > /tmp/lollipop-11.export
|
||||||
|
|
||||||
|
# create a new database at the desired version
|
||||||
|
dokku postgres:create lollipop-12 --image-version 12.8
|
||||||
|
|
||||||
|
# import the export file
|
||||||
|
dokku postgres:import lollipop-12 < /tmp/lollipop-11.export
|
||||||
|
|
||||||
|
# run any sql tests against the new database to verify the import went smoothly
|
||||||
|
|
||||||
|
# unlink the old database from your apps
|
||||||
|
dokku postgres:unlink lollipop-11 linked-app
|
||||||
|
|
||||||
|
# link the new database to your apps
|
||||||
|
dokku postgres:link lollipop-12 linked-app
|
||||||
|
|
||||||
|
# start the linked apps again
|
||||||
|
dokku ps:start linked-app
|
||||||
|
```
|
||||||
|
|
||||||
|
### Service Automation
|
||||||
|
|
||||||
|
Service scripting can be executed using the following commands:
|
||||||
|
|
||||||
|
### list all postgres service links for a given app
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:app-links <app>
|
||||||
|
```
|
||||||
|
|
||||||
|
List all postgres services that are linked to the `playground` app.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:app-links playground
|
||||||
|
```
|
||||||
|
|
||||||
|
### create container <new-name> then copy data from <name> into <new-name>
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:clone <service> <new-service> [--clone-flags...]
|
||||||
|
```
|
||||||
|
|
||||||
|
flags:
|
||||||
|
|
||||||
|
- `-c|--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 (default: unlimited)
|
||||||
|
- `-p|--password PASSWORD`: override the user-level service password
|
||||||
|
- `-r|--root-password PASSWORD`: override the root-level service password
|
||||||
|
- `-s|--shm-size SHM_SIZE`: override shared memory size for postgres docker container
|
||||||
|
|
||||||
|
You can clone an existing service to a new one:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:clone lollipop lollipop-2
|
||||||
|
```
|
||||||
|
|
||||||
|
### check if the postgres service exists
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:exists <service>
|
||||||
|
```
|
||||||
|
|
||||||
|
Here we check if the lollipop postgres service exists.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:exists lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
### check if the postgres service is linked to an app
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:linked <service> <app>
|
||||||
|
```
|
||||||
|
|
||||||
|
Here we check if the lollipop postgres service is linked to the `playground` app.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:linked lollipop playground
|
||||||
|
```
|
||||||
|
|
||||||
|
### list all apps linked to the postgres service
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:links <service>
|
||||||
|
```
|
||||||
|
|
||||||
|
List all apps linked to the `lollipop` postgres service.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:links lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
### Data Management
|
||||||
|
|
||||||
|
The underlying service data can be imported and exported with the following commands:
|
||||||
|
|
||||||
|
### import a dump into the postgres service database
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:import <service>
|
||||||
|
```
|
||||||
|
|
||||||
|
Import a datastore dump:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:import lollipop < data.dump
|
||||||
|
```
|
||||||
|
|
||||||
|
### export a dump of the postgres service database
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:export <service>
|
||||||
|
```
|
||||||
|
|
||||||
|
By default, datastore output is exported to stdout:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:export lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
You can redirect this output to a file:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:export lollipop > data.dump
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that the export will result in a file containing the binary postgres export data. It can be converted to plain text using `pg_restore` as follows
|
||||||
|
|
||||||
|
```shell
|
||||||
|
pg_restore data.dump -f plain.sql
|
||||||
|
```
|
||||||
|
|
||||||
|
### Backups
|
||||||
|
|
||||||
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 postgres service
|
||||||
# setup s3 backup authentication
|
|
||||||
dokku postgres:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
|
|
||||||
|
|
||||||
# remove s3 authentication
|
|
||||||
dokku postgres:backup-deauth lolipop
|
|
||||||
|
|
||||||
# backup the `lolipop` service to the `BUCKET_NAME` bucket on AWS
|
|
||||||
dokku postgres:backup lolipop BUCKET_NAME
|
|
||||||
|
|
||||||
# schedule a backup
|
|
||||||
# CRON_SCHEDULE is a crontab expression, eg. "0 3 * * *" for each day at 3am
|
|
||||||
dokku postgres:backup-schedule lolipop CRON_SCHEDULE BUCKET_NAME
|
|
||||||
|
|
||||||
# cat the contents of the configured backup cronfile for the service
|
|
||||||
dokku postgres:backup-schedule-cat lolipop
|
|
||||||
|
|
||||||
# remove the scheduled backup from cron
|
|
||||||
dokku postgres:backup-unschedule lolipop
|
|
||||||
```
|
|
||||||
|
|
||||||
Backup auth can also be set up for different regions, signature versions and endpoints (e.g. for minio):
|
|
||||||
|
|
||||||
```
|
|
||||||
# setup s3 backup authentication with different region
|
|
||||||
dokku postgres:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
|
|
||||||
|
|
||||||
# setup s3 backup authentication with different signature version and endpoint
|
|
||||||
dokku postgres:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL
|
|
||||||
|
|
||||||
# more specific example for minio auth
|
|
||||||
dokku postgres:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
|
|
||||||
```
|
|
||||||
|
|
||||||
## Importing Data
|
|
||||||
|
|
||||||
The `import` command should be used with any non-plain-text files exported by `pg_dump`. To import a SQL file, use `connect` like this:
|
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
dokku postgres:connect db < ./dump.sql
|
# usage
|
||||||
|
dokku postgres:backup-auth <service> <aws-access-key-id> <aws-secret-access-key> <aws-default-region> <aws-signature-version> <endpoint-url>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Security
|
Setup s3 backup authentication:
|
||||||
|
|
||||||
The connection to the database is done over SSL. A self-signed certificate is
|
```shell
|
||||||
automatically generated when creating the service. It can be replaced by a
|
dokku postgres:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
|
||||||
custom certificate by overwriting the `server.crt` and `server.key` files in
|
```
|
||||||
`/var/lib/dokku/services/postgres/<DB_NAME>/data`.
|
|
||||||
The `server.key` must be chmoded to 600 and must be owned by the postgres user
|
|
||||||
or root.
|
|
||||||
|
|
||||||
## Disabling `docker pull` calls
|
Setup s3 backup authentication with different region:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
|
||||||
|
```
|
||||||
|
|
||||||
|
Setup s3 backup authentication with different signature version and endpoint:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL
|
||||||
|
```
|
||||||
|
|
||||||
|
More specific example for minio auth:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:backup-auth lollipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
|
||||||
|
```
|
||||||
|
|
||||||
|
### remove backup authentication for the postgres service
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:backup-deauth <service>
|
||||||
|
```
|
||||||
|
|
||||||
|
Remove s3 authentication:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:backup-deauth lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
### create a backup of the postgres service to an existing s3 bucket
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:backup <service> <bucket-name> [--use-iam]
|
||||||
|
```
|
||||||
|
|
||||||
|
flags:
|
||||||
|
|
||||||
|
- `-u|--use-iam`: use the IAM profile associated with the current server
|
||||||
|
|
||||||
|
Backup the `lollipop` service to the `my-s3-bucket` bucket on `AWS`:`
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:backup lollipop my-s3-bucket --use-iam
|
||||||
|
```
|
||||||
|
|
||||||
|
Restore a backup file (assuming it was extracted via `tar -xf backup.tgz`):
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:import lollipop < backup-folder/export
|
||||||
|
```
|
||||||
|
|
||||||
|
### set encryption for all future backups of postgres service
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:backup-set-encryption <service> <passphrase>
|
||||||
|
```
|
||||||
|
|
||||||
|
Set the GPG-compatible passphrase for encrypting backups for backups:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:backup-set-encryption lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
### unset encryption for future backups of the postgres service
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:backup-unset-encryption <service>
|
||||||
|
```
|
||||||
|
|
||||||
|
Unset the `GPG` encryption passphrase for backups:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:backup-unset-encryption lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
### schedule a backup of the postgres service
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:backup-schedule <service> <schedule> <bucket-name> [--use-iam]
|
||||||
|
```
|
||||||
|
|
||||||
|
flags:
|
||||||
|
|
||||||
|
- `-u|--use-iam`: use the IAM profile associated with the current server
|
||||||
|
|
||||||
|
Schedule a backup:
|
||||||
|
|
||||||
|
> 'schedule' is a crontab expression, eg. "0 3 * * *" for each day at 3am
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:backup-schedule lollipop "0 3 * * *" my-s3-bucket
|
||||||
|
```
|
||||||
|
|
||||||
|
Schedule a backup and authenticate via iam:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:backup-schedule lollipop "0 3 * * *" my-s3-bucket --use-iam
|
||||||
|
```
|
||||||
|
|
||||||
|
### cat the contents of the configured backup cronfile for the service
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:backup-schedule-cat <service>
|
||||||
|
```
|
||||||
|
|
||||||
|
Cat the contents of the configured backup cronfile for the service:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:backup-schedule-cat lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
### unschedule the backup of the postgres service
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:backup-unschedule <service>
|
||||||
|
```
|
||||||
|
|
||||||
|
Remove the scheduled backup from cron:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:backup-unschedule lollipop
|
||||||
|
```
|
||||||
|
|
||||||
|
### Disabling `docker pull` calls
|
||||||
|
|
||||||
If you wish to disable the `docker pull` calls that the plugin triggers, you may set the `POSTGRES_DISABLE_PULL` environment variable to `true`. Once disabled, you will need to pull the service image you wish to deploy as shown in the `stderr` output.
|
If you wish to disable the `docker pull` calls that the plugin triggers, you may set the `POSTGRES_DISABLE_PULL` environment variable to `true`. Once disabled, you will need to pull the service image you wish to deploy as shown in the `stderr` output.
|
||||||
|
|
||||||
|
|||||||
9
Vagrantfile
vendored
9
Vagrantfile
vendored
@@ -1,8 +1,8 @@
|
|||||||
# -*- mode: ruby -*-
|
# -*- mode: ruby -*-
|
||||||
# vi: set ft=ruby :
|
# vi: set ft=ruby :
|
||||||
|
|
||||||
BOX_NAME = ENV["BOX_NAME"] || "bento/ubuntu-14.04"
|
BOX_NAME = ENV["BOX_NAME"] || "bento/ubuntu-18.04"
|
||||||
BOX_MEMORY = ENV["BOX_MEMORY"] || "512"
|
BOX_MEMORY = ENV["BOX_MEMORY"] || "2048"
|
||||||
DOKKU_VERSION = "master"
|
DOKKU_VERSION = "master"
|
||||||
|
|
||||||
Vagrant.configure(2) do |config|
|
Vagrant.configure(2) do |config|
|
||||||
@@ -10,9 +10,6 @@ Vagrant.configure(2) do |config|
|
|||||||
config.ssh.forward_agent = true
|
config.ssh.forward_agent = true
|
||||||
|
|
||||||
config.vm.provider :virtualbox do |vb|
|
config.vm.provider :virtualbox do |vb|
|
||||||
# Ubuntu's Raring 64-bit cloud image is set to a 32-bit Ubuntu OS type by
|
|
||||||
# default in Virtualbox and thus will not boot. Manually override that.
|
|
||||||
vb.customize ["modifyvm", :id, "--ostype", "Ubuntu_64"]
|
|
||||||
vb.customize ["modifyvm", :id, "--memory", BOX_MEMORY]
|
vb.customize ["modifyvm", :id, "--memory", BOX_MEMORY]
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -23,7 +20,7 @@ Vagrant.configure(2) do |config|
|
|||||||
config.vm.define "default", primary: true do |vm|
|
config.vm.define "default", primary: true do |vm|
|
||||||
vm.vm.synced_folder File.dirname(__FILE__), "/vagrant"
|
vm.vm.synced_folder File.dirname(__FILE__), "/vagrant"
|
||||||
|
|
||||||
vm.vm.provision :shell, :inline => "apt-get update > /dev/null && apt-get install -y -qq git software-properties-common"
|
vm.vm.provision :shell, :inline => "apt -q update && apt -y -qq install git software-properties-common"
|
||||||
vm.vm.provision :shell, :inline => "cd /vagrant && DOKKU_VERSION=#{DOKKU_VERSION} make setup"
|
vm.vm.provision :shell, :inline => "cd /vagrant && DOKKU_VERSION=#{DOKKU_VERSION} make setup"
|
||||||
vm.vm.provision :shell, :inline => "cd /vagrant && DOKKU_TRACE=1 DOKKU_VERSION=#{DOKKU_VERSION} make test"
|
vm.vm.provision :shell, :inline => "cd /vagrant && DOKKU_TRACE=1 DOKKU_VERSION=#{DOKKU_VERSION} make test"
|
||||||
end
|
end
|
||||||
|
|||||||
538
bin/generate
Executable file
538
bin/generate
Executable file
@@ -0,0 +1,538 @@
|
|||||||
|
#!/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'[](https://github.com/dokku/dokku-{service}/actions/workflows/ci.yml?query=branch%3Amaster)',
|
||||||
|
f'[](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"]
|
||||||
|
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",
|
||||||
|
"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 pull` calls",
|
||||||
|
"",
|
||||||
|
f"If you wish to disable the `docker pull` calls that the plugin triggers, you may set the `{service_prefix}_DISABLE_PULL` environment variable to `true`. Once disabled, you will need to pull the service image you wish to deploy as shown in the `stderr` output.",
|
||||||
|
"",
|
||||||
|
"Please ensure the proper images are in place when `docker pull` is disabled.",
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def fetch_commands_content(
|
||||||
|
service, variable, alias, image, scheme, ports, 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']}",
|
||||||
|
"```",
|
||||||
|
]
|
||||||
|
|
||||||
|
# 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()
|
||||||
3
commands
3
commands
@@ -2,7 +2,8 @@
|
|||||||
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_BASE_PATH/common/functions"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
|
|
||||||
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/help-functions"
|
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/help-functions"
|
||||||
|
|
||||||
|
|||||||
582
common-functions
582
common-functions
@@ -1,37 +1,55 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
|
||||||
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
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"
|
||||||
|
}
|
||||||
|
|
||||||
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]} "
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
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"
|
docker 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 DATABASE="$1"
|
declare SERVICE="$1"
|
||||||
# some datastores do not like special characters in database names
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
# so we need to normalize them out
|
|
||||||
echo "$DATABASE" | tr .- _
|
if [[ ! -f "$SERVICE_ROOT/DATABASE_NAME" ]]; then
|
||||||
|
echo "$SERVICE" > "$SERVICE_ROOT/DATABASE_NAME"
|
||||||
|
fi
|
||||||
|
|
||||||
|
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
|
||||||
local quit=0
|
local quit=0
|
||||||
while [ "$quit" -ne 1 ]; do
|
while [ "$quit" -ne 1 ]; do
|
||||||
netstat -an | grep $port > /dev/null
|
netstat -an | grep $port >/dev/null
|
||||||
# shellcheck disable=SC2181
|
# shellcheck disable=SC2181
|
||||||
if [ $? -gt 0 ]; then
|
if [ $? -gt 0 ]; then
|
||||||
quit=1
|
quit=1
|
||||||
@@ -44,22 +62,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 inspect -f "$TEMPLATE" "$CID" 2>/dev/null || true)
|
||||||
|
|
||||||
if [[ "$CONTAINER_STATUS" == "true" ]]; then
|
if [[ "$CONTAINER_STATUS" == "true" ]]; then
|
||||||
return 0
|
return 0
|
||||||
@@ -67,45 +94,104 @@ is_container_status() {
|
|||||||
return 1
|
return 1
|
||||||
}
|
}
|
||||||
|
|
||||||
|
is_implemented_command() {
|
||||||
|
declare desc="return true if value ($1) is in list (all other arguments)"
|
||||||
|
declare CMD="$1"
|
||||||
|
CMD="$(echo "$CMD" | cut -d ':' -f2)"
|
||||||
|
|
||||||
|
if [[ ${#PLUGIN_UNIMPLEMENTED_SUBCOMMANDS[@]} -eq 0 ]]; then
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
local e
|
||||||
|
for e in "${PLUGIN_UNIMPLEMENTED_SUBCOMMANDS[@]}"; do
|
||||||
|
[[ "$e" == "$CMD" ]] && return 1
|
||||||
|
done
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
is_valid_service_name() {
|
||||||
|
declare desc="validate a service name"
|
||||||
|
declare SERVICE="$1"
|
||||||
|
[[ -z "$SERVICE" ]] && return 1
|
||||||
|
|
||||||
|
if [[ "$SERVICE" =~ ^[A-Za-z0-9_-]+$ ]]; then
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
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"
|
||||||
|
|
||||||
mkdir -p "$SERVICE_ROOT" || dokku_log_fail "Unable to create service directory"
|
if [[ ! -f "$LINKS_FILE" ]]; then
|
||||||
touch "$LINKS_FILE"
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
sed -i.bak "/^$APP\$/d" "$LINKS_FILE" && rm "$LINKS_FILE.bak"
|
sed -i.bak "/^$APP\$/d" "$LINKS_FILE" && rm "$LINKS_FILE.bak"
|
||||||
sort "$LINKS_FILE" -u -o "$LINKS_FILE"
|
sort "$LINKS_FILE" -u -o "$LINKS_FILE"
|
||||||
}
|
}
|
||||||
|
|
||||||
service_alias() {
|
retry-docker-command() {
|
||||||
declare desc="Retrieves the alias of a service"
|
local ID="$1" COMMAND="$2"
|
||||||
declare SERVICE="$1"
|
local i=0 success=false
|
||||||
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
until [ $i -ge 100 ]; do
|
||||||
echo "$SERVICE_NAME" | tr ._ -
|
set +e
|
||||||
|
suppress_output docker exec "$ID" sh -c "$COMMAND"
|
||||||
|
exit_code=$?
|
||||||
|
set -e
|
||||||
|
if [[ "$exit_code" == 0 ]]; then
|
||||||
|
success=true
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
i=$((i + 1))
|
||||||
|
sleep 1
|
||||||
|
done
|
||||||
|
if [[ $i -gt 0 ]]; then
|
||||||
|
dokku_log_verbose "Container command retried ${i} time(s): ${COMMAND}"
|
||||||
|
fi
|
||||||
|
[[ "$success" == "true" ]] || dokku_log_fail "Failed to run command: ${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
|
||||||
|
|
||||||
while [[ -z $ALIAS ]]; do
|
for COLOR in "${COLORS[@]}"; do
|
||||||
local IDX=$((RANDOM % ${#COLORS[*]}))
|
|
||||||
local COLOR=${COLORS[IDX]}
|
|
||||||
ALIAS="${PLUGIN_ALT_ALIAS}_${COLOR}"
|
ALIAS="${PLUGIN_ALT_ALIAS}_${COLOR}"
|
||||||
local IN_USE=$(echo "$EXISTING_CONFIG" | grep "${ALIAS}_URL")
|
local IN_USE=$(echo "$EXISTING_CONFIG" | grep "${ALIAS}_URL")
|
||||||
if [[ -n $IN_USE ]]; then
|
if [[ -z "$IN_USE" ]]; then
|
||||||
unset ALIAS
|
break
|
||||||
fi
|
fi
|
||||||
|
unset ALIAS
|
||||||
done
|
done
|
||||||
echo "$ALIAS"
|
echo "$ALIAS"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
service_app_links() {
|
||||||
|
declare desc="output all service links for a given app"
|
||||||
|
declare APP="$1"
|
||||||
|
local SERVICE LINKED_APP
|
||||||
|
|
||||||
|
pushd "$PLUGIN_DATA_ROOT" >/dev/null
|
||||||
|
for SERVICE in *; do
|
||||||
|
[[ -f "$SERVICE/LINKS" ]] || continue
|
||||||
|
for LINKED_APP in $(<"$SERVICE/LINKS"); do
|
||||||
|
if [[ "$LINKED_APP" == "$APP" ]]; then
|
||||||
|
echo "$SERVICE"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
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"
|
||||||
@@ -123,18 +209,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 inspect "$ID" &>/dev/null || 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")"
|
||||||
@@ -153,33 +239,73 @@ service_backup() {
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
# shellcheck disable=SC2086
|
# shellcheck disable=SC2086
|
||||||
docker run $BACKUP_PARAMETERS dokkupaas/s3backup:0.8.0
|
docker run --rm $BACKUP_PARAMETERS "$PLUGIN_S3BACKUP_IMAGE"
|
||||||
|
}
|
||||||
|
|
||||||
|
service_commit_config() {
|
||||||
|
declare SERVICE="$1"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
local CONFIG_VARIABLE="${PLUGIN_VARIABLE}_CONFIG_OPTIONS"
|
||||||
|
local ENV_VARIABLE="${PLUGIN_VARIABLE}_CUSTOM_ENV"
|
||||||
|
|
||||||
|
|
||||||
|
custom_env="${!ENV_VARIABLE}"
|
||||||
|
[[ -n "$SERVICE_CUSTOM_ENV" ]] && custom_env="$SERVICE_CUSTOM_ENV"
|
||||||
|
if [[ -n $custom_env ]]; then
|
||||||
|
echo "$custom_env" | tr ';' "\n" >"$SERVICE_ROOT/ENV"
|
||||||
|
else
|
||||||
|
echo "" >"$SERVICE_ROOT/ENV"
|
||||||
|
fi
|
||||||
|
|
||||||
|
config_options="${!CONFIG_VARIABLE}"
|
||||||
|
[[ -n "$PLUGIN_CONFIG_OPTIONS" ]] && config_options="$PLUGIN_CONFIG_OPTIONS"
|
||||||
|
if [[ -n "$config_options" ]]; then
|
||||||
|
echo "$config_options" >"$SERVICE_ROOT/CONFIG_OPTIONS"
|
||||||
|
else
|
||||||
|
echo "" >"$SERVICE_ROOT/CONFIG_OPTIONS"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ -n "$SERVICE_MEMORY" ]]; then
|
||||||
|
echo "$SERVICE_MEMORY" >"$SERVICE_ROOT/SERVICE_MEMORY"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ -n "$SERVICE_SHM_SIZE" ]]; then
|
||||||
|
echo "$SERVICE_SHM_SIZE" >"$SERVICE_ROOT/SHM_SIZE"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ -n "$PLUGIN_IMAGE" ]]; then
|
||||||
|
echo "$PLUGIN_IMAGE" >"$SERVICE_ROOT/IMAGE"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ -n "$PLUGIN_IMAGE_VERSION" ]]; then
|
||||||
|
echo "$PLUGIN_IMAGE_VERSION" >"$SERVICE_ROOT/IMAGE_VERSION"
|
||||||
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
service_backup_auth() {
|
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"
|
||||||
|
|
||||||
mkdir -p "$SERVICE_BACKUP_ROOT"
|
mkdir "$SERVICE_BACKUP_ROOT"
|
||||||
echo "$AWS_ACCESS_KEY_ID" > "$SERVICE_BACKUP_ROOT/AWS_ACCESS_KEY_ID"
|
echo "$AWS_ACCESS_KEY_ID" >"$SERVICE_BACKUP_ROOT/AWS_ACCESS_KEY_ID"
|
||||||
echo "$AWS_SECRET_ACCESS_KEY" > "$SERVICE_BACKUP_ROOT/AWS_SECRET_ACCESS_KEY"
|
echo "$AWS_SECRET_ACCESS_KEY" >"$SERVICE_BACKUP_ROOT/AWS_SECRET_ACCESS_KEY"
|
||||||
|
|
||||||
if [[ -n "$AWS_DEFAULT_REGION" ]]; then
|
if [[ -n "$AWS_DEFAULT_REGION" ]]; then
|
||||||
echo "$AWS_DEFAULT_REGION" > "$SERVICE_BACKUP_ROOT/AWS_DEFAULT_REGION"
|
echo "$AWS_DEFAULT_REGION" >"$SERVICE_BACKUP_ROOT/AWS_DEFAULT_REGION"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [[ -n "$AWS_SIGNATURE_VERSION" ]]; then
|
if [[ -n "$AWS_SIGNATURE_VERSION" ]]; then
|
||||||
echo "$AWS_SIGNATURE_VERSION" > "$SERVICE_BACKUP_ROOT/AWS_SIGNATURE_VERSION"
|
echo "$AWS_SIGNATURE_VERSION" >"$SERVICE_BACKUP_ROOT/AWS_SIGNATURE_VERSION"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [[ -n "$ENDPOINT_URL" ]]; then
|
if [[ -n "$ENDPOINT_URL" ]]; then
|
||||||
echo "$ENDPOINT_URL" > "$SERVICE_BACKUP_ROOT/ENDPOINT_URL"
|
echo "$ENDPOINT_URL" >"$SERVICE_BACKUP_ROOT/ENDPOINT_URL"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
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/"
|
||||||
@@ -198,7 +324,7 @@ service_backup_schedule() {
|
|||||||
dokku_log_fail "Invalid flag provided, only '--use-iam' allowed"
|
dokku_log_fail "Invalid flag provided, only '--use-iam' allowed"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
echo "${SCHEDULE} dokku ${DOKKU_BIN} ${PLUGIN_COMMAND_PREFIX}:backup ${SERVICE} ${BUCKET_NAME} ${USE_IAM_OPTIONAL_FLAG}" > "$TMP_CRON_FILE"
|
echo "${SCHEDULE} dokku ${DOKKU_BIN} ${PLUGIN_COMMAND_PREFIX}:backup ${SERVICE} ${BUCKET_NAME} ${USE_IAM_OPTIONAL_FLAG}" >"$TMP_CRON_FILE"
|
||||||
sudo /bin/mv "$TMP_CRON_FILE" "$CRON_FILE"
|
sudo /bin/mv "$TMP_CRON_FILE" "$CRON_FILE"
|
||||||
sudo /bin/chown root:root "$CRON_FILE"
|
sudo /bin/chown root:root "$CRON_FILE"
|
||||||
sudo /bin/chmod 644 "$CRON_FILE"
|
sudo /bin/chmod 644 "$CRON_FILE"
|
||||||
@@ -216,26 +342,26 @@ service_backup_schedule_cat() {
|
|||||||
cat "$CRON_FILE"
|
cat "$CRON_FILE"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
service_backup_set_encryption() {
|
||||||
|
declare desc="set up backup encryption"
|
||||||
|
declare SERVICE="$1" ENCRYPTION_KEY="$2"
|
||||||
|
local SERVICE_ROOT="${PLUGIN_DATA_ROOT}/${SERVICE}"
|
||||||
|
local SERVICE_BACKUP_ENCRYPTION_ROOT="${SERVICE_ROOT}/backup-encryption/"
|
||||||
|
|
||||||
|
mkdir "$SERVICE_BACKUP_ENCRYPTION_ROOT"
|
||||||
|
echo "$ENCRYPTION_KEY" >"${SERVICE_BACKUP_ENCRYPTION_ROOT}/ENCRYPTION_KEY"
|
||||||
|
}
|
||||||
|
|
||||||
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}"
|
||||||
|
|
||||||
sudo /bin/rm -f "$CRON_FILE"
|
sudo /bin/rm -f "$CRON_FILE"
|
||||||
}
|
}
|
||||||
|
|
||||||
service_backup_set_encryption() {
|
|
||||||
declare desc="Sets up backup encryption"
|
|
||||||
declare SERVICE="$1" ENCRYPTION_KEY="$2"
|
|
||||||
local SERVICE_ROOT="${PLUGIN_DATA_ROOT}/${SERVICE}"
|
|
||||||
local SERVICE_BACKUP_ENCRYPTION_ROOT="${SERVICE_ROOT}/backup-encryption/"
|
|
||||||
|
|
||||||
mkdir -p "$SERVICE_BACKUP_ENCRYPTION_ROOT"
|
|
||||||
echo "$ENCRYPTION_KEY" > "${SERVICE_BACKUP_ENCRYPTION_ROOT}/ENCRYPTION_KEY"
|
|
||||||
}
|
|
||||||
|
|
||||||
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/"
|
||||||
@@ -243,13 +369,40 @@ service_backup_unset_encryption() {
|
|||||||
rm -rf "$SERVICE_BACKUP_ENCRYPTION_ROOT"
|
rm -rf "$SERVICE_BACKUP_ENCRYPTION_ROOT"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
service_container_rm() {
|
||||||
|
declare desc="stop a service and remove the running container"
|
||||||
|
declare SERVICE="$1"
|
||||||
|
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||||
|
local ID
|
||||||
|
|
||||||
|
service_stop "$SERVICE"
|
||||||
|
ID=$(docker ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
|
||||||
|
# this may be 'true' in tests...
|
||||||
|
if [[ -z "$ID" ]] || [[ "$ID" == "true" ]]; then
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
dokku_log_verbose_quiet "Removing container"
|
||||||
|
docker update --restart=no "$SERVICE_NAME" >/dev/null 2>&1
|
||||||
|
if ! docker rm "$SERVICE_NAME" >/dev/null 2>&1; then
|
||||||
|
dokku_log_fail "Unable to remove container for service $SERVICE"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
service_dns_hostname() {
|
||||||
|
declare desc="retrieve the alias of a service"
|
||||||
|
declare SERVICE="$1"
|
||||||
|
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||||
|
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 inspect "$ID" &>/dev/null || 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=""
|
||||||
@@ -259,19 +412,36 @@ service_enter() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
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"
|
||||||
[[ ! -f $PORT_FILE ]] && echo '-' && return 0
|
[[ ! -f $PORT_FILE ]] && echo '-' && return 0
|
||||||
local PORTS=($(cat "$PORT_FILE"))
|
local PORTS=($(cat "$PORT_FILE"))
|
||||||
for (( i=0; i < ${#PLUGIN_DATASTORE_PORTS[@]}; i++ )); do
|
for ((i = 0; i < ${#PLUGIN_DATASTORE_PORTS[@]}; i++)); do
|
||||||
echo -n "${PLUGIN_DATASTORE_PORTS[i]}->${PORTS[i]} "
|
echo -n "${PLUGIN_DATASTORE_PORTS[i]}->${PORTS[i]} "
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
|
service_image_exists() {
|
||||||
|
declare desc="check if the current image exists"
|
||||||
|
declare SERVICE="$1"
|
||||||
|
local plugin_image="$PLUGIN_IMAGE"
|
||||||
|
local plugin_image_version="$PLUGIN_IMAGE_VERSION"
|
||||||
|
|
||||||
|
[[ -f "$SERVICE_ROOT/IMAGE" ]] && plugin_image="$(cat "$SERVICE_ROOT/IMAGE")"
|
||||||
|
[[ -f "$SERVICE_ROOT/IMAGE_VERSION" ]] && plugin_image_version="$(cat "$SERVICE_ROOT/IMAGE_VERSION")"
|
||||||
|
local IMAGE="$plugin_image:$plugin_image_version"
|
||||||
|
|
||||||
|
if [[ "$(docker images -q "$IMAGE" 2>/dev/null)" == "" ]]; then
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
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")
|
||||||
@@ -280,7 +450,8 @@ 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")"
|
||||||
"--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")"
|
||||||
@@ -292,7 +463,7 @@ service_info() {
|
|||||||
"--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 "$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#*: }")"
|
||||||
@@ -310,7 +481,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")
|
||||||
@@ -324,7 +495,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")
|
||||||
@@ -332,59 +503,81 @@ service_link() {
|
|||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
local EXISTING_CONFIG=$(config_all "$APP")
|
local EXISTING_CONFIG=$(config_all "$APP")
|
||||||
local LINK=$(echo "$EXISTING_CONFIG" | grep "$SERVICE_URL" | cut -d: -f1) || true
|
local LINK=$(echo "$EXISTING_CONFIG" | grep "$SERVICE_URL" | cut -d: -f1) || true
|
||||||
local DEFAULT_ALIAS=$(echo "$EXISTING_CONFIG" | grep "${PLUGIN_DEFAULT_ALIAS}_URL") || true
|
local SERVICE_DNS_HOSTNAME=$(service_dns_hostname "$SERVICE")
|
||||||
local SERVICE_ALIAS=$(service_alias "$SERVICE")
|
|
||||||
local LINKS_FILE="$SERVICE_ROOT/LINKS"
|
local LINKS_FILE="$SERVICE_ROOT/LINKS"
|
||||||
|
local ALIAS="$PLUGIN_DEFAULT_ALIAS"
|
||||||
|
local DEFAULT_ALIAS
|
||||||
|
|
||||||
|
if [[ -n "$SERVICE_ALIAS" ]]; then
|
||||||
|
ALIAS="$SERVICE_ALIAS"
|
||||||
|
ALIAS_IN_USE=$(echo "$EXISTING_CONFIG" | grep "${ALIAS}_URL") || true
|
||||||
|
[[ -n "$ALIAS_IN_USE" ]] && dokku_log_fail "Specified alias $ALIAS already in use"
|
||||||
|
else
|
||||||
|
DEFAULT_ALIAS=$(echo "$EXISTING_CONFIG" | grep "${PLUGIN_DEFAULT_ALIAS}_URL") || true
|
||||||
|
if [[ -n "$DEFAULT_ALIAS" ]]; then
|
||||||
|
ALIAS=$(service_alternative_alias "$EXISTING_CONFIG")
|
||||||
|
fi
|
||||||
|
[[ -z "$ALIAS" ]] && dokku_log_fail "Unable to use default or generated URL alias"
|
||||||
|
fi
|
||||||
|
|
||||||
[[ -n $LINK ]] && dokku_log_fail "Already linked as $LINK"
|
[[ -n $LINK ]] && dokku_log_fail "Already linked as $LINK"
|
||||||
mkdir -p "$SERVICE_ROOT" || dokku_log_fail "Unable to create service directory"
|
plugn trigger service-action pre-link "$SERVICE" "$APP"
|
||||||
touch "$LINKS_FILE"
|
add_to_links_file "$SERVICE" "$APP"
|
||||||
echo "$APP" >> "$LINKS_FILE"
|
|
||||||
sort "$LINKS_FILE" -u -o "$LINKS_FILE"
|
|
||||||
|
|
||||||
local ALIAS="$PLUGIN_DEFAULT_ALIAS"
|
if declare -f -F add_passed_docker_option >/dev/null; then
|
||||||
if [[ -n $DEFAULT_ALIAS ]]; then
|
|
||||||
ALIAS=$(service_alternative_alias "$EXISTING_CONFIG")
|
|
||||||
fi
|
|
||||||
|
|
||||||
if declare -f -F add_passed_docker_option > /dev/null; then
|
|
||||||
# shellcheck disable=SC2034
|
# shellcheck disable=SC2034
|
||||||
local passed_phases=(build deploy run)
|
local passed_phases=(build deploy run)
|
||||||
add_passed_docker_option passed_phases[@] "--link $SERVICE_NAME:$SERVICE_ALIAS"
|
add_passed_docker_option passed_phases[@] "--link $SERVICE_NAME:$SERVICE_DNS_HOSTNAME"
|
||||||
else
|
else
|
||||||
dokku docker-options:add "$APP" build,deploy,run "--link $SERVICE_NAME:$SERVICE_ALIAS"
|
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}"
|
||||||
|
plugn trigger service-action post-link "$SERVICE" "$APP"
|
||||||
config_set "$APP" "${ALIAS}_URL=$SERVICE_URL"
|
config_set "$APP" "${ALIAS}_URL=$SERVICE_URL"
|
||||||
|
plugn trigger service-action post-link-complete "$SERVICE" "$APP"
|
||||||
}
|
}
|
||||||
|
|
||||||
service_linked_apps() {
|
service_linked_apps() {
|
||||||
declare desc="Lists all applications linked to a service"
|
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"
|
||||||
|
|
||||||
touch "$LINKS_FILE"
|
touch "$LINKS_FILE"
|
||||||
[[ -z $(< "$LINKS_FILE") ]] && echo '-' && return 0
|
[[ -z $(<"$LINKS_FILE") ]] && echo '-' && return 0
|
||||||
|
|
||||||
tr '\n' ' ' < "$LINKS_FILE"
|
tr '\n' ' ' <"$LINKS_FILE"
|
||||||
|
}
|
||||||
|
|
||||||
|
service_links() {
|
||||||
|
declare desc="list all apps linked to a service"
|
||||||
|
declare SERVICE="$1"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
local LINKS_FILE="$SERVICE_ROOT/LINKS"
|
||||||
|
|
||||||
|
touch "$LINKS_FILE"
|
||||||
|
[[ -z $(<"$LINKS_FILE") ]] && return 0
|
||||||
|
|
||||||
|
cat "$LINKS_FILE"
|
||||||
}
|
}
|
||||||
|
|
||||||
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)
|
local SERVICES=$(ls "$PLUGIN_DATA_ROOT" 2>/dev/null)
|
||||||
|
|
||||||
if [[ -z $SERVICES ]]; then
|
if [[ -z $SERVICES ]]; then
|
||||||
dokku_log_warn "There are no $PLUGIN_SERVICE services"
|
dokku_log_warn "There are no $PLUGIN_SERVICE services"
|
||||||
else
|
return
|
||||||
LIST="NAME,VERSION,STATUS,EXPOSED PORTS,LINKS\n"
|
|
||||||
for SERVICE in $SERVICES; do
|
|
||||||
LIST+="$SERVICE,$(service_version "$SERVICE"),$(service_status "$SERVICE"),$(service_exposed_ports "$SERVICE"),$(service_linked_apps "$SERVICE")\n"
|
|
||||||
done
|
|
||||||
printf "%b" "$LIST" | column -t -s,
|
|
||||||
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"
|
||||||
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")
|
||||||
@@ -395,75 +588,116 @@ service_logs() {
|
|||||||
DOKKU_LOGS_ARGS="--follow"
|
DOKKU_LOGS_ARGS="--follow"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
docker inspect "$ID" &> /dev/null || dokku_log_fail "Service container does not exist"
|
docker inspect "$ID" &>/dev/null || 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> /dev/null
|
docker logs $DOKKU_LOGS_ARGS "$ID" 2>&1
|
||||||
}
|
}
|
||||||
|
|
||||||
service_parse_args() {
|
service_parse_args() {
|
||||||
declare desc="cli arg parser"
|
declare desc="cli arg parser"
|
||||||
local next_index=1; local skip=false; local args=("$@")
|
local next_index=1
|
||||||
|
local skip=false
|
||||||
|
local args=("$@")
|
||||||
|
|
||||||
for arg in "$@"; do
|
for arg in "$@"; do
|
||||||
shift
|
shift
|
||||||
case "$arg" in
|
case "$arg" in
|
||||||
|
"--alias") set -- "$@" "-a" ;;
|
||||||
"--config-options") set -- "$@" "-c" ;;
|
"--config-options") set -- "$@" "-c" ;;
|
||||||
"--custom-env") set -- "$@" "-C" ;;
|
"--custom-env") set -- "$@" "-C" ;;
|
||||||
"--image") set -- "$@" "-i" ;;
|
"--database") set -- "$@" "-d" ;;
|
||||||
"--image-version") set -- "$@" "-I" ;;
|
"--image-version") set -- "$@" "-I" ;;
|
||||||
"--password") set -- "$@" "-p" ;;
|
"--image") set -- "$@" "-i" ;;
|
||||||
"--root-password") set -- "$@" "-r" ;;
|
"--memory") set -- "$@" "-m" ;;
|
||||||
|
"--password") set -- "$@" "-p" ;;
|
||||||
"--alias") set -- "$@" "-a" ;;
|
"--querystring") set -- "$@" "-q" ;;
|
||||||
"--database") set -- "$@" "-d" ;;
|
"--restart-apps") set -- "$@" "-R" ;;
|
||||||
"--memory") set -- "$@" "-m" ;;
|
"--root-password") set -- "$@" "-r" ;;
|
||||||
"--querystring") set -- "$@" "-q" ;;
|
"--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:u:" opt; do
|
while getopts "a:c:C:d:i:I:m:p:q:R:r:s:u:" opt; do
|
||||||
case "$opt" in
|
case "$opt" in
|
||||||
a) export SERVICE_ALIAS=$OPTARG
|
a)
|
||||||
;;
|
SERVICE_ALIAS="${OPTARG^^}"
|
||||||
c) export PLUGIN_CONFIG_OPTIONS=$OPTARG
|
export SERVICE_ALIAS="${SERVICE_ALIAS%_URL}"
|
||||||
;;
|
;;
|
||||||
C) export SERVICE_CUSTOM_ENV=$OPTARG
|
c)
|
||||||
;;
|
export PLUGIN_CONFIG_OPTIONS=$OPTARG
|
||||||
d) export SERVICE_DATABASE=$OPTARG
|
;;
|
||||||
;;
|
C)
|
||||||
i) export PLUGIN_IMAGE=$OPTARG
|
export SERVICE_CUSTOM_ENV=$OPTARG
|
||||||
;;
|
;;
|
||||||
I) export PLUGIN_IMAGE_VERSION=$OPTARG
|
d)
|
||||||
;;
|
export SERVICE_DATABASE=$OPTARG
|
||||||
m) export SERVICE_MEMORY=$OPTARG
|
;;
|
||||||
;;
|
i)
|
||||||
p) export SERVICE_PASSWORD=$OPTARG
|
export PLUGIN_IMAGE=$OPTARG
|
||||||
;;
|
;;
|
||||||
q) export SERVICE_QUERYSTRING=$OPTARG
|
I)
|
||||||
;;
|
export PLUGIN_IMAGE_VERSION=$OPTARG
|
||||||
r) export SERVICE_ROOT_PASSWORD=$OPTARG
|
;;
|
||||||
;;
|
m)
|
||||||
u) export SERVICE_USER=$OPTARG
|
export SERVICE_MEMORY=$OPTARG
|
||||||
;;
|
;;
|
||||||
|
p)
|
||||||
|
export SERVICE_PASSWORD=$OPTARG
|
||||||
|
;;
|
||||||
|
q)
|
||||||
|
export SERVICE_QUERYSTRING=${OPTARG#"?"}
|
||||||
|
;;
|
||||||
|
R)
|
||||||
|
export SERVICE_RESTART_APPS=$OPTARG
|
||||||
|
;;
|
||||||
|
r)
|
||||||
|
export SERVICE_ROOT_PASSWORD=$OPTARG
|
||||||
|
;;
|
||||||
|
s)
|
||||||
|
export SERVICE_SHM_SIZE=$OPTARG
|
||||||
|
;;
|
||||||
|
u)
|
||||||
|
export SERVICE_USER=$OPTARG
|
||||||
|
;;
|
||||||
esac
|
esac
|
||||||
done
|
done
|
||||||
shift "$(( OPTIND - 1 ))" # remove options from positional parameters
|
shift "$((OPTIND - 1))" # remove options from positional parameters
|
||||||
|
}
|
||||||
|
|
||||||
|
service_password() {
|
||||||
|
declare desc="fetch the password for a service"
|
||||||
|
declare SERVICE="$1"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
local PASSWORD_FILE="$SERVICE_ROOT/PASSWORD"
|
||||||
|
if [[ -f "$PASSWORD_FILE" ]]; then
|
||||||
|
cat "$PASSWORD_FILE"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
service_root_password() {
|
||||||
|
declare desc="fetch the root password for a service"
|
||||||
|
declare SERVICE="$1"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
local PASSWORD_FILE="$SERVICE_ROOT/ROOTPASSWORD"
|
||||||
|
if [[ -f "$PASSWORD_FILE" ]]; then
|
||||||
|
cat "$PASSWORD_FILE"
|
||||||
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
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"
|
||||||
service_start "$SERVICE" "true"
|
service_start "$SERVICE" "true"
|
||||||
service_port_unpause "$SERVICE" "true" "${@:2}"
|
service_port_unpause "$SERVICE" "true" "${@:2}"
|
||||||
}
|
}
|
||||||
|
|
||||||
service_port_pause() {
|
service_port_pause() {
|
||||||
declare desc="Pauses service exposure"
|
declare desc="pause service exposure"
|
||||||
declare SERVICE="$1" LOG_FAIL="$2"
|
declare SERVICE="$1" LOG_FAIL="$2"
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
local EXPOSED_NAME="$(get_service_name "$SERVICE").ambassador"
|
local EXPOSED_NAME="$(get_service_name "$SERVICE").ambassador"
|
||||||
@@ -485,15 +719,15 @@ service_port_pause() {
|
|||||||
return
|
return
|
||||||
fi
|
fi
|
||||||
|
|
||||||
docker stop "$EXPOSED_NAME" > /dev/null 2>&1 || true
|
docker stop "$EXPOSED_NAME" >/dev/null 2>&1 || true
|
||||||
docker rm "$EXPOSED_NAME" > /dev/null 2>&1 || true
|
docker rm "$EXPOSED_NAME" >/dev/null 2>&1 || true
|
||||||
if [[ "$LOG_FAIL" == "true" ]]; then
|
if [[ "$LOG_FAIL" == "true" ]]; then
|
||||||
dokku_log_info1 "Service $SERVICE unexposed"
|
dokku_log_info1 "Service $SERVICE unexposed"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
service_port_unexpose() {
|
service_port_unexpose() {
|
||||||
declare desc="Wrapper for pausing exposed service ports"
|
declare desc="wrapper for pausing exposed service ports"
|
||||||
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"
|
||||||
@@ -502,7 +736,7 @@ service_port_unexpose() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
service_port_unpause() {
|
service_port_unpause() {
|
||||||
declare desc="Starts service exposure"
|
declare desc="start service exposure"
|
||||||
declare SERVICE="$1" LOG_FAIL="$2"
|
declare SERVICE="$1" LOG_FAIL="$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")"
|
||||||
@@ -523,17 +757,17 @@ service_port_unpause() {
|
|||||||
PORTS=($(cat "$PORT_FILE"))
|
PORTS=($(cat "$PORT_FILE"))
|
||||||
fi
|
fi
|
||||||
|
|
||||||
echo "${PORTS[@]}" > "$PORT_FILE"
|
echo "${PORTS[@]}" >"$PORT_FILE"
|
||||||
|
|
||||||
# shellcheck disable=SC2046
|
# shellcheck disable=SC2046
|
||||||
docker run -d --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" --name "$EXPOSED_NAME" $(docker_ports_options "${PORTS[@]}") --restart always --label dokku=ambassador --label "dokku.ambassador=$PLUGIN_COMMAND_PREFIX" svendowideit/ambassador > /dev/null
|
docker run -d --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" --name "$EXPOSED_NAME" $(docker_ports_options "${PORTS[@]}") --restart always --label dokku=ambassador --label "dokku.ambassador=$PLUGIN_COMMAND_PREFIX" "$PLUGIN_AMBASSADOR_IMAGE" >/dev/null
|
||||||
if [[ "$LOG_FAIL" == "true" ]]; then
|
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")"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
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")
|
||||||
@@ -561,85 +795,81 @@ 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"
|
||||||
|
|
||||||
mkdir -p "$SERVICE_ROOT" || dokku_log_fail "Unable to create service directory"
|
|
||||||
touch "$ALIAS_FILE"
|
touch "$ALIAS_FILE"
|
||||||
echo "$ALIAS" > "$ALIAS_FILE"
|
echo "$ALIAS" >"$ALIAS_FILE"
|
||||||
}
|
}
|
||||||
|
|
||||||
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 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_stop() {
|
||||||
declare desc="Stops a running service"
|
declare desc="stop 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 -f status=running | grep -e "$SERVICE_NAME$" | awk '{print $1}') || true
|
local ID=$(docker ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
|
||||||
[[ -z $ID ]] && dokku_log_warn "Service is already stopped" && return 0
|
[[ -z $ID ]] && dokku_log_warn "Service is already stopped" && return 0
|
||||||
|
|
||||||
if [[ -n $ID ]]; then
|
if [[ -n $ID ]]; then
|
||||||
dokku_log_info1_quiet "Stopping container"
|
dokku_log_info2_quiet "Stopping container"
|
||||||
docker stop "$SERVICE_NAME" > /dev/null
|
docker stop "$SERVICE_NAME" >/dev/null
|
||||||
service_port_pause "$SERVICE"
|
service_port_pause "$SERVICE"
|
||||||
dokku_log_info2 "Container stopped"
|
dokku_log_verbose_quiet "Container stopped"
|
||||||
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")
|
||||||
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||||
local EXISTING_CONFIG=$(config_all "$APP")
|
local EXISTING_CONFIG=$(config_all "$APP")
|
||||||
local SERVICE_ALIAS=$(service_alias "$SERVICE")
|
local SERVICE_DNS_HOSTNAME=$(service_dns_hostname "$SERVICE")
|
||||||
local LINK=($(echo "$EXISTING_CONFIG" | grep "$SERVICE_URL" | cut -d: -f1)) || true
|
local LINK=($(echo "$EXISTING_CONFIG" | grep "$SERVICE_URL" | cut -d: -f1)) || true
|
||||||
|
|
||||||
|
plugn trigger service-action pre-unlink "$SERVICE" "$APP"
|
||||||
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
|
||||||
# shellcheck disable=SC2034
|
# shellcheck disable=SC2034
|
||||||
local passed_phases=(build deploy run)
|
local passed_phases=(build deploy run)
|
||||||
remove_passed_docker_option passed_phases[@] "--link $SERVICE_NAME:$SERVICE_ALIAS"
|
remove_passed_docker_option passed_phases[@] "--link $SERVICE_NAME:$SERVICE_DNS_HOSTNAME"
|
||||||
else
|
else
|
||||||
dokku docker-options:remove "$APP" build,deploy,run "--link $SERVICE_NAME:$SERVICE_ALIAS"
|
dokku docker-options:remove "$APP" build,deploy,run "--link $SERVICE_NAME:$SERVICE_DNS_HOSTNAME"
|
||||||
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 "$SERVICE" "$APP"
|
||||||
|
config_unset "$APP" "${LINK[@]}"
|
||||||
|
plugn trigger service-action post-unlink-complete "$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 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
|
||||||
|
|
||||||
@@ -648,9 +878,19 @@ 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="$1"
|
||||||
[[ ! -n "$SERVICE" ]] && dokku_log_fail "(verify_service_name) SERVICE must not be null"
|
[[ -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"
|
[[ ! -d "$PLUGIN_DATA_ROOT/$SERVICE" ]] && dokku_log_fail "$PLUGIN_SERVICE service $SERVICE does not exist"
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
|
|
||||||
|
write_database_name() {
|
||||||
|
declare desc="write a sanitized database name"
|
||||||
|
declare SERVICE="$1"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
|
||||||
|
# some datastores do not like special characters in database names
|
||||||
|
# so we need to normalize them out
|
||||||
|
echo "$SERVICE" | tr .- _ > "$SERVICE_ROOT/DATABASE_NAME"
|
||||||
|
}
|
||||||
|
|||||||
18
config
18
config
@@ -1,9 +1,11 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
export POSTGRES_IMAGE=${POSTGRES_IMAGE:="postgres"}
|
_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||||
export POSTGRES_IMAGE_VERSION=${POSTGRES_IMAGE_VERSION:="10.2"}
|
export POSTGRES_IMAGE=${POSTGRES_IMAGE:="$(awk -F '[ :]' '{print $2}' "${_DIR}/Dockerfile")"}
|
||||||
export POSTGRES_ROOT=${POSTGRES_ROOT:="/var/lib/dokku/services/postgres"}
|
export POSTGRES_IMAGE_VERSION=${POSTGRES_IMAGE_VERSION:="$(awk -F '[ :]' '{print $3}' "${_DIR}/Dockerfile")"}
|
||||||
|
export POSTGRES_ROOT=${POSTGRES_ROOT:="$DOKKU_LIB_ROOT/services/postgres"}
|
||||||
export POSTGRES_HOST_ROOT=${POSTGRES_HOST_ROOT:=$POSTGRES_ROOT}
|
export POSTGRES_HOST_ROOT=${POSTGRES_HOST_ROOT:=$POSTGRES_ROOT}
|
||||||
|
|
||||||
|
export PLUGIN_UNIMPLEMENTED_SUBCOMMANDS=()
|
||||||
export PLUGIN_COMMAND_PREFIX="postgres"
|
export PLUGIN_COMMAND_PREFIX="postgres"
|
||||||
export PLUGIN_CONFIG_ROOT=${PLUGIN_CONFIG_ROOT:="$DOKKU_LIB_ROOT/config/$PLUGIN_COMMAND_PREFIX"}
|
export PLUGIN_CONFIG_ROOT=${PLUGIN_CONFIG_ROOT:="$DOKKU_LIB_ROOT/config/$PLUGIN_COMMAND_PREFIX"}
|
||||||
export PLUGIN_DATA_ROOT=$POSTGRES_ROOT
|
export PLUGIN_DATA_ROOT=$POSTGRES_ROOT
|
||||||
@@ -20,10 +22,14 @@ export PLUGIN_SCHEME="postgres"
|
|||||||
export PLUGIN_SERVICE="Postgres"
|
export PLUGIN_SERVICE="Postgres"
|
||||||
export PLUGIN_VARIABLE="POSTGRES"
|
export PLUGIN_VARIABLE="POSTGRES"
|
||||||
export PLUGIN_BASE_PATH="$PLUGIN_PATH"
|
export PLUGIN_BASE_PATH="$PLUGIN_PATH"
|
||||||
|
export PLUGIN_CONFIG_SUFFIX="data"
|
||||||
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
|
||||||
|
|
||||||
if [[ -d "$PLUGIN_DATA_ROOT/*" ]]; then
|
export PLUGIN_BUSYBOX_IMAGE="busybox:1.31.1-uclibc"
|
||||||
rm -rf "${PLUGIN_DATA_ROOT:?}/*"
|
export PLUGIN_AMBASSADOR_IMAGE="dokku/ambassador:0.3.3"
|
||||||
fi
|
export PLUGIN_S3BACKUP_IMAGE="dokku/s3backup:0.10.3"
|
||||||
|
export PLUGIN_WAIT_IMAGE="dokku/wait:0.4.3"
|
||||||
|
|
||||||
|
export POSTGRES_CONFIG_OPTIONS=${POSTGRES_CONFIG_OPTIONS:=""}
|
||||||
|
|||||||
4
docs/README.md
Normal file
4
docs/README.md
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
# Extra Documentation
|
||||||
|
|
||||||
|
The documentation in this folder is supplemental to using this plugin. It is injected automatically into the plugin's readme during documentation generation.
|
||||||
|
|
||||||
5
docs/create.md
Normal file
5
docs/create.md
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
Official Postgres docker images does not include postgis extension (amongst others). The following example creates a new postgres service using `postgis/postgis:13-3.1` image, which includes the `postgis` extension.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:create postgis-database --image "postgis/postgis" --image-version "13-3.1"
|
||||||
|
```
|
||||||
5
docs/export.md
Normal file
5
docs/export.md
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
Note that the export will result in a file containing the binary postgres export data. It can be converted to plain text using `pg_restore` as follows
|
||||||
|
|
||||||
|
```shell
|
||||||
|
pg_restore data.dump -f plain.sql
|
||||||
|
```
|
||||||
30
docs/upgrade.md
Normal file
30
docs/upgrade.md
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
Postgres does not handle upgrading data for major versions automatically (eg. 11 => 12). Upgrades should be done manually. Users are encouraged to upgrade to the latest minor release for their postgres version before performing a major upgrade.
|
||||||
|
|
||||||
|
While there are many ways to upgrade a postgres database, for safety purposes, it is recommended that an upgrade is performed by exporting the data from an existing database and importing it into a new database. This also allows testing to ensure that applications interact with the database correctly after the upgrade, and can be used in a staging environment.
|
||||||
|
|
||||||
|
The following is an example of how to upgrade a postgres database named `lollipop-11` from 11.13 to 12.8.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# stop any linked apps
|
||||||
|
dokku ps:stop linked-app
|
||||||
|
|
||||||
|
# export the database contents
|
||||||
|
dokku postgres:export lollipop-11 > /tmp/lollipop-11.export
|
||||||
|
|
||||||
|
# create a new database at the desired version
|
||||||
|
dokku postgres:create lollipop-12 --image-version 12.8
|
||||||
|
|
||||||
|
# import the export file
|
||||||
|
dokku postgres:import lollipop-12 < /tmp/lollipop-11.export
|
||||||
|
|
||||||
|
# run any sql tests against the new database to verify the import went smoothly
|
||||||
|
|
||||||
|
# unlink the old database from your apps
|
||||||
|
dokku postgres:unlink lollipop-11 linked-app
|
||||||
|
|
||||||
|
# link the new database to your apps
|
||||||
|
dokku postgres:link lollipop-12 linked-app
|
||||||
|
|
||||||
|
# start the linked apps again
|
||||||
|
dokku ps:start linked-app
|
||||||
|
```
|
||||||
106
functions
106
functions
@@ -1,6 +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"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $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_BASE_PATH/common/functions"
|
||||||
source "$PLUGIN_AVAILABLE_PATH/config/functions"
|
source "$PLUGIN_AVAILABLE_PATH/config/functions"
|
||||||
@@ -8,8 +9,6 @@ if [[ -f "$PLUGIN_AVAILABLE_PATH/docker-options/functions" ]]; then
|
|||||||
source "$PLUGIN_AVAILABLE_PATH/docker-options/functions"
|
source "$PLUGIN_AVAILABLE_PATH/docker-options/functions"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# non-generic functions
|
|
||||||
|
|
||||||
service_connect() {
|
service_connect() {
|
||||||
local SERVICE="$1"
|
local SERVICE="$1"
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
@@ -18,18 +17,20 @@ service_connect() {
|
|||||||
local SERVICE_TTY_OPTS
|
local SERVICE_TTY_OPTS
|
||||||
has_tty && SERVICE_TTY_OPTS="-t"
|
has_tty && SERVICE_TTY_OPTS="-t"
|
||||||
|
|
||||||
docker exec -i $SERVICE_TTY_OPTS "$SERVICE_NAME" psql -h localhost -U postgres "$DATABASE_NAME"
|
docker exec --env=LANG=C.UTF-8 --env=LC_ALL=C.UTF-8 -i $SERVICE_TTY_OPTS "$SERVICE_NAME" psql -h localhost -U postgres "$DATABASE_NAME"
|
||||||
}
|
}
|
||||||
|
|
||||||
service_create() {
|
service_create() {
|
||||||
local SERVICE="$1"
|
local SERVICE="$1"
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
|
is_valid_service_name "$SERVICE" || dokku_log_fail "Please specify a valid name for the service. Valid characters are: [A-Za-z0-9_]+"
|
||||||
|
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
|
||||||
[[ ! -d "$PLUGIN_DATA_ROOT/$SERVICE" ]] || dokku_log_fail "$PLUGIN_SERVICE service $SERVICE already exists"
|
[[ ! -d "$PLUGIN_DATA_ROOT/$SERVICE" ]] || dokku_log_fail "$PLUGIN_SERVICE service $SERVICE already exists"
|
||||||
SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"; LINKS_FILE="$SERVICE_ROOT/LINKS"
|
SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
LINKS_FILE="$SERVICE_ROOT/LINKS"
|
||||||
|
|
||||||
service_parse_args "${@:2}"
|
service_parse_args "${@:2}"
|
||||||
|
|
||||||
if ! docker images | grep -e "^$PLUGIN_IMAGE " | grep -q " $PLUGIN_IMAGE_VERSION " ; 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 pull ${IMAGE}" 1>&2
|
||||||
@@ -39,24 +40,24 @@ service_create() {
|
|||||||
docker pull "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" || dokku_log_fail "$PLUGIN_SERVICE image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION pull failed"
|
docker pull "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" || dokku_log_fail "$PLUGIN_SERVICE image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION pull failed"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
plugn trigger service-action pre-create "$SERVICE"
|
||||||
mkdir -p "$SERVICE_ROOT" || dokku_log_fail "Unable to create service directory"
|
mkdir -p "$SERVICE_ROOT" || dokku_log_fail "Unable to create service directory"
|
||||||
mkdir -p "$SERVICE_ROOT/data" || dokku_log_fail "Unable to create service data directory"
|
mkdir -p "$SERVICE_ROOT/data" || dokku_log_fail "Unable to create service data directory"
|
||||||
touch "$LINKS_FILE"
|
touch "$LINKS_FILE"
|
||||||
|
|
||||||
PASSWORD=$(openssl rand -hex 16)
|
PASSWORD=$(openssl rand -hex 16)
|
||||||
if [[ -n "$SERVICE_PASSWORD" ]]; then
|
if [[ -n "$SERVICE_PASSWORD" ]]; then
|
||||||
PASSWORD="$SERVICE_PASSWORD"
|
PASSWORD="$SERVICE_PASSWORD"
|
||||||
dokku_log_warn "Specified password may not be as secure as the auto-generated password"
|
dokku_log_warn "Specified password may not be as secure as the auto-generated password"
|
||||||
fi
|
fi
|
||||||
echo "$PASSWORD" > "$SERVICE_ROOT/PASSWORD"
|
echo "$PASSWORD" >"$SERVICE_ROOT/PASSWORD"
|
||||||
chmod 640 "$SERVICE_ROOT/PASSWORD"
|
chmod 640 "$SERVICE_ROOT/PASSWORD"
|
||||||
|
|
||||||
[[ -n "$SERVICE_CUSTOM_ENV" ]] && POSTGRES_CUSTOM_ENV="$SERVICE_CUSTOM_ENV"
|
service_commit_config "$SERVICE"
|
||||||
if [[ -n $POSTGRES_CUSTOM_ENV ]]; then
|
write_database_name "$SERVICE"
|
||||||
echo "$POSTGRES_CUSTOM_ENV" | tr ';' "\n" > "$SERVICE_ROOT/ENV"
|
plugn trigger service-action post-create "$SERVICE"
|
||||||
else
|
|
||||||
echo "" > "$SERVICE_ROOT/ENV"
|
|
||||||
fi
|
|
||||||
service_create_container "$SERVICE"
|
service_create_container "$SERVICE"
|
||||||
|
plugn trigger service-action post-create-complete "$SERVICE"
|
||||||
}
|
}
|
||||||
|
|
||||||
service_create_container() {
|
service_create_container() {
|
||||||
@@ -64,25 +65,43 @@ service_create_container() {
|
|||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
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")"
|
||||||
local PASSWORD="$(cat "$SERVICE_ROOT/PASSWORD")"
|
local PASSWORD="$(service_password "$SERVICE")"
|
||||||
|
local DATABASE_NAME="$(get_database_name "$SERVICE")"
|
||||||
local PREVIOUS_ID
|
local PREVIOUS_ID
|
||||||
|
|
||||||
ID=$(docker run --name "$SERVICE_NAME" -v "$SERVICE_HOST_ROOT/data:/var/lib/postgresql/data" -e "POSTGRES_PASSWORD=$PASSWORD" --env-file="$SERVICE_ROOT/ENV" -d --restart always --label dokku=service --label dokku.service=postgres "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION")
|
if [[ -f "$SERVICE_ROOT/CONFIG_OPTIONS" ]]; then
|
||||||
echo "$ID" > "$SERVICE_ROOT/ID"
|
export CONFIG_OPTIONS="$(cat "$SERVICE_ROOT/CONFIG_OPTIONS")"
|
||||||
|
fi
|
||||||
|
|
||||||
|
[[ -f "$SERVICE_ROOT/SERVICE_MEMORY" ]] && SERVICE_MEMORY="$(cat "$SERVICE_ROOT/SERVICE_MEMORY")"
|
||||||
|
if [[ -n "$SERVICE_MEMORY" ]]; then
|
||||||
|
MEMORY_LIMIT="--memory=${SERVICE_MEMORY}m"
|
||||||
|
fi
|
||||||
|
|
||||||
|
[[ -f "$SERVICE_ROOT/SHM_SIZE" ]] && SERVICE_SHM_SIZE="$(cat "$SERVICE_ROOT/SHM_SIZE")"
|
||||||
|
if [[ -n "$SERVICE_SHM_SIZE" ]]; then
|
||||||
|
SHM_SIZE="--shm-size=${SERVICE_SHM_SIZE}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
[[ -f "$SERVICE_ROOT/IMAGE" ]] && PLUGIN_IMAGE="$(cat "$SERVICE_ROOT/IMAGE")"
|
||||||
|
[[ -f "$SERVICE_ROOT/IMAGE_VERSION" ]] && PLUGIN_IMAGE_VERSION="$(cat "$SERVICE_ROOT/IMAGE_VERSION")"
|
||||||
|
|
||||||
|
# shellcheck disable=SC2086
|
||||||
|
ID=$(docker run --name "$SERVICE_NAME" $MEMORY_LIMIT $SHM_SIZE -v "$SERVICE_HOST_ROOT/data:/var/lib/postgresql/data" -e "POSTGRES_PASSWORD=$PASSWORD" --env-file="$SERVICE_ROOT/ENV" -d --restart always --label dokku=service --label dokku.service=postgres "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" $CONFIG_OPTIONS)
|
||||||
|
echo "$ID" >"$SERVICE_ROOT/ID"
|
||||||
|
|
||||||
dokku_log_verbose_quiet "Waiting for container to be ready"
|
dokku_log_verbose_quiet "Waiting for container to be ready"
|
||||||
docker run --rm --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" dokkupaas/wait:0.2 -p "$PLUGIN_DATASTORE_WAIT_PORT" > /dev/null
|
docker run --rm --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" "$PLUGIN_WAIT_IMAGE" -p "$PLUGIN_DATASTORE_WAIT_PORT" >/dev/null
|
||||||
|
|
||||||
dokku_log_verbose_quiet "Creating container database"
|
dokku_log_verbose_quiet "Creating container database"
|
||||||
DATABASE_NAME="$(get_database_name "$SERVICE")"
|
docker exec "$SERVICE_NAME" su - postgres -c "createdb -E utf8 $DATABASE_NAME" 2>/dev/null || dokku_log_verbose_quiet 'Already exists'
|
||||||
docker exec "$SERVICE_NAME" su - postgres -c "createdb -E utf8 $DATABASE_NAME" 2> /dev/null || dokku_log_verbose_quiet 'Already exists'
|
|
||||||
|
|
||||||
dokku_log_verbose_quiet "Securing connection to database"
|
dokku_log_verbose_quiet "Securing connection to database"
|
||||||
service_stop "$SERVICE" > /dev/null
|
service_stop "$SERVICE" >/dev/null
|
||||||
docker run --rm -i -v "$SERVICE_HOST_ROOT/data:/var/lib/postgresql/data" "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" bash -s < "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/scripts/enable_ssl.sh" &> /dev/null
|
docker run --rm -i -v "$SERVICE_HOST_ROOT/data:/var/lib/postgresql/data" "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" bash -s <"$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/scripts/enable_ssl.sh" &>/dev/null
|
||||||
|
|
||||||
PREVIOUS_ID=$(docker ps -f status=exited | grep -e "$SERVICE_NAME$" | awk '{print $1}') || true
|
PREVIOUS_ID=$(docker ps -aq --no-trunc --filter "status=exited" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
|
||||||
docker start "$PREVIOUS_ID" > /dev/null
|
docker start "$PREVIOUS_ID" >/dev/null
|
||||||
service_port_unpause "$SERVICE"
|
service_port_unpause "$SERVICE"
|
||||||
|
|
||||||
dokku_log_info2 "$PLUGIN_SERVICE container created: $SERVICE"
|
dokku_log_info2 "$PLUGIN_SERVICE container created: $SERVICE"
|
||||||
@@ -94,7 +113,7 @@ service_export() {
|
|||||||
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 DATABASE_NAME="$(get_database_name "$SERVICE")"
|
local DATABASE_NAME="$(get_database_name "$SERVICE")"
|
||||||
local PASSWORD="$(cat "$SERVICE_ROOT/PASSWORD")"
|
local PASSWORD="$(service_password "$SERVICE")"
|
||||||
|
|
||||||
[[ -n $SSH_TTY ]] && stty -opost
|
[[ -n $SSH_TTY ]] && stty -opost
|
||||||
docker exec "$SERVICE_NAME" env PGPASSWORD="$PASSWORD" pg_dump -Fc --no-acl --no-owner -h localhost -U postgres -w "$DATABASE_NAME"
|
docker exec "$SERVICE_NAME" env PGPASSWORD="$PASSWORD" pg_dump -Fc --no-acl --no-owner -h localhost -U postgres -w "$DATABASE_NAME"
|
||||||
@@ -109,12 +128,12 @@ service_import() {
|
|||||||
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")"
|
||||||
local DATABASE_NAME="$(get_database_name "$SERVICE")"
|
local DATABASE_NAME="$(get_database_name "$SERVICE")"
|
||||||
local PASSWORD="$(cat "$SERVICE_ROOT/PASSWORD")"
|
local PASSWORD="$(service_password "$SERVICE")"
|
||||||
|
|
||||||
if [[ -t 0 ]]; then
|
if [[ -t 0 ]]; then
|
||||||
dokku_log_fail "No data provided on stdin."
|
dokku_log_fail "No data provided on stdin."
|
||||||
fi
|
fi
|
||||||
docker exec -i "$SERVICE_NAME" env PGPASSWORD="$PASSWORD" pg_restore -h localhost -cO -d "$DATABASE_NAME" -U postgres -w
|
docker exec -i "$SERVICE_NAME" env PGPASSWORD="$PASSWORD" pg_restore -h localhost -cO --if-exists -d "$DATABASE_NAME" -U postgres -w
|
||||||
}
|
}
|
||||||
|
|
||||||
service_start() {
|
service_start() {
|
||||||
@@ -122,34 +141,41 @@ 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 -f status=running | grep -e "$SERVICE_NAME$" | awk '{print $1}') || true
|
local ID=$(docker ps -aq --no-trunc --filter "status=running" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || 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
|
||||||
|
[[ -z $QUIET ]] && dokku_log_warn "Updating local container ID"
|
||||||
|
echo "$ID" >"$SERVICE_ROOT/ID"
|
||||||
|
fi
|
||||||
return 0
|
return 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
dokku_log_info1_quiet "Starting container"
|
dokku_log_info2_quiet "Starting container"
|
||||||
local PREVIOUS_ID=$(docker ps -f status=exited | grep -e "$SERVICE_NAME$" | awk '{print $1}') || true
|
local PREVIOUS_ID=$(docker ps -aq --no-trunc --filter "status=exited" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
|
||||||
local IMAGE_EXISTS=$(docker images | grep -e "^$PLUGIN_IMAGE " | grep -q " $PLUGIN_IMAGE_VERSION " && true)
|
local PASSWORD="$(service_password "$SERVICE")"
|
||||||
local PASSWORD="$(cat "$SERVICE_ROOT/PASSWORD")"
|
|
||||||
|
|
||||||
if [[ -n $PREVIOUS_ID ]]; then
|
if [[ -n $PREVIOUS_ID ]]; then
|
||||||
docker start "$PREVIOUS_ID" > /dev/null
|
docker start "$PREVIOUS_ID" >/dev/null
|
||||||
service_port_unpause "$SERVICE"
|
service_port_unpause "$SERVICE"
|
||||||
dokku_log_info2 "Container started"
|
dokku_log_info2 "Container started"
|
||||||
elif $IMAGE_EXISTS && [[ -n "$PASSWORD" ]]; then
|
elif service_image_exists "$SERVICE" && [[ -n "$PASSWORD" ]]; 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
|
||||||
}
|
}
|
||||||
|
|
||||||
service_url() {
|
service_url() {
|
||||||
local SERVICE="$1"
|
local SERVICE="$1"
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
local SERVICE_DNS_HOSTNAME="$(service_dns_hostname "$SERVICE")"
|
||||||
|
|
||||||
local PASSWORD="$(cat "$SERVICE_ROOT/PASSWORD")"
|
|
||||||
local DATABASE_NAME="$(get_database_name "$SERVICE")"
|
local DATABASE_NAME="$(get_database_name "$SERVICE")"
|
||||||
local SERVICE_ALIAS="$(service_alias "$SERVICE")"
|
local PASSWORD="$(service_password "$SERVICE")"
|
||||||
echo "$PLUGIN_SCHEME://postgres:$PASSWORD@$SERVICE_ALIAS:${PLUGIN_DATASTORE_PORTS[0]}/$DATABASE_NAME"
|
echo "$PLUGIN_SCHEME://postgres:$PASSWORD@$SERVICE_DNS_HOSTNAME:${PLUGIN_DATASTORE_PORTS[0]}/$DATABASE_NAME"
|
||||||
}
|
}
|
||||||
|
|||||||
114
help-functions
114
help-functions
@@ -1,6 +1,8 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
|
||||||
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
|
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
|
||||||
export SUBCOMMAND_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/subcommands"
|
export SUBCOMMAND_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/subcommands"
|
||||||
|
|
||||||
fn-help() {
|
fn-help() {
|
||||||
@@ -12,7 +14,7 @@ fn-help() {
|
|||||||
exit 0
|
exit 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
pushd "$SUBCOMMAND_ROOT" > /dev/null 2>&1
|
pushd "$SUBCOMMAND_ROOT" >/dev/null 2>&1
|
||||||
for cmd in *; do
|
for cmd in *; do
|
||||||
if [[ "$CMD" == "${PLUGIN_COMMAND_PREFIX}:$cmd" ]]; then
|
if [[ "$CMD" == "${PLUGIN_COMMAND_PREFIX}:$cmd" ]]; then
|
||||||
"$SUBCOMMAND_ROOT/$cmd" "$@"
|
"$SUBCOMMAND_ROOT/$cmd" "$@"
|
||||||
@@ -20,27 +22,27 @@ fn-help() {
|
|||||||
exit "$EXIT_CODE"
|
exit "$EXIT_CODE"
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
popd > /dev/null 2>&1
|
popd >/dev/null 2>&1
|
||||||
|
|
||||||
exit "$DOKKU_NOT_IMPLEMENTED_EXIT"
|
exit "$DOKKU_NOT_IMPLEMENTED_EXIT"
|
||||||
}
|
}
|
||||||
|
|
||||||
fn-help-all() {
|
fn-help-all() {
|
||||||
declare CMD="$1" SUBCOMMAND="$2"
|
declare CMD="$1" SUBCOMMAND="$2"
|
||||||
local CMD_OUTPUT BLUE BOLD FULL_OUTPUT NORMAL
|
local CMD_OUTPUT BLUE BOLD FULL_OUTPUT NORMAL
|
||||||
FULL_OUTPUT=true
|
FULL_OUTPUT=true
|
||||||
|
|
||||||
if [[ "$CMD" = "$PLUGIN_COMMAND_PREFIX:help" ]] || [[ "$CMD" == "$PLUGIN_COMMAND_PREFIX" ]] || [[ "$CMD" == "$PLUGIN_COMMAND_PREFIX:default" ]] ; then
|
if [[ "$CMD" == "$PLUGIN_COMMAND_PREFIX:help" ]] || [[ "$CMD" == "$PLUGIN_COMMAND_PREFIX" ]] || [[ "$CMD" == "$PLUGIN_COMMAND_PREFIX:default" ]]; then
|
||||||
BOLD="$(tput bold)"
|
BOLD="$(fn-help-fancy-tput bold)"
|
||||||
NORMAL="\033[m"
|
NORMAL="$(fn-help-fancy-color "\033[m")"
|
||||||
BLUE="\033[0;34m"
|
BLUE="$(fn-help-fancy-color "\033[0;34m")"
|
||||||
CYAN="\033[1;36m"
|
CYAN="$(fn-help-fancy-color "\033[1;36m")"
|
||||||
if [[ -n "$SUBCOMMAND" ]] && [[ "$SUBCOMMAND" != "--all" ]]; then
|
if [[ -n "$SUBCOMMAND" ]] && [[ "$SUBCOMMAND" != "--all" ]]; then
|
||||||
fn-help-contents-subcommand "$SUBCOMMAND" "$FULL_OUTPUT"
|
fn-help-contents-subcommand "$SUBCOMMAND" "$FULL_OUTPUT"
|
||||||
return "$?"
|
return "$?"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
echo -e "${BOLD}usage${NORMAL}: dokku $PLUGIN_COMMAND_PREFIX[:COMMAND]"
|
echo -e "${BOLD}usage${NORMAL}: dokku ${PLUGIN_COMMAND_PREFIX}[:COMMAND]"
|
||||||
echo ''
|
echo ''
|
||||||
echo -e "${BOLD}List your $PLUGIN_COMMAND_PREFIX services.${NORMAL}"
|
echo -e "${BOLD}List your $PLUGIN_COMMAND_PREFIX services.${NORMAL}"
|
||||||
echo ''
|
echo ''
|
||||||
@@ -57,7 +59,7 @@ fn-help-all() {
|
|||||||
elif [[ $(ps -o command= $PPID) == *"--all"* ]]; then
|
elif [[ $(ps -o command= $PPID) == *"--all"* ]]; then
|
||||||
fn-help-contents
|
fn-help-contents
|
||||||
else
|
else
|
||||||
cat<<help_desc
|
cat <<help_desc
|
||||||
$PLUGIN_COMMAND_PREFIX, Plugin for managing $PLUGIN_SERVICE services
|
$PLUGIN_COMMAND_PREFIX, Plugin for managing $PLUGIN_SERVICE services
|
||||||
help_desc
|
help_desc
|
||||||
fi
|
fi
|
||||||
@@ -66,7 +68,7 @@ help_desc
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn-help-contents() {
|
fn-help-contents() {
|
||||||
pushd "$SUBCOMMAND_ROOT" > /dev/null 2>&1
|
pushd "$SUBCOMMAND_ROOT" >/dev/null 2>&1
|
||||||
for cmd in *; do
|
for cmd in *; do
|
||||||
fn-help-contents-subcommand "$cmd" || true
|
fn-help-contents-subcommand "$cmd" || true
|
||||||
done
|
done
|
||||||
@@ -74,16 +76,16 @@ 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"
|
||||||
|
|
||||||
fn-help-subcommand-sanitize "$UNCLEAN_FILE" "$CLEAN_FILE"
|
fn-help-subcommand-sanitize "$UNCLEAN_FILE" "$CLEAN_FILE"
|
||||||
if [[ "$(fn-help-is-subcommand-unimplemented "$CLEAN_FILE")" == true ]]; then
|
if ! is_implemented_command "$SUBCOMMAND"; then
|
||||||
return 1
|
return 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
@@ -94,12 +96,12 @@ fn-help-contents-subcommand() {
|
|||||||
desc="$(grep desc "$CLEAN_FILE" | head -1)"
|
desc="$(grep desc "$CLEAN_FILE" | head -1)"
|
||||||
eval "$desc"
|
eval "$desc"
|
||||||
|
|
||||||
BLUE="\033[0;34m"
|
BLUE="$(fn-help-fancy-color "\033[0;34m")"
|
||||||
BOLD="$(tput bold)"
|
BOLD="$(fn-help-fancy-tput bold)"
|
||||||
CYAN="\033[1;36m"
|
CYAN="$(fn-help-fancy-color "\033[1;36m")"
|
||||||
NORMAL="\033[m"
|
NORMAL="$(fn-help-fancy-color "\033[m")"
|
||||||
LIGHT_GRAY="\033[2;37m"
|
LIGHT_GRAY="$(fn-help-fancy-color "\033[2;37m")"
|
||||||
LIGHT_RED="\033[1;31m"
|
LIGHT_RED="$(fn-help-fancy-color "\033[1;31m")"
|
||||||
CMD_OUTPUT="$(echo -e " ${PLUGIN_COMMAND_PREFIX}${cmd_line}, ${LIGHT_GRAY}${desc}${NORMAL}")"
|
CMD_OUTPUT="$(echo -e " ${PLUGIN_COMMAND_PREFIX}${cmd_line}, ${LIGHT_GRAY}${desc}${NORMAL}")"
|
||||||
if [[ "$FULL_OUTPUT" != "true" ]]; then
|
if [[ "$FULL_OUTPUT" != "true" ]]; then
|
||||||
echo "$CMD_OUTPUT"
|
echo "$CMD_OUTPUT"
|
||||||
@@ -138,24 +140,32 @@ fn-help-contents-subcommand() {
|
|||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
|
|
||||||
fn-help-is-subcommand-unimplemented() {
|
fn-help-fancy-tput() {
|
||||||
declare FUNC_FILE="$1"
|
declare desc="a wrapper around tput"
|
||||||
local UNIMPLEMENTED
|
|
||||||
|
|
||||||
UNIMPLEMENTED="$(grep "Not yet implemented" "$FUNC_FILE" | head -1 || true)"
|
if [[ -n "$DOKKU_NO_COLOR" ]] || [[ "$TERM" == "unknown" ]] || [[ "$TERM" == "dumb" ]]; then
|
||||||
if [[ -n "$UNIMPLEMENTED" ]]; then
|
return
|
||||||
echo true
|
|
||||||
else
|
|
||||||
echo false
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
tput "$@"
|
||||||
|
}
|
||||||
|
|
||||||
|
fn-help-fancy-color() {
|
||||||
|
declare desc="a wrapper around colors"
|
||||||
|
|
||||||
|
if [[ -n "$DOKKU_NO_COLOR" ]] || [[ "$TERM" == "unknown" ]] || [[ "$TERM" == "dumb" ]]; then
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "$@"
|
||||||
}
|
}
|
||||||
|
|
||||||
fn-help-list-example() {
|
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
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -164,8 +174,8 @@ fn-help-subcommand-args() {
|
|||||||
local argline arglist args argpos BLUE NORMAL
|
local argline arglist args argpos BLUE NORMAL
|
||||||
|
|
||||||
if [[ "$FULL_OUTPUT" == "true" ]]; then
|
if [[ "$FULL_OUTPUT" == "true" ]]; then
|
||||||
BLUE="\033[0;34m"
|
BLUE="$(fn-help-fancy-color "\033[0;34m")"
|
||||||
NORMAL="\033[m"
|
NORMAL="$(fn-help-fancy-color "\033[m")"
|
||||||
fi
|
fi
|
||||||
argline=$(grep declare "$FUNC_FILE" | grep -v "declare desc" | head -1 || true)
|
argline=$(grep declare "$FUNC_FILE" | grep -v "declare desc" | head -1 || true)
|
||||||
arglist=($(echo -e "${argline// /"\n"}" | awk -F= '/=/{print ""$1""}'))
|
arglist=($(echo -e "${argline// /"\n"}" | awk -F= '/=/{print ""$1""}'))
|
||||||
@@ -181,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}"
|
||||||
@@ -210,12 +220,12 @@ fn-help-subcommand-example() {
|
|||||||
return 0
|
return 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
BOLD="$(tput bold)"
|
BOLD="$(fn-help-fancy-tput bold)"
|
||||||
LAST_LINE=""
|
LAST_LINE=""
|
||||||
LIGHT_GRAY="\033[2;37m"
|
LIGHT_GRAY="$(fn-help-fancy-color "\033[2;37m")"
|
||||||
OTHER_GRAY="\033[7;37m"
|
OTHER_GRAY="$(fn-help-fancy-color "\033[7;37m")"
|
||||||
NEWLINE=""
|
NEWLINE=""
|
||||||
NORMAL="\033[m"
|
NORMAL="$(fn-help-fancy-color "\033[m")"
|
||||||
_fn-help-apply-shell-expansion "$EXAMPLE" | while read -r line; do
|
_fn-help-apply-shell-expansion "$EXAMPLE" | while read -r line; do
|
||||||
line="$(echo "$line" | cut -c 4-)"
|
line="$(echo "$line" | cut -c 4-)"
|
||||||
if [[ "$line" == export* ]] || [[ "$line" == dokku* ]]; then
|
if [[ "$line" == export* ]] || [[ "$line" == dokku* ]]; then
|
||||||
@@ -245,10 +255,10 @@ fn-help-subcommand-list-args() {
|
|||||||
return 0
|
return 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
NORMAL="\033[m"
|
NORMAL="$(fn-help-fancy-color "\033[m")"
|
||||||
LIGHT_GRAY="\033[2;37m"
|
LIGHT_GRAY="$(fn-help-fancy-color "\033[2;37m")"
|
||||||
|
|
||||||
_fn-help-apply-shell-expansion "$FLAGS" | while read -r line; do
|
_fn-help-apply-shell-expansion "$FLAGS" | while read -r line; do
|
||||||
echo -e "$(echo "$line" | cut -d',' -f1),${LIGHT_GRAY}$(echo "$line" | cut -d',' -f2-)${NORMAL}"
|
echo -e "$(echo "$line" | cut -d',' -f1),${LIGHT_GRAY}$(echo "$line" | cut -d',' -f2-)${NORMAL}"
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
@@ -262,10 +272,10 @@ fn-help-subcommand-list-flags() {
|
|||||||
return 0
|
return 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
NORMAL="\033[m"
|
NORMAL="$(fn-help-fancy-color "\033[m")"
|
||||||
LIGHT_GRAY="\033[2;37m"
|
LIGHT_GRAY="$(fn-help-fancy-color "\033[2;37m")"
|
||||||
|
|
||||||
_fn-help-apply-shell-expansion "$FLAGS" | while read -r line; do
|
_fn-help-apply-shell-expansion "$FLAGS" | while read -r line; do
|
||||||
echo -e "$(echo "$line" | cut -d',' -f1),${LIGHT_GRAY}$(echo "$line" | cut -d',' -f2-)${NORMAL}"
|
echo -e "$(echo "$line" | cut -d',' -f1),${LIGHT_GRAY}$(echo "$line" | cut -d',' -f2-)${NORMAL}"
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
@@ -286,20 +296,20 @@ fn-help-subcommand-sanitize() {
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
if [[ "$FUNCTION_FOUND" == true ]]; then
|
if [[ "$FUNCTION_FOUND" == true ]]; then
|
||||||
echo "$p" >> "$OUTGOING_FUNC_FILE"
|
echo "$p" >>"$OUTGOING_FUNC_FILE"
|
||||||
continue
|
continue
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [[ "$p" == *"()"* ]]; then
|
if [[ "$p" == *"()"* ]]; then
|
||||||
FUNCTION_FOUND=true
|
FUNCTION_FOUND=true
|
||||||
echo "$p" >> "$OUTGOING_FUNC_FILE"
|
echo "$p" >>"$OUTGOING_FUNC_FILE"
|
||||||
continue
|
continue
|
||||||
fi
|
fi
|
||||||
done < "$FUNC_FILE"
|
done <"$FUNC_FILE"
|
||||||
}
|
}
|
||||||
|
|
||||||
_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"
|
||||||
|
|||||||
33
install
33
install
@@ -1,6 +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"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
|
||||||
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
|
|
||||||
plugin-install() {
|
plugin-install() {
|
||||||
pull-docker-image() {
|
pull-docker-image() {
|
||||||
@@ -10,16 +12,16 @@ plugin-install() {
|
|||||||
echo " ! docker pull ${IMAGE}" 1>&2
|
echo " ! docker pull ${IMAGE}" 1>&2
|
||||||
return
|
return
|
||||||
fi
|
fi
|
||||||
if [[ "$(docker images -q "${IMAGE}" 2> /dev/null)" == "" ]]; then
|
if [[ "$(docker images -q "${IMAGE}" 2>/dev/null)" == "" ]]; then
|
||||||
docker pull "${IMAGE}"
|
docker pull "${IMAGE}"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
pull-docker-image "${PLUGIN_IMAGE}:${PLUGIN_IMAGE_VERSION}"
|
pull-docker-image "${PLUGIN_IMAGE}:${PLUGIN_IMAGE_VERSION}"
|
||||||
pull-docker-image "svendowideit/ambassador:latest"
|
pull-docker-image "$PLUGIN_BUSYBOX_IMAGE"
|
||||||
pull-docker-image "dokkupaas/wait:0.2"
|
pull-docker-image "$PLUGIN_AMBASSADOR_IMAGE"
|
||||||
pull-docker-image "dokkupaas/s3backup:0.8.0"
|
pull-docker-image "$PLUGIN_S3BACKUP_IMAGE"
|
||||||
pull-docker-image "busybox:latest"
|
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:dokku "$PLUGIN_DATA_ROOT"
|
||||||
@@ -31,7 +33,7 @@ plugin-install() {
|
|||||||
_SUDOERS_FILE="/etc/sudoers.d/dokku-${PLUGIN_COMMAND_PREFIX}"
|
_SUDOERS_FILE="/etc/sudoers.d/dokku-${PLUGIN_COMMAND_PREFIX}"
|
||||||
|
|
||||||
touch "$_SUDOERS_FILE"
|
touch "$_SUDOERS_FILE"
|
||||||
cat > "$_SUDOERS_FILE" <<EOL
|
cat >"$_SUDOERS_FILE" <<EOL
|
||||||
%dokku ALL=(ALL) NOPASSWD:/bin/rm -f /etc/cron.d/dokku-${PLUGIN_COMMAND_PREFIX}-*
|
%dokku ALL=(ALL) NOPASSWD:/bin/rm -f /etc/cron.d/dokku-${PLUGIN_COMMAND_PREFIX}-*
|
||||||
%dokku ALL=(ALL) NOPASSWD:/bin/chown root\:root /etc/cron.d/dokku-${PLUGIN_COMMAND_PREFIX}-*
|
%dokku ALL=(ALL) NOPASSWD:/bin/chown root\:root /etc/cron.d/dokku-${PLUGIN_COMMAND_PREFIX}-*
|
||||||
%dokku ALL=(ALL) NOPASSWD:/bin/chmod 644 /etc/cron.d/dokku-${PLUGIN_COMMAND_PREFIX}-*
|
%dokku ALL=(ALL) NOPASSWD:/bin/chmod 644 /etc/cron.d/dokku-${PLUGIN_COMMAND_PREFIX}-*
|
||||||
@@ -41,6 +43,23 @@ plugin-install() {
|
|||||||
EOL
|
EOL
|
||||||
|
|
||||||
chmod 0440 "$_SUDOERS_FILE"
|
chmod 0440 "$_SUDOERS_FILE"
|
||||||
|
|
||||||
|
local SERVICES=$(ls "$PLUGIN_DATA_ROOT" 2>/dev/null)
|
||||||
|
for SERVICE in $SERVICES; 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
|
||||||
|
|
||||||
|
if [[ -f "$SERVICE_ROOT/${PLUGIN_VARIABLE}_CONFIG_OPTIONS" ]]; then
|
||||||
|
mv "$SERVICE_ROOT/${PLUGIN_VARIABLE}_CONFIG_OPTIONS" "$SERVICE_ROOT/CONFIG_OPTIONS"
|
||||||
|
fi
|
||||||
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
plugin-install "$@"
|
plugin-install "$@"
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
[plugin]
|
[plugin]
|
||||||
description = "dokku postgres service plugin"
|
description = "dokku postgres service plugin"
|
||||||
version = "1.2.6"
|
version = "1.14.1"
|
||||||
[plugin.config]
|
[plugin.config]
|
||||||
|
|||||||
19
post-app-clone-setup
Executable file
19
post-app-clone-setup
Executable file
@@ -0,0 +1,19 @@
|
|||||||
|
#!/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"
|
||||||
|
|
||||||
|
local SERVICES=$(ls "$PLUGIN_DATA_ROOT" 2>/dev/null)
|
||||||
|
for SERVICE in $SERVICES; 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 "$@"
|
||||||
19
post-app-rename-setup
Executable file
19
post-app-rename-setup
Executable file
@@ -0,0 +1,19 @@
|
|||||||
|
#!/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"
|
||||||
|
|
||||||
|
local SERVICES=$(ls "$PLUGIN_DATA_ROOT" 2>/dev/null)
|
||||||
|
for SERVICE in $SERVICES; 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 "$@"
|
||||||
@@ -1,6 +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"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
source "$PLUGIN_BASE_PATH/common/functions"
|
||||||
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
|
|
||||||
PLUGIN_BASE_PATH="$PLUGIN_PATH"
|
PLUGIN_BASE_PATH="$PLUGIN_PATH"
|
||||||
if [[ -n $DOKKU_API_VERSION ]]; then
|
if [[ -n $DOKKU_API_VERSION ]]; then
|
||||||
@@ -10,7 +12,10 @@ source "$PLUGIN_BASE_PATH/common/functions"
|
|||||||
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/functions"
|
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/functions"
|
||||||
|
|
||||||
APP="$1"
|
APP="$1"
|
||||||
for SERVICE in "$PLUGIN_DATA_ROOT"/*; do
|
pushd "$PLUGIN_DATA_ROOT" >/dev/null
|
||||||
|
for SERVICE in *; do
|
||||||
|
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
|
exit 0
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
cd /var/lib/postgresql/data
|
pushd /var/lib/postgresql/data >/dev/null
|
||||||
openssl req -new -newkey rsa:4096 -x509 -nodes -out server.crt -keyout server.key -batch
|
openssl req -new -newkey rsa:4096 -x509 -nodes -out server.crt -keyout server.key -batch
|
||||||
chmod 600 server.key
|
chmod 600 server.key
|
||||||
sed -i "s/^#ssl = off/ssl = on/" postgresql.conf
|
sed -i "s/^#ssl = off/ssl = on/" postgresql.conf
|
||||||
sed -i "s/^#ssl_ciphers =.*/ssl_ciphers = 'AES256+EECDH:AES256+EDH'/" postgresql.conf
|
sed -i "s/^#ssl_ciphers =.*/ssl_ciphers = 'AES256+EECDH:AES256+EDH'/" postgresql.conf
|
||||||
|
popd >/dev/null
|
||||||
|
|||||||
23
subcommands/app-links
Executable file
23
subcommands/app-links
Executable file
@@ -0,0 +1,23 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
|
source "$PLUGIN_BASE_PATH/common/functions"
|
||||||
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||||
|
|
||||||
|
service-app-links-cmd() {
|
||||||
|
#E list all $PLUGIN_COMMAND_PREFIX services that are linked to the 'playground' app.
|
||||||
|
#E dokku $PLUGIN_COMMAND_PREFIX:app-links playground
|
||||||
|
#A app, app to run command against
|
||||||
|
declare desc="list all $PLUGIN_SERVICE service links for a given app"
|
||||||
|
local cmd="$PLUGIN_COMMAND_PREFIX:app-links" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
|
declare APP="$1"
|
||||||
|
APP=${APP:="$DOKKU_APP_NAME"}
|
||||||
|
|
||||||
|
[[ -z "$APP" ]] && dokku_log_fail "Please specify an app to run the command on"
|
||||||
|
verify_app_name "$APP"
|
||||||
|
service_app_links "$APP"
|
||||||
|
}
|
||||||
|
|
||||||
|
service-app-links-cmd "$@"
|
||||||
@@ -1,20 +1,25 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:backup" argv=("$@")
|
||||||
|
[[ ${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"
|
||||||
|
is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
|
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
|
||||||
[[ -z "$BUCKET_NAME" ]] && dokku_log_fail "Please specify an aws bucket for the backup"
|
[[ -z "$BUCKET_NAME" ]] && dokku_log_fail "Please specify an aws bucket for the backup"
|
||||||
verify_service_name "$SERVICE"
|
verify_service_name "$SERVICE"
|
||||||
service_backup "$SERVICE" "$BUCKET_NAME" "$USE_IAM_OPTIONAL_FLAG"
|
service_backup "$SERVICE" "$BUCKET_NAME" "$USE_IAM_OPTIONAL_FLAG"
|
||||||
|
|||||||
@@ -1,29 +1,32 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:backup-auth" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1" AWS_ACCESS_KEY_ID="$2" AWS_SECRET_ACCESS_KEY="$3" AWS_DEFAULT_REGION="$4" AWS_SIGNATURE_VERSION="$5" ENDPOINT_URL="$6"
|
declare SERVICE="$1" AWS_ACCESS_KEY_ID="$2" AWS_SECRET_ACCESS_KEY="$3" AWS_DEFAULT_REGION="$4" AWS_SIGNATURE_VERSION="$5" ENDPOINT_URL="$6"
|
||||||
|
is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
|
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
|
||||||
[[ -z "$AWS_ACCESS_KEY_ID" ]] && dokku_log_fail "Please specify an aws access key id"
|
[[ -z "$AWS_ACCESS_KEY_ID" ]] && dokku_log_fail "Please specify an aws access key id"
|
||||||
[[ -z "$AWS_SECRET_ACCESS_KEY" ]] && dokku_log_fail "Please specify an aws secret access key"
|
[[ -z "$AWS_SECRET_ACCESS_KEY" ]] && dokku_log_fail "Please specify an aws secret access key"
|
||||||
verify_service_name "$SERVICE"
|
verify_service_name "$SERVICE"
|
||||||
|
|||||||
@@ -1,18 +1,21 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:backup-deauth" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1"
|
declare SERVICE="$1"
|
||||||
|
is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a 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_backup_deauth "$SERVICE"
|
service_backup_deauth "$SERVICE"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,24 +1,27 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:backup-schedule" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1" SCHEDULE="$2" BUCKET_NAME="$3" USE_IAM_OPTIONAL_FLAG="$4"
|
declare SERVICE="$1" SCHEDULE="$2" BUCKET_NAME="$3" USE_IAM_OPTIONAL_FLAG="$4"
|
||||||
|
is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
|
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
|
||||||
[[ -z "$SCHEDULE" ]] && dokku_log_fail "Please specify a schedule for the backup"
|
[[ -z "$SCHEDULE" ]] && dokku_log_fail "Please specify a schedule for the backup"
|
||||||
[[ -z "$BUCKET_NAME" ]] && dokku_log_fail "Please specify an aws bucket for the backup"
|
[[ -z "$BUCKET_NAME" ]] && dokku_log_fail "Please specify an aws bucket for the backup"
|
||||||
verify_service_name "$SERVICE"
|
verify_service_name "$SERVICE"
|
||||||
|
|||||||
@@ -1,18 +1,20 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:backup-schedule-cat" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1"
|
declare SERVICE="$1"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a 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_backup_schedule_cat "$SERVICE"
|
service_backup_schedule_cat "$SERVICE"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,22 +1,25 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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 encryption key 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 encryption-key, a GPG encryption key
|
#A passphrase, a GPG-compatible passphrase
|
||||||
declare desc="sets encryption for all future backups of $PLUGIN_SERVICE service"
|
declare desc="set encryption for all future backups of $PLUGIN_SERVICE service"
|
||||||
local cmd="$PLUGIN_COMMAND_PREFIX:backup-set-encryption" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:backup-set-encryption" argv=("$@")
|
||||||
declare SERVICE="$1" ENCRYPTION_KEY="$2"
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
|
declare SERVICE="$1" PASSPHRASE="$2"
|
||||||
|
is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
|
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
|
||||||
[[ -z "$ENCRYPTION_KEY" ]] && dokku_log_fail "Please specify a GPG encryption key"
|
[[ -z "$PASSPHRASE" ]] && dokku_log_fail "Please specify a GPG backup passphrase"
|
||||||
verify_service_name "$SERVICE"
|
verify_service_name "$SERVICE"
|
||||||
service_backup_set_encryption "$SERVICE" "$ENCRYPTION_KEY"
|
service_backup_set_encryption "$SERVICE" "$PASSPHRASE"
|
||||||
}
|
}
|
||||||
|
|
||||||
service-backup-set-encryption-cmd "$@"
|
service-backup-set-encryption-cmd "$@"
|
||||||
|
|||||||
@@ -1,18 +1,21 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:backup-unschedule" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1"
|
declare SERVICE="$1"
|
||||||
|
is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a 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_backup_unschedule "$SERVICE"
|
service_backup_unschedule "$SERVICE"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,18 +1,21 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:backup-unset-encryption" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1"
|
declare SERVICE="$1"
|
||||||
|
is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a 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_backup_unset_encryption "$SERVICE"
|
service_backup_unset_encryption "$SERVICE"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,29 +1,47 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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 -i|--image IMAGE, the image name to start the service with
|
||||||
|
#F -I|--image-version IMAGE_VERSION, the image version to start the service with
|
||||||
|
#F -m|--memory MEMORY, container memory limit (default: unlimited)
|
||||||
|
#F -p|--password PASSWORD, override the user-level service password
|
||||||
|
#F -r|--root-password PASSWORD, override the root-level service password
|
||||||
|
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
|
||||||
declare desc="create container <new-name> then copy data from <name> into <new-name>"
|
declare desc="create container <new-name> then copy data from <name> into <new-name>"
|
||||||
local cmd="$PLUGIN_COMMAND_PREFIX:clone" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:clone" argv=("$@")
|
||||||
declare SERVICE="$1" NEW_SERVICE="$2" CLONE_FLAGS_LIST="${@:3}"
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
|
declare SERVICE="$1" NEW_SERVICE="$2" CLONE_FLAGS_LIST=("${@:3}")
|
||||||
|
is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a 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"
|
||||||
|
|
||||||
PLUGIN_IMAGE=$(service_version "$SERVICE" | grep -o "^.*:" | sed -r "s/://g")
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
PLUGIN_IMAGE_VERSION=$(service_version "$SERVICE" | grep -o ":.*$" | sed -r "s/://g")
|
local ID="$(cat "$SERVICE_ROOT/ID")"
|
||||||
|
is_container_status "$ID" "Running" || dokku_log_fail "Service ${SERVICE} container is not running"
|
||||||
|
|
||||||
|
PLUGIN_IMAGE=$(service_version "$SERVICE" | grep -o "^.*:" | sed -r "s/://g")
|
||||||
|
PLUGIN_IMAGE_VERSION=$(service_version "$SERVICE" | grep -o ":.*$" | sed -r "s/://g")
|
||||||
|
|
||||||
|
service_parse_args "${@:3}"
|
||||||
|
|
||||||
|
dokku_log_info2 "Cloning $SERVICE to $NEW_SERVICE @ $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION"
|
||||||
service_create "$NEW_SERVICE" "${@:3}"
|
service_create "$NEW_SERVICE" "${@:3}"
|
||||||
dokku_log_info1 "Copying data from $SERVICE to $NEW_SERVICE"
|
dokku_log_info1 "Copying data from $SERVICE to $NEW_SERVICE"
|
||||||
service_export "$SERVICE" | service_import "$NEW_SERVICE" > /dev/null 2>&1 || true
|
service_export "$SERVICE" | service_import "$NEW_SERVICE" >/dev/null 2>&1 || true
|
||||||
dokku_log_info1 "Done"
|
dokku_log_info2 "Done"
|
||||||
}
|
}
|
||||||
|
|
||||||
service-clone-cmd "$@"
|
service-clone-cmd "$@"
|
||||||
|
|||||||
@@ -1,18 +1,22 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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 via psql to a $PLUGIN_SERVICE service"
|
declare desc="connect to the service via the $PLUGIN_COMMAND_PREFIX connection tool"
|
||||||
local cmd="$PLUGIN_COMMAND_PREFIX:connect" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:connect" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1"
|
declare SERVICE="$1"
|
||||||
|
is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a 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_connect "$SERVICE"
|
service_connect "$SERVICE"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,30 +1,35 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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 semi-colon 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|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
|
#F -c|--config-options "--args --go=here", extra arguments to pass to the container create command
|
||||||
|
#F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
|
||||||
#F -i|--image IMAGE, the image name to start the service with
|
#F -i|--image 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 (default: unlimited)
|
||||||
#F -p|--password PASSWORD, override the user-level service password
|
#F -p|--password PASSWORD, override the user-level service password
|
||||||
#F -r|--root-password PASSWORD, override the root-level service password
|
#F -r|--root-password PASSWORD, override the root-level service password
|
||||||
|
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
|
||||||
declare desc="create a $PLUGIN_SERVICE service"
|
declare desc="create a $PLUGIN_SERVICE service"
|
||||||
local cmd="$PLUGIN_COMMAND_PREFIX:create" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:create" argv=("$@")
|
||||||
declare SERVICE="$1" CREATE_FLAGS_LIST="${@:2}"
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
|
declare SERVICE="$1" CREATE_FLAGS_LIST=("${@:2}")
|
||||||
|
|
||||||
service_create "$SERVICE" "${@:2}"
|
service_create "$SERVICE" "${@:2}"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,21 +1,24 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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"
|
||||||
local cmd="$PLUGIN_COMMAND_PREFIX:destroy" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:destroy" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1" FORCE_FLAG="$2"
|
declare SERVICE="$1" FORCE_FLAG="$2"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a 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_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"; LINKS_FILE="$SERVICE_ROOT/LINKS"
|
SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
LINKS_FILE="$SERVICE_ROOT/LINKS"
|
||||||
SERVICE_HOST_ROOT="$PLUGIN_DATA_HOST_ROOT/$SERVICE"
|
SERVICE_HOST_ROOT="$PLUGIN_DATA_HOST_ROOT/$SERVICE"
|
||||||
SERVICE_NAME="$(get_service_name "$SERVICE")"
|
SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||||
|
|
||||||
@@ -37,23 +40,16 @@ service-destroy-cmd() {
|
|||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
dokku_log_info1 "Deleting $SERVICE"
|
dokku_log_info2_quiet "Deleting $SERVICE"
|
||||||
if [[ -n $(docker ps -aq -f name="$SERVICE_NAME") ]]; then
|
plugn trigger service-action pre-delete "$SERVICE"
|
||||||
dokku_log_verbose_quiet "Deleting container data"
|
service_backup_unschedule "$SERVICE"
|
||||||
service_stop "$SERVICE"
|
service_container_rm "$SERVICE"
|
||||||
sleep 1
|
|
||||||
|
|
||||||
dokku_log_verbose_quiet "Removing container"
|
|
||||||
docker rm -v "$SERVICE_NAME" > /dev/null
|
|
||||||
sleep 1
|
|
||||||
else
|
|
||||||
dokku_log_verbose_quiet "No container exists for $SERVICE"
|
|
||||||
fi
|
|
||||||
|
|
||||||
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" "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" chmod 777 -R /config /data
|
docker run --rm -v "$SERVICE_HOST_ROOT/data:/data" -v "$SERVICE_HOST_ROOT/$PLUGIN_CONFIG_SUFFIX:/config" "$PLUGIN_BUSYBOX_IMAGE" chmod 777 -R /config /data
|
||||||
rm -rf "$SERVICE_ROOT"
|
rm -rf "$SERVICE_ROOT"
|
||||||
|
|
||||||
|
plugn trigger service-action post-delete "$SERVICE"
|
||||||
dokku_log_info2 "$PLUGIN_SERVICE container deleted: $SERVICE"
|
dokku_log_info2 "$PLUGIN_SERVICE container deleted: $SERVICE"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,19 +1,22 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:enter" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1"
|
declare SERVICE="$1"
|
||||||
|
|
||||||
dokku_log_info1_quiet "Filesystem changes may not persist after container restarts"
|
dokku_log_info1_quiet "Filesystem changes may not persist after container restarts"
|
||||||
|
|||||||
@@ -1,18 +1,20 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:exists" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1"
|
declare SERVICE="$1"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a 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"
|
||||||
dokku_log_info1 "Service $SERVICE exists"
|
dokku_log_info1 "Service $SERVICE exists"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,20 +1,23 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:export" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1"
|
declare SERVICE="$1"
|
||||||
|
is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a 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_export "$SERVICE"
|
service_export "$SERVICE"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,19 +1,23 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:expose" argv=("$@")
|
||||||
declare SERVICE="$1" PORTS_LIST="${@:2}"
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
|
declare SERVICE="$1" PORTS_LIST=("${@:2}")
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a 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_port_expose "$SERVICE" "${@:2}"
|
service_port_expose "$SERVICE" "${@:2}"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,18 +1,21 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:import" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1"
|
declare SERVICE="$1"
|
||||||
|
is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a 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_import "$SERVICE"
|
service_import "$SERVICE"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,23 +1,24 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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 --links
|
||||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --service-root
|
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --service-root
|
||||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --status
|
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --status
|
||||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --version
|
#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
|
||||||
@@ -29,11 +30,12 @@ service-info-cmd() {
|
|||||||
#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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:info" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1" INFO_FLAG="$2"
|
declare SERVICE="$1" INFO_FLAG="$2"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a 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_info "$SERVICE" "$INFO_FLAG"
|
service_info "$SERVICE" "$INFO_FLAG"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_PATH/common/functions"
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||||
|
|
||||||
@@ -9,45 +10,50 @@ 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 won’t be listed when calling dokku config):
|
#E (not on the app itself, so they won’t be listed when calling dokku config):
|
||||||
#E
|
#E
|
||||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_NAME=/lolipop/DATABASE
|
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_NAME=/lollipop/DATABASE
|
||||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]}
|
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]}
|
||||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]}
|
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]}
|
||||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PROTO=tcp
|
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PROTO=tcp
|
||||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PORT=${PLUGIN_DATASTORE_PORTS[0]}
|
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PORT=${PLUGIN_DATASTORE_PORTS[0]}
|
||||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_ADDR=172.17.0.1
|
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_ADDR=172.17.0.1
|
||||||
#E
|
#E
|
||||||
#E the following will be set on the linked application by default:
|
#E the following will be set on the linked application by default:
|
||||||
#E
|
#E
|
||||||
#E ${PLUGIN_DEFAULT_ALIAS}_URL=${PLUGIN_SCHEME}://lolipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lolipop:${PLUGIN_DATASTORE_PORTS[0]}/lolipop
|
#E ${PLUGIN_DEFAULT_ALIAS}_URL=${PLUGIN_SCHEME}://lollipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lollipop:${PLUGIN_DATASTORE_PORTS[0]}/lollipop
|
||||||
#E
|
#E
|
||||||
#E the host exposed here only works internally in docker containers.
|
#E the host exposed here only works internally in docker containers.
|
||||||
#E if you want your container to be reachable from outside, you should
|
#E if you want your container to be reachable from outside, you should
|
||||||
#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://lollipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lollipop:${PLUGIN_DATASTORE_PORTS[0]}/lollipop
|
||||||
#A service, service to run command against
|
#A service, service to run command against
|
||||||
#A app, app to run command against
|
#A app, app to run command against
|
||||||
|
#F -a|--alias "BLUE_DATABASE", an alternative alias to use for linking to an app via environment variable
|
||||||
|
#F -q|--querystring "pool=5", ampersand delimited querystring arguments to append to the service link
|
||||||
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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:link" argv=("$@")
|
||||||
declare SERVICE="$1" APP="$2"
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
|
declare SERVICE="$1" APP="$2" LINK_FLAGS_LIST=("${@:3}")
|
||||||
APP=${APP:="$DOKKU_APP_NAME"}
|
APP=${APP:="$DOKKU_APP_NAME"}
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
|
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
|
||||||
[[ -z "$APP" ]] && dokku_log_fail "Please specify an app to run the command on"
|
[[ -z "$APP" ]] && dokku_log_fail "Please specify an app to run the command on"
|
||||||
verify_app_name "$APP"
|
verify_app_name "$APP"
|
||||||
verify_service_name "$SERVICE"
|
verify_service_name "$SERVICE"
|
||||||
|
|
||||||
|
service_parse_args "${@:3}"
|
||||||
service_link "$SERVICE" "$APP"
|
service_link "$SERVICE" "$APP"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,20 +1,22 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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"
|
||||||
local cmd="$PLUGIN_COMMAND_PREFIX:linked" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:linked" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1" APP="$2"
|
declare SERVICE="$1" APP="$2"
|
||||||
APP=${APP:="$DOKKU_APP_NAME"}
|
APP=${APP:="$DOKKU_APP_NAME"}
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
|
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
|
||||||
[[ -z "$APP" ]] && dokku_log_fail "Please specify an app to run the command on"
|
[[ -z "$APP" ]] && dokku_log_fail "Please specify an app to run the command on"
|
||||||
verify_app_name "$APP"
|
verify_app_name "$APP"
|
||||||
verify_service_name "$SERVICE"
|
verify_service_name "$SERVICE"
|
||||||
|
|||||||
24
subcommands/links
Executable file
24
subcommands/links
Executable file
@@ -0,0 +1,24 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
|
source "$PLUGIN_BASE_PATH/common/functions"
|
||||||
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||||
|
|
||||||
|
service-links-cmd() {
|
||||||
|
#E list all apps linked to the 'lollipop' $PLUGIN_COMMAND_PREFIX service.
|
||||||
|
#E dokku $PLUGIN_COMMAND_PREFIX:links lollipop
|
||||||
|
#A service, service to run command against
|
||||||
|
declare desc="list all apps linked to the $PLUGIN_SERVICE service"
|
||||||
|
local cmd="$PLUGIN_COMMAND_PREFIX:links" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
|
declare SERVICE="$1"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
local LINKS_FILE="$SERVICE_ROOT/LINKS"
|
||||||
|
|
||||||
|
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
|
||||||
|
verify_service_name "$SERVICE"
|
||||||
|
service_links "$SERVICE"
|
||||||
|
}
|
||||||
|
|
||||||
|
service-links-cmd "$@"
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_PATH/common/functions"
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||||
|
|
||||||
@@ -8,7 +9,8 @@ service-list-cmd() {
|
|||||||
#E list all services
|
#E list all services
|
||||||
#E dokku $PLUGIN_COMMAND_PREFIX:list
|
#E dokku $PLUGIN_COMMAND_PREFIX:list
|
||||||
declare desc="list all $PLUGIN_SERVICE services"
|
declare desc="list all $PLUGIN_SERVICE services"
|
||||||
local cmd="$PLUGIN_COMMAND_PREFIX:list" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:list" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
|
|
||||||
service_list
|
service_list
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,21 +1,23 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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
|
||||||
#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, 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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:logs" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1" TAIL_FLAG="$2"
|
declare SERVICE="$1" TAIL_FLAG="$2"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a 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"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_PATH/common/functions"
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||||
|
|
||||||
@@ -19,15 +20,16 @@ service-promote-cmd() {
|
|||||||
#E
|
#E
|
||||||
#E ${PLUGIN_DEFAULT_ALIAS}_URL=${PLUGIN_SCHEME}://other_service:ANOTHER_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-other-service:${PLUGIN_DATASTORE_PORTS[0]}/other_service
|
#E ${PLUGIN_DEFAULT_ALIAS}_URL=${PLUGIN_SCHEME}://other_service:ANOTHER_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-other-service:${PLUGIN_DATASTORE_PORTS[0]}/other_service
|
||||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_BLUE_URL=${PLUGIN_SCHEME}://other_service:ANOTHER_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-other-service:${PLUGIN_DATASTORE_PORTS[0]}/other_service
|
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_BLUE_URL=${PLUGIN_SCHEME}://other_service:ANOTHER_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-other-service:${PLUGIN_DATASTORE_PORTS[0]}/other_service
|
||||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_SILVER_URL=${PLUGIN_SCHEME}://lolipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lolipop:${PLUGIN_DATASTORE_PORTS[0]}/lolipop
|
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_SILVER_URL=${PLUGIN_SCHEME}://lollipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lollipop:${PLUGIN_DATASTORE_PORTS[0]}/lollipop
|
||||||
#A service, service to run command against
|
#A service, service to run command against
|
||||||
#A app, app to run command against
|
#A app, app to run command against
|
||||||
declare desc="promote service <service> as ${PLUGIN_DEFAULT_ALIAS}_URL in <app>"
|
declare desc="promote service <service> as ${PLUGIN_DEFAULT_ALIAS}_URL in <app>"
|
||||||
local cmd="$PLUGIN_COMMAND_PREFIX:promote" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:promote" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1" APP="$2"
|
declare SERVICE="$1" APP="$2"
|
||||||
APP=${APP:="$DOKKU_APP_NAME"}
|
APP=${APP:="$DOKKU_APP_NAME"}
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
|
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
|
||||||
[[ -z "$APP" ]] && dokku_log_fail "Please specify an app to run the command on"
|
[[ -z "$APP" ]] && dokku_log_fail "Please specify an app to run the command on"
|
||||||
verify_service_name "$SERVICE"
|
verify_service_name "$SERVICE"
|
||||||
verify_app_name "$APP"
|
verify_app_name "$APP"
|
||||||
|
|||||||
@@ -1,18 +1,20 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:restart" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1"
|
declare SERVICE="$1"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a 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_stop "$SERVICE"
|
||||||
service_start "$SERVICE"
|
service_start "$SERVICE"
|
||||||
|
|||||||
@@ -1,18 +1,20 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:start" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1"
|
declare SERVICE="$1"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a 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_start "$SERVICE"
|
service_start "$SERVICE"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,18 +1,20 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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 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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:stop" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1"
|
declare SERVICE="$1"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a 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_stop "$SERVICE"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,18 +1,20 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:unexpose" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1"
|
declare SERVICE="$1"
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a 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_port_unexpose "$SERVICE"
|
service_port_unexpose "$SERVICE"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,21 +1,23 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
source "$PLUGIN_BASE_PATH/common/functions"
|
source "$PLUGIN_BASE_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
|
||||||
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=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
|
local cmd="$PLUGIN_COMMAND_PREFIX:unlink" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
declare SERVICE="$1" APP="$2"
|
declare SERVICE="$1" APP="$2"
|
||||||
APP=${APP:="$DOKKU_APP_NAME"}
|
APP=${APP:="$DOKKU_APP_NAME"}
|
||||||
|
|
||||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
|
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
|
||||||
[[ -z "$APP" ]] && dokku_log_fail "Please specify an app to run the command on"
|
[[ -z "$APP" ]] && dokku_log_fail "Please specify an app to run the command on"
|
||||||
verify_service_name "$SERVICE"
|
verify_service_name "$SERVICE"
|
||||||
verify_app_name "$APP"
|
verify_app_name "$APP"
|
||||||
|
|||||||
67
subcommands/upgrade
Executable file
67
subcommands/upgrade
Executable file
@@ -0,0 +1,67 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
|
source "$PLUGIN_BASE_PATH/common/functions"
|
||||||
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||||
|
source "$PLUGIN_AVAILABLE_PATH/ps/functions"
|
||||||
|
|
||||||
|
service-upgrade-cmd() {
|
||||||
|
#E you can upgrade an existing service to a new image or image-version
|
||||||
|
#E dokku $PLUGIN_COMMAND_PREFIX:upgrade lollipop
|
||||||
|
#A service, service to run command against
|
||||||
|
#F -c|--config-options "--args --go=here", extra arguments to pass to the container create command
|
||||||
|
#F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
|
||||||
|
#F -i|--image IMAGE, the image name to start the service with
|
||||||
|
#F -I|--image-version IMAGE_VERSION, the image version to start the service with
|
||||||
|
#F -R|--restart-apps "true", whether to force an app restart
|
||||||
|
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
|
||||||
|
declare desc="upgrade service <service> to the specified versions"
|
||||||
|
local cmd="$PLUGIN_COMMAND_PREFIX:upgrade" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
|
declare SERVICE="$1" UPGRADE_FLAGS_LIST=("${@:2}")
|
||||||
|
|
||||||
|
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
|
||||||
|
verify_service_name "$SERVICE"
|
||||||
|
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
|
||||||
|
service_parse_args "${@:2}"
|
||||||
|
|
||||||
|
if ! service_image_exists "$SERVICE"; then
|
||||||
|
dokku_log_fail "Unable to proceed with upgrade, image ${PLUGIN_IMAGE}:${PLUGIN_IMAGE_VERSION} does not exist"
|
||||||
|
fi
|
||||||
|
|
||||||
|
local NEW_PLUGIN_IMAGE_TAG="$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION"
|
||||||
|
if [[ "$(service_version "$SERVICE")" == "$NEW_PLUGIN_IMAGE_TAG" ]]; then
|
||||||
|
dokku_log_info1 "Service $SERVICE already running $NEW_PLUGIN_IMAGE_TAG"
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
service_commit_config "$SERVICE"
|
||||||
|
|
||||||
|
dokku_log_info2 "Upgrading $SERVICE to $NEW_PLUGIN_IMAGE_TAG"
|
||||||
|
if [[ "$SERVICE_RESTART_APPS" == "true" ]]; then
|
||||||
|
dokku_log_info2 "Stopping all linked services"
|
||||||
|
for app in $(service_linked_apps "$SERVICE"); do
|
||||||
|
[[ "$app" == "-" ]] && continue
|
||||||
|
ps_stop "$app"
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
|
dokku_log_info2 "Stopping $SERVICE"
|
||||||
|
service_container_rm "$SERVICE"
|
||||||
|
service_start "$SERVICE" "${@:2}"
|
||||||
|
|
||||||
|
if [[ "$SERVICE_RESTART_APPS" == "true" ]]; then
|
||||||
|
dokku_log_info2 "Starting all linked services"
|
||||||
|
for app in $(service_linked_apps "$SERVICE"); do
|
||||||
|
[[ "$app" == "-" ]] && continue
|
||||||
|
ps_start "$app"
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
|
dokku_log_info2 "Done"
|
||||||
|
}
|
||||||
|
|
||||||
|
service-upgrade-cmd "$@"
|
||||||
@@ -1,38 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
set -eo pipefail; [[ $TRACE ]] && set -x
|
|
||||||
|
|
||||||
semver-parse-into() {
|
|
||||||
declare VERSION="$1"
|
|
||||||
local RE='[^0-9]*\([0-9]*\)[.]\([0-9]*\)[.]\([0-9]*\)'
|
|
||||||
local MAJOR="$(echo "$VERSION" | sed -e "s#$RE#\1#")"
|
|
||||||
local MINOR="$(echo "$VERSION" | sed -e "s#$RE#\2#")"
|
|
||||||
local PATCH="$(echo "$VERSION" | sed -e "s#$RE#\3#")"
|
|
||||||
echo "${MAJOR} ${MINOR} ${PATCH}"
|
|
||||||
}
|
|
||||||
|
|
||||||
main() {
|
|
||||||
declare MIN_VERSION="$1" CHECK_VERSION="$2"
|
|
||||||
local IS_AT_LEAST_VERSION=false
|
|
||||||
local MAJOR_MIN MINOR_MIN PATCH_MIN MAJOR_CHECK MINOR_CHECK PATCH_CHECK PARSED_MIN PARSED_CHECK
|
|
||||||
|
|
||||||
PARSED_MIN="$(semver-parse-into "$MIN_VERSION")"
|
|
||||||
PARSED_CHECK="$(semver-parse-into "$CHECK_VERSION")"
|
|
||||||
MAJOR_MIN="$(echo "$PARSED_MIN" | cut -d' ' -f1)"
|
|
||||||
MINOR_MIN="$(echo "$PARSED_MIN" | cut -d' ' -f2)"
|
|
||||||
PATCH_MIN="$(echo "$PARSED_MIN" | cut -d' ' -f3)"
|
|
||||||
MAJOR_CHECK="$(echo "$PARSED_CHECK" | cut -d' ' -f1)"
|
|
||||||
MINOR_CHECK="$(echo "$PARSED_CHECK" | cut -d' ' -f2)"
|
|
||||||
PATCH_CHECK="$(echo "$PARSED_CHECK" | cut -d' ' -f3)"
|
|
||||||
|
|
||||||
if [[ "$MAJOR_CHECK" -gt "$MAJOR_MIN" ]]; then
|
|
||||||
IS_AT_LEAST_VERSION=true
|
|
||||||
elif [[ "$MAJOR_CHECK" -eq "$MAJOR_MIN" ]] && [[ "$MINOR_CHECK" -gt "$MINOR_MIN" ]]; then
|
|
||||||
IS_AT_LEAST_VERSION=true
|
|
||||||
elif [[ "$MAJOR_CHECK" -eq "$MAJOR_MIN" ]] && [[ "$MINOR_CHECK" -eq "$MINOR_MIN" ]] && [[ "$PATCH_CHECK" -ge "$PATCH_MIN" ]]; then
|
|
||||||
IS_AT_LEAST_VERSION=true
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "$IS_AT_LEAST_VERSION"
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
101
tests/bin/docker
101
tests/bin/docker
@@ -1,101 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
# shellcheck source=../../config
|
|
||||||
# shellcheck disable=SC1091
|
|
||||||
source "$(dirname "$0")/../../config"
|
|
||||||
|
|
||||||
if [[ $ECHO_DOCKER_COMMAND == "true" ]]; then
|
|
||||||
echo "$(basename "$0") $*"
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
case "$1" in
|
|
||||||
exec)
|
|
||||||
echo "exec called with $@"
|
|
||||||
;;
|
|
||||||
images)
|
|
||||||
echo "REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE"
|
|
||||||
echo "elasticsearch 2.3.5 89ed89918502 2 days ago 522.1 MB"
|
|
||||||
echo "frodenas/couchdb 1.6 cb9a62e007eb 2 days ago 537 MB"
|
|
||||||
echo "dokkupaas/docker-grafana-graphite 3.0.1 75dcd48a5eef 2 days ago 936.4 MB"
|
|
||||||
echo "mariadb 10.1.16 f2485761e714 2 days ago 302.2 MB"
|
|
||||||
echo "memcached 1.4.31 8a05b51f8876 2 days ago 132.4 MB"
|
|
||||||
echo "mongo 3.2.9 12eadb136159 2 days ago 291.1 MB"
|
|
||||||
echo "mysql 5.7.12 57d56ac47bed 2 days ago 321.3 MB"
|
|
||||||
echo "nats 0.9.4 9216d5a4eec8 2 days ago 109.3 MB"
|
|
||||||
echo "postgres 10.2 6412eb70175e 2 days ago 265.7 MB"
|
|
||||||
echo "rabbitmq 3.6.5-management 327b803301e9 2 days ago 143.5 MB"
|
|
||||||
echo "redis 3.2.3 9216d5a4eec8 2 days ago 109.3 MB"
|
|
||||||
echo "rethinkdb 2.3.4 f27010a550ec 2 days ago 196.3 MB"
|
|
||||||
echo "svendowideit/ambassador latest 0d2200edc53e 2 days ago 7.241 MB"
|
|
||||||
;;
|
|
||||||
inspect)
|
|
||||||
if [[ $@ = *"IPAddress"* ]]; then
|
|
||||||
echo "172.17.0.34"
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ $@ =~ \{\{.Config.Image\}\} ]]; then
|
|
||||||
echo "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION"
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ $@ =~ \{\{\.State\..*\}\} ]]; then
|
|
||||||
if [[ $@ =~ \{\{\.State\.Running\}\} ]]; then
|
|
||||||
echo "true"
|
|
||||||
else
|
|
||||||
echo "false"
|
|
||||||
fi
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
# running
|
|
||||||
echo "true"
|
|
||||||
;;
|
|
||||||
kill)
|
|
||||||
echo "testid"
|
|
||||||
;;
|
|
||||||
logs)
|
|
||||||
echo "$PLUGIN_SERVICE $PLUGIN_IMAGE_VERSION"
|
|
||||||
;;
|
|
||||||
ps)
|
|
||||||
if [[ $@ = *"no-trunc"* ]]; then
|
|
||||||
echo "1479bbd60ade8a92617d2aeb4935bd3ff3179bd0fd71c22c3102c421f4bc221f"
|
|
||||||
exit 0
|
|
||||||
else
|
|
||||||
echo 'CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES'
|
|
||||||
echo '4eeaae231d5e elasticsearch:2.3.5 "/docker-entrypoint." 11 seconds ago Up 10 seconds 9200/tcp, 9300/tcp dokku.elasticsearch.l'
|
|
||||||
echo '2b20a383226d frodenas/couchdb:1.6 "/scripts/run.sh" 11 seconds ago Up 10 seconds 5984/tcp dokku.couchdb.l'
|
|
||||||
echo '76a0e7154483 dokkupaas/docker-grafana-graphite:3.0.1 "/usr/bin/supervisor" 11 seconds ago Up 10 seconds 80/tcp, 2003/tcp, 8126/tcp, 8125/udp dokku.graphite.l'
|
|
||||||
echo '94df08fe5550 mariadb:10.1.16 "/docker-entrypoint." 11 seconds ago Up 10 seconds 3306/tcp dokku.mariadb.l'
|
|
||||||
echo 'ef27fec191ba memcached:1.4.31 "/entrypoint.sh memc" 11 seconds ago Up 10 seconds 11211/tcp dokku.memcached.l'
|
|
||||||
echo 'c0f74fc90377 mongo:3.2.9 "/entrypoint.sh mong" 11 seconds ago Up 10 seconds 27017/tcp dokku.mongo.l'
|
|
||||||
echo '0f33b1c86da9 mysql:5.7.12 "/entrypoint.sh mysq" 11 seconds ago Up 10 seconds 3306/tcp dokku.mysql.l'
|
|
||||||
echo '9f10b6dc12d5 nats:0.9.4 "/entrypoint.sh redi" 11 seconds ago Up 10 seconds 4222/tcp dokku.nats.l'
|
|
||||||
echo '7f899b723c08 postgres:10.2 "/docker-entrypoint." 11 seconds ago Up 10 seconds 5432/tcp dokku.postgres.l'
|
|
||||||
echo '5e50a462661e rabbitmq:3.6.5-management "/docker-entrypoint." 11 seconds ago Up 10 seconds 5672/tcp, 15672/tcp dokku.rabbitmq.l'
|
|
||||||
echo 'c39ca00fa3c6 redis:3.2.3 "/entrypoint.sh redi" 11 seconds ago Up 10 seconds 6379/tcp dokku.redis.l'
|
|
||||||
echo 'dc98c2939a80 rethinkdb:2.3.4 "rethinkdb --bind al" 11 seconds ago Up 10 seconds 8080/tcp, 28015/tcp, 29015/tcp dokku.rethinkdb.l'
|
|
||||||
fi
|
|
||||||
;;
|
|
||||||
pull)
|
|
||||||
exit 0
|
|
||||||
;;
|
|
||||||
restart)
|
|
||||||
echo "testid"
|
|
||||||
;;
|
|
||||||
rm)
|
|
||||||
echo "testid"
|
|
||||||
;;
|
|
||||||
run)
|
|
||||||
echo "testid"
|
|
||||||
;;
|
|
||||||
start)
|
|
||||||
echo "testid"
|
|
||||||
;;
|
|
||||||
stop)
|
|
||||||
echo "testid"
|
|
||||||
;;
|
|
||||||
*)
|
|
||||||
exit "$DOKKU_NOT_IMPLEMENTED_EXIT"
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
echo "dokku"
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
if [[ "$(uname)" == "Darwin" ]]; then
|
|
||||||
echo "Darwin"
|
|
||||||
else
|
|
||||||
echo "Ubuntu"
|
|
||||||
fi
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
exit 0
|
|
||||||
@@ -2,19 +2,18 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
dokku apps:create my_app >&2
|
dokku apps:create my-app
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l >&2
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app >&2
|
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app >&2
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app >&2
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app >&2
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l >&2
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
rm -rf "$DOKKU_ROOT/my_app"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@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/l/LINKS") ]]
|
||||||
dokku --force apps:destroy my_app
|
dokku --force apps:destroy my-app
|
||||||
[[ -z $(< "$PLUGIN_DATA_ROOT/l/LINKS") ]]
|
[[ -z $(< "$PLUGIN_DATA_ROOT/l/LINKS") ]]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,34 +2,37 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
export ECHO_DOCKER_COMMAND="false"
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l >&2
|
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
export ECHO_DOCKER_COMMAND="false"
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l >&2
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:clone) error when there are no arguments" {
|
@test "($PLUGIN_COMMAND_PREFIX:clone) error when there are no arguments" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:clone"
|
run dokku "$PLUGIN_COMMAND_PREFIX:clone"
|
||||||
assert_contains "${lines[*]}" "Please specify a name for the service"
|
assert_contains "${lines[*]}" "Please specify a valid name for the service"
|
||||||
|
assert_failure
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:clone) error when service does not exist" {
|
@test "($PLUGIN_COMMAND_PREFIX:clone) error when service does not exist" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:clone" not_existing_service new_service
|
run dokku "$PLUGIN_COMMAND_PREFIX:clone" not_existing_service new_service
|
||||||
assert_contains "${lines[*]}" "service not_existing_service does not exist"
|
assert_contains "${lines[*]}" "service not_existing_service does not exist"
|
||||||
|
assert_failure
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:clone) error when new service isn't provided" {
|
@test "($PLUGIN_COMMAND_PREFIX:clone) error when new service isn't provided" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:clone" l
|
run dokku "$PLUGIN_COMMAND_PREFIX:clone" l
|
||||||
assert_contains "${lines[*]}" "Please specify a name for the new service"
|
assert_contains "${lines[*]}" "Please specify a name for the new service"
|
||||||
|
assert_failure
|
||||||
}
|
}
|
||||||
|
|
||||||
@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[*]}" "service new_service already exists"
|
||||||
|
assert_failure
|
||||||
|
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" new_service
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" new_service
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -38,5 +41,7 @@ teardown() {
|
|||||||
[[ -f $PLUGIN_DATA_ROOT/new_service/ID ]]
|
[[ -f $PLUGIN_DATA_ROOT/new_service/ID ]]
|
||||||
assert_contains "${lines[*]}" "Copying data from l to new_service"
|
assert_contains "${lines[*]}" "Copying data from l to new_service"
|
||||||
assert_contains "${lines[*]}" "Done"
|
assert_contains "${lines[*]}" "Done"
|
||||||
}
|
assert_success
|
||||||
|
|
||||||
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" new_service
|
||||||
|
}
|
||||||
|
|||||||
@@ -2,18 +2,16 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
export ECHO_DOCKER_COMMAND="false"
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l >&2
|
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
export ECHO_DOCKER_COMMAND="false"
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l >&2
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:connect) error when there are no arguments" {
|
@test "($PLUGIN_COMMAND_PREFIX:connect) error when there are no arguments" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:connect"
|
run dokku "$PLUGIN_COMMAND_PREFIX:connect"
|
||||||
assert_contains "${lines[*]}" "Please specify a name for the service"
|
assert_contains "${lines[*]}" "Please specify a valid name for the service"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:connect) error when service does not exist" {
|
@test "($PLUGIN_COMMAND_PREFIX:connect) error when service does not exist" {
|
||||||
@@ -22,8 +20,7 @@ teardown() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:connect) success" {
|
@test "($PLUGIN_COMMAND_PREFIX:connect) success" {
|
||||||
export ECHO_DOCKER_COMMAND="true"
|
skip "Connect hangs indefinitely without input"
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:connect" l
|
run dokku "$PLUGIN_COMMAND_PREFIX:connect" l
|
||||||
assert_output 'docker exec -i -t dokku.postgres.l psql -h localhost -U postgres l'
|
assert_success
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -4,9 +4,24 @@ load test_helper
|
|||||||
@test "($PLUGIN_COMMAND_PREFIX:create) success" {
|
@test "($PLUGIN_COMMAND_PREFIX:create) success" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
run dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
assert_contains "${lines[*]}" "container created: l"
|
assert_contains "${lines[*]}" "container created: l"
|
||||||
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "($PLUGIN_COMMAND_PREFIX:create) service with dashes" {
|
||||||
|
run dokku "$PLUGIN_COMMAND_PREFIX:create" service-with-dashes
|
||||||
|
assert_contains "${lines[*]}" "container created: service-with-dashes"
|
||||||
|
assert_contains "${lines[*]}" "dokku-$PLUGIN_COMMAND_PREFIX-service-with-dashes"
|
||||||
|
assert_contains "${lines[*]}" "service_with_dashes"
|
||||||
|
|
||||||
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" service-with-dashes
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:create) error when there are no arguments" {
|
@test "($PLUGIN_COMMAND_PREFIX:create) error when there are no arguments" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:create"
|
run dokku "$PLUGIN_COMMAND_PREFIX:create"
|
||||||
assert_contains "${lines[*]}" "Please specify a name for the service"
|
assert_contains "${lines[*]}" "Please specify a valid name for the service"
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "($PLUGIN_COMMAND_PREFIX:create) error when there is an invalid name specified" {
|
||||||
|
run dokku "$PLUGIN_COMMAND_PREFIX:create" d.erp
|
||||||
|
assert_failure
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ load test_helper
|
|||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:destroy) error when there are no arguments" {
|
@test "($PLUGIN_COMMAND_PREFIX:destroy) error when there are no arguments" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:destroy"
|
run dokku "$PLUGIN_COMMAND_PREFIX:destroy"
|
||||||
assert_contains "${lines[*]}" "Please specify a name for the service"
|
assert_contains "${lines[*]}" "Please specify a valid name for the service"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:destroy) error when container does not exist" {
|
@test "($PLUGIN_COMMAND_PREFIX:destroy) error when container does not exist" {
|
||||||
@@ -21,7 +21,10 @@ load test_helper
|
|||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
dokku apps:create app
|
dokku apps:create app
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l app
|
dokku "$PLUGIN_COMMAND_PREFIX:link" l app
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:destroy" l
|
run dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
assert_contains "${lines[*]}" "Cannot delete linked service"
|
assert_contains "${lines[*]}" "Cannot delete linked service"
|
||||||
rm -rf "$DOKKU_ROOT/app"
|
|
||||||
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l app
|
||||||
|
run dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
|
assert_contains "${lines[*]}" "container deleted: l"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,18 +2,16 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
export ECHO_DOCKER_COMMAND="false"
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l >&2
|
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
export ECHO_DOCKER_COMMAND="false"
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l >&2
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:export) error when there are no arguments" {
|
@test "($PLUGIN_COMMAND_PREFIX:export) error when there are no arguments" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:export"
|
run dokku "$PLUGIN_COMMAND_PREFIX:export"
|
||||||
assert_contains "${lines[*]}" "Please specify a name for the service"
|
assert_contains "${lines[*]}" "Please specify a valid name for the service"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:export) error when service does not exist" {
|
@test "($PLUGIN_COMMAND_PREFIX:export) error when service does not exist" {
|
||||||
@@ -22,19 +20,20 @@ teardown() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:export) success with SSH_TTY" {
|
@test "($PLUGIN_COMMAND_PREFIX:export) success with SSH_TTY" {
|
||||||
export ECHO_DOCKER_COMMAND="true"
|
if [[ -n "$GITHUB_WORKFLOW" ]]; then
|
||||||
|
skip "No tty is available on Github Actions"
|
||||||
|
fi
|
||||||
export SSH_TTY=`tty`
|
export SSH_TTY=`tty`
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:export" l
|
run dokku "$PLUGIN_COMMAND_PREFIX:export" l
|
||||||
password="$(cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
assert_exit_status 0
|
assert_exit_status 0
|
||||||
assert_output "docker exec dokku.postgres.l env PGPASSWORD=$password pg_dump -Fc --no-acl --no-owner -h localhost -U postgres -w l"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:export) success without SSH_TTY" {
|
@test "($PLUGIN_COMMAND_PREFIX:export) success without SSH_TTY" {
|
||||||
export ECHO_DOCKER_COMMAND="true"
|
|
||||||
unset SSH_TTY
|
unset SSH_TTY
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:export" l
|
run dokku "$PLUGIN_COMMAND_PREFIX:export" l
|
||||||
password="$(cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
assert_exit_status 0
|
assert_exit_status 0
|
||||||
assert_output "docker exec dokku.postgres.l env PGPASSWORD=$password pg_dump -Fc --no-acl --no-owner -h localhost -U postgres -w l"
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,16 +2,16 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l >&2
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l >&2
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
}
|
}
|
||||||
|
|
||||||
@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"
|
||||||
assert_contains "${lines[*]}" "Please specify a 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" {
|
||||||
@@ -19,12 +19,12 @@ teardown() {
|
|||||||
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) success when not providing a custom port" {
|
@test "($PLUGIN_COMMAND_PREFIX:expose) success when not providing custom ports" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:expose" l
|
run dokku "$PLUGIN_COMMAND_PREFIX:expose" l
|
||||||
[[ "${lines[*]}" =~ exposed\ on\ port\(s\)\ \[container\-\>host\]\:\ [[:digit:]]+ ]]
|
[[ "${lines[*]}" =~ exposed\ on\ port\(s\)\ \[container\-\>host\]\:\ [[:digit:]]+ ]]
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:expose) success when providing a custom port" {
|
@test "($PLUGIN_COMMAND_PREFIX:expose) success when providing custom ports" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:expose" l 4242
|
run dokku "$PLUGIN_COMMAND_PREFIX:expose" l 4242
|
||||||
assert_contains "${lines[*]}" "exposed on port(s) [container->host]: 5432->4242"
|
assert_contains "${lines[*]}" "exposed on port(s) [container->host]: 5432->4242"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,36 +2,40 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
export ECHO_DOCKER_COMMAND="false"
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l >&2
|
echo "data" | tee "/tmp/fake.dump"
|
||||||
echo "data" > "$PLUGIN_DATA_ROOT/fake.dump"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
export ECHO_DOCKER_COMMAND="false"
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l >&2
|
rm -f "/tmp/fake.dump"
|
||||||
rm -f "$PLUGIN_DATA_ROOT/fake.dump"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:import) error when there are no arguments" {
|
@test "($PLUGIN_COMMAND_PREFIX:import) error when there are no arguments" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:import"
|
run dokku "$PLUGIN_COMMAND_PREFIX:import"
|
||||||
assert_contains "${lines[*]}" "Please specify a name for the service"
|
assert_contains "${lines[*]}" "Please specify a valid name for the service"
|
||||||
|
assert_failure
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:import) error when service does not exist" {
|
@test "($PLUGIN_COMMAND_PREFIX:import) error when service does not exist" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:import" not_existing_service
|
run dokku "$PLUGIN_COMMAND_PREFIX:import" not_existing_service
|
||||||
assert_contains "${lines[*]}" "service not_existing_service does not exist"
|
assert_contains "${lines[*]}" "service not_existing_service does not exist"
|
||||||
|
assert_failure
|
||||||
}
|
}
|
||||||
|
|
||||||
@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
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:import) success" {
|
@test "($PLUGIN_COMMAND_PREFIX:import) success" {
|
||||||
export ECHO_DOCKER_COMMAND="true"
|
skip "The fake dump is hard to work with in tests"
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:import" l < "$PLUGIN_DATA_ROOT/fake.dump"
|
run dokku "$PLUGIN_COMMAND_PREFIX:import" l < "/tmp/fake.dump"
|
||||||
password="$(cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
echo "output: $output"
|
||||||
assert_output "docker exec -i dokku.postgres.l env PGPASSWORD=$password pg_restore -h localhost -cO -d l -U postgres -w"
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -2,16 +2,16 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l >&2
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l >&2
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:info) error when there are no arguments" {
|
@test "($PLUGIN_COMMAND_PREFIX:info) error when there are no arguments" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:info"
|
run dokku "$PLUGIN_COMMAND_PREFIX:info"
|
||||||
assert_contains "${lines[*]}" "Please specify a name for the service"
|
assert_contains "${lines[*]}" "Please specify a valid name for the service"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:info) error when service does not exist" {
|
@test "($PLUGIN_COMMAND_PREFIX:info) error when service does not exist" {
|
||||||
@@ -21,21 +21,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
|
||||||
local password="$(cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
local password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||||
assert_contains "${lines[*]}" "postgres://postgres:$password@dokku-postgres-l:5432/l"
|
assert_contains "${lines[*]}" "postgres://postgres:$password@dokku-postgres-l:5432/l"
|
||||||
}
|
}
|
||||||
|
|
||||||
@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
|
||||||
local password="$(cat "$PLUGIN_DATA_ROOT/test_with_underscores/PASSWORD")"
|
local password="$(sudo cat "$PLUGIN_DATA_ROOT/test_with_underscores/PASSWORD")"
|
||||||
assert_contains "${lines[*]}" "postgres://postgres:$password@dokku-postgres-test-with-underscores:5432/test_with_underscores"
|
assert_contains "${lines[*]}" "postgres://postgres:$password@dokku-postgres-test-with-underscores:5432/test_with_underscores"
|
||||||
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
|
||||||
local password="$(cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
local password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||||
assert_output "postgres://postgres:$password@dokku-postgres-l:5432/l"
|
assert_output "postgres://postgres:$password@dokku-postgres-l:5432/l"
|
||||||
|
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:info" l --config-dir
|
run dokku "$PLUGIN_COMMAND_PREFIX:info" l --config-dir
|
||||||
|
|||||||
@@ -2,69 +2,118 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l >&2
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
dokku apps:create my_app >&2
|
dokku "$PLUGIN_COMMAND_PREFIX:create" m
|
||||||
|
dokku apps:create my-app
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l >&2
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" m
|
||||||
rm -rf "$DOKKU_ROOT/my_app"
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
|
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"
|
||||||
assert_contains "${lines[*]}" "Please specify a name for the service"
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_contains "${lines[*]}" "Please specify a valid name for the service"
|
||||||
|
assert_failure
|
||||||
}
|
}
|
||||||
|
|
||||||
@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" l
|
||||||
|
echo "output: $output"
|
||||||
|
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"
|
||||||
|
assert_failure
|
||||||
}
|
}
|
||||||
|
|
||||||
@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" l not_existing_app
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
assert_contains "${lines[*]}" "App not_existing_app does not exist"
|
assert_contains "${lines[*]}" "App not_existing_app does not exist"
|
||||||
|
assert_failure
|
||||||
}
|
}
|
||||||
|
|
||||||
@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 "status: $status"
|
||||||
assert_contains "${lines[*]}" "service not_existing_service does not exist"
|
assert_contains "${lines[*]}" "service not_existing_service does not exist"
|
||||||
|
assert_failure
|
||||||
}
|
}
|
||||||
|
|
||||||
@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" l my-app
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
|
run dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
assert_contains "${lines[*]}" "Already linked as DATABASE_URL"
|
assert_contains "${lines[*]}" "Already linked as DATABASE_URL"
|
||||||
|
assert_failure
|
||||||
|
|
||||||
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:link) exports DATABASE_URL to app" {
|
@test "($PLUGIN_COMMAND_PREFIX:link) exports DATABASE_URL to app" {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
|
run dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
|
||||||
url=$(dokku config:get my_app DATABASE_URL)
|
echo "output: $output"
|
||||||
password="$(cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
echo "status: $status"
|
||||||
|
url=$(dokku config:get my-app DATABASE_URL)
|
||||||
|
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||||
assert_contains "$url" "postgres://postgres:$password@dokku-postgres-l:5432/l"
|
assert_contains "$url" "postgres://postgres:$password@dokku-postgres-l:5432/l"
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
assert_success
|
||||||
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:link) generates an alternate config url when DATABASE_URL already in use" {
|
@test "($PLUGIN_COMMAND_PREFIX:link) generates an alternate config url when DATABASE_URL already in use" {
|
||||||
dokku config:set my_app DATABASE_URL=postgres://user:pass@host:5432/db
|
dokku config:set my-app DATABASE_URL=postgres://user:pass@host:5432/db
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
|
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
|
||||||
run dokku config my_app
|
run dokku config my-app
|
||||||
assert_contains "${lines[*]}" "DOKKU_POSTGRES_"
|
assert_contains "${lines[*]}" "DOKKU_POSTGRES_AQUA_URL"
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
assert_success
|
||||||
|
|
||||||
|
dokku "$PLUGIN_COMMAND_PREFIX:link" m my-app
|
||||||
|
run dokku config my-app
|
||||||
|
assert_contains "${lines[*]}" "DOKKU_POSTGRES_BLACK_URL"
|
||||||
|
assert_success
|
||||||
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" m my-app
|
||||||
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l 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" l my-app
|
||||||
run dokku docker-options my_app
|
run dokku docker-options:report my-app
|
||||||
assert_contains "${lines[*]}" "--link dokku.postgres.l:dokku-postgres-l"
|
assert_contains "${lines[*]}" "--link dokku.postgres.l:dokku-postgres-l"
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
assert_success
|
||||||
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:link) uses apps POSTGRES_DATABASE_SCHEME variable" {
|
@test "($PLUGIN_COMMAND_PREFIX:link) uses apps POSTGRES_DATABASE_SCHEME variable" {
|
||||||
dokku config:set my_app POSTGRES_DATABASE_SCHEME=postgres2
|
dokku config:set my-app POSTGRES_DATABASE_SCHEME=postgres2
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
|
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
|
||||||
url=$(dokku config:get my_app DATABASE_URL)
|
url=$(dokku config:get my-app DATABASE_URL)
|
||||||
password="$(cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||||
assert_contains "$url" "postgres2://postgres:$password@dokku-postgres-l:5432/l"
|
assert_contains "$url" "postgres2://postgres:$password@dokku-postgres-l:5432/l"
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
assert_success
|
||||||
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "($PLUGIN_COMMAND_PREFIX:link) adds a querystring" {
|
||||||
|
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app --querystring "pool=5"
|
||||||
|
url=$(dokku config:get my-app DATABASE_URL)
|
||||||
|
assert_contains "$url" "?pool=5"
|
||||||
|
assert_success
|
||||||
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "($PLUGIN_COMMAND_PREFIX:link) uses a specified config url when alias is specified" {
|
||||||
|
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app --alias "ALIAS"
|
||||||
|
url=$(dokku config:get my-app ALIAS_URL)
|
||||||
|
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||||
|
assert_contains "$url" "postgres://postgres:$password@dokku-postgres-l:5432/l"
|
||||||
|
assert_success
|
||||||
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,35 +2,21 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l >&2
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l >&2
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
}
|
}
|
||||||
|
|
||||||
@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 postgres:10.2 running - -"
|
assert_output "l"
|
||||||
}
|
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:list) with exposed ports" {
|
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:expose" l 4242
|
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:list"
|
|
||||||
assert_contains "${lines[*]}" "l postgres:10.2 running 5432->4242 -"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:list) with linked app" {
|
|
||||||
dokku apps:create my_app
|
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
|
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:list"
|
|
||||||
assert_contains "${lines[*]}" "l postgres:10.2 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 >&2
|
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 Postgres services"
|
assert_output "${lines[*]}" "There are no $PLUGIN_SERVICE services"
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l >&2
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,33 +2,41 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
export ECHO_DOCKER_COMMAND="false"
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l >&2
|
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
export ECHO_DOCKER_COMMAND="false"
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l >&2
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:logs) error when there are no arguments" {
|
@test "($PLUGIN_COMMAND_PREFIX:logs) error when there are no arguments" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:logs"
|
run dokku "$PLUGIN_COMMAND_PREFIX:logs"
|
||||||
assert_contains "${lines[*]}" "Please specify a name for the service"
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_contains "${lines[*]}" "Please specify a valid name for the service"
|
||||||
|
assert_failure
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:logs) error when service does not exist" {
|
@test "($PLUGIN_COMMAND_PREFIX:logs) error when service does not exist" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:logs" not_existing_service
|
run dokku "$PLUGIN_COMMAND_PREFIX:logs" not_existing_service
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
assert_contains "${lines[*]}" "service not_existing_service does not exist"
|
assert_contains "${lines[*]}" "service not_existing_service does not exist"
|
||||||
|
assert_failure
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:logs) success when not tailing" {
|
@test "($PLUGIN_COMMAND_PREFIX:logs) success when not tailing" {
|
||||||
export ECHO_DOCKER_COMMAND="true"
|
skip "This may fail if there is no log output"
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:logs" l
|
run dokku "$PLUGIN_COMMAND_PREFIX:logs" l
|
||||||
assert_output "docker logs --tail 100 testid"
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:logs) success when tailing" {
|
@test "($PLUGIN_COMMAND_PREFIX:logs) success when tailing" {
|
||||||
export ECHO_DOCKER_COMMAND="true"
|
skip "This will hang as it waits for log output"
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:logs" l -t
|
run dokku "$PLUGIN_COMMAND_PREFIX:logs" l -t
|
||||||
assert_output "docker logs --follow testid"
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,20 +2,20 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l >&2
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
dokku apps:create my_app >&2
|
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 >&2
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
rm -rf "$DOKKU_ROOT/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" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:promote"
|
run dokku "$PLUGIN_COMMAND_PREFIX:promote"
|
||||||
assert_contains "${lines[*]}" "Please specify a name for the service"
|
assert_contains "${lines[*]}" "Please specify a valid name for the service"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:promote) error when the app argument is missing" {
|
@test "($PLUGIN_COMMAND_PREFIX:promote) error when the app argument is missing" {
|
||||||
@@ -29,34 +29,34 @@ 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 DATABASE_URL"
|
assert_contains "${lines[*]}" "already promoted as DATABASE_URL"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:promote) changes DATABASE_URL" {
|
@test "($PLUGIN_COMMAND_PREFIX:promote) changes DATABASE_URL" {
|
||||||
password="$(cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||||
dokku config:set my_app "DATABASE_URL=postgres://u:p@host:5432/db" "DOKKU_POSTGRES_BLUE_URL=postgres://postgres:$password@dokku-postgres-l:5432/l"
|
dokku config:set my-app "DATABASE_URL=postgres://u:p@host:5432/db" "DOKKU_POSTGRES_BLUE_URL=postgres://postgres:$password@dokku-postgres-l:5432/l"
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my_app
|
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my-app
|
||||||
url=$(dokku config:get my_app DATABASE_URL)
|
url=$(dokku config:get my-app DATABASE_URL)
|
||||||
assert_equal "$url" "postgres://postgres:$password@dokku-postgres-l:5432/l"
|
assert_equal "$url" "postgres://postgres:$password@dokku-postgres-l:5432/l"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:promote) creates new config url when needed" {
|
@test "($PLUGIN_COMMAND_PREFIX:promote) creates new config url when needed" {
|
||||||
password="$(cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||||
dokku config:set my_app "DATABASE_URL=postgres://u:p@host:5432/db" "DOKKU_POSTGRES_BLUE_URL=postgres://postgres:$password@dokku-postgres-l:5432/l"
|
dokku config:set my-app "DATABASE_URL=postgres://u:p@host:5432/db" "DOKKU_POSTGRES_BLUE_URL=postgres://postgres:$password@dokku-postgres-l:5432/l"
|
||||||
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_POSTGRES_"
|
assert_contains "${lines[*]}" "DOKKU_POSTGRES_"
|
||||||
}
|
}
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:promote) uses POSTGRES_DATABASE_SCHEME variable" {
|
@test "($PLUGIN_COMMAND_PREFIX:promote) uses POSTGRES_DATABASE_SCHEME variable" {
|
||||||
password="$(cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||||
dokku config:set my_app "POSTGRES_DATABASE_SCHEME=postgres2" "DATABASE_URL=postgres://u:p@host:5432/db" "DOKKU_POSTGRES_BLUE_URL=postgres2://postgres:$password@dokku-postgres-l:5432/l"
|
dokku config:set my-app "POSTGRES_DATABASE_SCHEME=postgres2" "DATABASE_URL=postgres://u:p@host:5432/db" "DOKKU_POSTGRES_BLUE_URL=postgres2://postgres:$password@dokku-postgres-l:5432/l"
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my_app
|
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my-app
|
||||||
url=$(dokku config:get my_app DATABASE_URL)
|
url=$(dokku config:get my-app DATABASE_URL)
|
||||||
assert_contains "$url" "postgres2://postgres:$password@dokku-postgres-l:5432/l"
|
assert_contains "$url" "postgres2://postgres:$password@dokku-postgres-l:5432/l"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,16 +2,16 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l >&2
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l >&2
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:restart) error when there are no arguments" {
|
@test "($PLUGIN_COMMAND_PREFIX:restart) error when there are no arguments" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:restart"
|
run dokku "$PLUGIN_COMMAND_PREFIX:restart"
|
||||||
assert_contains "${lines[*]}" "Please specify a name for the service"
|
assert_contains "${lines[*]}" "Please specify a valid name for the service"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:restart) error when service does not exist" {
|
@test "($PLUGIN_COMMAND_PREFIX:restart) error when service does not exist" {
|
||||||
|
|||||||
@@ -2,16 +2,16 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l >&2
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l >&2
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:start) error when there are no arguments" {
|
@test "($PLUGIN_COMMAND_PREFIX:start) error when there are no arguments" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:start"
|
run dokku "$PLUGIN_COMMAND_PREFIX:start"
|
||||||
assert_contains "${lines[*]}" "Please specify a name for the service"
|
assert_contains "${lines[*]}" "Please specify a valid name for the service"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:start) error when service does not exist" {
|
@test "($PLUGIN_COMMAND_PREFIX:start) error when service does not exist" {
|
||||||
|
|||||||
@@ -2,16 +2,16 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l >&2
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l >&2
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:stop) error when there are no arguments" {
|
@test "($PLUGIN_COMMAND_PREFIX:stop) error when there are no arguments" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:stop"
|
run dokku "$PLUGIN_COMMAND_PREFIX:stop"
|
||||||
assert_contains "${lines[*]}" "Please specify a name for the service"
|
assert_contains "${lines[*]}" "Please specify a valid name for the service"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:stop) error when service does not exist" {
|
@test "($PLUGIN_COMMAND_PREFIX:stop) error when service does not exist" {
|
||||||
|
|||||||
@@ -2,16 +2,16 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l >&2
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l >&2
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:unexpose) error when there are no arguments" {
|
@test "($PLUGIN_COMMAND_PREFIX:unexpose) error when there are no arguments" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:unexpose"
|
run dokku "$PLUGIN_COMMAND_PREFIX:unexpose"
|
||||||
assert_contains "${lines[*]}" "Please specify a name for the service"
|
assert_contains "${lines[*]}" "Please specify a valid name for the service"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:unexpose) error when service does not exist" {
|
@test "($PLUGIN_COMMAND_PREFIX:unexpose) error when service does not exist" {
|
||||||
|
|||||||
@@ -2,18 +2,18 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
dokku apps:create my_app >&2
|
dokku apps:create my-app
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l >&2
|
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l >&2
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||||
rm -rf "$DOKKU_ROOT/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" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:unlink"
|
run dokku "$PLUGIN_COMMAND_PREFIX:unlink"
|
||||||
assert_contains "${lines[*]}" "Please specify a name for the service"
|
assert_contains "${lines[*]}" "Please specify a valid name for the service"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:unlink) error when the app argument is missing" {
|
@test "($PLUGIN_COMMAND_PREFIX:unlink) error when the app argument is missing" {
|
||||||
@@ -27,28 +27,27 @@ teardown() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@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" l 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" l my-app >&2
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
||||||
options=$(dokku docker-options my_app | xargs)
|
|
||||||
check_value=""
|
check_value="Docker options build: Docker options deploy: --restart=on-failure:10 Docker options run:"
|
||||||
[[ "$(dokku version)" == "master" ]] && check_value="Deploy options: --restart=on-failure:10"
|
options=$(dokku --quiet docker-options:report my-app | xargs)
|
||||||
[[ "$(at-least-version 0.7.0 "$(dokku version)")" == "true" ]] && check_value="Deploy options: --restart=on-failure:10"
|
|
||||||
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" l my-app >&2
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
||||||
config=$(dokku config:get my_app DATABASE_URL || true)
|
config=$(dokku config:get my-app DATABASE_URL || true)
|
||||||
assert_equal "$config" ""
|
assert_equal "$config" ""
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,34 +1,33 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail
|
||||||
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/test_helper.bash"
|
[[ $TRACE ]] && set -x
|
||||||
|
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 762E3157
|
||||||
|
echo "deb http://nginx.org/packages/ubuntu $(lsb_release -cs) nginx" | sudo tee /etc/apt/sources.list.d/nginx.list
|
||||||
|
curl -fsSL https://nginx.org/keys/nginx_signing.key | sudo apt-key add -
|
||||||
|
|
||||||
BIN_STUBS="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/bin"
|
sudo mkdir -p /etc/nginx
|
||||||
|
sudo curl https://raw.githubusercontent.com/dokku/dokku/master/tests/dhparam.pem -o /etc/nginx/dhparam.pem
|
||||||
|
|
||||||
if [[ ! -d $DOKKU_ROOT ]]; then
|
echo "dokku dokku/skip_key_file boolean true" | sudo debconf-set-selections
|
||||||
git clone https://github.com/progrium/dokku.git $DOKKU_ROOT > /dev/null
|
wget https://raw.githubusercontent.com/dokku/dokku/master/bootstrap.sh
|
||||||
|
if [[ "$DOKKU_VERSION" == "master" ]]; then
|
||||||
|
sudo bash bootstrap.sh
|
||||||
|
else
|
||||||
|
sudo DOKKU_TAG="$DOKKU_VERSION" bash bootstrap.sh
|
||||||
fi
|
fi
|
||||||
|
|
||||||
cd $DOKKU_ROOT
|
|
||||||
echo "Dokku version $DOKKU_VERSION"
|
echo "Dokku version $DOKKU_VERSION"
|
||||||
git checkout $DOKKU_VERSION > /dev/null
|
|
||||||
if grep go-build Makefile > /dev/null; then
|
|
||||||
mv "$BIN_STUBS/docker" "$BIN_STUBS/docker-stub"
|
|
||||||
make go-build
|
|
||||||
mv "$BIN_STUBS/docker-stub" "$BIN_STUBS/docker"
|
|
||||||
fi
|
|
||||||
cd -
|
|
||||||
|
|
||||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
export DOKKU_LIB_ROOT="/var/lib/dokku"
|
||||||
rm -rf $DOKKU_ROOT/plugins/$PLUGIN_COMMAND_PREFIX
|
export DOKKU_PLUGINS_ROOT="$DOKKU_LIB_ROOT/plugins/available"
|
||||||
mkdir -p $DOKKU_ROOT/plugins/$PLUGIN_COMMAND_PREFIX $DOKKU_ROOT/plugins/$PLUGIN_COMMAND_PREFIX/subcommands $DOKKU_ROOT/plugins/$PLUGIN_COMMAND_PREFIX/scripts
|
pushd "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")" >/dev/null
|
||||||
find ./ -maxdepth 1 -type f -exec cp '{}' $DOKKU_ROOT/plugins/$PLUGIN_COMMAND_PREFIX \;
|
source "config"
|
||||||
find ./subcommands -maxdepth 1 -type f -exec cp '{}' $DOKKU_ROOT/plugins/$PLUGIN_COMMAND_PREFIX/subcommands \;
|
popd >/dev/null
|
||||||
find ./scripts -maxdepth 1 -type f -exec cp '{}' $DOKKU_ROOT/plugins/$PLUGIN_COMMAND_PREFIX/scripts \;
|
sudo rm -rf "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX"
|
||||||
echo "$DOKKU_VERSION" > $DOKKU_ROOT/VERSION
|
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" \;
|
||||||
if [[ ! -f $BIN_STUBS/plugn ]]; then
|
[[ -d "./scripts" ]] && sudo find ./scripts -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/scripts" \;
|
||||||
wget -O- "$PLUGN_URL" | tar xzf - -C "$BIN_STUBS"
|
[[ -d "./subcommands" ]] && sudo find ./subcommands -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/subcommands" \;
|
||||||
plugn init
|
[[ -d "./templates" ]] && sudo find ./templates -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/templates" \;
|
||||||
find "$DOKKU_ROOT/plugins" -mindepth 1 -maxdepth 1 -type d ! -name 'available' ! -name 'enabled' -exec ln -s {} "$DOKKU_ROOT/plugins/available" \;
|
sudo mkdir -p "$PLUGIN_CONFIG_ROOT" "$PLUGIN_DATA_ROOT"
|
||||||
find "$DOKKU_ROOT/plugins" -mindepth 1 -maxdepth 1 -type d ! -name 'available' ! -name 'enabled' -exec ln -s {} "$DOKKU_ROOT/plugins/enabled" \;
|
sudo dokku plugin:enable "$PLUGIN_COMMAND_PREFIX"
|
||||||
fi
|
sudo dokku plugin:install
|
||||||
|
|||||||
7
tests/shellcheck-exclude
Normal file
7
tests/shellcheck-exclude
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
# SC1090 - Can't follow non-constant source. Use a directive to specify location - https://github.com/koalaman/shellcheck/wiki/SC1090
|
||||||
|
# SC2034 - Variable appears unused. Verify it or export it - https://github.com/koalaman/shellcheck/wiki/SC2034
|
||||||
|
# SC2155 - Declare and assign separately to avoid masking return values - https://github.com/koalaman/shellcheck/wiki/SC2155
|
||||||
|
# SC2206 - Quote to prevent word splitting/globbing, or split robustly with mapfile or read -a - https://github.com/koalaman/shellcheck/wiki/SC2206
|
||||||
|
# SC2207 - Prefer mapfile or read -a to split command output (or quote to avoid splitting) - https://github.com/koalaman/shellcheck/wiki/SC2207
|
||||||
|
# SC2220 - Invalid flags are not handled. Add a *) case - https://github.com/koalaman/shellcheck/wiki/SC2220
|
||||||
|
# SC2230 - which is non-standard. Use builtin 'command -v' instead - https://github.com/koalaman/shellcheck/wiki/SC2230
|
||||||
205
tests/shellcheck-to-junit
Executable file
205
tests/shellcheck-to-junit
Executable file
@@ -0,0 +1,205 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
from __future__ import print_function
|
||||||
|
import argparse
|
||||||
|
import collections
|
||||||
|
import datetime
|
||||||
|
import re
|
||||||
|
import socket
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from xml.etree import ElementTree
|
||||||
|
|
||||||
|
|
||||||
|
def CDATA(text=None):
|
||||||
|
element = ElementTree.Element('![CDATA[')
|
||||||
|
element.text = text
|
||||||
|
return element
|
||||||
|
|
||||||
|
|
||||||
|
def _serialize_xml(write, elem, qnames, namespaces,short_empty_elements, **kwargs):
|
||||||
|
|
||||||
|
if elem.tag == '![CDATA[':
|
||||||
|
write("\n<{}{}]]>\n".format(elem.tag, elem.text))
|
||||||
|
if elem.tail:
|
||||||
|
write(ElementTree._escape_cdata(elem.tail))
|
||||||
|
else:
|
||||||
|
return ElementTree._original_serialize_xml(write, elem, qnames, namespaces,short_empty_elements, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
|
ElementTree._original_serialize_xml = ElementTree._serialize_xml
|
||||||
|
ElementTree._serialize_xml = ElementTree._serialize['xml'] = _serialize_xml
|
||||||
|
|
||||||
|
|
||||||
|
def read_in():
|
||||||
|
lines = sys.stdin.readlines()
|
||||||
|
for i in range(len(lines)):
|
||||||
|
lines[i] = lines[i].rstrip()
|
||||||
|
return lines
|
||||||
|
|
||||||
|
|
||||||
|
def process_lines(lines):
|
||||||
|
files = {}
|
||||||
|
current_file = None
|
||||||
|
previous_line = None
|
||||||
|
line_no = None
|
||||||
|
new_issues = []
|
||||||
|
code = None
|
||||||
|
|
||||||
|
RE_VIOLATION = re.compile(r"\^-- (SC[\w]+): (.*)")
|
||||||
|
RE_VIOLATION_NEW = re.compile(r"\^[-]+\^ (SC[\w]+): (.*)")
|
||||||
|
|
||||||
|
for line in lines:
|
||||||
|
# start a new block
|
||||||
|
if line == '':
|
||||||
|
if current_file is not None:
|
||||||
|
file_data = files.get(current_file, {})
|
||||||
|
files[current_file] = file_data
|
||||||
|
|
||||||
|
issue_data = file_data.get(line_no, {})
|
||||||
|
issue_data['code'] = code
|
||||||
|
files[current_file][line_no] = issue_data
|
||||||
|
|
||||||
|
issues = issue_data.get('issues', [])
|
||||||
|
issues.extend(new_issues)
|
||||||
|
issue_data['issues'] = issues
|
||||||
|
|
||||||
|
files[current_file][line_no] = issue_data
|
||||||
|
|
||||||
|
code = None
|
||||||
|
current_file = None
|
||||||
|
line_no = None
|
||||||
|
elif line.startswith('In ./') and not previous_line:
|
||||||
|
current_file = line.split(' ')[1].replace('./', '')
|
||||||
|
line_no = line.split(' ')[3]
|
||||||
|
new_issues = []
|
||||||
|
code = None
|
||||||
|
elif code is None and len(new_issues) == 0:
|
||||||
|
code = line
|
||||||
|
else:
|
||||||
|
match = RE_VIOLATION.match(line.strip())
|
||||||
|
if not match:
|
||||||
|
match = RE_VIOLATION_NEW.match(line.strip())
|
||||||
|
|
||||||
|
if not match:
|
||||||
|
if 'https://www.shellcheck.net/wiki/SC' in line:
|
||||||
|
continue
|
||||||
|
if 'For more information:' == line:
|
||||||
|
continue
|
||||||
|
print('Error: Issue parsing line "{0}"'.format(line.strip()))
|
||||||
|
else:
|
||||||
|
new_issues.append({
|
||||||
|
'shellcheck_id': match.group(1),
|
||||||
|
'message': match.group(2),
|
||||||
|
'original_message': line
|
||||||
|
})
|
||||||
|
|
||||||
|
previous_line = line
|
||||||
|
|
||||||
|
return files
|
||||||
|
|
||||||
|
|
||||||
|
def output_junit(files, args):
|
||||||
|
timestamp = datetime.datetime.now().replace(microsecond=0).isoformat()
|
||||||
|
failures = 0
|
||||||
|
for file, data in files.items():
|
||||||
|
for line, issue_data in data.items():
|
||||||
|
code = issue_data.get('code')
|
||||||
|
for issue in issue_data.get('issues', []):
|
||||||
|
failures += 1
|
||||||
|
|
||||||
|
tests = 0
|
||||||
|
if args.files:
|
||||||
|
with open(args.files, 'r') as f:
|
||||||
|
tests = len(f.readlines())
|
||||||
|
|
||||||
|
root = ElementTree.Element("testsuite",
|
||||||
|
name="shellcheck",
|
||||||
|
tests="{0}".format(tests),
|
||||||
|
failures="{0}".format(failures),
|
||||||
|
errors="0",
|
||||||
|
skipped="0",
|
||||||
|
timestamp=timestamp,
|
||||||
|
time="0",
|
||||||
|
hostname=socket.gethostname())
|
||||||
|
|
||||||
|
properties = ElementTree.SubElement(root, "properties")
|
||||||
|
if args.exclude:
|
||||||
|
ElementTree.SubElement(properties,
|
||||||
|
"property",
|
||||||
|
name="exclude",
|
||||||
|
value=args.exclude)
|
||||||
|
|
||||||
|
if args.files:
|
||||||
|
with open(args.files, 'r') as f:
|
||||||
|
lines = f.readlines()
|
||||||
|
for i in range(len(lines)):
|
||||||
|
file = lines[i].rstrip().replace('./', '')
|
||||||
|
data = files.get(file, None)
|
||||||
|
if data:
|
||||||
|
for line, issue_data in data.items():
|
||||||
|
code = issue_data.get('code')
|
||||||
|
for issue in issue_data.get('issues', []):
|
||||||
|
testcase = ElementTree.SubElement(root,
|
||||||
|
"testcase",
|
||||||
|
classname=file,
|
||||||
|
name=file,
|
||||||
|
time="0")
|
||||||
|
shellcheck_id = issue.get('shellcheck_id')
|
||||||
|
message = 'line {0}: {1}'.format(
|
||||||
|
line, issue.get('message'))
|
||||||
|
original_message = issue.get('original_message')
|
||||||
|
e = ElementTree.Element("failure",
|
||||||
|
type=shellcheck_id,
|
||||||
|
message=message)
|
||||||
|
cdata = CDATA("\n".join([code, original_message]))
|
||||||
|
e.append(cdata)
|
||||||
|
testcase.append(e)
|
||||||
|
ElementTree.SubElement(root,
|
||||||
|
"testcase",
|
||||||
|
classname=file,
|
||||||
|
name=file,
|
||||||
|
time="0")
|
||||||
|
|
||||||
|
ElementTree.SubElement(root, "system-out")
|
||||||
|
ElementTree.SubElement(root, "system-err")
|
||||||
|
|
||||||
|
content = ElementTree.tostring(root, encoding='UTF-8', method='xml')
|
||||||
|
if args.output:
|
||||||
|
with open(args.output, 'w') as f:
|
||||||
|
try:
|
||||||
|
f.write(content)
|
||||||
|
except TypeError:
|
||||||
|
f.write(content.decode("utf-8"))
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
parser = argparse.ArgumentParser(
|
||||||
|
description='Process shellcheck output to junit.')
|
||||||
|
parser.add_argument('--output',
|
||||||
|
dest='output',
|
||||||
|
action='store',
|
||||||
|
default=None,
|
||||||
|
help='file to write shellcheck output')
|
||||||
|
parser.add_argument('--files',
|
||||||
|
dest='files',
|
||||||
|
action='store',
|
||||||
|
default=None,
|
||||||
|
help='a file containing a list of all files processed by shellcheck')
|
||||||
|
parser.add_argument('--exclude',
|
||||||
|
dest='exclude',
|
||||||
|
action='store',
|
||||||
|
default=None,
|
||||||
|
help='a comma-separated list of rules being excluded by shellcheck')
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
lines = read_in()
|
||||||
|
files = process_lines(lines)
|
||||||
|
files = collections.OrderedDict(sorted(files.items()))
|
||||||
|
output_junit(files, args)
|
||||||
|
for line in lines:
|
||||||
|
print(line)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
||||||
51
tests/test_helper.bash
Normal file → Executable file
51
tests/test_helper.bash
Normal file → Executable file
@@ -1,32 +1,13 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
export DOKKU_QUIET_OUTPUT=1
|
export DOKKU_LIB_ROOT="/var/lib/dokku"
|
||||||
export DOKKU_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/dokku"
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
export DOKKU_VERSION=${DOKKU_VERSION:-"master"}
|
|
||||||
export PATH="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/bin:$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/dokku:$PATH"
|
|
||||||
export PLUGIN_COMMAND_PREFIX="postgres"
|
|
||||||
export PLUGIN_PATH="$DOKKU_ROOT/plugins"
|
|
||||||
export PLUGIN_ENABLED_PATH="$PLUGIN_PATH"
|
|
||||||
export PLUGIN_AVAILABLE_PATH="$PLUGIN_PATH"
|
|
||||||
export PLUGIN_CORE_AVAILABLE_PATH="$PLUGIN_PATH"
|
|
||||||
export POSTGRES_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/fixtures"
|
|
||||||
export PLUGIN_DATA_ROOT="$POSTGRES_ROOT"
|
|
||||||
export PLUGIN_CONFIG_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
|
|
||||||
export DOKKU_LIB_PATH="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/lib-root"
|
|
||||||
if [[ "$(uname)" == "Darwin" ]]; then
|
|
||||||
export PLUGN_URL="https://github.com/dokku/plugn/releases/download/v0.3.0/plugn_0.3.0_darwin_x86_64.tgz"
|
|
||||||
else
|
|
||||||
export PLUGN_URL="https://github.com/dokku/plugn/releases/download/v0.3.0/plugn_0.3.0_linux_x86_64.tgz"
|
|
||||||
fi
|
|
||||||
|
|
||||||
mkdir -p "$PLUGIN_DATA_ROOT"
|
|
||||||
rm -rf "${PLUGIN_DATA_ROOT:?}"/*
|
|
||||||
|
|
||||||
mkdir -p "$PLUGIN_CONFIG_ROOT"
|
|
||||||
rm -rf "${PLUGIN_CONFIG_ROOT:?}"/*
|
|
||||||
|
|
||||||
flunk() {
|
flunk() {
|
||||||
{ if [ "$#" -eq 0 ]; then cat -
|
{
|
||||||
else echo "$*"
|
if [ "$#" -eq 0 ]; then
|
||||||
|
cat -
|
||||||
|
else
|
||||||
|
echo "$*"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
return 1
|
return 1
|
||||||
@@ -34,16 +15,22 @@ flunk() {
|
|||||||
|
|
||||||
assert_equal() {
|
assert_equal() {
|
||||||
if [ "$1" != "$2" ]; then
|
if [ "$1" != "$2" ]; then
|
||||||
{ echo "expected: $1"
|
{
|
||||||
|
echo "expected: $1"
|
||||||
echo "actual: $2"
|
echo "actual: $2"
|
||||||
} | flunk
|
} | flunk
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# ShellCheck doesn't know about $status from Bats
|
||||||
|
# shellcheck disable=SC2154
|
||||||
assert_exit_status() {
|
assert_exit_status() {
|
||||||
assert_equal "$status" "$1"
|
assert_equal "$1" "$status"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# ShellCheck doesn't know about $status from Bats
|
||||||
|
# shellcheck disable=SC2154
|
||||||
|
# shellcheck disable=SC2120
|
||||||
assert_success() {
|
assert_success() {
|
||||||
if [ "$status" -ne 0 ]; then
|
if [ "$status" -ne 0 ]; then
|
||||||
flunk "command failed with exit status $status"
|
flunk "command failed with exit status $status"
|
||||||
@@ -72,10 +59,14 @@ assert_contains() {
|
|||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# ShellCheck doesn't know about $output from Bats
|
||||||
|
# shellcheck disable=SC2154
|
||||||
assert_output() {
|
assert_output() {
|
||||||
local expected
|
local expected
|
||||||
if [ $# -eq 0 ]; then expected="$(cat -)"
|
if [ $# -eq 0 ]; then
|
||||||
else expected="$1"
|
expected="$(cat -)"
|
||||||
|
else
|
||||||
|
expected="$1"
|
||||||
fi
|
fi
|
||||||
assert_equal "$expected" "$output"
|
assert_equal "$expected" "$output"
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user