Compare commits
108 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2082f89ac1 | ||
|
|
902112cc75 | ||
|
|
18c4fbc79e | ||
|
|
3a8b4511c4 | ||
|
|
2dfcc76d26 | ||
|
|
071afd4a31 | ||
|
|
04541a0fc6 | ||
|
|
fea5aa6724 | ||
|
|
f48f67f67b | ||
|
|
8fda23f91c | ||
|
|
14ec6fd833 | ||
|
|
dafc9c7a2d | ||
|
|
21df3ee116 | ||
|
|
98cabcce0b | ||
|
|
f09a65e55f | ||
|
|
71c828eabd | ||
|
|
9eca41dcd5 | ||
|
|
6f392df029 | ||
|
|
aa8c6489ee | ||
|
|
f1629b8b51 | ||
|
|
18ce6d43b5 | ||
|
|
bb2ba3807a | ||
|
|
d2eecef68a | ||
|
|
9e0d948de7 | ||
|
|
90ab3a1191 | ||
|
|
23681960bf | ||
|
|
b8b97f0cb4 | ||
|
|
70c98338b0 | ||
|
|
872ed9c540 | ||
|
|
c85770a873 | ||
|
|
facd80f5bc | ||
|
|
bc5985881a | ||
|
|
4170c0b993 | ||
|
|
ca69e6f79d | ||
|
|
ca6b3b8815 | ||
|
|
e43904641b | ||
|
|
6d19569e82 | ||
|
|
01a1668867 | ||
|
|
f2c531bb5e | ||
|
|
2fd7152866 | ||
|
|
f9d5735c6c | ||
|
|
6497135ae8 | ||
|
|
adc1b724d3 | ||
|
|
b421d681af | ||
|
|
1e43387487 | ||
|
|
7a003dea68 | ||
|
|
0aefafed16 | ||
|
|
2f72b26396 | ||
|
|
75efb47a97 | ||
|
|
3d4258c794 | ||
|
|
4c194bf734 | ||
|
|
53968775f6 | ||
|
|
9589ad3924 | ||
|
|
5093de6bd9 | ||
|
|
565dba9801 | ||
|
|
81cca3b12b | ||
|
|
2d07341518 | ||
|
|
18f925d9f4 | ||
|
|
a4e1f43905 | ||
|
|
a6f3ea4552 | ||
|
|
138bcd3fe1 | ||
|
|
da6676efb8 | ||
|
|
3a7564c401 | ||
|
|
2d820a7c1c | ||
|
|
ba4024d202 | ||
|
|
34cbc30f63 | ||
|
|
9ace27266c | ||
|
|
d2185f2144 | ||
|
|
6feb270037 | ||
|
|
62484924e6 | ||
|
|
b9740bffcd | ||
|
|
3c4267fbb9 | ||
|
|
fb1b189aea | ||
|
|
e216b97c23 | ||
|
|
0c210e64f3 | ||
|
|
bc9874bc49 | ||
|
|
b7cfbd37b4 | ||
|
|
0ecf4f7cfd | ||
|
|
3bfcb5bc2c | ||
|
|
0fe6933897 | ||
|
|
0cec2f2119 | ||
|
|
3dcf263b56 | ||
|
|
233b03e7ca | ||
|
|
9bc7830c0c | ||
|
|
150591eb75 | ||
|
|
417311e9fb | ||
|
|
6fe12abbb5 | ||
|
|
bb27a06da9 | ||
|
|
068145b46e | ||
|
|
c5442f9754 | ||
|
|
07c36b7e6f | ||
|
|
b2b39c86f1 | ||
|
|
0a0e6c3140 | ||
|
|
007acf952a | ||
|
|
28275d777d | ||
|
|
a243d3cec9 | ||
|
|
312d9298c7 | ||
|
|
25ad144b54 | ||
|
|
77573a97ff | ||
|
|
5849f1f19f | ||
|
|
b3eb9ed085 | ||
|
|
86e7d53749 | ||
|
|
ba5b90349b | ||
|
|
46bd7f534f | ||
|
|
f2342ed6fc | ||
|
|
b1e5298be0 | ||
|
|
656cdd896f | ||
|
|
0c4db51565 |
31
.circleci/config.yml
Normal file
31
.circleci/config.yml
Normal file
@@ -0,0 +1,31 @@
|
||||
version: 2.1
|
||||
|
||||
commands:
|
||||
build:
|
||||
description: "run the build"
|
||||
parameters:
|
||||
python_version:
|
||||
type: string
|
||||
default: "3.7.0"
|
||||
steps:
|
||||
- checkout
|
||||
|
||||
executors:
|
||||
machine:
|
||||
machine:
|
||||
docker_layer_caching: false
|
||||
image: ubuntu-1604:201903-01
|
||||
|
||||
jobs:
|
||||
build-master:
|
||||
environment:
|
||||
DOKKU_VERSION: master
|
||||
executor: machine
|
||||
steps:
|
||||
- build
|
||||
|
||||
workflows:
|
||||
version: 2
|
||||
build:
|
||||
jobs:
|
||||
- "build-master"
|
||||
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,9 +0,0 @@
|
||||
dist: trusty
|
||||
language: bash
|
||||
env:
|
||||
- DOKKU_VERSION=master
|
||||
- DOKKU_VERSION=v0.14.0
|
||||
- DOKKU_VERSION=v0.12.0
|
||||
install: make setup
|
||||
script: make test
|
||||
after_failure: make report
|
||||
1
Dockerfile
Normal file
1
Dockerfile
Normal file
@@ -0,0 +1 @@
|
||||
FROM redis:6.2.4
|
||||
@@ -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:
|
||||
|
||||
|
||||
33
Makefile
33
Makefile
@@ -1,5 +1,9 @@
|
||||
HARDWARE = $(shell uname -m)
|
||||
SYSTEM_NAME = $(shell uname -s | tr '[:upper:]' '[:lower:]')
|
||||
SHFMT_VERSION = 3.0.2
|
||||
XUNIT_TO_GITHUB_VERSION = 0.3.0
|
||||
XUNIT_READER_VERSION = 0.1.0
|
||||
|
||||
|
||||
bats:
|
||||
ifeq ($(SYSTEM_NAME),darwin)
|
||||
@@ -7,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
|
||||
@@ -28,7 +32,7 @@ ifneq ($(shell shfmt --version >/dev/null 2>&1 ; echo $$?),0)
|
||||
ifeq ($(shfmt),Darwin)
|
||||
brew install shfmt
|
||||
else
|
||||
wget -qO /tmp/shfmt https://github.com/mvdan/sh/releases/download/v2.6.2/shfmt_v2.6.2_linux_amd64
|
||||
wget -qO /tmp/shfmt https://github.com/mvdan/sh/releases/download/v$(SHFMT_VERSION)/shfmt_v$(SHFMT_VERSION)_linux_amd64
|
||||
chmod +x /tmp/shfmt
|
||||
sudo mv /tmp/shfmt /usr/local/bin/shfmt
|
||||
endif
|
||||
@@ -59,11 +63,17 @@ 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
|
||||
curl -o tmp/xunit-reader.tgz -sL https://github.com/josegonzalez/go-xunit-reader/releases/download/v$(XUNIT_READER_VERSION)/xunit-reader_$(XUNIT_READER_VERSION)_$(SYSTEM_NAME)_$(HARDWARE).tgz
|
||||
tar xf tmp/xunit-reader.tgz -C tmp
|
||||
chmod +x tmp/xunit-reader
|
||||
|
||||
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/v0.3.0/xunit-to-github_0.3.0_$(SYSTEM_NAME)_$(HARDWARE).tgz
|
||||
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
|
||||
|
||||
@@ -73,7 +83,9 @@ setup:
|
||||
|
||||
test: lint unit-tests
|
||||
|
||||
report: tmp/xunit-to-github
|
||||
report: tmp/xunit-reader tmp/xunit-to-github
|
||||
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)
|
||||
@@ -81,3 +93,14 @@ ifneq ($(TRAVIS_PULL_REQUEST),false)
|
||||
endif
|
||||
endif
|
||||
endif
|
||||
|
||||
.PHONY: clean
|
||||
clean:
|
||||
rm -f README.md
|
||||
|
||||
.PHONY: generate
|
||||
generate: clean README.md
|
||||
|
||||
.PHONY: README.md
|
||||
README.md:
|
||||
bin/generate
|
||||
|
||||
727
README.md
727
README.md
@@ -1,78 +1,126 @@
|
||||
# dokku redis [](https://travis-ci.org/dokku/dokku-redis) [](https://webchat.freenode.net/?channels=dokku)
|
||||
# dokku redis [](https://circleci.com/gh/dokku/dokku-redis/tree/master) [](https://webchat.freenode.net/?channels=dokku)
|
||||
|
||||
Official redis plugin for dokku. Currently defaults to installing [redis 5.0.4](https://hub.docker.com/_/redis/).
|
||||
Official redis plugin for dokku. Currently defaults to installing [redis 6.2.4](https://hub.docker.com/_/redis/).
|
||||
|
||||
## requirements
|
||||
## Requirements
|
||||
|
||||
- dokku 0.12.x+
|
||||
- dokku 0.19.x+
|
||||
- docker 1.8.x
|
||||
|
||||
## installation
|
||||
## Installation
|
||||
|
||||
```shell
|
||||
# on 0.12.x+
|
||||
# on 0.19.x+
|
||||
sudo dokku plugin:install https://github.com/dokku/dokku-redis.git redis
|
||||
```
|
||||
|
||||
## commands
|
||||
## Commands
|
||||
|
||||
```
|
||||
redis:app-links <app> List all redis service links for a given app
|
||||
redis:backup <name> <bucket> (--use-iam) Create a backup of the redis service to an existing s3 bucket
|
||||
redis:backup-auth <name> <aws_access_key_id> <aws_secret_access_key> (<aws_default_region>) (<aws_signature_version>) (<endpoint_url>) Sets up authentication for backups on the redis service
|
||||
redis:backup-deauth <name> Removes backup authentication for the redis service
|
||||
redis:backup-schedule <name> <schedule> <bucket> Schedules a backup of the redis service
|
||||
redis:backup-schedule-cat <name> Cat the contents of the configured backup cronfile for the service
|
||||
redis:backup-set-encryption <name> <passphrase> Set a GPG passphrase for backups
|
||||
redis:backup-unschedule <name> Unschedules the backup of the redis service
|
||||
redis:backup-unset-encryption <name> Removes backup encryption for future backups of the redis service
|
||||
redis:clone <name> <new-name> Create container <new-name> then copy data from <name> into <new-name>
|
||||
redis:connect <name> Connect via redis-cli to a redis service
|
||||
redis:create <name> Create a redis service with environment variables
|
||||
redis:destroy <name> Delete the service, delete the data and stop its container if there are no links left
|
||||
redis:enter <name> [command] Enter or run a command in a running redis service container
|
||||
redis:exists <service> Check if the redis service exists
|
||||
redis:export <name> > <file> Export a dump of the redis service database
|
||||
redis:expose <name> [port] Expose a redis service on custom port if provided (random port otherwise)
|
||||
redis:import <name> <file> Import a dump into the redis service database
|
||||
redis:info <name> Print the connection information
|
||||
redis:link <name> <app> Link the redis service to the app
|
||||
redis:linked <name> <app> Check if the redis service is linked to an app
|
||||
redis:list List all redis services
|
||||
redis:logs <name> [-t] Print the most recent log(s) for this service
|
||||
redis:promote <name> <app> Promote service <name> as REDIS_URL in <app>
|
||||
redis:restart <name> Graceful shutdown and restart of the redis service container
|
||||
redis:start <name> Start a previously stopped redis service
|
||||
redis:stop <name> Stop a running redis service
|
||||
redis:unexpose <name> Unexpose a previously exposed redis service
|
||||
redis:unlink <name> <app> Unlink the redis service from the app
|
||||
redis:upgrade <name> Upgrade service <service> to the specified version
|
||||
redis:app-links <app> # list all redis service links for a given app
|
||||
redis:backup <service> <bucket-name> [--use-iam] # creates a backup of the redis service to an existing s3 bucket
|
||||
redis: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 redis service
|
||||
redis:backup-deauth <service> # removes backup authentication for the redis service
|
||||
redis:backup-schedule <service> <schedule> <bucket-name> [--use-iam] # schedules a backup of the redis service
|
||||
redis:backup-schedule-cat <service> # cat the contents of the configured backup cronfile for the service
|
||||
redis:backup-set-encryption <service> <passphrase> # sets encryption for all future backups of redis service
|
||||
redis:backup-unschedule <service> # unschedules the backup of the redis service
|
||||
redis:backup-unset-encryption <service> # unsets encryption for future backups of the redis service
|
||||
redis:clone <service> <new-service> [--clone-flags...] # create container <new-name> then copy data from <name> into <new-name>
|
||||
redis:connect <service> # connect to the service via the redis connection tool
|
||||
redis:create <service> [--create-flags...] # create a redis service
|
||||
redis:destroy <service> [-f|--force] # delete the redis service/data/container if there are no links left
|
||||
redis:enter <service> # enter or run a command in a running redis service container
|
||||
redis:exists <service> # check if the redis service exists
|
||||
redis:export <service> # export a dump of the redis service database
|
||||
redis:expose <service> <ports...> # expose a redis service on custom port if provided (random port otherwise)
|
||||
redis:import <service> # import a dump into the redis service database
|
||||
redis:info <service> [--single-info-flag] # print the service information
|
||||
redis:link <service> <app> [--link-flags...] # link the redis service to the app
|
||||
redis:linked <service> <app> # check if the redis service is linked to an app
|
||||
redis:links <service> # list all apps linked to the redis service
|
||||
redis:list # list all redis services
|
||||
redis:logs <service> [-t|--tail] # print the most recent log(s) for this service
|
||||
redis:promote <service> <app> # promote service <service> as REDIS_URL in <app>
|
||||
redis:restart <service> # graceful shutdown and restart of the redis service container
|
||||
redis:start <service> # start a previously stopped redis service
|
||||
redis:stop <service> # stop a running redis service
|
||||
redis:unexpose <service> # unexpose a previously exposed redis service
|
||||
redis:unlink <service> <app> # unlink the redis service from the app
|
||||
redis:upgrade <service> [--upgrade-flags...] # upgrade service <service> to the specified versions
|
||||
```
|
||||
|
||||
## usage
|
||||
## Usage
|
||||
|
||||
Help for any commands can be displayed by specifying the command as an argument to redis:help. Please consult the `redis:help` command for any undocumented commands.
|
||||
|
||||
### Basic Usage
|
||||
|
||||
### create a redis service
|
||||
|
||||
```shell
|
||||
# create a redis service named lolipop
|
||||
dokku redis:create lolipop
|
||||
# usage
|
||||
dokku redis:create <service> [--create-flags...]
|
||||
```
|
||||
|
||||
# you can also specify the image and image
|
||||
# version to use for the service
|
||||
# it *must* be compatible with the
|
||||
# official redis image
|
||||
flags:
|
||||
|
||||
- `-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
|
||||
- `-p|--password PASSWORD`: override the user-level service password
|
||||
- `-r|--root-password PASSWORD`: override the root-level service password
|
||||
|
||||
Create a redis service named lolipop:
|
||||
|
||||
```shell
|
||||
dokku redis:create lolipop
|
||||
```
|
||||
|
||||
You can also specify the image and image version to use for the service. It *must* be compatible with the redis image.
|
||||
|
||||
```shell
|
||||
export REDIS_IMAGE="redis"
|
||||
export REDIS_IMAGE_VERSION="2.8.21"
|
||||
export REDIS_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
|
||||
dokku redis:create lolipop
|
||||
```
|
||||
|
||||
# you can also specify custom environment
|
||||
# variables to start the redis service
|
||||
# in semi-colon separated form
|
||||
You can also specify custom environment variables to start the redis service in semi-colon separated form.
|
||||
|
||||
```shell
|
||||
export REDIS_CUSTOM_ENV="USER=alpha;HOST=beta"
|
||||
dokku redis:create lolipop
|
||||
```
|
||||
|
||||
# get connection information as follows
|
||||
### print the service information
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis: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 redis:info lolipop
|
||||
```
|
||||
|
||||
# you can also retrieve a specific piece of service info via flags
|
||||
You can also retrieve a specific piece of service info via flags:
|
||||
|
||||
```shell
|
||||
dokku redis:info lolipop --config-dir
|
||||
dokku redis:info lolipop --data-dir
|
||||
dokku redis:info lolipop --dsn
|
||||
@@ -83,152 +131,525 @@ dokku redis:info lolipop --links
|
||||
dokku redis:info lolipop --service-root
|
||||
dokku redis:info lolipop --status
|
||||
dokku redis:info lolipop --version
|
||||
```
|
||||
|
||||
# a bash prompt can be opened against a running service
|
||||
# filesystem changes will not be saved to disk
|
||||
dokku redis:enter lolipop
|
||||
### list all redis services
|
||||
|
||||
# you may also run a command directly against the service
|
||||
# filesystem changes will not be saved to disk
|
||||
dokku redis:enter lolipop ls -lah /
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:list
|
||||
```
|
||||
|
||||
# a redis service can be linked to a
|
||||
# container this will use native docker
|
||||
# links via the docker-options plugin
|
||||
# here we link it to our 'playground' app
|
||||
# NOTE: this will restart your app
|
||||
dokku redis:link lolipop playground
|
||||
List all services:
|
||||
|
||||
# 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_REDIS_LOLIPOP_NAME=/lolipop/DATABASE
|
||||
# DOKKU_REDIS_LOLIPOP_PORT=tcp://172.17.0.1:6379
|
||||
# DOKKU_REDIS_LOLIPOP_PORT_6379_TCP=tcp://172.17.0.1:6379
|
||||
# DOKKU_REDIS_LOLIPOP_PORT_6379_TCP_PROTO=tcp
|
||||
# DOKKU_REDIS_LOLIPOP_PORT_6379_TCP_PORT=6379
|
||||
# DOKKU_REDIS_LOLIPOP_PORT_6379_TCP_ADDR=172.17.0.1
|
||||
#
|
||||
# and the following will be set on the linked application by default
|
||||
#
|
||||
# REDIS_URL=redis://lolipop:SOME_PASSWORD@dokku-redis-lolipop:6379
|
||||
#
|
||||
# NOTE: the host exposed here only works internally in docker containers. If
|
||||
# you want your container to be reachable from outside, you should use `expose`.
|
||||
```shell
|
||||
dokku redis:list
|
||||
```
|
||||
|
||||
# another service can be linked to your app
|
||||
dokku redis:link other_service playground
|
||||
### print the most recent log(s) for this service
|
||||
|
||||
# since REDIS_URL is already in use, another environment variable will be
|
||||
# generated automatically
|
||||
#
|
||||
# DOKKU_REDIS_BLUE_URL=redis://other_service:ANOTHER_PASSWORD@dokku-redis-other-service:6379
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:logs <service> [-t|--tail]
|
||||
```
|
||||
|
||||
# you can then promote the new service to be the primary one
|
||||
# NOTE: this will restart your app
|
||||
dokku redis:promote other_service playground
|
||||
flags:
|
||||
|
||||
# this will replace REDIS_URL with the url from other_service and generate
|
||||
# another environment variable to hold the previous value if necessary.
|
||||
# you could end up with the following for example:
|
||||
#
|
||||
# REDIS_URL=redis://other_service:ANOTHER_PASSWORD@dokku-redis-other-service:6379
|
||||
# DOKKU_REDIS_BLUE_URL=redis://other_service:ANOTHER_PASSWORD@dokku-redis-other-service:6379
|
||||
# DOKKU_REDIS_SILVER_URL=redis://lolipop:SOME_PASSWORD@dokku-redis-lolipop:6379/lolipop
|
||||
- `-t|--tail`: do not stop when end of the logs are reached and wait for additional output
|
||||
|
||||
# you can also unlink a redis service
|
||||
# NOTE: this will restart your app and unset related environment variables
|
||||
dokku redis:unlink lolipop playground
|
||||
You can tail logs for a particular service:
|
||||
|
||||
# you can tail logs for a particular service
|
||||
```shell
|
||||
dokku redis:logs lolipop
|
||||
dokku redis:logs lolipop -t # to tail
|
||||
|
||||
# you can dump the database
|
||||
dokku redis:export lolipop > lolipop.rdb
|
||||
|
||||
# you can import a dump
|
||||
dokku redis:import lolipop < database.rdb
|
||||
|
||||
# you can clone an existing database to a new one
|
||||
dokku redis:clone lolipop new_database
|
||||
|
||||
# finally, you can destroy the container
|
||||
dokku redis:destroy lolipop
|
||||
```
|
||||
|
||||
## Changing database adapter
|
||||
By default, logs will not be tailed, but you can do this with the --tail flag:
|
||||
|
||||
It's possible to change the protocol for REDIS_URL by setting
|
||||
the environment variable REDIS_DATABASE_SCHEME on the app:
|
||||
```shell
|
||||
dokku redis:logs lolipop --tail
|
||||
```
|
||||
|
||||
### link the redis service to the app
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:link <service> <app> [--link-flags...]
|
||||
```
|
||||
|
||||
flags:
|
||||
|
||||
- `-a|--alias "BLUE_DATABASE"`: an alternative alias to use for linking to an app via environment variable
|
||||
- `-q|--querystring "pool=5"`: ampersand delimited querystring arguments to append to the service link
|
||||
|
||||
A redis service can be linked to a container. This will use native docker links via the docker-options plugin. Here we link it to our 'playground' app.
|
||||
|
||||
> NOTE: this will restart your app
|
||||
|
||||
```shell
|
||||
dokku redis:link lolipop 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_REDIS_LOLIPOP_NAME=/lolipop/DATABASE
|
||||
DOKKU_REDIS_LOLIPOP_PORT=tcp://172.17.0.1:6379
|
||||
DOKKU_REDIS_LOLIPOP_PORT_6379_TCP=tcp://172.17.0.1:6379
|
||||
DOKKU_REDIS_LOLIPOP_PORT_6379_TCP_PROTO=tcp
|
||||
DOKKU_REDIS_LOLIPOP_PORT_6379_TCP_PORT=6379
|
||||
DOKKU_REDIS_LOLIPOP_PORT_6379_TCP_ADDR=172.17.0.1
|
||||
```
|
||||
|
||||
The following will be set on the linked application by default:
|
||||
|
||||
```
|
||||
REDIS_URL=redis://:SOME_PASSWORD@dokku-redis-lolipop:6379/lolipop
|
||||
```
|
||||
|
||||
The host exposed here only works internally in docker containers. If you want your container to be reachable from outside, you should use the 'expose' subcommand. Another service can be linked to your app:
|
||||
|
||||
```shell
|
||||
dokku redis:link other_service playground
|
||||
```
|
||||
|
||||
It is possible to change the protocol for `REDIS_URL` by setting the environment variable `REDIS_DATABASE_SCHEME` on the app. Doing so will after linking will cause the plugin to think the service is not linked, and we advise you to unlink before proceeding.
|
||||
|
||||
```shell
|
||||
dokku config:set playground REDIS_DATABASE_SCHEME=redis2
|
||||
dokku redis:link lolipop playground
|
||||
```
|
||||
|
||||
Will cause REDIS_URL to be set as
|
||||
redis2://lolipop:SOME_PASSWORD@dokku-redis-lolipop:6379/lolipop
|
||||
This will cause `REDIS_URL` to be set as:
|
||||
|
||||
CAUTION: Changing REDIS_DATABASE_SCHEME after linking will cause dokku to
|
||||
believe the redis is not linked when attempting to use `dokku redis:unlink`
|
||||
or `dokku redis:promote`.
|
||||
You should be able to fix this by
|
||||
```
|
||||
redis2://:SOME_PASSWORD@dokku-redis-lolipop:6379/lolipop
|
||||
```
|
||||
|
||||
- Changing REDIS_URL manually to the new value.
|
||||
### unlink the redis service from the app
|
||||
|
||||
OR
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:unlink <service> <app>
|
||||
```
|
||||
|
||||
- Set REDIS_DATABASE_SCHEME back to its original setting
|
||||
- Unlink the service
|
||||
- Change REDIS_DATABASE_SCHEME to the desired setting
|
||||
- Relink the service
|
||||
You can unlink a redis service:
|
||||
|
||||
## Backups
|
||||
> NOTE: this will restart your app and unset related environment variables
|
||||
|
||||
```shell
|
||||
dokku redis:unlink lolipop playground
|
||||
```
|
||||
|
||||
### Service Lifecycle
|
||||
|
||||
The lifecycle of each service can be managed through the following commands:
|
||||
|
||||
### connect to the service via the redis connection tool
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:connect <service>
|
||||
```
|
||||
|
||||
Connect to the service via the redis connection tool:
|
||||
|
||||
```shell
|
||||
dokku redis:connect lolipop
|
||||
```
|
||||
|
||||
### enter or run a command in a running redis service container
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:enter <service>
|
||||
```
|
||||
|
||||
A bash prompt can be opened against a running service. Filesystem changes will not be saved to disk.
|
||||
|
||||
```shell
|
||||
dokku redis:enter lolipop
|
||||
```
|
||||
|
||||
You may also run a command directly against the service. Filesystem changes will not be saved to disk.
|
||||
|
||||
```shell
|
||||
dokku redis:enter lolipop touch /tmp/test
|
||||
```
|
||||
|
||||
### expose a redis service on custom port if provided (random port otherwise)
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:expose <service> <ports...>
|
||||
```
|
||||
|
||||
Expose the service on the service's normal ports, allowing access to it from the public interface (`0.0.0.0`):
|
||||
|
||||
```shell
|
||||
dokku redis:expose lolipop 6379
|
||||
```
|
||||
|
||||
### unexpose a previously exposed redis service
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:unexpose <service>
|
||||
```
|
||||
|
||||
Unexpose the service, removing access to it from the public interface (`0.0.0.0`):
|
||||
|
||||
```shell
|
||||
dokku redis:unexpose lolipop
|
||||
```
|
||||
|
||||
### promote service <service> as REDIS_URL in <app>
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:promote <service> <app>
|
||||
```
|
||||
|
||||
If you have a redis service linked to an app and try to link another redis service another link environment variable will be generated automatically:
|
||||
|
||||
```
|
||||
DOKKU_REDIS_BLUE_URL=redis://:ANOTHER_PASSWORD@dokku-redis-other-service:6379/other_service
|
||||
```
|
||||
|
||||
You can promote the new service to be the primary one:
|
||||
|
||||
> NOTE: this will restart your app
|
||||
|
||||
```shell
|
||||
dokku redis:promote other_service playground
|
||||
```
|
||||
|
||||
This will replace `REDIS_URL` with the url from other_service and generate another environment variable to hold the previous value if necessary. You could end up with the following for example:
|
||||
|
||||
```
|
||||
REDIS_URL=redis://:ANOTHER_PASSWORD@dokku-redis-other-service:6379/other_service
|
||||
DOKKU_REDIS_BLUE_URL=redis://:ANOTHER_PASSWORD@dokku-redis-other-service:6379/other_service
|
||||
DOKKU_REDIS_SILVER_URL=redis://:SOME_PASSWORD@dokku-redis-lolipop:6379/lolipop
|
||||
```
|
||||
|
||||
### start a previously stopped redis service
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:start <service>
|
||||
```
|
||||
|
||||
Start the service:
|
||||
|
||||
```shell
|
||||
dokku redis:start lolipop
|
||||
```
|
||||
|
||||
### stop a running redis service
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:stop <service>
|
||||
```
|
||||
|
||||
Stop the service and the running container:
|
||||
|
||||
```shell
|
||||
dokku redis:stop lolipop
|
||||
```
|
||||
|
||||
### graceful shutdown and restart of the redis service container
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:restart <service>
|
||||
```
|
||||
|
||||
Restart the service:
|
||||
|
||||
```shell
|
||||
dokku redis:restart lolipop
|
||||
```
|
||||
|
||||
### upgrade service <service> to the specified versions
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:upgrade <service> [--upgrade-flags...]
|
||||
```
|
||||
|
||||
flags:
|
||||
|
||||
- `-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
|
||||
|
||||
You can upgrade an existing service to a new image or image-version:
|
||||
|
||||
```shell
|
||||
dokku redis:upgrade lolipop
|
||||
```
|
||||
|
||||
### Service Automation
|
||||
|
||||
Service scripting can be executed using the following commands:
|
||||
|
||||
### list all redis service links for a given app
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:app-links <app>
|
||||
```
|
||||
|
||||
List all redis services that are linked to the 'playground' app.
|
||||
|
||||
```shell
|
||||
dokku redis:app-links playground
|
||||
```
|
||||
|
||||
### create container <new-name> then copy data from <name> into <new-name>
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:clone <service> <new-service> [--clone-flags...]
|
||||
```
|
||||
|
||||
flags:
|
||||
|
||||
- `-C|--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
|
||||
- `-p|--password PASSWORD`: override the user-level service password
|
||||
- `-r|--root-password PASSWORD`: override the root-level service password
|
||||
|
||||
You can clone an existing service to a new one:
|
||||
|
||||
```shell
|
||||
dokku redis:clone lolipop lolipop-2
|
||||
```
|
||||
|
||||
### check if the redis service exists
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:exists <service>
|
||||
```
|
||||
|
||||
Here we check if the lolipop redis service exists.
|
||||
|
||||
```shell
|
||||
dokku redis:exists lolipop
|
||||
```
|
||||
|
||||
### check if the redis service is linked to an app
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:linked <service> <app>
|
||||
```
|
||||
|
||||
Here we check if the lolipop redis service is linked to the 'playground' app.
|
||||
|
||||
```shell
|
||||
dokku redis:linked lolipop playground
|
||||
```
|
||||
|
||||
### list all apps linked to the redis service
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:links <service>
|
||||
```
|
||||
|
||||
List all apps linked to the 'lolipop' redis service.
|
||||
|
||||
```shell
|
||||
dokku redis:links lolipop
|
||||
```
|
||||
|
||||
### Data Management
|
||||
|
||||
The underlying service data can be imported and exported with the following commands:
|
||||
|
||||
### import a dump into the redis service database
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:import <service>
|
||||
```
|
||||
|
||||
Import a datastore dump:
|
||||
|
||||
```shell
|
||||
dokku redis:import lolipop < database.dump
|
||||
```
|
||||
|
||||
### export a dump of the redis service database
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:export <service>
|
||||
```
|
||||
|
||||
By default, datastore output is exported to stdout:
|
||||
|
||||
```shell
|
||||
dokku redis:export lolipop
|
||||
```
|
||||
|
||||
You can redirect this output to a file:
|
||||
|
||||
```shell
|
||||
dokku redis:export lolipop > lolipop.dump
|
||||
```
|
||||
|
||||
### Backups
|
||||
|
||||
Datastore backups are supported via AWS S3 and S3 compatible services like [minio](https://github.com/minio/minio).
|
||||
|
||||
You may skip the `backup-auth` step if your dokku install is running within EC2
|
||||
and has access to the bucket via an IAM profile. In that case, use the `--use-iam`
|
||||
option with the `backup` command.
|
||||
You may skip the `backup-auth` step if your dokku install is running within EC2 and has access to the bucket via an IAM profile. In that case, use the `--use-iam` option with the `backup` command.
|
||||
|
||||
Backups can be performed using the backup commands:
|
||||
|
||||
### sets up authentication for backups on the redis service
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:backup-auth <service> <aws-access-key-id> <aws-secret-access-key> <aws-default-region> <aws-signature-version> <endpoint-url>
|
||||
```
|
||||
# setup s3 backup authentication
|
||||
|
||||
Setup s3 backup authentication:
|
||||
|
||||
```shell
|
||||
dokku redis:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
|
||||
|
||||
# remove s3 authentication
|
||||
dokku redis:backup-deauth lolipop
|
||||
|
||||
# backup the `lolipop` service to the `BUCKET_NAME` bucket on AWS
|
||||
dokku redis:backup lolipop BUCKET_NAME
|
||||
|
||||
# schedule a backup
|
||||
# CRON_SCHEDULE is a crontab expression, eg. "0 3 * * *" for each day at 3am
|
||||
dokku redis:backup-schedule lolipop CRON_SCHEDULE BUCKET_NAME
|
||||
|
||||
# cat the contents of the configured backup cronfile for the service
|
||||
dokku redis:backup-schedule-cat lolipop
|
||||
|
||||
# remove the scheduled backup from cron
|
||||
dokku redis:backup-unschedule lolipop
|
||||
```
|
||||
|
||||
Backup auth can also be set up for different regions, signature versions and endpoints (e.g. for minio):
|
||||
Setup s3 backup authentication with different region:
|
||||
|
||||
```
|
||||
# setup s3 backup authentication with different region
|
||||
```shell
|
||||
dokku redis:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
|
||||
```
|
||||
|
||||
# setup s3 backup authentication with different signature version and endpoint
|
||||
Setup s3 backup authentication with different signature version and endpoint:
|
||||
|
||||
```shell
|
||||
dokku redis:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL
|
||||
```
|
||||
|
||||
# more specific example for minio auth
|
||||
More specific example for minio auth:
|
||||
|
||||
```shell
|
||||
dokku redis:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
|
||||
```
|
||||
|
||||
## Disabling `docker pull` calls
|
||||
### removes backup authentication for the redis service
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:backup-deauth <service>
|
||||
```
|
||||
|
||||
Remove s3 authentication:
|
||||
|
||||
```shell
|
||||
dokku redis:backup-deauth lolipop
|
||||
```
|
||||
|
||||
### creates a backup of the redis service to an existing s3 bucket
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:backup <service> <bucket-name> [--use-iam]
|
||||
```
|
||||
|
||||
flags:
|
||||
|
||||
- `-u|--use-iam`: use the IAM profile associated with the current server
|
||||
|
||||
Backup the 'lolipop' service to the 'my-s3-bucket' bucket on ``AWS`:`
|
||||
|
||||
```shell
|
||||
dokku redis:backup lolipop my-s3-bucket --use-iam
|
||||
```
|
||||
|
||||
### sets encryption for all future backups of redis service
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:backup-set-encryption <service> <passphrase>
|
||||
```
|
||||
|
||||
Set the GPG-compatible passphrase for encrypting backups for backups:
|
||||
|
||||
```shell
|
||||
dokku redis:backup-set-encryption lolipop
|
||||
```
|
||||
|
||||
### unsets encryption for future backups of the redis service
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:backup-unset-encryption <service>
|
||||
```
|
||||
|
||||
Unset the `GPG` encryption passphrase for backups:
|
||||
|
||||
```shell
|
||||
dokku redis:backup-unset-encryption lolipop
|
||||
```
|
||||
|
||||
### schedules a backup of the redis service
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:backup-schedule <service> <schedule> <bucket-name> [--use-iam]
|
||||
```
|
||||
|
||||
flags:
|
||||
|
||||
- `-u|--use-iam`: use the IAM profile associated with the current server
|
||||
|
||||
Schedule a backup:
|
||||
|
||||
> 'schedule' is a crontab expression, eg. "0 3 * * *" for each day at 3am
|
||||
|
||||
```shell
|
||||
dokku redis:backup-schedule lolipop "0 3 * * *" my-s3-bucket
|
||||
```
|
||||
|
||||
Schedule a backup and authenticate via iam:
|
||||
|
||||
```shell
|
||||
dokku redis:backup-schedule lolipop "0 3 * * *" my-s3-bucket --use-iam
|
||||
```
|
||||
|
||||
### cat the contents of the configured backup cronfile for the service
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:backup-schedule-cat <service>
|
||||
```
|
||||
|
||||
Cat the contents of the configured backup cronfile for the service:
|
||||
|
||||
```shell
|
||||
dokku redis:backup-schedule-cat lolipop
|
||||
```
|
||||
|
||||
### unschedules the backup of the redis service
|
||||
|
||||
```shell
|
||||
# usage
|
||||
dokku redis:backup-unschedule <service>
|
||||
```
|
||||
|
||||
Remove the scheduled backup from cron:
|
||||
|
||||
```shell
|
||||
dokku redis:backup-unschedule lolipop
|
||||
```
|
||||
|
||||
### Disabling `docker pull` calls
|
||||
|
||||
If you wish to disable the `docker pull` calls that the plugin triggers, you may set the `REDIS_DISABLE_PULL` environment variable to `true`. Once disabled, you will need to pull the service image you wish to deploy as shown in the `stderr` output.
|
||||
|
||||
|
||||
518
bin/generate
Executable file
518
bin/generate
Executable file
@@ -0,0 +1,518 @@
|
||||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
from __future__ import print_function
|
||||
import os
|
||||
import re
|
||||
|
||||
|
||||
def compile(service, version, variable, alias, image, scheme, ports, sponsors, unimplemented, dokku_version):
|
||||
prefix = "\n\n".join([
|
||||
header(service),
|
||||
description(service, image, version),
|
||||
])
|
||||
|
||||
if len(sponsors) > 0:
|
||||
prefix += "\n\n"
|
||||
prefix += sponsors_section(service, sponsors)
|
||||
|
||||
return (
|
||||
"\n\n".join(
|
||||
[
|
||||
prefix,
|
||||
requirements_section(dokku_version),
|
||||
installation_section(service, dokku_version),
|
||||
commands_section(service, variable, alias, image, scheme, ports, unimplemented),
|
||||
usage_section(service, variable, alias, image, scheme, ports, 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://circleci.com/gh/dokku/dokku-{service}/tree/master)',
|
||||
f'[](https://webchat.freenode.net/?channels=dokku)',
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
def description(service, full_image, version):
|
||||
base = "_"
|
||||
image = full_image
|
||||
if "/" in full_image:
|
||||
base = "r/" + full_image.split("/")[0]
|
||||
image = full_image.split("/")[1]
|
||||
|
||||
return f"Official {service} plugin for dokku. Currently defaults to installing [{full_image} {version}](https://hub.docker.com/{base}/{image}/)."
|
||||
|
||||
|
||||
def sponsors_section(service, sponsors):
|
||||
if len(sponsors) == 0:
|
||||
return ""
|
||||
|
||||
sponsor_data = ["## Sponsors", "", f"The {service} plugin was generously sponsored by the following:", ""]
|
||||
sponsor_data.extend([f"- [{s}](https://github.com/{s})" for s in sponsors])
|
||||
|
||||
return "\n".join(
|
||||
sponsor_data
|
||||
)
|
||||
|
||||
|
||||
def requirements_section(dokku_version):
|
||||
return "\n".join(
|
||||
["## Requirements", "", f"- dokku {dokku_version}", "- docker 1.8.x",]
|
||||
)
|
||||
|
||||
|
||||
def installation_section(service, dokku_version):
|
||||
return "\n".join(
|
||||
[
|
||||
"## Installation",
|
||||
"",
|
||||
"```shell",
|
||||
f"# on {dokku_version}",
|
||||
f"sudo dokku plugin:install https://github.com/dokku/dokku-{service}.git {service}",
|
||||
"```",
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
def commands_section(service, variable, alias, image, scheme, ports, unimplemented):
|
||||
content = [
|
||||
"## Commands",
|
||||
"",
|
||||
"```",
|
||||
]
|
||||
|
||||
subcommands = os.listdir("subcommands")
|
||||
subcommands.sort()
|
||||
|
||||
command_list = []
|
||||
descriptions = []
|
||||
for filename in subcommands:
|
||||
if filename in unimplemented:
|
||||
continue
|
||||
data = command_data(filename, service, variable, alias, image, scheme, ports)
|
||||
description = data["description"]
|
||||
arguments = data["arguments_string"]
|
||||
|
||||
command_list.append(f"{service}:{filename} {arguments}")
|
||||
descriptions.append(description)
|
||||
|
||||
maxlen = max(map(len, command_list))
|
||||
if maxlen > 50:
|
||||
maxlen = 50
|
||||
for command, description in zip(command_list, descriptions):
|
||||
space_count = maxlen - len(command)
|
||||
content.append("{0}{1} # {2}".format(command, " " * space_count, description))
|
||||
|
||||
content.append("```")
|
||||
return "\n".join(content)
|
||||
|
||||
|
||||
def usage_section(service, variable, alias, image, scheme, ports, unimplemented):
|
||||
return "\n\n".join(
|
||||
[
|
||||
"## Usage",
|
||||
f"Help for any commands can be displayed by specifying the command as an argument to {service}:help. Please consult the `{service}:help` command for any undocumented commands.",
|
||||
usage_intro(service, variable, alias, image, scheme, ports, unimplemented),
|
||||
usage_lifecycle(service, variable, alias, image, scheme, ports, unimplemented),
|
||||
usage_automation(service, variable, alias, image, scheme, ports, unimplemented),
|
||||
usage_data_management(service, variable, alias, image, scheme, ports, unimplemented),
|
||||
usage_backup(service, variable, alias, image, scheme, ports, unimplemented),
|
||||
usage_docker_pull(service, variable, alias, image, scheme, ports, unimplemented),
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
def usage_intro(service, variable, alias, image, scheme, ports, unimplemented):
|
||||
commands = ["create", "info", "list", "logs", "link", "unlink"]
|
||||
content = ["### Basic Usage"]
|
||||
|
||||
return fetch_commands_content(
|
||||
service, variable, alias, image, scheme, ports, unimplemented, commands, content
|
||||
)
|
||||
|
||||
|
||||
def usage_lifecycle(service, variable, alias, image, scheme, ports, unimplemented):
|
||||
commands = [
|
||||
"connect",
|
||||
"enter",
|
||||
"expose",
|
||||
"unexpose",
|
||||
"promote",
|
||||
"start",
|
||||
"stop",
|
||||
"restart",
|
||||
"upgrade",
|
||||
]
|
||||
content = [
|
||||
"### Service Lifecycle",
|
||||
"",
|
||||
"The lifecycle of each service can be managed through the following commands:",
|
||||
"",
|
||||
]
|
||||
|
||||
return fetch_commands_content(
|
||||
service, variable, alias, image, scheme, ports, unimplemented, commands, content
|
||||
)
|
||||
|
||||
|
||||
def usage_automation(service, variable, alias, image, scheme, ports, unimplemented):
|
||||
commands = ["app-links", "clone", "exists", "linked", "links"]
|
||||
content = [
|
||||
"### Service Automation",
|
||||
"",
|
||||
"Service scripting can be executed using the following commands:",
|
||||
"",
|
||||
]
|
||||
|
||||
return fetch_commands_content(
|
||||
service, variable, alias, image, scheme, ports, unimplemented, commands, content
|
||||
)
|
||||
|
||||
|
||||
def usage_data_management(service, variable, alias, image, scheme, ports, unimplemented):
|
||||
commands = ["import", "export"]
|
||||
content = [
|
||||
"### Data Management",
|
||||
"",
|
||||
"The underlying service data can be imported and exported with the following commands:",
|
||||
"",
|
||||
]
|
||||
|
||||
return fetch_commands_content(
|
||||
service, variable, alias, image, scheme, ports, unimplemented, commands, content
|
||||
)
|
||||
|
||||
|
||||
def usage_backup(service, variable, alias, image, scheme, ports, unimplemented):
|
||||
commands = [
|
||||
"backup-auth",
|
||||
"backup-deauth",
|
||||
"backup",
|
||||
"backup-set-encryption",
|
||||
"backup-unset-encryption",
|
||||
"backup-schedule",
|
||||
"backup-schedule-cat",
|
||||
"backup-unschedule",
|
||||
]
|
||||
content = [
|
||||
"### Backups",
|
||||
"",
|
||||
"Datastore backups are supported via AWS S3 and S3 compatible services like [minio](https://github.com/minio/minio).",
|
||||
"",
|
||||
"You may skip the `backup-auth` step if your dokku install is running within EC2 and has access to the bucket via an IAM profile. In that case, use the `--use-iam` option with the `backup` command.",
|
||||
"",
|
||||
"Backups can be performed using the backup commands:",
|
||||
"",
|
||||
]
|
||||
|
||||
return fetch_commands_content(
|
||||
service, variable, alias, image, scheme, ports, unimplemented, commands, content
|
||||
)
|
||||
|
||||
|
||||
def usage_docker_pull(service, variable, alias, image, scheme, ports, unimplemented):
|
||||
service_prefix = service.upper()
|
||||
return "\n".join(
|
||||
[
|
||||
"### Disabling `docker pull` calls",
|
||||
"",
|
||||
f"If you wish to disable the `docker pull` calls that the plugin triggers, you may set the `{service_prefix}_DISABLE_PULL` environment variable to `true`. Once disabled, you will need to pull the service image you wish to deploy as shown in the `stderr` output.",
|
||||
"",
|
||||
"Please ensure the proper images are in place when `docker pull` is disabled.",
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
def fetch_commands_content(
|
||||
service, variable, alias, image, scheme, ports, unimplemented, commands, content
|
||||
):
|
||||
i = 0
|
||||
for command in commands:
|
||||
output = command_help(command, service, variable, alias, image, scheme, ports, unimplemented)
|
||||
if output == "":
|
||||
continue
|
||||
content.append(output)
|
||||
i += 1
|
||||
|
||||
if i == 0:
|
||||
return ""
|
||||
|
||||
return "\n".join(content)
|
||||
|
||||
|
||||
def parse_args(line):
|
||||
line = line.strip()
|
||||
arguments = []
|
||||
for arg in re.findall("([A-Z_]+)", line):
|
||||
arg = arg.replace("_", "-").lower()
|
||||
if arg.endswith("optional-flag"):
|
||||
arg = arg.replace("-optional-flag", "")
|
||||
arguments.append(f"[--{arg}]")
|
||||
elif arg.endswith("-flag"):
|
||||
if arg == "info-flag":
|
||||
arguments.append(f"[--single-info-flag]")
|
||||
else:
|
||||
arg = arg.replace("-flag", "")
|
||||
first_letter = arg[0]
|
||||
arguments.append(f"[-{first_letter}|--{arg}]")
|
||||
elif arg.endswith("-flags-list"):
|
||||
arg = arg.replace("-list", "")
|
||||
arguments.append(f"[--{arg}...]")
|
||||
elif arg.endswith("list"):
|
||||
arg = arg.replace("-list", "")
|
||||
arguments.append(f"<{arg}...>")
|
||||
else:
|
||||
arguments.append(f"<{arg}>")
|
||||
return " ".join(arguments)
|
||||
|
||||
|
||||
def command_help(command, service, variable, alias, image, scheme, ports, unimplemented):
|
||||
if command in unimplemented:
|
||||
return ""
|
||||
|
||||
data = command_data(command, service, variable, alias, image, scheme, ports)
|
||||
content = [
|
||||
f"### {data['description']}",
|
||||
"",
|
||||
"```shell",
|
||||
"# usage",
|
||||
f"dokku {service}:{command} {data['arguments_string']}",
|
||||
"```",
|
||||
]
|
||||
|
||||
# if len(data["arguments"]) > 0:
|
||||
# content.append("")
|
||||
# content.append("arguments:")
|
||||
# content.append("")
|
||||
# for argument in data["arguments"]:
|
||||
# content.append(f"- {argument}")
|
||||
|
||||
if len(data["flags"]) > 0:
|
||||
content.append("")
|
||||
content.append("flags:")
|
||||
content.append("")
|
||||
for flag in data["flags"]:
|
||||
content.append(f"- {flag}")
|
||||
|
||||
if len(data["examples"]) > 0:
|
||||
content.append("")
|
||||
content.append(data["examples"])
|
||||
|
||||
return "\n" + "\n".join(content)
|
||||
|
||||
|
||||
def command_data(command, service, variable, alias, image, scheme, ports):
|
||||
description = None
|
||||
arguments = []
|
||||
arguments_string = ""
|
||||
example_lines = []
|
||||
flags = []
|
||||
with open(os.path.join("subcommands", command)) as f:
|
||||
for line in f.readlines():
|
||||
line = line.strip()
|
||||
line = line.replace("$PLUGIN_SERVICE", service)
|
||||
line = line.replace("$PLUGIN_COMMAND_PREFIX", service)
|
||||
line = line.replace("${PLUGIN_COMMAND_PREFIX}", service)
|
||||
line = line.replace("${PLUGIN_VARIABLE}", variable)
|
||||
line = line.replace("${PLUGIN_DEFAULT_ALIAS}", alias)
|
||||
line = line.replace("${PLUGIN_IMAGE}", image)
|
||||
line = line.replace("${PLUGIN_SCHEME}", scheme)
|
||||
line = line.replace("${PLUGIN_DATASTORE_PORTS[0]}", ports[0])
|
||||
line = line.replace("${PLUGIN_DATASTORE_PORTS[@]}", " ".join(ports))
|
||||
|
||||
if "declare desc" in line:
|
||||
description = re.search('"(.+)"', line).group(1)
|
||||
elif "$1" in line:
|
||||
arguments_string = parse_args(line)
|
||||
elif line.startswith("#A "):
|
||||
argument = line.replace("#A ", "")
|
||||
parts = [a.strip() for a in argument.split(",", 1)]
|
||||
arguments.append(f"`{parts[0]}`: {parts[1]}")
|
||||
elif line.startswith("#F "):
|
||||
flag = line.replace("#F ", "")
|
||||
parts = [a.strip() for a in flag.split(",", 1)]
|
||||
flags.append(f"`{parts[0]}`: {parts[1]}")
|
||||
elif line.startswith("#E "):
|
||||
example_lines.append(line.replace("#E ", ""))
|
||||
|
||||
examples = []
|
||||
sentence_lines = []
|
||||
command_lines = []
|
||||
codeblock_lines = []
|
||||
blockquote_lines = []
|
||||
for line in example_lines:
|
||||
if line.startswith("export") or line.startswith("dokku"):
|
||||
if len(blockquote_lines) > 0:
|
||||
examples.append("\n" + process_blockquote(blockquote_lines))
|
||||
blockquote_lines = []
|
||||
if len(codeblock_lines) > 0:
|
||||
examples.append("\n" + process_codeblock(codeblock_lines))
|
||||
codeblock_lines = []
|
||||
if len(sentence_lines) > 0:
|
||||
examples.append("\n" + process_sentence(sentence_lines))
|
||||
sentence_lines = []
|
||||
|
||||
command_lines.append(line)
|
||||
elif line.startswith(" "):
|
||||
if len(blockquote_lines) > 0:
|
||||
examples.append("\n" + process_blockquote(blockquote_lines))
|
||||
blockquote_lines = []
|
||||
if len(command_lines) > 0:
|
||||
examples.append("\n" + process_command(command_lines))
|
||||
command_lines = []
|
||||
if len(sentence_lines) > 0:
|
||||
examples.append("\n" + process_sentence(sentence_lines))
|
||||
sentence_lines = []
|
||||
|
||||
codeblock_lines.append(line.strip())
|
||||
elif line.startswith(">"):
|
||||
if len(codeblock_lines) > 0:
|
||||
examples.append("\n" + process_codeblock(codeblock_lines))
|
||||
codeblock_lines = []
|
||||
if len(command_lines) > 0:
|
||||
examples.append("\n" + process_command(command_lines))
|
||||
command_lines = []
|
||||
if len(sentence_lines) > 0:
|
||||
examples.append("\n" + process_sentence(sentence_lines))
|
||||
sentence_lines = []
|
||||
|
||||
blockquote_lines.append(line)
|
||||
else:
|
||||
if len(blockquote_lines) > 0:
|
||||
examples.append("\n" + process_blockquote(blockquote_lines))
|
||||
blockquote_lines = []
|
||||
if len(codeblock_lines) > 0:
|
||||
examples.append("\n" + process_codeblock(codeblock_lines))
|
||||
codeblock_lines = []
|
||||
if len(command_lines) > 0:
|
||||
examples.append("\n" + process_command(command_lines))
|
||||
command_lines = []
|
||||
|
||||
sentence_lines.append(line)
|
||||
|
||||
if len(blockquote_lines) > 0:
|
||||
examples.append("\n" + process_blockquote(blockquote_lines))
|
||||
blockquote_lines = []
|
||||
if len(codeblock_lines) > 0:
|
||||
examples.append("\n" + process_codeblock(codeblock_lines))
|
||||
codeblock_lines = []
|
||||
if len(command_lines) > 0:
|
||||
examples.append("\n" + process_command(command_lines))
|
||||
command_lines = []
|
||||
if len(sentence_lines) > 0:
|
||||
examples.append("\n" + process_sentence(sentence_lines))
|
||||
sentence_lines = []
|
||||
|
||||
return {
|
||||
"description": description,
|
||||
"arguments_string": arguments_string,
|
||||
"arguments": arguments,
|
||||
"flags": flags,
|
||||
"examples": "\n".join(examples).strip(),
|
||||
}
|
||||
|
||||
|
||||
def process_sentence(sentence_lines):
|
||||
sentence_lines = " ".join(sentence_lines)
|
||||
sentences = ". ".join(
|
||||
upperfirst(i.strip()) for i in sentence_lines.split(".")
|
||||
).strip()
|
||||
if not sentences.endswith(".") and not sentences.endswith(":"):
|
||||
sentences += ":"
|
||||
|
||||
text = []
|
||||
for sentence in sentences.split("."):
|
||||
parts = []
|
||||
for word in sentence.strip().split(" "):
|
||||
if word.isupper() and len(word) > 1:
|
||||
for ending in [':', '.']:
|
||||
if word.endswith(ending):
|
||||
word = '`{0}`{1}'.format(word[:-1], ending)
|
||||
else:
|
||||
word = '`{0}`'.format(word)
|
||||
parts.append(word)
|
||||
text.append(" ".join(parts))
|
||||
|
||||
text = ". ".join(text)
|
||||
|
||||
# some cleanup
|
||||
text = text.replace("(0. 0. 0. 0)", "(`0.0.0.0`)")
|
||||
|
||||
return text
|
||||
|
||||
|
||||
def upperfirst(x):
|
||||
return x[:1].upper() + x[1:]
|
||||
|
||||
|
||||
def process_blockquote(blockquote_lines):
|
||||
return "\n".join(blockquote_lines)
|
||||
|
||||
|
||||
def process_command(command_lines):
|
||||
command_lines = "\n".join(command_lines)
|
||||
return f"```shell\n{command_lines}\n```"
|
||||
|
||||
|
||||
def process_codeblock(codeblock_lines):
|
||||
codeblock_lines = "\n".join(codeblock_lines)
|
||||
return f"```\n{codeblock_lines}\n```"
|
||||
|
||||
|
||||
def main():
|
||||
service = None
|
||||
version = None
|
||||
variable = None
|
||||
image = None
|
||||
alias = None
|
||||
unimplemented = []
|
||||
|
||||
with open("Dockerfile") as f:
|
||||
for line in f.readlines():
|
||||
if "FROM " in line:
|
||||
image, version = line.split(" ")[1].split(":")
|
||||
image = image.strip()
|
||||
version = version.strip()
|
||||
|
||||
with open("config") as f:
|
||||
for line in f.readlines():
|
||||
if "PLUGIN_COMMAND_PREFIX=" in line:
|
||||
service = re.search('"(.+)"', line).group(1)
|
||||
if "PLUGIN_DEFAULT_ALIAS=" in line:
|
||||
alias = re.search('"(.+)"', line).group(1)
|
||||
if "PLUGIN_VARIABLE=" in line:
|
||||
variable = re.search('"(.+)"', line).group(1)
|
||||
if "PLUGIN_SCHEME=" in line:
|
||||
scheme = re.search('"(.+)"', line).group(1)
|
||||
if "PLUGIN_DATASTORE_PORTS=" in line:
|
||||
ports = re.search("\((.+)\)", line).group(1).split(" ")
|
||||
if "PLUGIN_UNIMPLEMENTED_SUBCOMMANDS=" in line:
|
||||
match = re.search("\((.+)\)", line)
|
||||
if match is not None:
|
||||
unimplemented = [s.strip('"') for s in match.group(1).split(" ")]
|
||||
|
||||
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, 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)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -1,4 +1,5 @@
|
||||
#!/usr/bin/env bash
|
||||
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
|
||||
set -eo pipefail
|
||||
[[ $DOKKU_TRACE ]] && set -x
|
||||
source "$PLUGIN_AVAILABLE_PATH/config/functions"
|
||||
@@ -14,7 +15,7 @@ docker_ports_options() {
|
||||
get_container_ip() {
|
||||
declare desc="Retrieves the ip address of a container"
|
||||
declare CONTAINER_ID="$1"
|
||||
docker inspect --format '{{ .NetworkSettings.IPAddress }}' "$CONTAINER_ID"
|
||||
docker inspect --format '{{ .NetworkSettings.IPAddress }}' "$CONTAINER_ID" 2>/dev/null
|
||||
}
|
||||
|
||||
get_database_name() {
|
||||
@@ -187,18 +188,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")"
|
||||
@@ -217,7 +218,7 @@ service_backup() {
|
||||
fi
|
||||
|
||||
# shellcheck disable=SC2086
|
||||
docker run --rm $BACKUP_PARAMETERS dokku/s3backup:0.9.4
|
||||
docker run --rm $BACKUP_PARAMETERS "$PLUGIN_S3BACKUP_IMAGE"
|
||||
}
|
||||
|
||||
service_backup_auth() {
|
||||
@@ -382,7 +383,7 @@ service_info() {
|
||||
local flag key valid_flags
|
||||
|
||||
local flag_map=(
|
||||
"--config-dir: ${SERVICE_ROOT}/config"
|
||||
"--config-dir: ${SERVICE_ROOT}/${PLUGIN_CONFIG_SUFFIX}"
|
||||
"--data-dir: ${SERVICE_ROOT}/data"
|
||||
"--dsn: ${SERVICE_URL}"
|
||||
"--exposed-ports: $(service_exposed_ports "$SERVICE")"
|
||||
@@ -394,7 +395,7 @@ service_info() {
|
||||
"--version: $(service_version "$SERVICE")"
|
||||
)
|
||||
if [[ -z "$INFO_FLAG" ]]; then
|
||||
dokku_log_info2 "Container Information"
|
||||
dokku_log_info2 "$SERVICE $PLUGIN_COMMAND_PREFIX service information"
|
||||
for flag in "${flag_map[@]}"; do
|
||||
key="$(echo "${flag#--}" | cut -f1 -d' ' | tr - ' ')"
|
||||
dokku_log_verbose "$(printf "%-20s %-25s" "${key^}" "${flag#*: }")"
|
||||
@@ -452,6 +453,7 @@ service_link() {
|
||||
fi
|
||||
|
||||
[[ -n $LINK ]] && dokku_log_fail "Already linked as $LINK"
|
||||
plugn trigger service-action pre-link "$SERVICE" "$APP"
|
||||
touch "$LINKS_FILE"
|
||||
echo "$APP" >>"$LINKS_FILE"
|
||||
sort "$LINKS_FILE" -u -o "$LINKS_FILE"
|
||||
@@ -464,11 +466,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 applications linked to a service"
|
||||
declare desc="Lists 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"
|
||||
@@ -479,22 +483,31 @@ service_linked_apps() {
|
||||
tr '\n' ' ' <"$LINKS_FILE"
|
||||
}
|
||||
|
||||
service_links() {
|
||||
declare desc="Lists all apps linked to a service"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local LINKS_FILE="$SERVICE_ROOT/LINKS"
|
||||
|
||||
touch "$LINKS_FILE"
|
||||
[[ -z $(<"$LINKS_FILE") ]] && return 0
|
||||
|
||||
cat "$LINKS_FILE"
|
||||
}
|
||||
|
||||
service_list() {
|
||||
declare desc="Lists all services and their status"
|
||||
local SERVICES=$(ls "$PLUGIN_DATA_ROOT" 2>/dev/null)
|
||||
|
||||
if [[ -z $SERVICES ]]; then
|
||||
dokku_log_warn "There are no $PLUGIN_SERVICE services"
|
||||
else
|
||||
LIST=""
|
||||
if [[ -z "$DOKKU_QUIET_OUTPUT" ]]; then
|
||||
LIST="NAME,VERSION,STATUS,EXPOSED PORTS,LINKS\n"
|
||||
return
|
||||
fi
|
||||
|
||||
dokku_log_info2_quiet "$PLUGIN_SERVICE services"
|
||||
for SERVICE in $SERVICES; do
|
||||
LIST+="$SERVICE,$(service_version "$SERVICE"),$(service_status "$SERVICE"),$(service_exposed_ports "$SERVICE"),$(service_linked_apps "$SERVICE")\n"
|
||||
echo "$SERVICE"
|
||||
done
|
||||
printf "%b" "$LIST" | column -t -s,
|
||||
fi
|
||||
}
|
||||
|
||||
service_logs() {
|
||||
@@ -586,6 +599,26 @@ service_parse_args() {
|
||||
shift "$((OPTIND - 1))" # remove options from positional parameters
|
||||
}
|
||||
|
||||
service_password() {
|
||||
declare desc="Fetch the password for a service"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local PASSWORD_FILE="$SERVICE_ROOT/PASSWORD"
|
||||
if [[ -f "$PASSWORD_FILE" ]]; then
|
||||
cat "$PASSWORD_FILE"
|
||||
fi
|
||||
}
|
||||
|
||||
service_root_password() {
|
||||
declare desc="Fetch the root password for a service"
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local PASSWORD_FILE="$SERVICE_ROOT/ROOTPASSWORD"
|
||||
if [[ -f "$PASSWORD_FILE" ]]; then
|
||||
cat "$PASSWORD_FILE"
|
||||
fi
|
||||
}
|
||||
|
||||
service_port_expose() {
|
||||
declare desc="Wrapper for exposing service ports"
|
||||
declare SERVICE="$1"
|
||||
@@ -657,7 +690,7 @@ service_port_unpause() {
|
||||
echo "${PORTS[@]}" >"$PORT_FILE"
|
||||
|
||||
# shellcheck disable=SC2046
|
||||
docker run -d --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" --name "$EXPOSED_NAME" $(docker_ports_options "${PORTS[@]}") --restart always --label dokku=ambassador --label "dokku.ambassador=$PLUGIN_COMMAND_PREFIX" dokku/ambassador:0.2.0 >/dev/null
|
||||
docker run -d --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" --name "$EXPOSED_NAME" $(docker_ports_options "${PORTS[@]}") --restart always --label dokku=ambassador --label "dokku.ambassador=$PLUGIN_COMMAND_PREFIX" "$PLUGIN_AMBASSADOR_IMAGE" >/dev/null
|
||||
if [[ "$LOG_FAIL" == "true" ]]; then
|
||||
dokku_log_info1 "Service $SERVICE exposed on port(s) [container->host]: $(service_exposed_ports "$SERVICE")"
|
||||
fi
|
||||
@@ -708,13 +741,7 @@ service_status() {
|
||||
local ID="$(cat "$SERVICE_ROOT/ID")"
|
||||
local CONTAINER_STATUS
|
||||
|
||||
is_container_status "$ID" "Dead" && echo "dead" && return 0
|
||||
is_container_status "$ID" "OOMKilled" && echo "oomkilled" && return 0
|
||||
is_container_status "$ID" "Paused" && echo "paused" && return 0
|
||||
is_container_status "$ID" "Restarting" && echo "restarting" && return 0
|
||||
is_container_status "$ID" "Running" && echo "running" && return 0
|
||||
|
||||
CONTAINER_STATUS=$(docker inspect -f "{{.State.Status}}" "$CID" 2>/dev/null || true)
|
||||
CONTAINER_STATUS=$(docker inspect -f "{{.State.Status}}" "$ID" 2>/dev/null || true)
|
||||
[[ -n "$CONTAINER_STATUS" ]] && echo "$CONTAINER_STATUS" && return 0
|
||||
echo "missing" && return 0
|
||||
}
|
||||
@@ -747,6 +774,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
|
||||
@@ -758,7 +786,9 @@ service_unlink() {
|
||||
fi
|
||||
|
||||
[[ -z ${LINK[*]} ]] && dokku_log_fail "Not linked to app $APP"
|
||||
plugn trigger service-action post-unlink "$SERVICE" "$APP"
|
||||
config_unset "$APP" "${LINK[*]}"
|
||||
plugn trigger service-action post-unlink-complete "$SERVICE" "$APP"
|
||||
}
|
||||
|
||||
service_version() {
|
||||
|
||||
11
config
11
config
@@ -1,6 +1,7 @@
|
||||
#!/usr/bin/env bash
|
||||
export REDIS_IMAGE=${REDIS_IMAGE:="redis"}
|
||||
export REDIS_IMAGE_VERSION=${REDIS_IMAGE_VERSION:="5.0.4"}
|
||||
_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
export REDIS_IMAGE=${REDIS_IMAGE:="$(awk -F '[ :]' '{print $2}' "${_DIR}/Dockerfile")"}
|
||||
export REDIS_IMAGE_VERSION=${REDIS_IMAGE_VERSION:="$(awk -F '[ :]' '{print $3}' "${_DIR}/Dockerfile")"}
|
||||
export REDIS_ROOT=${REDIS_ROOT:="$DOKKU_LIB_ROOT/services/redis"}
|
||||
export REDIS_HOST_ROOT=${REDIS_HOST_ROOT:=$REDIS_ROOT}
|
||||
|
||||
@@ -21,6 +22,12 @@ export PLUGIN_SCHEME="redis"
|
||||
export PLUGIN_SERVICE="Redis"
|
||||
export PLUGIN_VARIABLE="REDIS"
|
||||
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 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"
|
||||
|
||||
39
functions
39
functions
@@ -40,15 +40,16 @@ 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"
|
||||
|
||||
if [[ -z $REDIS_CONFIG_PATH ]]; then
|
||||
curl -sSL "https://raw.githubusercontent.com/antirez/redis/${PLUGIN_IMAGE_VERSION:0:3}/redis.conf" >"$SERVICE_ROOT/config/redis.conf" || dokku_log_fail "Unable to download the default redis.conf to the config directory"
|
||||
curl -sSL "https://raw.githubusercontent.com/antirez/redis/${PLUGIN_IMAGE_VERSION:0:3}/redis.conf" >"$SERVICE_ROOT/$PLUGIN_CONFIG_SUFFIX/redis.conf" || dokku_log_fail "Unable to download the default redis.conf to the config directory"
|
||||
else
|
||||
cp "$REDIS_CONFIG_PATH" "$SERVICE_ROOT/config/redis.conf" || dokku_log_fail "Unable to copy the ${REDIS_CONFIG_PATH} to the config directory"
|
||||
cp "$REDIS_CONFIG_PATH" "$SERVICE_ROOT/$PLUGIN_CONFIG_SUFFIX/redis.conf" || dokku_log_fail "Unable to copy the ${REDIS_CONFIG_PATH} to the config directory"
|
||||
fi
|
||||
PASSWORD=$(openssl rand -hex 32)
|
||||
if [[ -n "$SERVICE_PASSWORD" ]]; then
|
||||
@@ -57,7 +58,7 @@ service_create() {
|
||||
fi
|
||||
echo "$PASSWORD" >"$SERVICE_ROOT/PASSWORD"
|
||||
chmod 640 "$SERVICE_ROOT/PASSWORD"
|
||||
sed -i.bak "s/# requirepass.*/requirepass ${PASSWORD}/" "$SERVICE_ROOT/config/redis.conf" && rm "$SERVICE_ROOT/config/redis.conf.bak"
|
||||
sed -i.bak "s/# requirepass.*/requirepass ${PASSWORD}/" "$SERVICE_ROOT/$PLUGIN_CONFIG_SUFFIX/redis.conf" && rm "$SERVICE_ROOT/$PLUGIN_CONFIG_SUFFIX/redis.conf.bak"
|
||||
|
||||
[[ -n "$SERVICE_CUSTOM_ENV" ]] && REDIS_CUSTOM_ENV="$SERVICE_CUSTOM_ENV"
|
||||
if [[ -n $REDIS_CUSTOM_ENV ]]; then
|
||||
@@ -67,7 +68,9 @@ service_create() {
|
||||
fi
|
||||
|
||||
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() {
|
||||
@@ -76,11 +79,11 @@ service_create_container() {
|
||||
local SERVICE_HOST_ROOT="$PLUGIN_DATA_HOST_ROOT/$SERVICE"
|
||||
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||
|
||||
ID=$(docker run --name "$SERVICE_NAME" -v "$SERVICE_HOST_ROOT/data:/data" -v "$SERVICE_HOST_ROOT/config:/usr/local/etc/redis" --env-file="$SERVICE_ROOT/ENV" -d --restart always --label dokku=service --label dokku.service=redis "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" redis-server /usr/local/etc/redis/redis.conf --bind 0.0.0.0)
|
||||
ID=$(docker run --name "$SERVICE_NAME" -v "$SERVICE_HOST_ROOT/data:/data" -v "$SERVICE_HOST_ROOT/$PLUGIN_CONFIG_SUFFIX:/usr/local/etc/redis" --env-file="$SERVICE_ROOT/ENV" -d --restart always --label dokku=service --label dokku.service=redis "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" redis-server /usr/local/etc/redis/redis.conf --bind 0.0.0.0)
|
||||
echo "$ID" >"$SERVICE_ROOT/ID"
|
||||
|
||||
dokku_log_verbose_quiet "Waiting for container to be ready"
|
||||
docker run --rm --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" dokku/wait:0.3.0 -p "$PLUGIN_DATASTORE_WAIT_PORT" >/dev/null
|
||||
docker run --rm --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" "$PLUGIN_WAIT_IMAGE" -p "$PLUGIN_DATASTORE_WAIT_PORT" >/dev/null
|
||||
|
||||
dokku_log_info2 "$PLUGIN_SERVICE container created: $SERVICE"
|
||||
service_info "$SERVICE"
|
||||
@@ -93,7 +96,16 @@ service_export() {
|
||||
local PASSWORD="$(service_password "$SERVICE")"
|
||||
|
||||
[[ -n $SSH_TTY ]] && stty -opost
|
||||
docker exec "$SERVICE_NAME" bash -c "echo SAVE | redis-cli -a ${PASSWORD}" >/dev/null 2>&1
|
||||
LASTSAVE1=$(docker exec "$SERVICE_NAME" bash -c "echo LASTSAVE | redis-cli -a ${PASSWORD}")
|
||||
docker exec "$SERVICE_NAME" bash -c "echo BGSAVE | redis-cli -a ${PASSWORD}" >/dev/null 2>&1
|
||||
LASTSAVE2=$(docker exec "$SERVICE_NAME" bash -c "echo LASTSAVE | redis-cli -a ${PASSWORD}")
|
||||
|
||||
until [[ "$LASTSAVE1" != "$LASTSAVE2" ]];
|
||||
do
|
||||
LASTSAVE2=$(docker exec "$SERVICE_NAME" bash -c "echo LASTSAVE | redis-cli -a ${PASSWORD}")
|
||||
sleep 5
|
||||
done
|
||||
|
||||
docker exec "$SERVICE_NAME" cat /data/dump.rdb
|
||||
status=$?
|
||||
[[ -n $SSH_TTY ]] && stty opost
|
||||
@@ -121,6 +133,10 @@ service_start() {
|
||||
local ID=$(docker ps -aq --no-trunc --filter "status=running" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
|
||||
if [[ -n $ID ]]; then
|
||||
[[ -z $QUIET ]] && dokku_log_warn "Service is already started"
|
||||
if [[ ! -f "$SERVICE_ROOT/ID" ]] || [[ "$(cat "$SERVICE_ROOT/ID")" != "$ID" ]]; then
|
||||
[[ -z $QUIET ]] && dokku_log_warn "Updating local container ID"
|
||||
echo "$ID" >"$SERVICE_ROOT/ID"
|
||||
fi
|
||||
return 0
|
||||
fi
|
||||
|
||||
@@ -138,16 +154,9 @@ service_start() {
|
||||
fi
|
||||
}
|
||||
|
||||
service_password() {
|
||||
local SERVICE="$1"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local PASSWORD="$(cat "$SERVICE_ROOT/PASSWORD")"
|
||||
echo "$PASSWORD"
|
||||
}
|
||||
|
||||
service_url() {
|
||||
local SERVICE="$1"
|
||||
local PASSWORD="$(service_password "$SERVICE")"
|
||||
local SERVICE_DNS_HOSTNAME="$(service_dns_hostname "$SERVICE")"
|
||||
echo "$PLUGIN_SCHEME://$SERVICE:$PASSWORD@$SERVICE_DNS_HOSTNAME:${PLUGIN_DATASTORE_PORTS[0]}"
|
||||
echo "$PLUGIN_SCHEME://:$PASSWORD@$SERVICE_DNS_HOSTNAME:${PLUGIN_DATASTORE_PORTS[0]}"
|
||||
}
|
||||
|
||||
@@ -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"
|
||||
@@ -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
|
||||
}
|
||||
|
||||
@@ -191,7 +191,7 @@ fn-help-subcommand-args() {
|
||||
if [[ "$arg" == *_FLAG ]]; then
|
||||
arg="${arg/_FLAG/}"
|
||||
if [[ $arg == "INFO" ]]; then
|
||||
arg="SINGLE_INFO_FLAG..."
|
||||
arg="SINGLE_INFO_FLAG"
|
||||
args+=" ${BLUE}[--${arg//_/-}]${NORMAL}"
|
||||
else
|
||||
args+=" ${BLUE}[-${arg:0:1}|--${arg//_/-}]${NORMAL}"
|
||||
|
||||
8
install
8
install
@@ -17,10 +17,10 @@ plugin-install() {
|
||||
}
|
||||
|
||||
pull-docker-image "${PLUGIN_IMAGE}:${PLUGIN_IMAGE_VERSION}"
|
||||
pull-docker-image "dokku/ambassador:0.2.0"
|
||||
pull-docker-image "dokku/wait:0.3.0"
|
||||
pull-docker-image "dokku/s3backup:0.9.4"
|
||||
pull-docker-image "busybox:1.30.1-uclibc"
|
||||
pull-docker-image "$PLUGIN_BUSYBOX_IMAGE"
|
||||
pull-docker-image "$PLUGIN_AMBASSADOR_IMAGE"
|
||||
pull-docker-image "$PLUGIN_S3BACKUP_IMAGE"
|
||||
pull-docker-image "$PLUGIN_WAIT_IMAGE"
|
||||
|
||||
mkdir -p "$PLUGIN_DATA_ROOT" || echo "Failed to create $PLUGIN_SERVICE data directory"
|
||||
chown dokku:dokku "$PLUGIN_DATA_ROOT"
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[plugin]
|
||||
description = "dokku redis service plugin"
|
||||
version = "1.8.0"
|
||||
version = "1.15.0"
|
||||
[plugin.config]
|
||||
|
||||
@@ -6,7 +6,7 @@ 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 set the GPG-compatible passphrase for encrypting backups for backups
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-set-encryption lolipop
|
||||
#A service, service to run command against
|
||||
#A passphrase, a GPG-compatible passphrase
|
||||
|
||||
@@ -6,7 +6,7 @@ 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 unset the GPG encryption passphrase for backups
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:backup-unset-encryption lolipop
|
||||
#A service, service to run command against
|
||||
declare desc="unsets encryption for future backups of the $PLUGIN_SERVICE service"
|
||||
|
||||
@@ -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" busybox:1.30.1-uclibc 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"
|
||||
}
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ service-info-cmd() {
|
||||
#F --service-root, show the service root directory
|
||||
#F --status, show the service running status
|
||||
#F --version, show the service image version
|
||||
declare desc="print the connection information"
|
||||
declare desc="print the service information"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:info" argv=("$@")
|
||||
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||
declare SERVICE="$1" INFO_FLAG="$2"
|
||||
|
||||
@@ -23,21 +23,21 @@ service-link-cmd() {
|
||||
#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}://:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lolipop:${PLUGIN_DATASTORE_PORTS[0]}/lolipop
|
||||
#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 config:set playground ${PLUGIN_VARIABLE}_DATABASE_SCHEME=${PLUGIN_SCHEME}2
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:link lolipop 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://:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lolipop:${PLUGIN_DATASTORE_PORTS[0]}/lolipop
|
||||
#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
|
||||
|
||||
24
subcommands/links
Executable file
24
subcommands/links
Executable file
@@ -0,0 +1,24 @@
|
||||
#!/usr/bin/env bash
|
||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||
set -eo pipefail
|
||||
[[ $DOKKU_TRACE ]] && set -x
|
||||
source "$PLUGIN_BASE_PATH/common/functions"
|
||||
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||
|
||||
service-links-cmd() {
|
||||
#E list all apps linked to the 'lolipop' $PLUGIN_COMMAND_PREFIX service.
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:links lolipop
|
||||
#A service, service to run command against
|
||||
declare desc="list all apps linked to the $PLUGIN_SERVICE service"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:links" argv=("$@")
|
||||
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||
declare SERVICE="$1"
|
||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||
local LINKS_FILE="$SERVICE_ROOT/LINKS"
|
||||
|
||||
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
|
||||
verify_service_name "$SERVICE"
|
||||
service_links "$SERVICE"
|
||||
}
|
||||
|
||||
service-links-cmd "$@"
|
||||
@@ -9,7 +9,7 @@ service-promote-cmd() {
|
||||
#E if you have a $PLUGIN_COMMAND_PREFIX service linked to an app and try to link another $PLUGIN_COMMAND_PREFIX service
|
||||
#E another link environment variable will be generated automatically:
|
||||
#E
|
||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_BLUE_URL=${PLUGIN_SCHEME}://other_service:ANOTHER_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-other-service:${PLUGIN_DATASTORE_PORTS[0]}/other_service
|
||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_BLUE_URL=${PLUGIN_SCHEME}://:ANOTHER_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-other-service:${PLUGIN_DATASTORE_PORTS[0]}/other_service
|
||||
#E
|
||||
#E you can promote the new service to be the primary one
|
||||
#E > NOTE: this will restart your app
|
||||
@@ -18,9 +18,9 @@ service-promote-cmd() {
|
||||
#E another environment variable to hold the previous value if necessary.
|
||||
#E you could end up with the following for example:
|
||||
#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 ${PLUGIN_DEFAULT_ALIAS}_URL=${PLUGIN_SCHEME}://:ANOTHER_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-other-service:${PLUGIN_DATASTORE_PORTS[0]}/other_service
|
||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_BLUE_URL=${PLUGIN_SCHEME}://:ANOTHER_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-other-service:${PLUGIN_DATASTORE_PORTS[0]}/other_service
|
||||
#E DOKKU_${PLUGIN_DEFAULT_ALIAS}_SILVER_URL=${PLUGIN_SCHEME}://:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lolipop:${PLUGIN_DATASTORE_PORTS[0]}/lolipop
|
||||
#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>"
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -22,21 +22,21 @@ teardown() {
|
||||
@test "($PLUGIN_COMMAND_PREFIX:info) success" {
|
||||
run dokku "$PLUGIN_COMMAND_PREFIX:info" l
|
||||
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||
assert_contains "${lines[*]}" "redis://l:$password@dokku-redis-l:6379"
|
||||
assert_contains "${lines[*]}" "redis://:$password@dokku-redis-l:6379"
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:info) replaces underscores by dash in hostname" {
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:create" test_with_underscores
|
||||
run dokku "$PLUGIN_COMMAND_PREFIX:info" test_with_underscores
|
||||
password="$(sudo cat "$PLUGIN_DATA_ROOT/test_with_underscores/PASSWORD")"
|
||||
assert_contains "${lines[*]}" "redis://test_with_underscores:$password@dokku-redis-test-with-underscores:6379"
|
||||
assert_contains "${lines[*]}" "redis://:$password@dokku-redis-test-with-underscores:6379"
|
||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" test_with_underscores
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:info) success with flag" {
|
||||
run dokku "$PLUGIN_COMMAND_PREFIX:info" l --dsn
|
||||
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||
assert_output "redis://l:$password@dokku-redis-l:6379"
|
||||
assert_output "redis://:$password@dokku-redis-l:6379"
|
||||
|
||||
run dokku "$PLUGIN_COMMAND_PREFIX:info" l --config-dir
|
||||
assert_success
|
||||
|
||||
@@ -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 REDIS_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 REDIS_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 REDIS_URL)
|
||||
url=$(dokku config:get my-app REDIS_URL)
|
||||
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||
assert_contains "$url" "redis://l:$password@dokku-redis-l:6379"
|
||||
assert_contains "$url" "redis://:$password@dokku-redis-l:6379"
|
||||
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 REDIS_URL already in use" {
|
||||
dokku config:set my_app REDIS_URL=redis://host:6379
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
|
||||
run dokku config my_app
|
||||
dokku config:set my-app REDIS_URL=redis://host:6379
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
|
||||
run dokku config my-app
|
||||
assert_contains "${lines[*]}" "DOKKU_REDIS_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_REDIS_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 my_app
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
|
||||
run dokku docker-options:report my-app
|
||||
assert_contains "${lines[*]}" "--link dokku.redis.l:dokku-redis-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 REDIS_DATABASE_SCHEME variable" {
|
||||
dokku config:set my_app REDIS_DATABASE_SCHEME=redis2
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
|
||||
url=$(dokku config:get my_app REDIS_URL)
|
||||
dokku config:set my-app REDIS_DATABASE_SCHEME=redis2
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
|
||||
url=$(dokku config:get my-app REDIS_URL)
|
||||
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||
assert_contains "$url" "redis2://l:$password@dokku-redis-l:6379"
|
||||
assert_contains "$url" "redis2://:$password@dokku-redis-l:6379"
|
||||
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 REDIS_URL)
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app --querystring "pool=5"
|
||||
url=$(dokku config:get my-app REDIS_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" "redis://l:$password@dokku-redis-l:6379"
|
||||
assert_contains "$url" "redis://:$password@dokku-redis-l:6379"
|
||||
assert_success
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
||||
}
|
||||
|
||||
@@ -10,27 +10,13 @@ teardown() {
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:list) with no exposed ports, no linked apps" {
|
||||
run dokku "$PLUGIN_COMMAND_PREFIX:list"
|
||||
assert_contains "${lines[*]}" "l redis:5.0.4 running - -"
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:list) with exposed ports" {
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:expose" l 4242
|
||||
run dokku "$PLUGIN_COMMAND_PREFIX:list"
|
||||
assert_contains "${lines[*]}" "l redis:5.0.4 running 6379->4242 -"
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:list) with linked app" {
|
||||
dokku apps:create my_app
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
|
||||
run dokku "$PLUGIN_COMMAND_PREFIX:list"
|
||||
assert_contains "${lines[*]}" "l redis:5.0.4 running - my_app"
|
||||
dokku --force apps:destroy my_app
|
||||
run dokku --quiet "$PLUGIN_COMMAND_PREFIX:list"
|
||||
assert_output "l"
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:list) when there are no services" {
|
||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
||||
run dokku "$PLUGIN_COMMAND_PREFIX:list"
|
||||
assert_contains "${lines[*]}" "There are no Redis services"
|
||||
assert_output "${lines[*]}" "There are no $PLUGIN_SERVICE services"
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
||||
}
|
||||
|
||||
@@ -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,35 +29,35 @@ 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 REDIS_URL"
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:promote) changes REDIS_URL" {
|
||||
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||
dokku config:set my_app "REDIS_URL=redis://u:p@host:6379/db" "DOKKU_REDIS_BLUE_URL=redis://l:$password@dokku-redis-l:6379"
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my_app
|
||||
url=$(dokku config:get my_app REDIS_URL)
|
||||
assert_equal "$url" "redis://l:$password@dokku-redis-l:6379"
|
||||
dokku config:set my-app "REDIS_URL=redis://:p@host:6379/db" "DOKKU_REDIS_BLUE_URL=redis://:$password@dokku-redis-l:6379"
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my-app
|
||||
url=$(dokku config:get my-app REDIS_URL)
|
||||
assert_equal "$url" "redis://:$password@dokku-redis-l:6379"
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:promote) creates new config url when needed" {
|
||||
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||
dokku config:set my_app "REDIS_URL=redis://u:p@host:6379/db" "DOKKU_REDIS_BLUE_URL=redis://l:$password@dokku-redis-l:6379"
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my_app
|
||||
run dokku config my_app
|
||||
dokku config:set my-app "REDIS_URL=redis://:p@host:6379/db" "DOKKU_REDIS_BLUE_URL=redis://:$password@dokku-redis-l:6379"
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my-app
|
||||
run dokku config my-app
|
||||
assert_contains "${lines[*]}" "DOKKU_REDIS_"
|
||||
}
|
||||
|
||||
@test "($PLUGIN_COMMAND_PREFIX:promote) uses REDIS_DATABASE_SCHEME variable" {
|
||||
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
||||
dokku config:set my_app "REDIS_DATABASE_SCHEME=redis2" "REDIS_URL=redis://u:p@host:6379" "DOKKU_REDIS_BLUE_URL=redis2://l:$password@dokku-redis-l:6379"
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my_app
|
||||
url=$(dokku config:get my_app REDIS_URL)
|
||||
assert_equal "$url" "redis2://l:$password@dokku-redis-l:6379"
|
||||
dokku config:set my-app "REDIS_DATABASE_SCHEME=redis2" "REDIS_URL=redis://:p@host:6379" "DOKKU_REDIS_BLUE_URL=redis2://:$password@dokku-redis-l:6379"
|
||||
dokku "$PLUGIN_COMMAND_PREFIX:promote" l my-app
|
||||
url=$(dokku config:get my-app REDIS_URL)
|
||||
assert_equal "$url" "redis2://:$password@dokku-redis-l:6379"
|
||||
}
|
||||
|
||||
@@ -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 REDIS_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 REDIS_URL || true)
|
||||
assert_equal "$config" ""
|
||||
}
|
||||
|
||||
@@ -1,6 +1,14 @@
|
||||
#!/usr/bin/env bash
|
||||
set -eo pipefail
|
||||
[[ $TRACE ]] && set -x
|
||||
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 762E3157
|
||||
echo "deb http://nginx.org/packages/ubuntu $(lsb_release -cs) nginx" | sudo tee /etc/apt/sources.list.d/nginx.list
|
||||
curl -fsSL https://nginx.org/keys/nginx_signing.key | sudo apt-key add -
|
||||
|
||||
sudo mkdir -p /etc/nginx
|
||||
sudo curl https://raw.githubusercontent.com/dokku/dokku/master/tests/dhparam.pem -o /etc/nginx/dhparam.pem
|
||||
|
||||
echo "dokku dokku/skip_key_file boolean true" | sudo debconf-set-selections
|
||||
wget https://raw.githubusercontent.com/dokku/dokku/master/bootstrap.sh
|
||||
if [[ "$DOKKU_VERSION" == "master" ]]; then
|
||||
sudo bash bootstrap.sh
|
||||
@@ -11,11 +19,14 @@ 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"
|
||||
sudo mkdir -p "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX" "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/subcommands" "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/scripts"
|
||||
sudo find ./ -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX" \;
|
||||
sudo find ./subcommands -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/subcommands" \;
|
||||
[[ -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" \;
|
||||
sudo mkdir -p "$PLUGIN_CONFIG_ROOT" "$PLUGIN_DATA_ROOT"
|
||||
sudo dokku plugin:enable "$PLUGIN_COMMAND_PREFIX"
|
||||
sudo dokku plugin:install
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# SC1090 - Can't follow non-constant source. Use a directive to specify location - https://github.com/koalaman/shellcheck/wiki/SC1090
|
||||
# SC2034 - Variable appears unused. Verify it or export it - https://github.com/koalaman/shellcheck/wiki/SC2034
|
||||
# SC2155 - Declare and assign separately to avoid masking return values - https://github.com/koalaman/shellcheck/wiki/SC2155
|
||||
# SC2206 - Quote to prevent word splitting/globbing, or split robustly with mapfile or read -a - https://github.com/koalaman/shellcheck/wiki/SC2206
|
||||
# SC2207 - Prefer mapfile or read -a to split command output (or quote to avoid splitting) - https://github.com/koalaman/shellcheck/wiki/SC2207
|
||||
# SC2220 - Invalid flags are not handled. Add a *) case - https://github.com/koalaman/shellcheck/wiki/SC2220
|
||||
# SC2230 - which is non-standard. Use builtin 'command -v' instead - https://github.com/koalaman/shellcheck/wiki/SC2230
|
||||
|
||||
Reference in New Issue
Block a user