Compare commits
85 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
dca2ba4a23 | ||
|
|
529d339ee5 | ||
|
|
c44089527f | ||
|
|
3087575877 | ||
|
|
8e1dd3d050 | ||
|
|
a27a012c91 | ||
|
|
ddc8a4dcc9 | ||
|
|
f38df7f861 | ||
|
|
5899a238ab | ||
|
|
88124250c0 | ||
|
|
323d859dc2 | ||
|
|
7a324ad965 | ||
|
|
66446eb3d1 | ||
|
|
3da2546c96 | ||
|
|
be5abcc9fa | ||
|
|
29caa13725 | ||
|
|
fa5548b6fc | ||
|
|
31df8da3d4 | ||
|
|
ad40041a23 | ||
|
|
7e138018e2 | ||
|
|
87bd7e61ad | ||
|
|
e85ee89320 | ||
|
|
e637d6edc1 | ||
|
|
6a55fc4474 | ||
|
|
e9e9c444df | ||
|
|
d5bacd10e4 | ||
|
|
c1e3d75820 | ||
|
|
2b03f18580 | ||
|
|
38d30d24b5 | ||
|
|
008fe264c5 | ||
|
|
dd8a5a41f0 | ||
|
|
f1d7100475 | ||
|
|
e09524029e | ||
|
|
d480a76f07 | ||
|
|
563e4a2ee6 | ||
|
|
7b22b310df | ||
|
|
66996bced9 | ||
|
|
ffddb96ec4 | ||
|
|
e9891556d9 | ||
|
|
7a0b20aed6 | ||
|
|
cdfe98a4e1 | ||
|
|
cfeff3e168 | ||
|
|
b9e339f1d0 | ||
|
|
9da6fd80f7 | ||
|
|
9de844b8eb | ||
|
|
4d0f09ff6b | ||
|
|
8bac5ad244 | ||
|
|
4cbcefdb0f | ||
|
|
ddf4d4d58c | ||
|
|
de11d2f9b1 | ||
|
|
fefed14b39 | ||
|
|
de492a3aa1 | ||
|
|
8cb329581f | ||
|
|
23cf608add | ||
|
|
0bedfa6dde | ||
|
|
f6be651ab1 | ||
|
|
b0bd29f770 | ||
|
|
0d23b71c28 | ||
|
|
eeecc9127c | ||
|
|
a72a118e71 | ||
|
|
4d6972fd4b | ||
|
|
6822c923a0 | ||
|
|
7c63d5c04d | ||
|
|
aa2b3c8b86 | ||
|
|
b97b7ce2e6 | ||
|
|
483e6c54cc | ||
|
|
476ccb73e1 | ||
|
|
6ca823d417 | ||
|
|
114fc89ec3 | ||
|
|
7f4a5d2b09 | ||
|
|
224173e5dc | ||
|
|
51efb0150b | ||
|
|
31ade32c05 | ||
|
|
f6523d1917 | ||
|
|
7b3b134b49 | ||
|
|
dc3ae48aed | ||
|
|
f62d233fdd | ||
|
|
956bc4aafa | ||
|
|
dd83b621f2 | ||
|
|
d0060ad532 | ||
|
|
19b4960ea2 | ||
|
|
2cd56cdf4b | ||
|
|
6285aa7d68 | ||
|
|
b11dea9734 | ||
|
|
78da679ea6 |
@@ -1,68 +0,0 @@
|
||||
version: 2
|
||||
jobs:
|
||||
build-master:
|
||||
environment:
|
||||
DOKKU_VERSION: master
|
||||
machine:
|
||||
docker_layer_caching: false
|
||||
image: ubuntu-1604:201903-01
|
||||
steps:
|
||||
- checkout
|
||||
- run: pyenv global 3.7.0
|
||||
- run: make setup
|
||||
- run: sudo sysctl -w vm.max_map_count=262144
|
||||
- run:
|
||||
command: |
|
||||
make generate;
|
||||
if [[ $(git diff) ]]; then
|
||||
echo "Please run `make generate`";
|
||||
git status --short;
|
||||
git diff;
|
||||
exit 1;
|
||||
fi
|
||||
- run: make test
|
||||
- store_artifacts:
|
||||
path: build
|
||||
destination: build
|
||||
- store_artifacts:
|
||||
path: tmp/test-results
|
||||
destination: test-results
|
||||
- store_test_results:
|
||||
path: tmp/test-results
|
||||
|
||||
build-version:
|
||||
environment:
|
||||
DOKKU_VERSION: v0.19.0
|
||||
machine:
|
||||
docker_layer_caching: false
|
||||
image: ubuntu-1604:201903-01
|
||||
steps:
|
||||
- checkout
|
||||
- run: pyenv global 3.7.0
|
||||
- run: make setup
|
||||
- run: sudo sysctl -w vm.max_map_count=262144
|
||||
- run:
|
||||
command: |
|
||||
make generate;
|
||||
if [[ $(git diff) ]]; then
|
||||
echo "Please run `make generate`";
|
||||
git status --short;
|
||||
git diff;
|
||||
exit 1;
|
||||
fi
|
||||
- run: make test
|
||||
- store_artifacts:
|
||||
path: build
|
||||
destination: build
|
||||
- store_artifacts:
|
||||
path: tmp/test-results
|
||||
destination: test-results
|
||||
- store_test_results:
|
||||
path: tmp/test-results
|
||||
|
||||
workflows:
|
||||
version: 2
|
||||
build:
|
||||
jobs:
|
||||
- "build-master"
|
||||
- "build-version"
|
||||
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"
|
||||
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
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -1,2 +1,3 @@
|
||||
/tmp
|
||||
.vagrant
|
||||
bootstrap.sh
|
||||
|
||||
1
Dockerfile
Normal file
1
Dockerfile
Normal file
@@ -0,0 +1 @@
|
||||
FROM mongo:5.0.3
|
||||
@@ -1,4 +1,4 @@
|
||||
Copyright (C) 2018 Jose Diaz-Gonzalez
|
||||
Copyright (C) 2020 Jose Diaz-Gonzalez
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
|
||||
19
Makefile
19
Makefile
@@ -11,7 +11,7 @@ ifneq ($(shell bats --version >/dev/null 2>&1 ; echo $$?),0)
|
||||
brew install bats-core
|
||||
endif
|
||||
else
|
||||
git clone https://github.com/josegonzalez/bats-core.git /tmp/bats
|
||||
git clone https://github.com/bats-core/bats-core.git /tmp/bats
|
||||
cd /tmp/bats && sudo ./install.sh /usr/local
|
||||
rm -rf /tmp/bats
|
||||
endif
|
||||
@@ -63,7 +63,7 @@ unit-tests:
|
||||
@echo running unit tests...
|
||||
@mkdir -p tmp/test-results/bats
|
||||
@cd tests && echo "executing tests: $(shell cd tests ; ls *.bats | xargs)"
|
||||
cd tests && bats --formatter bats-format-junit -e -T -o ../tmp/test-results/bats *.bats
|
||||
cd tests && bats --report-formatter junit --timing -o ../tmp/test-results/bats *.bats
|
||||
|
||||
tmp/xunit-reader:
|
||||
mkdir -p tmp
|
||||
@@ -71,28 +71,15 @@ tmp/xunit-reader:
|
||||
tar xf tmp/xunit-reader.tgz -C tmp
|
||||
chmod +x tmp/xunit-reader
|
||||
|
||||
tmp/xunit-to-github:
|
||||
mkdir -p tmp
|
||||
curl -o tmp/xunit-to-github.tgz -sL https://github.com/josegonzalez/go-xunit-to-github/releases/download/v$(XUNIT_TO_GITHUB_VERSION)/xunit-to-github_$(XUNIT_TO_GITHUB_VERSION)_$(SYSTEM_NAME)_$(HARDWARE).tgz
|
||||
tar xf tmp/xunit-to-github.tgz -C tmp
|
||||
chmod +x tmp/xunit-to-github
|
||||
|
||||
setup:
|
||||
bash tests/setup.sh
|
||||
$(MAKE) ci-dependencies
|
||||
|
||||
test: lint unit-tests
|
||||
|
||||
report: tmp/xunit-reader tmp/xunit-to-github
|
||||
report: tmp/xunit-reader
|
||||
tmp/xunit-reader -p 'tmp/test-results/bats/*.xml'
|
||||
tmp/xunit-reader -p 'tmp/test-results/shellcheck/*.xml'
|
||||
ifdef TRAVIS_REPO_SLUG
|
||||
ifdef GITHUB_ACCESS_TOKEN
|
||||
ifneq ($(TRAVIS_PULL_REQUEST),false)
|
||||
tmp/xunit-to-github --skip-ok --job-url "$(TRAVIS_JOB_WEB_URL)" --pull-request-id "$(TRAVIS_PULL_REQUEST)" --repository-slug "$(TRAVIS_REPO_SLUG)" --title "DOKKU_VERSION=$(DOKKU_VERSION)" tmp/test-results/bats tmp/test-results/shellcheck
|
||||
endif
|
||||
endif
|
||||
endif
|
||||
|
||||
.PHONY: clean
|
||||
clean:
|
||||
|
||||
277
README.md
277
README.md
@@ -1,16 +1,16 @@
|
||||
# dokku mongo [](https://travis-ci.org/dokku/dokku-mongo) [](https://webchat.freenode.net/?channels=dokku)
|
||||
# dokku mongo [](https://github.com/dokku/dokku-mongo/actions/workflows/ci.yml?query=branch%3Amaster) [](https://webchat.libera.chat/?channels=dokku)
|
||||
|
||||
Official mongo plugin for dokku. Currently defaults to installing [mongo 3.6.15](https://hub.docker.com/_/mongo/).
|
||||
Official mongo plugin for dokku. Currently defaults to installing [mongo 5.0.3](https://hub.docker.com/_/mongo/).
|
||||
|
||||
## Requirements
|
||||
|
||||
- dokku 0.12.x+
|
||||
- dokku 0.19.x+
|
||||
- docker 1.8.x
|
||||
|
||||
## Installation
|
||||
|
||||
```shell
|
||||
# on 0.12.x+
|
||||
# on 0.19.x+
|
||||
sudo dokku plugin:install https://github.com/dokku/dokku-mongo.git mongo
|
||||
```
|
||||
|
||||
@@ -18,14 +18,14 @@ sudo dokku plugin:install https://github.com/dokku/dokku-mongo.git mongo
|
||||
|
||||
```
|
||||
mongo:app-links <app> # list all mongo service links for a given app
|
||||
mongo:backup <service> <bucket-name> [--use-iam] # creates a backup of the mongo service to an existing s3 bucket
|
||||
mongo:backup-auth <service> <aws-access-key-id> <aws-secret-access-key> <aws-default-region> <aws-signature-version> <endpoint-url> # sets up authentication for backups on the mongo service
|
||||
mongo:backup-deauth <service> # removes backup authentication for the mongo service
|
||||
mongo:backup-schedule <service> <schedule> <bucket-name> [--use-iam] # schedules a backup of the mongo service
|
||||
mongo:backup <service> <bucket-name> [--use-iam] # create a backup of the mongo service to an existing s3 bucket
|
||||
mongo: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 mongo service
|
||||
mongo:backup-deauth <service> # remove backup authentication for the mongo service
|
||||
mongo:backup-schedule <service> <schedule> <bucket-name> [--use-iam] # schedule a backup of the mongo service
|
||||
mongo:backup-schedule-cat <service> # cat the contents of the configured backup cronfile for the service
|
||||
mongo:backup-set-encryption <service> <passphrase> # sets encryption for all future backups of mongo service
|
||||
mongo:backup-unschedule <service> # unschedules the backup of the mongo service
|
||||
mongo:backup-unset-encryption <service> # unsets encryption for future backups of the mongo service
|
||||
mongo:backup-set-encryption <service> <passphrase> # set encryption for all future backups of mongo service
|
||||
mongo:backup-unschedule <service> # unschedule the backup of the mongo service
|
||||
mongo:backup-unset-encryption <service> # unset encryption for future backups of the mongo service
|
||||
mongo:clone <service> <new-service> [--clone-flags...] # create container <new-name> then copy data from <name> into <new-name>
|
||||
mongo:connect <service> # connect to the service via the mongo connection tool
|
||||
mongo:connect-admin <service> # connect via mongo to a mongo service as admin user
|
||||
@@ -34,14 +34,14 @@ mongo:destroy <service> [-f|--force] # delete the mongo service/da
|
||||
mongo:enter <service> # enter or run a command in a running mongo service container
|
||||
mongo:exists <service> # check if the mongo service exists
|
||||
mongo:export <service> # export a dump of the mongo service database
|
||||
mongo:expose <service> <ports...> # expose a mongo service on custom port if provided (random port otherwise)
|
||||
mongo:expose <service> <ports...> # expose a mongo service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)
|
||||
mongo:import <service> # import a dump into the mongo service database
|
||||
mongo:info <service> [--single-info-flag] # print the service information
|
||||
mongo:link <service> <app> [--link-flags...] # link the mongo service to the app
|
||||
mongo:linked <service> <app> # check if the mongo service is linked to an app
|
||||
mongo:links <service> # list all apps linked to the mongo service
|
||||
mongo:list # list all mongo services
|
||||
mongo:logs <service> [-t|--tail] # print the most recent log(s) for this service
|
||||
mongo:logs <service> [-t|--tail] <tail-num-optional> # print the most recent log(s) for this service
|
||||
mongo:promote <service> <app> # promote service <service> as MONGO_URL in <app>
|
||||
mongo:restart <service> # graceful shutdown and restart of the mongo service container
|
||||
mongo:start <service> # start a previously stopped mongo service
|
||||
@@ -53,7 +53,7 @@ mongo:upgrade <service> [--upgrade-flags...] # upgrade service <service> t
|
||||
|
||||
## Usage
|
||||
|
||||
Help for any commands can be displayed by specifying the command as an argument to mongo:help. Please consult the `mongo:help` command for any undocumented commands.
|
||||
Help for any commands can be displayed by specifying the command as an argument to mongo:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `mongo:help` command for any undocumented commands.
|
||||
|
||||
### Basic Usage
|
||||
|
||||
@@ -64,25 +64,36 @@ Help for any commands can be displayed by specifying the command as an argument
|
||||
dokku mongo:create <service> [--create-flags...]
|
||||
```
|
||||
|
||||
Create a mongo service named lolipop:
|
||||
flags:
|
||||
|
||||
- `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: ` --storageEngine wiredTiger --auth `)
|
||||
- `-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 mongo docker container
|
||||
|
||||
Create a mongo service named lollipop:
|
||||
|
||||
```shell
|
||||
dokku mongo:create lolipop
|
||||
dokku mongo:create lollipop
|
||||
```
|
||||
|
||||
You can also specify the image and image version to use for the service. It *must* be compatible with the ${plugin_image} image.
|
||||
You can also specify the image and image version to use for the service. It *must* be compatible with the mongo image.
|
||||
|
||||
```shell
|
||||
export MONGO_IMAGE="${PLUGIN_IMAGE}"
|
||||
export MONGO_IMAGE="mongo"
|
||||
export MONGO_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
|
||||
dokku mongo:create lolipop
|
||||
dokku mongo:create lollipop
|
||||
```
|
||||
|
||||
You can also specify custom environment variables to start the mongo service in semi-colon separated form.
|
||||
|
||||
```shell
|
||||
export MONGO_CUSTOM_ENV="USER=alpha;HOST=beta"
|
||||
dokku mongo:create lolipop
|
||||
dokku mongo:create lollipop
|
||||
```
|
||||
|
||||
### print the service information
|
||||
@@ -92,25 +103,38 @@ dokku mongo:create lolipop
|
||||
dokku mongo:info <service> [--single-info-flag]
|
||||
```
|
||||
|
||||
flags:
|
||||
|
||||
- `--config-dir`: show the service configuration directory
|
||||
- `--data-dir`: show the service data directory
|
||||
- `--dsn`: show the service DSN
|
||||
- `--exposed-ports`: show service exposed ports
|
||||
- `--id`: show the service container id
|
||||
- `--internal-ip`: show the service internal ip
|
||||
- `--links`: show the service app links
|
||||
- `--service-root`: show the service root directory
|
||||
- `--status`: show the service running status
|
||||
- `--version`: show the service image version
|
||||
|
||||
Get connection information as follows:
|
||||
|
||||
```shell
|
||||
dokku mongo:info lolipop
|
||||
dokku mongo:info lollipop
|
||||
```
|
||||
|
||||
You can also retrieve a specific piece of service info via flags:
|
||||
|
||||
```shell
|
||||
dokku mongo:info lolipop --config-dir
|
||||
dokku mongo:info lolipop --data-dir
|
||||
dokku mongo:info lolipop --dsn
|
||||
dokku mongo:info lolipop --exposed-ports
|
||||
dokku mongo:info lolipop --id
|
||||
dokku mongo:info lolipop --internal-ip
|
||||
dokku mongo:info lolipop --links
|
||||
dokku mongo:info lolipop --service-root
|
||||
dokku mongo:info lolipop --status
|
||||
dokku mongo:info lolipop --version
|
||||
dokku mongo:info lollipop --config-dir
|
||||
dokku mongo:info lollipop --data-dir
|
||||
dokku mongo:info lollipop --dsn
|
||||
dokku mongo:info lollipop --exposed-ports
|
||||
dokku mongo:info lollipop --id
|
||||
dokku mongo:info lollipop --internal-ip
|
||||
dokku mongo:info lollipop --links
|
||||
dokku mongo:info lollipop --service-root
|
||||
dokku mongo:info lollipop --status
|
||||
dokku mongo:info lollipop --version
|
||||
```
|
||||
|
||||
### list all mongo services
|
||||
@@ -130,19 +154,29 @@ dokku mongo:list
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku mongo:logs <service> [-t|--tail]
|
||||
dokku mongo:logs <service> [-t|--tail] <tail-num-optional>
|
||||
```
|
||||
|
||||
flags:
|
||||
|
||||
- `-t|--tail [<tail-num>]`: do not stop when end of the logs are reached and wait for additional output
|
||||
|
||||
You can tail logs for a particular service:
|
||||
|
||||
```shell
|
||||
dokku mongo:logs lolipop
|
||||
dokku mongo:logs lollipop
|
||||
```
|
||||
|
||||
By default, logs will not be tailed, but you can do this with the --tail flag:
|
||||
|
||||
```shell
|
||||
dokku mongo:logs lolipop --tail
|
||||
dokku mongo:logs lollipop --tail
|
||||
```
|
||||
|
||||
The default tail setting is to show all logs, but an initial count can also be specified:
|
||||
|
||||
```shell
|
||||
dokku mongo:logs lollipop --tail 5
|
||||
```
|
||||
|
||||
### link the mongo service to the app
|
||||
@@ -152,48 +186,53 @@ dokku mongo:logs lolipop --tail
|
||||
dokku mongo:link <service> <app> [--link-flags...]
|
||||
```
|
||||
|
||||
A mongo 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.
|
||||
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 mongo 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 mongo:link lolipop playground
|
||||
dokku mongo: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_MONGO_LOLIPOP_NAME=/lolipop/DATABASE
|
||||
DOKKU_MONGO_LOLIPOP_PORT=tcp://172.17.0.1:27017
|
||||
DOKKU_MONGO_LOLIPOP_PORT_27017_TCP=tcp://172.17.0.1:27017
|
||||
DOKKU_MONGO_LOLIPOP_PORT_27017_TCP_PROTO=tcp
|
||||
DOKKU_MONGO_LOLIPOP_PORT_27017_TCP_PORT=27017
|
||||
DOKKU_MONGO_LOLIPOP_PORT_27017_TCP_ADDR=172.17.0.1
|
||||
DOKKU_MONGO_LOLLIPOP_NAME=/lollipop/DATABASE
|
||||
DOKKU_MONGO_LOLLIPOP_PORT=tcp://172.17.0.1:27017
|
||||
DOKKU_MONGO_LOLLIPOP_PORT_27017_TCP=tcp://172.17.0.1:27017
|
||||
DOKKU_MONGO_LOLLIPOP_PORT_27017_TCP_PROTO=tcp
|
||||
DOKKU_MONGO_LOLLIPOP_PORT_27017_TCP_PORT=27017
|
||||
DOKKU_MONGO_LOLLIPOP_PORT_27017_TCP_ADDR=172.17.0.1
|
||||
```
|
||||
|
||||
The following will be set on the linked application by default:
|
||||
|
||||
```
|
||||
MONGO_URL=mongodb://lolipop:SOME_PASSWORD@dokku-mongo-lolipop:27017/lolipop
|
||||
MONGO_URL=mongodb://lollipop:SOME_PASSWORD@dokku-mongo-lollipop:27017/lollipop
|
||||
```
|
||||
|
||||
The host exposed here only works internally in docker containers. If you want your container to be reachable from outside, you should use the 'expose' subcommand. Another service can be linked to your app:
|
||||
The host exposed here only works internally in docker containers. If you want your container to be reachable from outside, you should use the `expose` subcommand. Another service can be linked to your app:
|
||||
|
||||
```shell
|
||||
dokku mongo:link other_service playground
|
||||
```
|
||||
|
||||
It is possible to change the protocol for mongo_url by setting the environment variable mongo_database_scheme on the app. Doing so will after linking will cause the plugin to think the service is not linked, and we advise you to unlink before proceeding.
|
||||
It is possible to change the protocol for `MONGO_URL` by setting the environment variable `MONGO_DATABASE_SCHEME` on the app. Doing so will after linking will cause the plugin to think the service is not linked, and we advise you to unlink before proceeding.
|
||||
|
||||
```shell
|
||||
dokku config:set playground MONGO_DATABASE_SCHEME=mongodb2
|
||||
dokku mongo:link lolipop playground
|
||||
dokku mongo:link lollipop playground
|
||||
```
|
||||
|
||||
This will cause mongo_url to be set as:
|
||||
This will cause `MONGO_URL` to be set as:
|
||||
|
||||
```
|
||||
mongodb2://lolipop:SOME_PASSWORD@dokku-mongo-lolipop:27017/lolipop
|
||||
mongodb2://lollipop:SOME_PASSWORD@dokku-mongo-lollipop:27017/lollipop
|
||||
```
|
||||
|
||||
### unlink the mongo service from the app
|
||||
@@ -208,7 +247,7 @@ You can unlink a mongo service:
|
||||
> NOTE: this will restart your app and unset related environment variables
|
||||
|
||||
```shell
|
||||
dokku mongo:unlink lolipop playground
|
||||
dokku mongo:unlink lollipop playground
|
||||
```
|
||||
|
||||
### Service Lifecycle
|
||||
@@ -224,8 +263,10 @@ dokku mongo:connect <service>
|
||||
|
||||
Connect to the service via the mongo connection tool:
|
||||
|
||||
> NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098
|
||||
|
||||
```shell
|
||||
dokku mongo:connect lolipop
|
||||
dokku mongo:connect lollipop
|
||||
```
|
||||
|
||||
### enter or run a command in a running mongo service container
|
||||
@@ -237,27 +278,35 @@ dokku mongo: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 mongo:enter lolipop
|
||||
dokku mongo:enter lollipop
|
||||
```
|
||||
|
||||
You may also run a command directly against the service. Filesystem changes will not be saved to disk.
|
||||
|
||||
```shell
|
||||
dokku mongo:enter lolipop touch /tmp/test
|
||||
dokku mongo:enter lollipop touch /tmp/test
|
||||
```
|
||||
|
||||
### expose a mongo service on custom port if provided (random port otherwise)
|
||||
### expose a mongo service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku mongo:expose <service> <ports...>
|
||||
```
|
||||
|
||||
Expose the service on the service's normal ports, allowing access to it from the public interface (0. 0. 0. 0):
|
||||
Expose the service on the service's normal ports, allowing access to it from the public interface (`0.0.0.0`):
|
||||
|
||||
```shell
|
||||
dokku mongo:expose lolipop ${PLUGIN_DATASTORE_PORTS[@]}
|
||||
dokku mongo:expose lollipop 27017 27018 27019 28017
|
||||
```
|
||||
|
||||
Expose the service on the service's normal ports, with the first on a specified ip adddress (127.0.0.1):
|
||||
|
||||
```shell
|
||||
dokku mongo:expose lollipop 127.0.0.1:27017 27018 27019 28017
|
||||
```
|
||||
|
||||
### unexpose a previously exposed mongo service
|
||||
@@ -267,10 +316,10 @@ dokku mongo:expose lolipop ${PLUGIN_DATASTORE_PORTS[@]}
|
||||
dokku mongo:unexpose <service>
|
||||
```
|
||||
|
||||
Unexpose the service, removing access to it from the public interface (0. 0. 0. 0):
|
||||
Unexpose the service, removing access to it from the public interface (`0.0.0.0`):
|
||||
|
||||
```shell
|
||||
dokku mongo:unexpose lolipop
|
||||
dokku mongo:unexpose lollipop
|
||||
```
|
||||
|
||||
### promote service <service> as MONGO_URL in <app>
|
||||
@@ -294,12 +343,12 @@ You can promote the new service to be the primary one:
|
||||
dokku mongo:promote other_service playground
|
||||
```
|
||||
|
||||
This will replace mongo_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:
|
||||
This will replace `MONGO_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:
|
||||
|
||||
```
|
||||
MONGO_URL=mongodb://other_service:ANOTHER_PASSWORD@dokku-mongo-other-service:27017/other_service
|
||||
DOKKU_MONGO_BLUE_URL=mongodb://other_service:ANOTHER_PASSWORD@dokku-mongo-other-service:27017/other_service
|
||||
DOKKU_MONGO_SILVER_URL=mongodb://lolipop:SOME_PASSWORD@dokku-mongo-lolipop:27017/lolipop
|
||||
DOKKU_MONGO_SILVER_URL=mongodb://lollipop:SOME_PASSWORD@dokku-mongo-lollipop:27017/lollipop
|
||||
```
|
||||
|
||||
### start a previously stopped mongo service
|
||||
@@ -312,7 +361,7 @@ dokku mongo:start <service>
|
||||
Start the service:
|
||||
|
||||
```shell
|
||||
dokku mongo:start lolipop
|
||||
dokku mongo:start lollipop
|
||||
```
|
||||
|
||||
### stop a running mongo service
|
||||
@@ -325,7 +374,7 @@ dokku mongo:stop <service>
|
||||
Stop the service and the running container:
|
||||
|
||||
```shell
|
||||
dokku mongo:stop lolipop
|
||||
dokku mongo:stop lollipop
|
||||
```
|
||||
|
||||
### graceful shutdown and restart of the mongo service container
|
||||
@@ -338,7 +387,7 @@ dokku mongo:restart <service>
|
||||
Restart the service:
|
||||
|
||||
```shell
|
||||
dokku mongo:restart lolipop
|
||||
dokku mongo:restart lollipop
|
||||
```
|
||||
|
||||
### upgrade service <service> to the specified versions
|
||||
@@ -348,10 +397,19 @@ dokku mongo:restart lolipop
|
||||
dokku mongo:upgrade <service> [--upgrade-flags...]
|
||||
```
|
||||
|
||||
flags:
|
||||
|
||||
- `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: ` --storageEngine wiredTiger --auth `)
|
||||
- `-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 mongo docker container
|
||||
|
||||
You can upgrade an existing service to a new image or image-version:
|
||||
|
||||
```shell
|
||||
dokku mongo:upgrade lolipop
|
||||
dokku mongo:upgrade lollipop
|
||||
```
|
||||
|
||||
### Service Automation
|
||||
@@ -365,7 +423,7 @@ Service scripting can be executed using the following commands:
|
||||
dokku mongo:app-links <app>
|
||||
```
|
||||
|
||||
List all mongo services that are linked to the 'playground' app.
|
||||
List all mongo services that are linked to the `playground` app.
|
||||
|
||||
```shell
|
||||
dokku mongo:app-links playground
|
||||
@@ -378,10 +436,21 @@ dokku mongo:app-links playground
|
||||
dokku mongo:clone <service> <new-service> [--clone-flags...]
|
||||
```
|
||||
|
||||
flags:
|
||||
|
||||
- `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: ` --storageEngine wiredTiger --auth `)
|
||||
- `-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 mongo docker container
|
||||
|
||||
You can clone an existing service to a new one:
|
||||
|
||||
```shell
|
||||
dokku mongo:clone lolipop lolipop-2
|
||||
dokku mongo:clone lollipop lollipop-2
|
||||
```
|
||||
|
||||
### check if the mongo service exists
|
||||
@@ -391,10 +460,10 @@ dokku mongo:clone lolipop lolipop-2
|
||||
dokku mongo:exists <service>
|
||||
```
|
||||
|
||||
Here we check if the lolipop mongo service exists.
|
||||
Here we check if the lollipop mongo service exists.
|
||||
|
||||
```shell
|
||||
dokku mongo:exists lolipop
|
||||
dokku mongo:exists lollipop
|
||||
```
|
||||
|
||||
### check if the mongo service is linked to an app
|
||||
@@ -404,10 +473,10 @@ dokku mongo:exists lolipop
|
||||
dokku mongo:linked <service> <app>
|
||||
```
|
||||
|
||||
Here we check if the lolipop mongo service is linked to the 'playground' app.
|
||||
Here we check if the lollipop mongo service is linked to the `playground` app.
|
||||
|
||||
```shell
|
||||
dokku mongo:linked lolipop playground
|
||||
dokku mongo:linked lollipop playground
|
||||
```
|
||||
|
||||
### list all apps linked to the mongo service
|
||||
@@ -417,10 +486,10 @@ dokku mongo:linked lolipop playground
|
||||
dokku mongo:links <service>
|
||||
```
|
||||
|
||||
List all apps linked to the 'lolipop' mongo service.
|
||||
List all apps linked to the `lollipop` mongo service.
|
||||
|
||||
```shell
|
||||
dokku mongo:links lolipop
|
||||
dokku mongo:links lollipop
|
||||
```
|
||||
|
||||
### Data Management
|
||||
@@ -437,7 +506,7 @@ dokku mongo:import <service>
|
||||
Import a datastore dump:
|
||||
|
||||
```shell
|
||||
dokku mongo:import lolipop < database.dump
|
||||
dokku mongo:import lollipop < data.dump
|
||||
```
|
||||
|
||||
### export a dump of the mongo service database
|
||||
@@ -450,13 +519,13 @@ dokku mongo:export <service>
|
||||
By default, datastore output is exported to stdout:
|
||||
|
||||
```shell
|
||||
dokku mongo:export lolipop
|
||||
dokku mongo:export lollipop
|
||||
```
|
||||
|
||||
You can redirect this output to a file:
|
||||
|
||||
```shell
|
||||
dokku mongo:export lolipop > lolipop.dump
|
||||
dokku mongo:export lollipop > data.dump
|
||||
```
|
||||
|
||||
### Backups
|
||||
@@ -467,7 +536,7 @@ You may skip the `backup-auth` step if your dokku install is running within EC2
|
||||
|
||||
Backups can be performed using the backup commands:
|
||||
|
||||
### sets up authentication for backups on the mongo service
|
||||
### set up authentication for backups on the mongo service
|
||||
|
||||
```shell
|
||||
# usage
|
||||
@@ -477,28 +546,28 @@ dokku mongo:backup-auth <service> <aws-access-key-id> <aws-secret-access-key> <a
|
||||
Setup s3 backup authentication:
|
||||
|
||||
```shell
|
||||
dokku mongo:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
|
||||
dokku mongo:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
|
||||
```
|
||||
|
||||
Setup s3 backup authentication with different region:
|
||||
|
||||
```shell
|
||||
dokku mongo:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
|
||||
dokku mongo: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 mongo:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL
|
||||
dokku mongo: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 mongo:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
|
||||
dokku mongo:backup-auth lollipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
|
||||
```
|
||||
|
||||
### removes backup authentication for the mongo service
|
||||
### remove backup authentication for the mongo service
|
||||
|
||||
```shell
|
||||
# usage
|
||||
@@ -508,67 +577,81 @@ dokku mongo:backup-deauth <service>
|
||||
Remove s3 authentication:
|
||||
|
||||
```shell
|
||||
dokku mongo:backup-deauth lolipop
|
||||
dokku mongo:backup-deauth lollipop
|
||||
```
|
||||
|
||||
### creates a backup of the mongo service to an existing s3 bucket
|
||||
### create a backup of the mongo service to an existing s3 bucket
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku mongo:backup <service> <bucket-name> [--use-iam]
|
||||
```
|
||||
|
||||
Backup the 'lolipop' service to the 'my-s3-bucket' bucket on aws:
|
||||
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 mongo:backup lolipop my-s3-bucket --use-iam
|
||||
dokku mongo:backup lollipop my-s3-bucket --use-iam
|
||||
```
|
||||
|
||||
### sets encryption for all future backups of mongo service
|
||||
Restore a backup file (assuming it was extracted via `tar -xf backup.tgz`):
|
||||
|
||||
```shell
|
||||
dokku mongo:import lollipop < backup-folder/export
|
||||
```
|
||||
|
||||
### set encryption for all future backups of mongo service
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku mongo:backup-set-encryption <service> <passphrase>
|
||||
```
|
||||
|
||||
Set a gpg passphrase for backups:
|
||||
Set the GPG-compatible passphrase for encrypting backups for backups:
|
||||
|
||||
```shell
|
||||
dokku mongo:backup-set-encryption lolipop
|
||||
dokku mongo:backup-set-encryption lollipop
|
||||
```
|
||||
|
||||
### unsets encryption for future backups of the mongo service
|
||||
### unset encryption for future backups of the mongo service
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku mongo:backup-unset-encryption <service>
|
||||
```
|
||||
|
||||
Unset a gpg encryption key for backups:
|
||||
Unset the `GPG` encryption passphrase for backups:
|
||||
|
||||
```shell
|
||||
dokku mongo:backup-unset-encryption lolipop
|
||||
dokku mongo:backup-unset-encryption lollipop
|
||||
```
|
||||
|
||||
### schedules a backup of the mongo service
|
||||
### schedule a backup of the mongo service
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku mongo: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 mongo:backup-schedule lolipop "0 3 * * *" my-s3-bucket
|
||||
dokku mongo:backup-schedule lollipop "0 3 * * *" my-s3-bucket
|
||||
```
|
||||
|
||||
Schedule a backup and authenticate via iam:
|
||||
|
||||
```shell
|
||||
dokku mongo:backup-schedule lolipop "0 3 * * *" my-s3-bucket --use-iam
|
||||
dokku mongo:backup-schedule lollipop "0 3 * * *" my-s3-bucket --use-iam
|
||||
```
|
||||
|
||||
### cat the contents of the configured backup cronfile for the service
|
||||
@@ -581,10 +664,10 @@ dokku mongo:backup-schedule-cat <service>
|
||||
Cat the contents of the configured backup cronfile for the service:
|
||||
|
||||
```shell
|
||||
dokku mongo:backup-schedule-cat lolipop
|
||||
dokku mongo:backup-schedule-cat lollipop
|
||||
```
|
||||
|
||||
### unschedules the backup of the mongo service
|
||||
### unschedule the backup of the mongo service
|
||||
|
||||
```shell
|
||||
# usage
|
||||
@@ -594,11 +677,11 @@ dokku mongo:backup-unschedule <service>
|
||||
Remove the scheduled backup from cron:
|
||||
|
||||
```shell
|
||||
dokku mongo:backup-unschedule lolipop
|
||||
dokku mongo:backup-unschedule lollipop
|
||||
```
|
||||
|
||||
### Disabling `docker pull` calls
|
||||
|
||||
If you wish to disable the `docker pull` calls that the plugin triggers, you may set the `MONGO_DISABLE_PULL` environment variable to `true`. Once disabled, you will need to pull the service image you wish to deploy as shown in the `stderr` output.
|
||||
|
||||
Please ensure the proper images are in place when `docker pull` is disabled.
|
||||
Please ensure the proper images are in place when `docker pull` is disabled.
|
||||
|
||||
300
bin/generate
300
bin/generate
@@ -5,50 +5,84 @@ import os
|
||||
import re
|
||||
|
||||
|
||||
def compile(service, version, alias, scheme, ports, unimplemented, dokku_version):
|
||||
return "\n\n".join([
|
||||
def compile(service, version, variable, alias, image, scheme, ports, sponsors, options, unimplemented, dokku_version):
|
||||
prefix = "\n\n".join([
|
||||
header(service),
|
||||
description(service, version),
|
||||
requirements_section(dokku_version),
|
||||
installation_section(service, dokku_version),
|
||||
commands_section(service, alias, scheme, ports, unimplemented),
|
||||
usage_section(service, alias, scheme, ports, unimplemented),
|
||||
]).replace("\n\n\n\n\n", "\n").replace("\n\n\n\n", "\n").replace("\n\n\n", "\n\n")
|
||||
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://travis-ci.org/dokku/dokku-{service})",
|
||||
f"[](https://webchat.freenode.net/?channels=dokku)",
|
||||
])
|
||||
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, version):
|
||||
return f"Official {service} plugin for dokku. Currently defaults to installing [{service} {version}](https://hub.docker.com/_/{service}/)."
|
||||
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",
|
||||
])
|
||||
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}",
|
||||
"```",
|
||||
])
|
||||
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, alias, scheme, ports, unimplemented):
|
||||
def commands_section(service, variable, alias, image, scheme, ports, unimplemented):
|
||||
content = [
|
||||
"## Commands",
|
||||
"",
|
||||
@@ -63,7 +97,7 @@ def commands_section(service, alias, scheme, ports, unimplemented):
|
||||
for filename in subcommands:
|
||||
if filename in unimplemented:
|
||||
continue
|
||||
data = command_data(filename, service, alias, scheme, ports)
|
||||
data = command_data(filename, service, variable, alias, image, scheme, ports)
|
||||
description = data["description"]
|
||||
arguments = data["arguments_string"]
|
||||
|
||||
@@ -81,28 +115,42 @@ def commands_section(service, alias, scheme, ports, unimplemented):
|
||||
return "\n".join(content)
|
||||
|
||||
|
||||
def usage_section(service, alias, scheme, ports, unimplemented):
|
||||
return "\n\n".join([
|
||||
"## Usage",
|
||||
f"Help for any commands can be displayed by specifying the command as an argument to {service}:help. Please consult the `{service}:help` command for any undocumented commands.",
|
||||
usage_intro(service, alias, scheme, ports, unimplemented),
|
||||
usage_lifecycle(service, alias, scheme, ports, unimplemented),
|
||||
usage_automation(service, alias, scheme, ports, unimplemented),
|
||||
usage_data_management(service, alias, scheme, ports, unimplemented),
|
||||
usage_backup(service, alias, scheme, ports, unimplemented),
|
||||
usage_docker_pull(service, alias, scheme, ports, unimplemented),
|
||||
])
|
||||
def usage_section(service, variable, alias, image, scheme, ports, options, unimplemented):
|
||||
return "\n\n".join(
|
||||
[
|
||||
"## Usage",
|
||||
f"Help for any commands can be displayed by specifying the command as an argument to {service}:help. 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, alias, scheme, ports, unimplemented):
|
||||
def usage_intro(service, variable, alias, image, scheme, ports, options, unimplemented):
|
||||
commands = ["create", "info", "list", "logs", "link", "unlink"]
|
||||
content = ["### Basic Usage"]
|
||||
|
||||
return fetch_commands_content(service, alias, scheme, ports, unimplemented, commands, content)
|
||||
return fetch_commands_content(
|
||||
service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
|
||||
)
|
||||
|
||||
|
||||
def usage_lifecycle(service, alias, scheme, ports, unimplemented):
|
||||
commands = ["connect", "enter", "expose", "unexpose", "promote", "start", "stop", "restart", "upgrade"]
|
||||
def usage_lifecycle(service, variable, alias, image, scheme, ports, options, unimplemented):
|
||||
commands = [
|
||||
"connect",
|
||||
"enter",
|
||||
"expose",
|
||||
"unexpose",
|
||||
"promote",
|
||||
"start",
|
||||
"stop",
|
||||
"restart",
|
||||
"upgrade",
|
||||
]
|
||||
content = [
|
||||
"### Service Lifecycle",
|
||||
"",
|
||||
@@ -110,10 +158,12 @@ def usage_lifecycle(service, alias, scheme, ports, unimplemented):
|
||||
"",
|
||||
]
|
||||
|
||||
return fetch_commands_content(service, alias, scheme, ports, unimplemented, commands, content)
|
||||
return fetch_commands_content(
|
||||
service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
|
||||
)
|
||||
|
||||
|
||||
def usage_automation(service, alias, scheme, ports, unimplemented):
|
||||
def usage_automation(service, variable, alias, image, scheme, ports, options, unimplemented):
|
||||
commands = ["app-links", "clone", "exists", "linked", "links"]
|
||||
content = [
|
||||
"### Service Automation",
|
||||
@@ -122,10 +172,12 @@ def usage_automation(service, alias, scheme, ports, unimplemented):
|
||||
"",
|
||||
]
|
||||
|
||||
return fetch_commands_content(service, alias, scheme, ports, unimplemented, commands, content)
|
||||
return fetch_commands_content(
|
||||
service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
|
||||
)
|
||||
|
||||
|
||||
def usage_data_management(service, alias, scheme, ports, unimplemented):
|
||||
def usage_data_management(service, variable, alias, image, scheme, ports, options, unimplemented):
|
||||
commands = ["import", "export"]
|
||||
content = [
|
||||
"### Data Management",
|
||||
@@ -134,11 +186,22 @@ def usage_data_management(service, alias, scheme, ports, unimplemented):
|
||||
"",
|
||||
]
|
||||
|
||||
return fetch_commands_content(service, alias, scheme, ports, unimplemented, commands, content)
|
||||
return fetch_commands_content(
|
||||
service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
|
||||
)
|
||||
|
||||
|
||||
def usage_backup(service, alias, scheme, ports, unimplemented):
|
||||
commands = ["backup-auth", "backup-deauth", "backup", "backup-set-encryption", "backup-unset-encryption", "backup-schedule", "backup-schedule-cat", "backup-unschedule",]
|
||||
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",
|
||||
"",
|
||||
@@ -150,24 +213,30 @@ def usage_backup(service, alias, scheme, ports, unimplemented):
|
||||
"",
|
||||
]
|
||||
|
||||
return fetch_commands_content(service, alias, scheme, ports, unimplemented, commands, content)
|
||||
return fetch_commands_content(
|
||||
service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
|
||||
)
|
||||
|
||||
|
||||
def usage_docker_pull(service, alias, scheme, ports, unimplemented):
|
||||
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.",
|
||||
])
|
||||
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, alias, scheme, ports, unimplemented, commands, content):
|
||||
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, alias, scheme, ports, unimplemented)
|
||||
output = command_help(command, service, variable, alias, image, scheme, ports, options, unimplemented)
|
||||
if output == "":
|
||||
continue
|
||||
content.append(output)
|
||||
@@ -205,11 +274,11 @@ def parse_args(line):
|
||||
return " ".join(arguments)
|
||||
|
||||
|
||||
def command_help(command, service, alias, scheme, ports, unimplemented):
|
||||
def command_help(command, service, variable, alias, image, scheme, ports, options, unimplemented):
|
||||
if command in unimplemented:
|
||||
return ""
|
||||
|
||||
data = command_data(command, service, alias, scheme, ports)
|
||||
data = command_data(command, service, variable, alias, image, scheme, ports)
|
||||
content = [
|
||||
f"### {data['description']}",
|
||||
"",
|
||||
@@ -226,21 +295,29 @@ def command_help(command, service, alias, scheme, ports, unimplemented):
|
||||
# for argument in data["arguments"]:
|
||||
# content.append(f"- {argument}")
|
||||
|
||||
# if len(data["flags"]) > 0:
|
||||
# content.append("")
|
||||
# content.append("flags:")
|
||||
# content.append("")
|
||||
# for flag in data["flags"]:
|
||||
# content.append(f"- {flag}")
|
||||
if len(data["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, alias, scheme, ports):
|
||||
def command_data(command, service, variable, alias, image, scheme, ports):
|
||||
description = None
|
||||
arguments = []
|
||||
arguments_string = ""
|
||||
@@ -252,9 +329,12 @@ def command_data(command, service, alias, scheme, ports):
|
||||
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)
|
||||
@@ -350,10 +430,39 @@ def command_data(command, service, alias, scheme, ports):
|
||||
|
||||
def process_sentence(sentence_lines):
|
||||
sentence_lines = " ".join(sentence_lines)
|
||||
sentences = ". ".join(i.strip().capitalize() for i in sentence_lines.split(".")).strip()
|
||||
sentences = ". ".join(
|
||||
upperfirst(i.strip()) for i in sentence_lines.split(". ")
|
||||
).strip()
|
||||
if not sentences.endswith(".") and not sentences.endswith(":"):
|
||||
sentences += ":"
|
||||
return 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):
|
||||
@@ -373,31 +482,56 @@ def process_codeblock(codeblock_lines):
|
||||
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 "IMAGE_VERSION=${" in line:
|
||||
version = re.search('"(.+)"', line).group(1)
|
||||
if "PLUGIN_COMMAND_PREFIX=" in line:
|
||||
service = re.search('"(.+)"', line).group(1)
|
||||
if "PLUGIN_DEFAULT_ALIAS=" in line:
|
||||
alias = re.search('"(.+)"', line).group(1)
|
||||
if "PLUGIN_VARIABLE=" in line:
|
||||
variable = re.search('"(.+)"', line).group(1)
|
||||
if "PLUGIN_SCHEME=" in line:
|
||||
scheme = re.search('"(.+)"', line).group(1)
|
||||
if "PLUGIN_DATASTORE_PORTS=" in line:
|
||||
ports = re.search('\((.+)\)', line).group(1).split(" ")
|
||||
ports = re.search("\((.+)\)", line).group(1).split(" ")
|
||||
if "PLUGIN_UNIMPLEMENTED_SUBCOMMANDS=" in line:
|
||||
match = re.search('\((.+)\)', line)
|
||||
match = re.search("\((.+)\)", line)
|
||||
if match is not None:
|
||||
unimplemented = [s.strip('"') for s in match.group(1).split(" ")]
|
||||
|
||||
text = compile(service, version, alias, scheme, ports, unimplemented, "0.12.x+")
|
||||
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)
|
||||
readme_file = os.path.join(base_path, "README.md")
|
||||
with open(readme_file, "w") as f:
|
||||
f.write(text + "\n")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
||||
196
common-functions
196
common-functions
@@ -4,8 +4,20 @@ set -eo pipefail
|
||||
[[ $DOKKU_TRACE ]] && set -x
|
||||
source "$PLUGIN_AVAILABLE_PATH/config/functions"
|
||||
|
||||
add_to_links_file() {
|
||||
declare desc="add an app to the service link file"
|
||||
declare SERVICE="$1" APP="$2"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local LINKS_FILE="$SERVICE_ROOT/LINKS"
|
||||
|
||||
touch "$LINKS_FILE"
|
||||
sed -i.bak "/^$APP\$/d" "$LINKS_FILE" && rm "$LINKS_FILE.bak"
|
||||
echo "$APP" >>"$LINKS_FILE"
|
||||
sort "$LINKS_FILE" -u -o "$LINKS_FILE"
|
||||
}
|
||||
|
||||
docker_ports_options() {
|
||||
declare desc="Exports a list of exposed ports"
|
||||
declare desc="export a list of exposed ports"
|
||||
declare PORTS=("$@")
|
||||
for ((i = 0; i < ${#PLUGIN_DATASTORE_PORTS[@]}; i++)); do
|
||||
echo -n "-p ${PORTS[i]}:${PLUGIN_DATASTORE_PORTS[i]} "
|
||||
@@ -13,13 +25,13 @@ docker_ports_options() {
|
||||
}
|
||||
|
||||
get_container_ip() {
|
||||
declare desc="Retrieves the ip address of a container"
|
||||
declare desc="retrieve the ip address of a container"
|
||||
declare CONTAINER_ID="$1"
|
||||
docker inspect --format '{{ .NetworkSettings.IPAddress }}' "$CONTAINER_ID" 2>/dev/null
|
||||
}
|
||||
|
||||
get_database_name() {
|
||||
declare desc="Retrieves a sanitized database name"
|
||||
declare desc="retrieve a sanitized database name"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
|
||||
@@ -31,7 +43,7 @@ get_database_name() {
|
||||
}
|
||||
|
||||
get_random_ports() {
|
||||
declare desc="Retrieves N random ports"
|
||||
declare desc="retrieve N random ports"
|
||||
declare iterations="${1:-1}"
|
||||
for ((i = 0; i < iterations; i++)); do
|
||||
local port=$RANDOM
|
||||
@@ -50,19 +62,28 @@ get_random_ports() {
|
||||
}
|
||||
|
||||
get_service_name() {
|
||||
declare desc="Retrieves a docker service label"
|
||||
declare desc="retrieve a docker service label"
|
||||
declare SERVICE="$1"
|
||||
echo "dokku.${PLUGIN_COMMAND_PREFIX}.$SERVICE"
|
||||
}
|
||||
|
||||
get_url_from_config() {
|
||||
declare desc="Retrieves a given _URL from a list of configuration variables"
|
||||
declare desc="retrieve a given _URL from a list of configuration variables"
|
||||
declare EXISTING_CONFIG="$1" CONFIG_VAR="$2"
|
||||
echo "$EXISTING_CONFIG" | grep "$CONFIG_VAR" | sed "s/$CONFIG_VAR:\s*//" | xargs
|
||||
}
|
||||
|
||||
in_links_file() {
|
||||
declare desc="check if a service LINKS file contains an app"
|
||||
declare SERVICE="$1" APP="$2"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local LINKS_FILE="$SERVICE_ROOT/LINKS"
|
||||
|
||||
grep -qE "^$APP\$" "$LINKS_FILE"
|
||||
}
|
||||
|
||||
is_container_status() {
|
||||
declare desc="Returns 0 or 1 depending upon whether a given container has a certain status"
|
||||
declare desc="return 0 or 1 depending upon whether a given container has a certain status"
|
||||
declare CID="$1" STATUS="$2"
|
||||
local TEMPLATE="{{.State.$STATUS}}"
|
||||
local CONTAINER_STATUS=$(docker inspect -f "$TEMPLATE" "$CID" 2>/dev/null || true)
|
||||
@@ -90,7 +111,7 @@ is_implemented_command() {
|
||||
}
|
||||
|
||||
is_valid_service_name() {
|
||||
declare desc="Validates a service name"
|
||||
declare desc="validate a service name"
|
||||
declare SERVICE="$1"
|
||||
[[ -z "$SERVICE" ]] && return 1
|
||||
|
||||
@@ -102,7 +123,7 @@ is_valid_service_name() {
|
||||
}
|
||||
|
||||
remove_from_links_file() {
|
||||
declare desc="Removes an app from the service link file"
|
||||
declare desc="remove an app from the service link file"
|
||||
declare SERVICE="$1" APP="$2"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local LINKS_FILE="$SERVICE_ROOT/LINKS"
|
||||
@@ -120,7 +141,7 @@ retry-docker-command() {
|
||||
local i=0 success=false
|
||||
until [ $i -ge 100 ]; do
|
||||
set +e
|
||||
docker exec -it "$ID" sh -c "$COMMAND" 2>/dev/null
|
||||
suppress_output docker exec "$ID" sh -c "$COMMAND"
|
||||
exit_code=$?
|
||||
set -e
|
||||
if [[ "$exit_code" == 0 ]]; then
|
||||
@@ -137,7 +158,7 @@ retry-docker-command() {
|
||||
}
|
||||
|
||||
service_alternative_alias() {
|
||||
declare desc="Retrieves an alternative alias for a service"
|
||||
declare desc="retrieve an alternative alias for a service"
|
||||
declare EXISTING_CONFIG="$1"
|
||||
local COLORS=(AQUA BLACK BLUE FUCHSIA GRAY GREEN LIME MAROON NAVY OLIVE PURPLE RED SILVER TEAL WHITE YELLOW)
|
||||
local ALIAS
|
||||
@@ -154,7 +175,7 @@ service_alternative_alias() {
|
||||
}
|
||||
|
||||
service_app_links() {
|
||||
declare desc="Outputs all service links for a given app"
|
||||
declare desc="output all service links for a given app"
|
||||
declare APP="$1"
|
||||
local SERVICE LINKED_APP
|
||||
|
||||
@@ -170,7 +191,7 @@ service_app_links() {
|
||||
}
|
||||
|
||||
service_backup() {
|
||||
declare desc="Creates a backup of a service to an existing s3 bucket"
|
||||
declare desc="create a backup of a service to an existing s3 bucket"
|
||||
declare SERVICE="$1" BUCKET_NAME="$2" USE_IAM_OPTIONAL_FLAG="$3"
|
||||
local SERVICE_BACKUP_ROOT="$PLUGIN_DATA_ROOT/$SERVICE/backup"
|
||||
local BACKUP_ENCRYPTION_CONFIG_ROOT="$PLUGIN_DATA_ROOT/$SERVICE/backup-encryption"
|
||||
@@ -188,18 +209,18 @@ service_backup() {
|
||||
dokku_log_fail "Provide AWS credentials or use the --use-iam flag"
|
||||
fi
|
||||
|
||||
TMPDIR=$(mktemp -d)
|
||||
trap 'rm -rf "$TMPDIR" > /dev/null' RETURN INT TERM EXIT
|
||||
BACKUP_TMPDIR=$(mktemp -d --tmpdir)
|
||||
trap 'rm -rf "$BACKUP_TMPDIR" > /dev/null' RETURN INT TERM EXIT
|
||||
|
||||
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"
|
||||
|
||||
(service_export "$SERVICE" >"${TMPDIR}/export")
|
||||
(service_export "$SERVICE" >"${BACKUP_TMPDIR}/export")
|
||||
|
||||
# Build parameter list for s3backup tool
|
||||
BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e BUCKET_NAME=$BUCKET_NAME"
|
||||
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
|
||||
BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e AWS_DEFAULT_REGION=$(cat "$SERVICE_BACKUP_ROOT/AWS_DEFAULT_REGION")"
|
||||
@@ -221,8 +242,48 @@ service_backup() {
|
||||
docker run --rm $BACKUP_PARAMETERS "$PLUGIN_S3BACKUP_IMAGE"
|
||||
}
|
||||
|
||||
service_commit_config() {
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local CONFIG_VARIABLE="${PLUGIN_VARIABLE}_CONFIG_OPTIONS"
|
||||
local ENV_VARIABLE="${PLUGIN_VARIABLE}_CUSTOM_ENV"
|
||||
|
||||
|
||||
custom_env="${!ENV_VARIABLE}"
|
||||
[[ -n "$SERVICE_CUSTOM_ENV" ]] && custom_env="$SERVICE_CUSTOM_ENV"
|
||||
if [[ -n $custom_env ]]; then
|
||||
echo "$custom_env" | tr ';' "\n" >"$SERVICE_ROOT/ENV"
|
||||
else
|
||||
echo "" >"$SERVICE_ROOT/ENV"
|
||||
fi
|
||||
|
||||
config_options="${!CONFIG_VARIABLE}"
|
||||
[[ -n "$PLUGIN_CONFIG_OPTIONS" ]] && config_options="$PLUGIN_CONFIG_OPTIONS"
|
||||
if [[ -n "$config_options" ]]; then
|
||||
echo "$config_options" >"$SERVICE_ROOT/CONFIG_OPTIONS"
|
||||
else
|
||||
echo "" >"$SERVICE_ROOT/CONFIG_OPTIONS"
|
||||
fi
|
||||
|
||||
if [[ -n "$SERVICE_MEMORY" ]]; then
|
||||
echo "$SERVICE_MEMORY" >"$SERVICE_ROOT/SERVICE_MEMORY"
|
||||
fi
|
||||
|
||||
if [[ -n "$SERVICE_SHM_SIZE" ]]; then
|
||||
echo "$SERVICE_SHM_SIZE" >"$SERVICE_ROOT/SHM_SIZE"
|
||||
fi
|
||||
|
||||
if [[ -n "$PLUGIN_IMAGE" ]]; then
|
||||
echo "$PLUGIN_IMAGE" >"$SERVICE_ROOT/IMAGE"
|
||||
fi
|
||||
|
||||
if [[ -n "$PLUGIN_IMAGE_VERSION" ]]; then
|
||||
echo "$PLUGIN_IMAGE_VERSION" >"$SERVICE_ROOT/IMAGE_VERSION"
|
||||
fi
|
||||
}
|
||||
|
||||
service_backup_auth() {
|
||||
declare desc="Sets up authentication"
|
||||
declare desc="set up authentication"
|
||||
declare SERVICE="$1" AWS_ACCESS_KEY_ID="$2" AWS_SECRET_ACCESS_KEY="$3" AWS_DEFAULT_REGION="$4" AWS_SIGNATURE_VERSION="$5" ENDPOINT_URL="$6"
|
||||
local SERVICE_BACKUP_ROOT="$PLUGIN_DATA_ROOT/$SERVICE/backup"
|
||||
|
||||
@@ -244,7 +305,7 @@ service_backup_auth() {
|
||||
}
|
||||
|
||||
service_backup_deauth() {
|
||||
declare desc="Removes authentication"
|
||||
declare desc="remove authentication"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_ROOT="${PLUGIN_DATA_ROOT}/${SERVICE}"
|
||||
local SERVICE_BACKUP_ROOT="${SERVICE_ROOT}/backup/"
|
||||
@@ -282,7 +343,7 @@ service_backup_schedule_cat() {
|
||||
}
|
||||
|
||||
service_backup_set_encryption() {
|
||||
declare desc="Sets up backup encryption"
|
||||
declare desc="set up backup encryption"
|
||||
declare SERVICE="$1" ENCRYPTION_KEY="$2"
|
||||
local SERVICE_ROOT="${PLUGIN_DATA_ROOT}/${SERVICE}"
|
||||
local SERVICE_BACKUP_ENCRYPTION_ROOT="${SERVICE_ROOT}/backup-encryption/"
|
||||
@@ -292,7 +353,7 @@ service_backup_set_encryption() {
|
||||
}
|
||||
|
||||
service_backup_unschedule() {
|
||||
declare desc="unschedules the backup of the service"
|
||||
declare desc="unschedule the backup of the service"
|
||||
declare SERVICE="$1"
|
||||
local CRON_FILE="/etc/cron.d/dokku-${PLUGIN_COMMAND_PREFIX}-${SERVICE}"
|
||||
|
||||
@@ -300,7 +361,7 @@ service_backup_unschedule() {
|
||||
}
|
||||
|
||||
service_backup_unset_encryption() {
|
||||
declare desc="Removes backup encryption"
|
||||
declare desc="remove backup encryption"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_ROOT="${PLUGIN_DATA_ROOT}/${SERVICE}"
|
||||
local SERVICE_BACKUP_ENCRYPTION_ROOT="${SERVICE_ROOT}/backup-encryption/"
|
||||
@@ -309,7 +370,7 @@ service_backup_unset_encryption() {
|
||||
}
|
||||
|
||||
service_container_rm() {
|
||||
declare desc="Stops a service and removes the running container"
|
||||
declare desc="stop a service and remove the running container"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||
local ID
|
||||
@@ -329,14 +390,14 @@ service_container_rm() {
|
||||
}
|
||||
|
||||
service_dns_hostname() {
|
||||
declare desc="Retrieves the alias of a service"
|
||||
declare desc="retrieve the alias of a service"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||
echo "$SERVICE_NAME" | tr ._ -
|
||||
}
|
||||
|
||||
service_enter() {
|
||||
declare desc="enters running app container of specified proc type"
|
||||
declare desc="enter running app container of specified proc type"
|
||||
declare SERVICE="$1" && shift 1
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local ID="$(cat "$SERVICE_ROOT/ID")"
|
||||
@@ -351,7 +412,7 @@ service_enter() {
|
||||
}
|
||||
|
||||
service_exposed_ports() {
|
||||
declare desc="Lists exposed ports for a service"
|
||||
declare desc="list exposed ports for a service"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local PORT_FILE="$SERVICE_ROOT/PORT"
|
||||
@@ -363,8 +424,14 @@ service_exposed_ports() {
|
||||
}
|
||||
|
||||
service_image_exists() {
|
||||
declare desc="Checks if the current image exists"
|
||||
local IMAGE="$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION"
|
||||
declare desc="check if the current image exists"
|
||||
declare SERVICE="$1"
|
||||
local plugin_image="$PLUGIN_IMAGE"
|
||||
local plugin_image_version="$PLUGIN_IMAGE_VERSION"
|
||||
|
||||
[[ -f "$SERVICE_ROOT/IMAGE" ]] && plugin_image="$(cat "$SERVICE_ROOT/IMAGE")"
|
||||
[[ -f "$SERVICE_ROOT/IMAGE_VERSION" ]] && plugin_image_version="$(cat "$SERVICE_ROOT/IMAGE_VERSION")"
|
||||
local IMAGE="$plugin_image:$plugin_image_version"
|
||||
|
||||
if [[ "$(docker images -q "$IMAGE" 2>/dev/null)" == "" ]]; then
|
||||
return 1
|
||||
@@ -374,7 +441,7 @@ service_image_exists() {
|
||||
}
|
||||
|
||||
service_info() {
|
||||
declare desc="Retrieves information about a given service"
|
||||
declare desc="retrieve information about a given service"
|
||||
declare SERVICE="$1" INFO_FLAG="$2"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local SERVICE_URL=$(service_url "$SERVICE")
|
||||
@@ -383,7 +450,8 @@ service_info() {
|
||||
local flag key valid_flags
|
||||
|
||||
local flag_map=(
|
||||
"--config-dir: ${SERVICE_ROOT}/config"
|
||||
"--config-dir: ${SERVICE_ROOT}/${PLUGIN_CONFIG_SUFFIX}"
|
||||
"--config-options: $(cat "$SERVICE_ROOT/CONFIG_OPTIONS" 2>/dev/null || true)"
|
||||
"--data-dir: ${SERVICE_ROOT}/data"
|
||||
"--dsn: ${SERVICE_URL}"
|
||||
"--exposed-ports: $(service_exposed_ports "$SERVICE")"
|
||||
@@ -395,7 +463,7 @@ service_info() {
|
||||
"--version: $(service_version "$SERVICE")"
|
||||
)
|
||||
if [[ -z "$INFO_FLAG" ]]; then
|
||||
dokku_log_info2 "$SERVICE $PLUGIN_COMMAND_PREFIX service information"
|
||||
dokku_log_info2_quiet "$SERVICE $PLUGIN_COMMAND_PREFIX service information"
|
||||
for flag in "${flag_map[@]}"; do
|
||||
key="$(echo "${flag#--}" | cut -f1 -d' ' | tr - ' ')"
|
||||
dokku_log_verbose "$(printf "%-20s %-25s" "${key^}" "${flag#*: }")"
|
||||
@@ -413,7 +481,7 @@ service_info() {
|
||||
}
|
||||
|
||||
service_is_linked() {
|
||||
declare desc="Links a service to an application"
|
||||
declare desc="link a service to an application"
|
||||
declare SERVICE="$1" APP="$2"
|
||||
update_plugin_scheme_for_app "$APP"
|
||||
local SERVICE_URL=$(service_url "$SERVICE")
|
||||
@@ -427,7 +495,7 @@ service_is_linked() {
|
||||
}
|
||||
|
||||
service_link() {
|
||||
declare desc="Links a service to an application"
|
||||
declare desc="link a service to an application"
|
||||
declare SERVICE="$1" APP="$2"
|
||||
update_plugin_scheme_for_app "$APP"
|
||||
local SERVICE_URL=$(service_url "$SERVICE")
|
||||
@@ -453,9 +521,8 @@ service_link() {
|
||||
fi
|
||||
|
||||
[[ -n $LINK ]] && dokku_log_fail "Already linked as $LINK"
|
||||
touch "$LINKS_FILE"
|
||||
echo "$APP" >>"$LINKS_FILE"
|
||||
sort "$LINKS_FILE" -u -o "$LINKS_FILE"
|
||||
plugn trigger service-action pre-link "$SERVICE" "$APP"
|
||||
add_to_links_file "$SERVICE" "$APP"
|
||||
|
||||
if declare -f -F add_passed_docker_option >/dev/null; then
|
||||
# shellcheck disable=SC2034
|
||||
@@ -465,11 +532,13 @@ service_link() {
|
||||
dokku docker-options:add "$APP" build,deploy,run "--link $SERVICE_NAME:$SERVICE_DNS_HOSTNAME"
|
||||
fi
|
||||
[[ -n "$SERVICE_QUERYSTRING" ]] && SERVICE_URL="${SERVICE_URL}?${SERVICE_QUERYSTRING}"
|
||||
plugn trigger service-action post-link "$SERVICE" "$APP"
|
||||
config_set "$APP" "${ALIAS}_URL=$SERVICE_URL"
|
||||
plugn trigger service-action post-link-complete "$SERVICE" "$APP"
|
||||
}
|
||||
|
||||
service_linked_apps() {
|
||||
declare desc="Lists all apps linked to a service for info output"
|
||||
declare desc="list all apps linked to a service for info output"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local LINKS_FILE="$SERVICE_ROOT/LINKS"
|
||||
@@ -481,7 +550,7 @@ service_linked_apps() {
|
||||
}
|
||||
|
||||
service_links() {
|
||||
declare desc="Lists all apps linked to a service"
|
||||
declare desc="list all apps linked to a service"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local LINKS_FILE="$SERVICE_ROOT/LINKS"
|
||||
@@ -493,7 +562,7 @@ service_links() {
|
||||
}
|
||||
|
||||
service_list() {
|
||||
declare desc="Lists all services and their status"
|
||||
declare desc="list all services and their status"
|
||||
local SERVICES=$(ls "$PLUGIN_DATA_ROOT" 2>/dev/null)
|
||||
|
||||
if [[ -z $SERVICES ]]; then
|
||||
@@ -508,15 +577,15 @@ service_list() {
|
||||
}
|
||||
|
||||
service_logs() {
|
||||
declare desc="Displays logs for a service"
|
||||
declare SERVICE="$1" TAIL_FLAG="$2"
|
||||
declare desc="display logs for a service"
|
||||
declare SERVICE="$1" TAIL_FLAG="$2" TAIL_COUNT="$3"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local ID=$(cat "$SERVICE_ROOT/ID")
|
||||
local RE_INTEGER='^[0-9]+$'
|
||||
|
||||
DOKKU_LOGS_ARGS="--tail 100"
|
||||
DOKKU_LOGS_ARGS="--tail $TAIL_COUNT"
|
||||
if [[ "$TAIL_FLAG" == "-t" ]] || [[ "$TAIL_FLAG" == "--tail" ]]; then
|
||||
DOKKU_LOGS_ARGS="--follow"
|
||||
DOKKU_LOGS_ARGS+=" --follow"
|
||||
fi
|
||||
|
||||
docker inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist"
|
||||
@@ -546,13 +615,14 @@ service_parse_args() {
|
||||
"--querystring") set -- "$@" "-q" ;;
|
||||
"--restart-apps") set -- "$@" "-R" ;;
|
||||
"--root-password") set -- "$@" "-r" ;;
|
||||
"--shm-size") set -- "$@" "-s" ;;
|
||||
"--user") set -- "$@" "-u" ;;
|
||||
*) set -- "$@" "$arg" ;;
|
||||
esac
|
||||
done
|
||||
|
||||
OPTIND=1
|
||||
while getopts "a:c:C:d:i:I:m:p:q:R:r:u:" opt; do
|
||||
while getopts "a:c:C:d:i:I:m:p:q:R:r:s:u:" opt; do
|
||||
case "$opt" in
|
||||
a)
|
||||
SERVICE_ALIAS="${OPTARG^^}"
|
||||
@@ -588,6 +658,9 @@ service_parse_args() {
|
||||
r)
|
||||
export SERVICE_ROOT_PASSWORD=$OPTARG
|
||||
;;
|
||||
s)
|
||||
export SERVICE_SHM_SIZE=$OPTARG
|
||||
;;
|
||||
u)
|
||||
export SERVICE_USER=$OPTARG
|
||||
;;
|
||||
@@ -597,7 +670,7 @@ service_parse_args() {
|
||||
}
|
||||
|
||||
service_password() {
|
||||
declare desc="Fetch the password for a service"
|
||||
declare desc="fetch the password for a service"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local PASSWORD_FILE="$SERVICE_ROOT/PASSWORD"
|
||||
@@ -607,7 +680,7 @@ service_password() {
|
||||
}
|
||||
|
||||
service_root_password() {
|
||||
declare desc="Fetch the root password for a service"
|
||||
declare desc="fetch the root password for a service"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local PASSWORD_FILE="$SERVICE_ROOT/ROOTPASSWORD"
|
||||
@@ -617,14 +690,14 @@ service_root_password() {
|
||||
}
|
||||
|
||||
service_port_expose() {
|
||||
declare desc="Wrapper for exposing service ports"
|
||||
declare desc="wrapper for exposing service ports"
|
||||
declare SERVICE="$1"
|
||||
service_start "$SERVICE" "true"
|
||||
service_port_unpause "$SERVICE" "true" "${@:2}"
|
||||
}
|
||||
|
||||
service_port_pause() {
|
||||
declare desc="Pauses service exposure"
|
||||
declare desc="pause service exposure"
|
||||
declare SERVICE="$1" LOG_FAIL="$2"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local EXPOSED_NAME="$(get_service_name "$SERVICE").ambassador"
|
||||
@@ -654,7 +727,7 @@ service_port_pause() {
|
||||
}
|
||||
|
||||
service_port_unexpose() {
|
||||
declare desc="Wrapper for pausing exposed service ports"
|
||||
declare desc="wrapper for pausing exposed service ports"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local PORT_FILE="$SERVICE_ROOT/PORT"
|
||||
@@ -663,7 +736,7 @@ service_port_unexpose() {
|
||||
}
|
||||
|
||||
service_port_unpause() {
|
||||
declare desc="Starts service exposure"
|
||||
declare desc="start service exposure"
|
||||
declare SERVICE="$1" LOG_FAIL="$2"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||
@@ -694,7 +767,7 @@ service_port_unpause() {
|
||||
}
|
||||
|
||||
service_promote() {
|
||||
declare desc="Promotes a secondary service to the primary env var"
|
||||
declare desc="promote a secondary service to the primary env var"
|
||||
declare SERVICE="$1" APP="$2"
|
||||
local PLUGIN_DEFAULT_CONFIG_VAR="${PLUGIN_DEFAULT_ALIAS}_URL"
|
||||
local EXISTING_CONFIG=$(config_all "$APP")
|
||||
@@ -722,7 +795,7 @@ service_promote() {
|
||||
}
|
||||
|
||||
service_set_alias() {
|
||||
declare desc="Sets the alias in use for a service"
|
||||
declare desc="sets the alias in use for a service"
|
||||
declare SERVICE="$1" ALIAS="$2"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local ALIAS_FILE="$SERVICE_ROOT/ALIAS"
|
||||
@@ -732,7 +805,7 @@ service_set_alias() {
|
||||
}
|
||||
|
||||
service_status() {
|
||||
declare desc="Displays the status of a service"
|
||||
declare desc="display the status of a service"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local ID="$(cat "$SERVICE_ROOT/ID")"
|
||||
@@ -744,7 +817,7 @@ service_status() {
|
||||
}
|
||||
|
||||
service_stop() {
|
||||
declare desc="Stops a running service"
|
||||
declare desc="stop a running service"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||
@@ -762,7 +835,7 @@ service_stop() {
|
||||
}
|
||||
|
||||
service_unlink() {
|
||||
declare desc="Unlinks an application from a service"
|
||||
declare desc="unlink an application from a service"
|
||||
declare SERVICE="$1" APP="$2"
|
||||
update_plugin_scheme_for_app "$APP"
|
||||
local SERVICE_URL=$(service_url "$SERVICE")
|
||||
@@ -771,6 +844,7 @@ service_unlink() {
|
||||
local SERVICE_DNS_HOSTNAME=$(service_dns_hostname "$SERVICE")
|
||||
local LINK=($(echo "$EXISTING_CONFIG" | grep "$SERVICE_URL" | cut -d: -f1)) || true
|
||||
|
||||
plugn trigger service-action pre-unlink "$SERVICE" "$APP"
|
||||
remove_from_links_file "$SERVICE" "$APP"
|
||||
|
||||
if declare -f -F add_passed_docker_option >/dev/null; then
|
||||
@@ -782,18 +856,20 @@ service_unlink() {
|
||||
fi
|
||||
|
||||
[[ -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() {
|
||||
declare desc="Displays the running version for an image"
|
||||
declare desc="display the running version for an image"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||
docker inspect -f '{{.Config.Image}}' "$SERVICE_NAME" 2>/dev/null || true
|
||||
}
|
||||
|
||||
update_plugin_scheme_for_app() {
|
||||
declare desc="Retrieves the updated plugin scheme"
|
||||
declare desc="retrieve the updated plugin scheme"
|
||||
declare APP="$1"
|
||||
local DATABASE_SCHEME
|
||||
|
||||
@@ -802,7 +878,7 @@ update_plugin_scheme_for_app() {
|
||||
}
|
||||
|
||||
verify_service_name() {
|
||||
declare desc="Verifies that a service exists"
|
||||
declare desc="verify that a service exists"
|
||||
declare SERVICE="$1"
|
||||
[[ -z "$SERVICE" ]] && dokku_log_fail "(verify_service_name) SERVICE must not be null"
|
||||
[[ ! -d "$PLUGIN_DATA_ROOT/$SERVICE" ]] && dokku_log_fail "$PLUGIN_SERVICE service $SERVICE does not exist"
|
||||
@@ -810,7 +886,7 @@ verify_service_name() {
|
||||
}
|
||||
|
||||
write_database_name() {
|
||||
declare desc="Writes a sanitized database name"
|
||||
declare desc="write a sanitized database name"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
|
||||
|
||||
10
config
10
config
@@ -1,6 +1,7 @@
|
||||
#!/usr/bin/env bash
|
||||
export MONGO_IMAGE=${MONGO_IMAGE:="mongo"}
|
||||
export MONGO_IMAGE_VERSION=${MONGO_IMAGE_VERSION:="3.6.15"}
|
||||
_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
export MONGO_IMAGE=${MONGO_IMAGE:="$(awk -F '[ :]' '{print $2}' "${_DIR}/Dockerfile")"}
|
||||
export MONGO_IMAGE_VERSION=${MONGO_IMAGE_VERSION:="$(awk -F '[ :]' '{print $3}' "${_DIR}/Dockerfile")"}
|
||||
export MONGO_ROOT=${MONGO_ROOT:="$DOKKU_LIB_ROOT/services/mongo"}
|
||||
export MONGO_HOST_ROOT=${MONGO_HOST_ROOT:=$MONGO_ROOT}
|
||||
|
||||
@@ -21,13 +22,14 @@ export PLUGIN_SCHEME="mongodb"
|
||||
export PLUGIN_SERVICE="MongoDB"
|
||||
export PLUGIN_VARIABLE="MONGO"
|
||||
export PLUGIN_BASE_PATH="$PLUGIN_PATH"
|
||||
export PLUGIN_CONFIG_SUFFIX="config"
|
||||
if [[ -n $DOKKU_API_VERSION ]]; then
|
||||
export PLUGIN_BASE_PATH="$PLUGIN_ENABLED_PATH"
|
||||
fi
|
||||
|
||||
export MONGO_CONFIG_OPTIONS=${MONGO_CONFIG_OPTIONS:=" --storageEngine wiredTiger --auth "}
|
||||
|
||||
export PLUGIN_BUSYBOX_IMAGE="busybox:1.31.1-uclibc"
|
||||
export PLUGIN_AMBASSADOR_IMAGE="dokku/ambassador:0.3.3"
|
||||
export PLUGIN_S3BACKUP_IMAGE="dokku/s3backup:0.10.3"
|
||||
export PLUGIN_WAIT_IMAGE="dokku/wait:0.4.3"
|
||||
|
||||
export MONGO_CONFIG_OPTIONS=${MONGO_CONFIG_OPTIONS:=" --storageEngine wiredTiger --auth "}
|
||||
|
||||
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.
|
||||
|
||||
49
functions
49
functions
@@ -18,7 +18,7 @@ service_connect() {
|
||||
local SERVICE_TTY_OPTS
|
||||
has_tty && SERVICE_TTY_OPTS="-t"
|
||||
|
||||
docker exec -i $SERVICE_TTY_OPTS "$SERVICE_NAME" mongo -u "$SERVICE" -p "$PASSWORD" --authenticationDatabase "$DATABASE_NAME" "$DATABASE_NAME"
|
||||
docker exec --env=LANG=C.UTF-8 --env=LC_ALL=C.UTF-8 -i $SERVICE_TTY_OPTS "$SERVICE_NAME" mongo -u "$SERVICE" -p "$PASSWORD" --authenticationDatabase "$DATABASE_NAME" "$DATABASE_NAME"
|
||||
}
|
||||
|
||||
service_create() {
|
||||
@@ -41,9 +41,10 @@ service_create() {
|
||||
docker pull "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" || dokku_log_fail "$PLUGIN_SERVICE image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION pull failed"
|
||||
fi
|
||||
|
||||
plugn trigger service-action pre-create "$SERVICE"
|
||||
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/config" || dokku_log_fail "Unable to create service config directory"
|
||||
mkdir -p "$SERVICE_ROOT/$PLUGIN_CONFIG_SUFFIX" || dokku_log_fail "Unable to create service config directory"
|
||||
touch "$LINKS_FILE"
|
||||
|
||||
ROOTPASSWORD=$(openssl rand -hex 16)
|
||||
@@ -60,22 +61,11 @@ service_create() {
|
||||
echo "$PASSWORD" >"$SERVICE_ROOT/PASSWORD"
|
||||
chmod 640 "$SERVICE_ROOT/ROOTPASSWORD" "$SERVICE_ROOT/PASSWORD"
|
||||
|
||||
[[ -n "$SERVICE_CUSTOM_ENV" ]] && MONGO_CUSTOM_ENV="$SERVICE_CUSTOM_ENV"
|
||||
if [[ -n $MONGO_CUSTOM_ENV ]]; then
|
||||
echo "$MONGO_CUSTOM_ENV" | tr ';' "\n" >"$SERVICE_ROOT/ENV"
|
||||
else
|
||||
echo "" >"$SERVICE_ROOT/ENV"
|
||||
fi
|
||||
|
||||
[[ -n "$PLUGIN_CONFIG_OPTIONS" ]] && MONGO_CONFIG_OPTIONS="$PLUGIN_CONFIG_OPTIONS"
|
||||
if [[ -n "$MONGO_CONFIG_OPTIONS" ]]; then
|
||||
echo "$MONGO_CONFIG_OPTIONS" >"$SERVICE_ROOT/MONGO_CONFIG_OPTIONS"
|
||||
else
|
||||
echo "" >"$SERVICE_ROOT/MONGO_CONFIG_OPTIONS"
|
||||
fi
|
||||
|
||||
service_commit_config "$SERVICE"
|
||||
write_database_name "$SERVICE"
|
||||
plugn trigger service-action post-create "$SERVICE"
|
||||
service_create_container "$SERVICE"
|
||||
plugn trigger service-action post-create-complete "$SERVICE"
|
||||
}
|
||||
|
||||
service_create_container() {
|
||||
@@ -87,12 +77,25 @@ service_create_container() {
|
||||
local PASSWORD="$(service_password "$SERVICE")"
|
||||
local DATABASE_NAME="$(get_database_name "$SERVICE")"
|
||||
|
||||
if [[ -f "$SERVICE_ROOT/MONGO_CONFIG_OPTIONS" ]]; then
|
||||
export MONGO_CONFIG_OPTIONS="$(cat "$SERVICE_ROOT/MONGO_CONFIG_OPTIONS")"
|
||||
if [[ -f "$SERVICE_ROOT/CONFIG_OPTIONS" ]]; then
|
||||
export CONFIG_OPTIONS="$(cat "$SERVICE_ROOT/CONFIG_OPTIONS")"
|
||||
fi
|
||||
|
||||
[[ -f "$SERVICE_ROOT/SERVICE_MEMORY" ]] && SERVICE_MEMORY="$(cat "$SERVICE_ROOT/SERVICE_MEMORY")"
|
||||
if [[ -n "$SERVICE_MEMORY" ]]; then
|
||||
MEMORY_LIMIT="--memory=${SERVICE_MEMORY}m"
|
||||
fi
|
||||
|
||||
[[ -f "$SERVICE_ROOT/SHM_SIZE" ]] && SERVICE_SHM_SIZE="$(cat "$SERVICE_ROOT/SHM_SIZE")"
|
||||
if [[ -n "$SERVICE_SHM_SIZE" ]]; then
|
||||
SHM_SIZE="--shm-size=${SERVICE_SHM_SIZE}"
|
||||
fi
|
||||
|
||||
[[ -f "$SERVICE_ROOT/IMAGE" ]] && PLUGIN_IMAGE="$(cat "$SERVICE_ROOT/IMAGE")"
|
||||
[[ -f "$SERVICE_ROOT/IMAGE_VERSION" ]] && PLUGIN_IMAGE_VERSION="$(cat "$SERVICE_ROOT/IMAGE_VERSION")"
|
||||
|
||||
# shellcheck disable=SC2086
|
||||
ID=$(docker run --name "$SERVICE_NAME" -v "$SERVICE_HOST_ROOT/data:/data/db" --env-file="$SERVICE_ROOT/ENV" --env "MONGO_INITDB_DATABASE=$DATABASE_NAME" -d --restart always --label dokku=service --label dokku.service=mongo "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" mongod $MONGO_CONFIG_OPTIONS)
|
||||
ID=$(docker run --name "$SERVICE_NAME" $MEMORY_LIMIT $SHM_SIZE -v "$SERVICE_HOST_ROOT/data:/data/db" --env-file="$SERVICE_ROOT/ENV" --env "MONGO_INITDB_DATABASE=$DATABASE_NAME" -d --restart always --label dokku=service --label dokku.service=mongo "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" mongod $CONFIG_OPTIONS)
|
||||
echo "$ID" >"$SERVICE_ROOT/ID"
|
||||
|
||||
dokku_log_verbose_quiet "Waiting for container to be ready"
|
||||
@@ -159,7 +162,13 @@ service_start() {
|
||||
elif service_image_exists "$SERVICE" && [[ -n "$ROOTPASSWORD" ]] && [[ -n "$PASSWORD" ]]; then
|
||||
service_create_container "$SERVICE"
|
||||
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
|
||||
}
|
||||
|
||||
|
||||
@@ -76,10 +76,10 @@ fn-help-contents() {
|
||||
|
||||
fn-help-contents-subcommand() {
|
||||
declare SUBCOMMAND="$1" FULL_OUTPUT="$2"
|
||||
local TMPDIR=$(mktemp -d)
|
||||
local UNCLEAN_FILE="${TMPDIR}/cmd-unclean" CLEAN_FILE="${TMPDIR}/cmd-clean"
|
||||
local HELP_TMPDIR=$(mktemp -d --tmpdir)
|
||||
local UNCLEAN_FILE="${HELP_TMPDIR}/cmd-unclean" CLEAN_FILE="${HELP_TMPDIR}/cmd-clean"
|
||||
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"
|
||||
cat "$SUBCOMMAND_ROOT/$SUBCOMMAND" >"$UNCLEAN_FILE"
|
||||
@@ -141,7 +141,7 @@ fn-help-contents-subcommand() {
|
||||
}
|
||||
|
||||
fn-help-fancy-tput() {
|
||||
declare desc="A wrapper around tput"
|
||||
declare desc="a wrapper around tput"
|
||||
|
||||
if [[ -n "$DOKKU_NO_COLOR" ]] || [[ "$TERM" == "unknown" ]] || [[ "$TERM" == "dumb" ]]; then
|
||||
return
|
||||
@@ -151,7 +151,7 @@ fn-help-fancy-tput() {
|
||||
}
|
||||
|
||||
fn-help-fancy-color() {
|
||||
declare desc="A wrapper around colors"
|
||||
declare desc="a wrapper around colors"
|
||||
|
||||
if [[ -n "$DOKKU_NO_COLOR" ]] || [[ "$TERM" == "unknown" ]] || [[ "$TERM" == "dumb" ]]; then
|
||||
return
|
||||
@@ -164,8 +164,8 @@ fn-help-list-example() {
|
||||
# shellcheck disable=SC2034
|
||||
declare desc="return $PLUGIN_COMMAND_PREFIX plugin help content"
|
||||
cat <<help_list
|
||||
NAME, VERSION, STATUS, EXPOSED PORTS, LINKS
|
||||
service-name, $PLUGIN_COMMAND_PREFIX:$PLUGIN_IMAGE_VERSION, running, -, app-name
|
||||
$PLUGIN_SERVICE services
|
||||
service-name
|
||||
help_list
|
||||
}
|
||||
|
||||
@@ -202,6 +202,9 @@ fn-help-subcommand-args() {
|
||||
elif [[ "$arg" == *_LIST ]]; then
|
||||
arg=${arg%_*}
|
||||
args+=" <${arg//_/-}...>"
|
||||
elif [[ "$arg" == *_OPTIONAL ]]; then
|
||||
argName="${arg/_OPTIONAL/}"
|
||||
args+=" [<${argName//_/-}>]"
|
||||
else
|
||||
args+=" <${arg//_/-}>"
|
||||
fi
|
||||
@@ -309,7 +312,7 @@ fn-help-subcommand-sanitize() {
|
||||
}
|
||||
|
||||
_fn-help-apply-shell-expansion() {
|
||||
declare desc="Expand environment variables for a shell command"
|
||||
declare desc="expand environment variables for a shell command"
|
||||
declare data="$1"
|
||||
declare delimiter="__apply_shell_expansion_delimiter__"
|
||||
declare command="cat <<$delimiter"$'\n'"$data"$'\n'"$delimiter"
|
||||
|
||||
18
install
18
install
@@ -1,5 +1,6 @@
|
||||
#!/usr/bin/env bash
|
||||
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
|
||||
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
|
||||
set -eo pipefail
|
||||
[[ $DOKKU_TRACE ]] && set -x
|
||||
|
||||
@@ -42,6 +43,23 @@ plugin-install() {
|
||||
EOL
|
||||
|
||||
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 "$@"
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[plugin]
|
||||
description = "dokku mongo service plugin"
|
||||
version = "1.11.2"
|
||||
version = "1.16.0"
|
||||
[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 "$@"
|
||||
36
pre-restore
Executable file
36
pre-restore
Executable file
@@ -0,0 +1,36 @@
|
||||
#!/usr/bin/env bash
|
||||
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
|
||||
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
|
||||
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/functions"
|
||||
set -eo pipefail
|
||||
[[ $DOKKU_TRACE ]] && set -x
|
||||
|
||||
plugin-pre-restore() {
|
||||
declare SCHEDULER="$1" APP="$2"
|
||||
|
||||
if [[ "$SCHEDULER" != "docker-local" ]]; then
|
||||
return
|
||||
fi
|
||||
|
||||
local SERVICES=$(ls "$PLUGIN_DATA_ROOT" 2>/dev/null)
|
||||
for SERVICE in $SERVICES; do
|
||||
if ! in_links_file "$SERVICE" "$APP"; then
|
||||
continue
|
||||
fi
|
||||
|
||||
local status="$(service_status "$SERVICE")"
|
||||
if [[ "$status" == "running" ]]; then
|
||||
continue
|
||||
fi
|
||||
|
||||
if [[ "$status" == "restarting" ]]; then
|
||||
dokku_log_warn "$PLUGIN_SERVICE service $SERVICE is restarting and may cause issues with linked app $APP"
|
||||
continue
|
||||
fi
|
||||
|
||||
dokku_log_warn "$PLUGIN_SERVICE service $SERVICE is not running, issuing service start"
|
||||
service_start "$SERVICE"
|
||||
done
|
||||
}
|
||||
|
||||
plugin-pre-restore "$@"
|
||||
32
pre-start
Executable file
32
pre-start
Executable file
@@ -0,0 +1,32 @@
|
||||
#!/usr/bin/env bash
|
||||
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
|
||||
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
|
||||
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/functions"
|
||||
set -eo pipefail
|
||||
[[ $DOKKU_TRACE ]] && set -x
|
||||
|
||||
plugin-pre-start() {
|
||||
declare APP="$1"
|
||||
|
||||
local SERVICES=$(ls "$PLUGIN_DATA_ROOT" 2>/dev/null)
|
||||
for SERVICE in $SERVICES; do
|
||||
if ! in_links_file "$SERVICE" "$APP"; then
|
||||
continue
|
||||
fi
|
||||
|
||||
local status="$(service_status "$SERVICE")"
|
||||
if [[ "$status" == "running" ]]; then
|
||||
continue
|
||||
fi
|
||||
|
||||
if [[ "$status" == "restarting" ]]; then
|
||||
dokku_log_warn "$PLUGIN_SERVICE service $SERVICE is restarting and may cause issues with linked app $APP"
|
||||
continue
|
||||
fi
|
||||
|
||||
dokku_log_warn "$PLUGIN_SERVICE service $SERVICE is not running, issuing service start"
|
||||
service_start "$SERVICE"
|
||||
done
|
||||
}
|
||||
|
||||
plugin-pre-start "$@"
|
||||
@@ -6,12 +6,14 @@ source "$PLUGIN_BASE_PATH/common/functions"
|
||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-backup-cmd() {
|
||||
#E backup the 'lolipop' service to the 'my-s3-bucket' bucket on AWS
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup lolipop my-s3-bucket --use-iam
|
||||
#E backup the 'lollipop' service to the 'my-s3-bucket' bucket on AWS
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup lollipop my-s3-bucket --use-iam
|
||||
#E restore a backup file (assuming it was extracted via 'tar -xf backup.tgz')
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:import lollipop < backup-folder/export
|
||||
#F -u|--use-iam, use the IAM profile associated with the current server
|
||||
#A service, service to run command against
|
||||
#A bucket-name, name of the s3 bucket to upload backups to
|
||||
declare desc="creates a backup of the $PLUGIN_SERVICE service to an existing s3 bucket"
|
||||
declare desc="create a backup of the $PLUGIN_SERVICE service to an existing s3 bucket"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:backup" argv=("$@")
|
||||
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||
declare SERVICE="$1" BUCKET_NAME="$2" USE_IAM_OPTIONAL_FLAG="$3"
|
||||
|
||||
@@ -7,20 +7,20 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-backup-auth-cmd() {
|
||||
#E setup s3 backup authentication
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
|
||||
#E setup s3 backup authentication with different region
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
|
||||
#E setup s3 backup authentication with different signature version and endpoint
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL
|
||||
#E more specific example for minio auth
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lollipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
|
||||
#A service, service to run command against
|
||||
#A access-key-id, an amazon AWS_ACCESS_KEY_ID
|
||||
#A aws-secret-access-key, an amazon AWS_SECRET_ACCESS_KEY
|
||||
#A aws-default-region, (optional) a valid amazon S3 region
|
||||
#A aws-signature-version, (optional) the AWS signature version to use when signing S3 requests
|
||||
#A endpoint-url, (optional) an aws endpoint to upload to
|
||||
declare desc="sets up authentication for backups on the $PLUGIN_SERVICE service"
|
||||
declare desc="set up authentication for backups on the $PLUGIN_SERVICE service"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:backup-auth" argv=("$@")
|
||||
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||
declare SERVICE="$1" AWS_ACCESS_KEY_ID="$2" AWS_SECRET_ACCESS_KEY="$3" AWS_DEFAULT_REGION="$4" AWS_SIGNATURE_VERSION="$5" ENDPOINT_URL="$6"
|
||||
|
||||
@@ -7,9 +7,9 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-backup-deauth-cmd() {
|
||||
#E remove s3 authentication
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-deauth lolipop
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-deauth lollipop
|
||||
#A service, service to run command against
|
||||
declare desc="removes backup authentication for the $PLUGIN_SERVICE service"
|
||||
declare desc="remove backup authentication for the $PLUGIN_SERVICE service"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:backup-deauth" argv=("$@")
|
||||
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||
declare SERVICE="$1"
|
||||
|
||||
@@ -8,14 +8,14 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
service-backup-schedule-cmd() {
|
||||
#E schedule a backup
|
||||
#E > 'schedule' is a crontab expression, eg. "0 3 * * *" for each day at 3am
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lolipop "0 3 * * *" my-s3-bucket
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lollipop "0 3 * * *" my-s3-bucket
|
||||
#E schedule a backup and authenticate via iam
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lolipop "0 3 * * *" my-s3-bucket --use-iam
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lollipop "0 3 * * *" my-s3-bucket --use-iam
|
||||
#F -u|--use-iam, use the IAM profile associated with the current server
|
||||
#A service, service to run command against
|
||||
#A schedule, a cron schedule to run backups on
|
||||
#A bucket-name, name of the s3 bucket to upload backups to
|
||||
declare desc="schedules a backup of the $PLUGIN_SERVICE service"
|
||||
declare desc="schedule a backup of the $PLUGIN_SERVICE service"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:backup-schedule" argv=("$@")
|
||||
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||
declare SERVICE="$1" SCHEDULE="$2" BUCKET_NAME="$3" USE_IAM_OPTIONAL_FLAG="$4"
|
||||
|
||||
@@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-backup-schedule-cat-cmd() {
|
||||
#E cat the contents of the configured backup cronfile for the service
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule-cat lolipop
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule-cat lollipop
|
||||
#A service, service to run command against
|
||||
declare desc="cat the contents of the configured backup cronfile for the service"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:backup-schedule-cat" argv=("$@")
|
||||
|
||||
@@ -6,11 +6,11 @@ source "$PLUGIN_BASE_PATH/common/functions"
|
||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-backup-set-encryption-cmd() {
|
||||
#E set a GPG passphrase for backups
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-set-encryption lolipop
|
||||
#E set the GPG-compatible passphrase for encrypting backups for backups
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-set-encryption lollipop
|
||||
#A service, service to run command against
|
||||
#A passphrase, a GPG-compatible passphrase
|
||||
declare desc="sets encryption for all future backups of $PLUGIN_SERVICE service"
|
||||
declare desc="set encryption for all future backups of $PLUGIN_SERVICE service"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:backup-set-encryption" argv=("$@")
|
||||
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||
declare SERVICE="$1" PASSPHRASE="$2"
|
||||
|
||||
@@ -7,9 +7,9 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-backup-unschedule-cmd() {
|
||||
#E remove the scheduled backup from cron
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-unschedule lolipop
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-unschedule lollipop
|
||||
#A service, service to run command against
|
||||
declare desc="unschedules the backup of the $PLUGIN_SERVICE service"
|
||||
declare desc="unschedule the backup of the $PLUGIN_SERVICE service"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:backup-unschedule" argv=("$@")
|
||||
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||
declare SERVICE="$1"
|
||||
|
||||
@@ -6,10 +6,10 @@ source "$PLUGIN_BASE_PATH/common/functions"
|
||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-backup-unset-encryption-cmd() {
|
||||
#E unset a GPG encryption key for backups
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-unset-encryption lolipop
|
||||
#E unset the GPG encryption passphrase for backups
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-unset-encryption lollipop
|
||||
#A service, service to run command against
|
||||
declare desc="unsets encryption for future backups of the $PLUGIN_SERVICE service"
|
||||
declare desc="unset encryption for future backups of the $PLUGIN_SERVICE service"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:backup-unset-encryption" argv=("$@")
|
||||
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||
declare SERVICE="$1"
|
||||
|
||||
@@ -7,14 +7,17 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-clone-cmd() {
|
||||
#E you can clone an existing service to a new one
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:clone lolipop lolipop-2
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:clone lollipop lollipop-2
|
||||
#A service, service to run command against
|
||||
#A new-service, name of new service
|
||||
#F -c|--config-options "--args --go=here", extra arguments to pass to the container create command
|
||||
#F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
|
||||
#F -i|--image IMAGE, the image name to start the service with
|
||||
#F -I|--image-version IMAGE_VERSION, the image version to start the service with
|
||||
#F -m|--memory MEMORY, container memory limit (default: unlimited)
|
||||
#F -p|--password PASSWORD, override the user-level service password
|
||||
#F -r|--root-password PASSWORD, override the root-level service password
|
||||
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
|
||||
declare desc="create container <new-name> then copy data from <name> into <new-name>"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:clone" argv=("$@")
|
||||
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||
|
||||
@@ -7,7 +7,8 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-connect-cmd() {
|
||||
#E connect to the service via the $PLUGIN_COMMAND_PREFIX connection tool
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:connect lolipop
|
||||
#E > NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:connect lollipop
|
||||
#A service, service to run command against
|
||||
declare desc="connect to the service via the $PLUGIN_COMMAND_PREFIX connection tool"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:connect" argv=("$@")
|
||||
|
||||
@@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-connect-admin-cmd() {
|
||||
#E connect with the admin user to the service via the $PLUGIN_COMMAND_PREFIX connection tool
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:connect-admin lolipop
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:connect-admin lollipop
|
||||
#A service, service to run command against
|
||||
declare desc="connect via mongo to a $PLUGIN_SERVICE service as admin user"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:connect-admin" argv=("$@")
|
||||
@@ -21,7 +21,7 @@ service-connect-admin-cmd() {
|
||||
PASSWORD="$(service_root_password "$SERVICE")"
|
||||
has_tty && SERVICE_TTY_OPTS="-t"
|
||||
|
||||
docker exec -i $SERVICE_TTY_OPTS "$SERVICE_NAME" mongo -u admin -p "$PASSWORD" --authenticationDatabase admin "$SERVICE"
|
||||
docker exec --env=LANG=C.UTF-8 --env=LC_ALL=C.UTF-8 -i $SERVICE_TTY_OPTS "$SERVICE_NAME" mongo -u admin -p "$PASSWORD" --authenticationDatabase admin "$SERVICE"
|
||||
}
|
||||
|
||||
service-connect-admin-cmd "$@"
|
||||
|
||||
@@ -6,23 +6,26 @@ source "$PLUGIN_BASE_PATH/common/functions"
|
||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-create-cmd() {
|
||||
#E create a $PLUGIN_COMMAND_PREFIX service named lolipop
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:create lolipop
|
||||
#E create a $PLUGIN_COMMAND_PREFIX service named lollipop
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
|
||||
#E you can also specify the image and image version to use for the service.
|
||||
#E it *must* be compatible with the ${PLUGIN_IMAGE} image.
|
||||
#E export ${PLUGIN_DEFAULT_ALIAS}_IMAGE="${PLUGIN_IMAGE}"
|
||||
#E export ${PLUGIN_DEFAULT_ALIAS}_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:create lolipop
|
||||
#E export ${PLUGIN_VARIABLE}_IMAGE="${PLUGIN_IMAGE}"
|
||||
#E export ${PLUGIN_VARIABLE}_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
|
||||
#E you can also specify custom environment variables to start
|
||||
#E the ${PLUGIN_COMMAND_PREFIX} service in semi-colon separated form.
|
||||
#E export ${PLUGIN_DEFAULT_ALIAS}_CUSTOM_ENV="USER=alpha;HOST=beta"
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:create lolipop
|
||||
#E export ${PLUGIN_VARIABLE}_CUSTOM_ENV="USER=alpha;HOST=beta"
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
|
||||
#A service, service to run command against
|
||||
#F -c|--config-options "--args --go=here", extra arguments to pass to the container create command
|
||||
#F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
|
||||
#F -i|--image IMAGE, the image name to start the service with
|
||||
#F -I|--image-version IMAGE_VERSION, the image version to start the service with
|
||||
#F -m|--memory MEMORY, container memory limit (default: unlimited)
|
||||
#F -p|--password PASSWORD, override the user-level service password
|
||||
#F -r|--root-password PASSWORD, override the root-level service password
|
||||
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
|
||||
declare desc="create a $PLUGIN_SERVICE service"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:create" argv=("$@")
|
||||
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||
|
||||
@@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-destroy-cmd() {
|
||||
#E destroy the service, it's data, and the running container
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:destroy lolipop
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:destroy lollipop
|
||||
#A service, service to run command against
|
||||
#F -f|--force, force destroy without asking for confirmation
|
||||
declare desc="delete the $PLUGIN_SERVICE service/data/container if there are no links left"
|
||||
@@ -41,13 +41,15 @@ service-destroy-cmd() {
|
||||
fi
|
||||
|
||||
dokku_log_info2_quiet "Deleting $SERVICE"
|
||||
plugn trigger service-action pre-delete "$SERVICE"
|
||||
service_backup_unschedule "$SERVICE"
|
||||
service_container_rm "$SERVICE"
|
||||
|
||||
dokku_log_verbose_quiet "Removing data"
|
||||
docker run --rm -v "$SERVICE_HOST_ROOT/data:/data" -v "$SERVICE_HOST_ROOT/config:/config" "$PLUGIN_BUSYBOX_IMAGE" 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"
|
||||
|
||||
plugn trigger service-action post-delete "$SERVICE"
|
||||
dokku_log_info2 "$PLUGIN_SERVICE container deleted: $SERVICE"
|
||||
}
|
||||
|
||||
|
||||
@@ -8,10 +8,11 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
service-enter-cmd() {
|
||||
#E a bash prompt can be opened against a running service.
|
||||
#E filesystem changes will not be saved to disk.
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:enter lolipop
|
||||
#E > NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:enter lollipop
|
||||
#E you may also run a command directly against the service.
|
||||
#E filesystem changes will not be saved to disk.
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:enter lolipop touch /tmp/test
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:enter lollipop touch /tmp/test
|
||||
#A service, service to run command against
|
||||
declare desc="enter or run a command in a running $PLUGIN_SERVICE service container"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:enter" argv=("$@")
|
||||
|
||||
@@ -6,8 +6,8 @@ source "$PLUGIN_BASE_PATH/common/functions"
|
||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-exists-cmd() {
|
||||
#E here we check if the lolipop $PLUGIN_COMMAND_PREFIX service exists.
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:exists lolipop
|
||||
#E here we check if the lollipop $PLUGIN_COMMAND_PREFIX service exists.
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:exists lollipop
|
||||
#A service, service to run command against
|
||||
declare desc="check if the $PLUGIN_SERVICE service exists"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:exists" argv=("$@")
|
||||
|
||||
@@ -7,9 +7,9 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-export-cmd() {
|
||||
#E by default, datastore output is exported to stdout
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:export lolipop
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:export lollipop
|
||||
#E you can redirect this output to a file
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:export lolipop > lolipop.dump
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:export lollipop > data.dump
|
||||
#A service, service to run command against
|
||||
declare desc="export a dump of the $PLUGIN_SERVICE service database"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:export" argv=("$@")
|
||||
|
||||
@@ -7,10 +7,12 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-expose-cmd() {
|
||||
#E expose the service on the service's normal ports, allowing access to it from the public interface (0.0.0.0)
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:expose lolipop ${PLUGIN_DATASTORE_PORTS[@]}
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:expose lollipop ${PLUGIN_DATASTORE_PORTS[@]}
|
||||
#E expose the service on the service's normal ports, with the first on a specified ip adddress (127.0.0.1)
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:expose lollipop 127.0.0.1:${PLUGIN_DATASTORE_PORTS[@]}
|
||||
#A service, service to run command against
|
||||
#A ports, a list of ports to run against
|
||||
declare desc="expose a $PLUGIN_SERVICE service on custom port if provided (random port otherwise)"
|
||||
declare desc="expose a $PLUGIN_SERVICE service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:expose" argv=("$@")
|
||||
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||
declare SERVICE="$1" PORTS_LIST=("${@:2}")
|
||||
|
||||
@@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-import-cmd() {
|
||||
#E import a datastore dump
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:import lolipop < database.dump
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:import lollipop < data.dump
|
||||
#A service, service to run command against
|
||||
declare desc="import a dump into the $PLUGIN_SERVICE service database"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:import" argv=("$@")
|
||||
|
||||
@@ -7,18 +7,18 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-info-cmd() {
|
||||
#E get connection information as follows:
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop
|
||||
#E you can also retrieve a specific piece of service info via flags:
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --config-dir
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --data-dir
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --dsn
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --exposed-ports
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --id
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --internal-ip
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --links
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --service-root
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --status
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --version
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --config-dir
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --data-dir
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --dsn
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --exposed-ports
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --id
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --internal-ip
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --links
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --service-root
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --status
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --version
|
||||
#A service, service to run command against
|
||||
#F --config-dir, show the service configuration directory
|
||||
#F --data-dir, show the service data directory
|
||||
|
||||
@@ -10,34 +10,34 @@ service-link-cmd() {
|
||||
#E this will use native docker links via the docker-options plugin.
|
||||
#E here we link it to our 'playground' app.
|
||||
#E > NOTE: this will restart your app
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:link lolipop playground
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:link lollipop playground
|
||||
#E the following environment variables will be set automatically by docker
|
||||
#E (not on the app itself, so they won’t be listed when calling dokku config):
|
||||
#E
|
||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_NAME=/lolipop/DATABASE
|
||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]}
|
||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]}
|
||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PROTO=tcp
|
||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PORT=${PLUGIN_DATASTORE_PORTS[0]}
|
||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_ADDR=172.17.0.1
|
||||
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_NAME=/lollipop/DATABASE
|
||||
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]}
|
||||
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]}
|
||||
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PROTO=tcp
|
||||
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PORT=${PLUGIN_DATASTORE_PORTS[0]}
|
||||
#E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_ADDR=172.17.0.1
|
||||
#E
|
||||
#E the following will be set on the linked application by default:
|
||||
#E
|
||||
#E ${PLUGIN_DEFAULT_ALIAS}_URL=${PLUGIN_SCHEME}://lolipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lolipop:${PLUGIN_DATASTORE_PORTS[0]}/lolipop
|
||||
#E ${PLUGIN_DEFAULT_ALIAS}_URL=${PLUGIN_SCHEME}://lollipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lollipop:${PLUGIN_DATASTORE_PORTS[0]}/lollipop
|
||||
#E
|
||||
#E the host exposed here only works internally in docker containers.
|
||||
#E if you want your container to be reachable from outside, you should
|
||||
#E use the 'expose' subcommand. another service can be linked to your app:
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:link other_service playground
|
||||
#E it is possible to change the protocol for ${PLUGIN_DEFAULT_ALIAS}_URL by setting the
|
||||
#E environment variable ${PLUGIN_DEFAULT_ALIAS}_DATABASE_SCHEME on the app. doing so will
|
||||
#E environment variable ${PLUGIN_VARIABLE}_DATABASE_SCHEME on the app. doing so will
|
||||
#E after linking will cause the plugin to think the service is not
|
||||
#E linked, and we advise you to unlink before proceeding.
|
||||
#E dokku config:set playground ${PLUGIN_DEFAULT_ALIAS}_DATABASE_SCHEME=${PLUGIN_SCHEME}2
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:link lolipop playground
|
||||
#E dokku config:set playground ${PLUGIN_VARIABLE}_DATABASE_SCHEME=${PLUGIN_SCHEME}2
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:link lollipop playground
|
||||
#E this will cause ${PLUGIN_DEFAULT_ALIAS}_URL to be set as:
|
||||
#E
|
||||
#E ${PLUGIN_SCHEME}2://lolipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lolipop:${PLUGIN_DATASTORE_PORTS[0]}/lolipop
|
||||
#E ${PLUGIN_SCHEME}2://lollipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lollipop:${PLUGIN_DATASTORE_PORTS[0]}/lollipop
|
||||
#A service, service to run command against
|
||||
#A app, app to run command against
|
||||
#F -a|--alias "BLUE_DATABASE", an alternative alias to use for linking to an app via environment variable
|
||||
|
||||
@@ -6,8 +6,8 @@ source "$PLUGIN_BASE_PATH/common/functions"
|
||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-linked-cmd() {
|
||||
#E here we check if the lolipop $PLUGIN_COMMAND_PREFIX service is linked to the 'playground' app.
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:linked lolipop playground
|
||||
#E here we check if the lollipop $PLUGIN_COMMAND_PREFIX service is linked to the 'playground' app.
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:linked lollipop playground
|
||||
#A service, service to run command against
|
||||
#A app, app to run command against
|
||||
declare desc="check if the $PLUGIN_SERVICE service is linked to an app"
|
||||
|
||||
@@ -6,8 +6,8 @@ source "$PLUGIN_BASE_PATH/common/functions"
|
||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-links-cmd() {
|
||||
#E list all apps linked to the 'lolipop' $PLUGIN_COMMAND_PREFIX service.
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:links lolipop
|
||||
#E list all apps linked to the 'lollipop' $PLUGIN_COMMAND_PREFIX service.
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:links lollipop
|
||||
#A service, service to run command against
|
||||
declare desc="list all apps linked to the $PLUGIN_SERVICE service"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:links" argv=("$@")
|
||||
|
||||
@@ -7,19 +7,21 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-logs-cmd() {
|
||||
#E you can tail logs for a particular service:
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:logs lolipop
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:logs lollipop
|
||||
#E by default, logs will not be tailed, but you can do this with the --tail flag:
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:logs lolipop --tail
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:logs lollipop --tail
|
||||
#E the default tail setting is to show all logs, but an initial count can also be specified
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:logs lollipop --tail 5
|
||||
#A service, service to run command against
|
||||
#F -t|--tail, do not stop when end of the logs are reached and wait for additional output
|
||||
#F -t|--tail [<tail-num>], do not stop when end of the logs are reached and wait for additional output
|
||||
declare desc="print the most recent log(s) for this service"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:logs" argv=("$@")
|
||||
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||
declare SERVICE="$1" TAIL_FLAG="$2"
|
||||
declare SERVICE="$1" TAIL_FLAG="$2" TAIL_NUM_OPTIONAL="${3:-all}"
|
||||
|
||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
|
||||
verify_service_name "$SERVICE"
|
||||
service_logs "$SERVICE" "$TAIL_FLAG"
|
||||
service_logs "$SERVICE" "$TAIL_FLAG" "$TAIL_NUM_OPTIONAL"
|
||||
}
|
||||
|
||||
service-logs-cmd "$@"
|
||||
|
||||
@@ -20,7 +20,7 @@ service-promote-cmd() {
|
||||
#E
|
||||
#E ${PLUGIN_DEFAULT_ALIAS}_URL=${PLUGIN_SCHEME}://other_service:ANOTHER_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-other-service:${PLUGIN_DATASTORE_PORTS[0]}/other_service
|
||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_BLUE_URL=${PLUGIN_SCHEME}://other_service:ANOTHER_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-other-service:${PLUGIN_DATASTORE_PORTS[0]}/other_service
|
||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_SILVER_URL=${PLUGIN_SCHEME}://lolipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lolipop:${PLUGIN_DATASTORE_PORTS[0]}/lolipop
|
||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_SILVER_URL=${PLUGIN_SCHEME}://lollipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lollipop:${PLUGIN_DATASTORE_PORTS[0]}/lollipop
|
||||
#A service, service to run command against
|
||||
#A app, app to run command against
|
||||
declare desc="promote service <service> as ${PLUGIN_DEFAULT_ALIAS}_URL in <app>"
|
||||
|
||||
@@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-restart-cmd() {
|
||||
#E restart the service
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:restart lolipop
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:restart lollipop
|
||||
#A service, service to run command against
|
||||
declare desc="graceful shutdown and restart of the $PLUGIN_SERVICE service container"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:restart" argv=("$@")
|
||||
|
||||
@@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-start-cmd() {
|
||||
#E start the service
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:start lolipop
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:start lollipop
|
||||
#A service, service to run command against
|
||||
declare desc="start a previously stopped $PLUGIN_SERVICE service"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:start" argv=("$@")
|
||||
|
||||
@@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-stop-cmd() {
|
||||
#E stop the service and the running container
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:stop lolipop
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:stop lollipop
|
||||
#A service, service to run command against
|
||||
declare desc="stop a running $PLUGIN_SERVICE service"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:stop" argv=("$@")
|
||||
|
||||
@@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-unexpose-cmd() {
|
||||
#E unexpose the service, removing access to it from the public interface (0.0.0.0)
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:unexpose lolipop
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:unexpose lollipop
|
||||
#A service, service to run command against
|
||||
declare desc="unexpose a previously exposed $PLUGIN_SERVICE service"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:unexpose" argv=("$@")
|
||||
|
||||
@@ -8,7 +8,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
service-unlink-cmd() {
|
||||
#E you can unlink a $PLUGIN_COMMAND_PREFIX service
|
||||
#E > NOTE: this will restart your app and unset related environment variables
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:unlink lolipop playground
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:unlink lollipop playground
|
||||
#A service, service to run command against
|
||||
#A app, app to run command against
|
||||
declare desc="unlink the $PLUGIN_SERVICE service from the app"
|
||||
|
||||
@@ -8,12 +8,14 @@ source "$PLUGIN_AVAILABLE_PATH/ps/functions"
|
||||
|
||||
service-upgrade-cmd() {
|
||||
#E you can upgrade an existing service to a new image or image-version
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:upgrade lolipop
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:upgrade lollipop
|
||||
#A service, service to run command against
|
||||
#F -c|--config-options "--args --go=here", extra arguments to pass to the container create command
|
||||
#F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
|
||||
#F -i|--image IMAGE, the image name to start the service with
|
||||
#F -I|--image-version IMAGE_VERSION, the image version to start the service with
|
||||
#F -R|--restart-apps "true", whether to force an app restart
|
||||
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
|
||||
declare desc="upgrade service <service> to the specified versions"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:upgrade" argv=("$@")
|
||||
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||
@@ -36,6 +38,8 @@ service-upgrade-cmd() {
|
||||
return
|
||||
fi
|
||||
|
||||
service_commit_config "$SERVICE"
|
||||
|
||||
dokku_log_info2 "Upgrading $SERVICE to $NEW_PLUGIN_IMAGE_TAG"
|
||||
if [[ "$SERVICE_RESTART_APPS" == "true" ]]; then
|
||||
dokku_log_info2 "Stopping all linked services"
|
||||
|
||||
@@ -2,18 +2,18 @@
|
||||
load test_helper
|
||||
|
||||
setup() {
|
||||
dokku apps:create my_app
|
||||
dokku apps:create my-app
|
||||
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() {
|
||||
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
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:hook:pre-delete) removes app from links file when destroying app" {
|
||||
[[ -n $(< "$PLUGIN_DATA_ROOT/l/LINKS") ]]
|
||||
dokku --force apps:destroy my_app
|
||||
dokku --force apps:destroy my-app
|
||||
[[ -z $(< "$PLUGIN_DATA_ROOT/l/LINKS") ]]
|
||||
}
|
||||
|
||||
@@ -20,6 +20,9 @@ teardown() {
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:export) success with SSH_TTY" {
|
||||
if [[ -n "$GITHUB_WORKFLOW" ]]; then
|
||||
skip "No tty is available on Github Actions"
|
||||
fi
|
||||
export SSH_TTY=`tty`
|
||||
run dokku "$PLUGIN_COMMAND_PREFIX:export" l
|
||||
echo "output: $output"
|
||||
|
||||
@@ -24,6 +24,9 @@ teardown() {
|
||||
}
|
||||
|
||||
@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
|
||||
assert_contains "${lines[*]}" "No data provided on stdin"
|
||||
assert_failure
|
||||
|
||||
@@ -4,13 +4,13 @@ load test_helper
|
||||
setup() {
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:create" m
|
||||
dokku apps:create my_app
|
||||
dokku apps:create my-app
|
||||
}
|
||||
|
||||
teardown() {
|
||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" m
|
||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||
dokku --force apps:destroy my_app
|
||||
dokku --force apps:destroy my-app
|
||||
}
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ teardown() {
|
||||
}
|
||||
|
||||
@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"
|
||||
@@ -47,73 +47,73 @@ teardown() {
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:link) error when the service is already linked to app" {
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
|
||||
run 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
|
||||
echo "output: $output"
|
||||
echo "status: $status"
|
||||
assert_contains "${lines[*]}" "Already linked as MONGO_URL"
|
||||
assert_failure
|
||||
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:link) exports MONGO_URL to 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"
|
||||
url=$(dokku config:get my_app MONGO_URL)
|
||||
url=$(dokku config:get my-app MONGO_URL)
|
||||
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||
assert_contains "$url" "mongodb://l:$password@dokku-mongo-l:27017/l"
|
||||
assert_success
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:link) generates an alternate config url when MONGO_URL already in use" {
|
||||
dokku config:set my_app MONGO_URL=mongodb://user:pass@host:27017/db
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
|
||||
run dokku config my_app
|
||||
dokku config:set my-app MONGO_URL=mongodb://user:pass@host:27017/db
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
|
||||
run dokku config my-app
|
||||
assert_contains "${lines[*]}" "DOKKU_MONGO_AQUA_URL"
|
||||
assert_success
|
||||
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" m my_app
|
||||
run dokku config my_app
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" m my-app
|
||||
run dokku config my-app
|
||||
assert_contains "${lines[*]}" "DOKKU_MONGO_BLACK_URL"
|
||||
assert_success
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" m my_app
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
||||
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" {
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
|
||||
run dokku docker-options:report my_app
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
|
||||
run dokku docker-options:report my-app
|
||||
assert_contains "${lines[*]}" "--link dokku.mongo.l:dokku-mongo-l"
|
||||
assert_success
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:link) uses apps MONGO_DATABASE_SCHEME variable" {
|
||||
dokku config:set my_app MONGO_DATABASE_SCHEME=mongodb2
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
|
||||
url=$(dokku config:get my_app MONGO_URL)
|
||||
dokku config:set my-app MONGO_DATABASE_SCHEME=mongodb2
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
|
||||
url=$(dokku config:get my-app MONGO_URL)
|
||||
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||
assert_contains "$url" "mongodb2://l:$password@dokku-mongo-l:27017/l"
|
||||
assert_success
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
||||
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 MONGO_URL)
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app --querystring "pool=5"
|
||||
url=$(dokku config:get my-app MONGO_URL)
|
||||
assert_contains "$url" "?pool=5"
|
||||
assert_success
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
||||
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)
|
||||
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" "mongodb://l:$password@dokku-mongo-l:27017/l"
|
||||
assert_success
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
||||
}
|
||||
|
||||
@@ -3,14 +3,14 @@ load test_helper
|
||||
|
||||
setup() {
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||
dokku apps:create my_app
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
|
||||
dokku apps:create my-app
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
|
||||
}
|
||||
|
||||
teardown() {
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||
dokku --force apps:destroy my_app
|
||||
dokku --force apps:destroy my-app
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:promote) error when there are no arguments" {
|
||||
@@ -29,34 +29,34 @@ teardown() {
|
||||
}
|
||||
|
||||
@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"
|
||||
}
|
||||
|
||||
@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 MONGO_URL"
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:promote) changes MONGO_URL" {
|
||||
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||
dokku config:set my_app "MONGO_URL=mongodb://u:p@host:27017/db" "DOKKU_MONGO_BLUE_URL=mongodb://l:$password@dokku-mongo-l:27017/l"
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my_app
|
||||
url=$(dokku config:get my_app MONGO_URL)
|
||||
dokku config:set my-app "MONGO_URL=mongodb://u:p@host:27017/db" "DOKKU_MONGO_BLUE_URL=mongodb://l:$password@dokku-mongo-l:27017/l"
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my-app
|
||||
url=$(dokku config:get my-app MONGO_URL)
|
||||
assert_equal "$url" "mongodb://l:$password@dokku-mongo-l:27017/l"
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:promote) creates new config url when needed" {
|
||||
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||
dokku config:set my_app "MONGO_URL=mongodb://u:p@host:27017/db" "DOKKU_MONGO_BLUE_URL=mongodb://l:$password@dokku-mongo-l:27017/l"
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my_app
|
||||
run dokku config my_app
|
||||
dokku config:set my-app "MONGO_URL=mongodb://u:p@host:27017/db" "DOKKU_MONGO_BLUE_URL=mongodb://l:$password@dokku-mongo-l:27017/l"
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my-app
|
||||
run dokku config my-app
|
||||
assert_contains "${lines[*]}" "DOKKU_MONGO_"
|
||||
}
|
||||
@test "($PLUGIN_COMMAND_PREFIX:promote) uses MONGO_DATABASE_SCHEME variable" {
|
||||
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||
dokku config:set my_app "MONGO_DATABASE_SCHEME=mongodb2" "MONGO_URL=mongodb://u:p@host:27017/db" "DOKKU_MONGO_BLUE_URL=mongodb2://l:$password@dokku-mongo-l:27017/l"
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my_app
|
||||
url=$(dokku config:get my_app MONGO_URL)
|
||||
dokku config:set my-app "MONGO_DATABASE_SCHEME=mongodb2" "MONGO_URL=mongodb://u:p@host:27017/db" "DOKKU_MONGO_BLUE_URL=mongodb2://l:$password@dokku-mongo-l:27017/l"
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my-app
|
||||
url=$(dokku config:get my-app MONGO_URL)
|
||||
assert_contains "$url" "mongodb2://l:$password@dokku-mongo-l:27017/l"
|
||||
}
|
||||
|
||||
@@ -2,13 +2,13 @@
|
||||
load test_helper
|
||||
|
||||
setup() {
|
||||
dokku apps:create my_app
|
||||
dokku apps:create my-app
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||
}
|
||||
|
||||
teardown() {
|
||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||
dokku --force apps:destroy my_app
|
||||
dokku --force apps:destroy my-app
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:unlink) error when there are no arguments" {
|
||||
@@ -27,27 +27,27 @@ teardown() {
|
||||
}
|
||||
|
||||
@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"
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:unlink) error when service not linked to app" {
|
||||
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
||||
assert_contains "${lines[*]}" "Not linked to app my_app"
|
||||
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
||||
assert_contains "${lines[*]}" "Not linked to app my-app"
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:unlink) removes link from docker-options" {
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app >&2
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app >&2
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
||||
|
||||
check_value="Docker options build: Docker options deploy: --restart=on-failure:10 Docker options run:"
|
||||
options=$(dokku --quiet docker-options:report my_app | xargs)
|
||||
options=$(dokku --quiet docker-options:report my-app | xargs)
|
||||
assert_equal "$options" "$check_value"
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:unlink) unsets config url from app" {
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app >&2
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
||||
config=$(dokku config:get my_app MONGO_URL || true)
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app >&2
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
||||
config=$(dokku config:get my-app MONGO_URL || true)
|
||||
assert_equal "$config" ""
|
||||
}
|
||||
|
||||
@@ -19,12 +19,15 @@ echo "Dokku version $DOKKU_VERSION"
|
||||
|
||||
export DOKKU_LIB_ROOT="/var/lib/dokku"
|
||||
export DOKKU_PLUGINS_ROOT="$DOKKU_LIB_ROOT/plugins/available"
|
||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||
pushd "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")" >/dev/null
|
||||
source "config"
|
||||
popd >/dev/null
|
||||
sudo rm -rf "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX"
|
||||
sudo mkdir -p "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX" "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/subcommands" "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/scripts"
|
||||
sudo mkdir -p "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX" "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/subcommands" "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/scripts" "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/templates"
|
||||
sudo find ./ -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX" \;
|
||||
[[ -d "./scripts" ]] && sudo find ./scripts -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/scripts" \;
|
||||
[[ -d "./subcommands" ]] && sudo find ./subcommands -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/subcommands" \;
|
||||
[[ -d "./templates" ]] && sudo find ./templates -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/templates" \;
|
||||
sudo mkdir -p "$PLUGIN_CONFIG_ROOT" "$PLUGIN_DATA_ROOT"
|
||||
sudo dokku plugin:enable "$PLUGIN_COMMAND_PREFIX"
|
||||
sudo dokku plugin:install
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/usr/bin/env python
|
||||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
from __future__ import print_function
|
||||
import argparse
|
||||
|
||||
Reference in New Issue
Block a user