Compare commits
115 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c728a443c2 | ||
|
|
fe6afbb51b | ||
|
|
945e43cb65 | ||
|
|
936fcb5931 | ||
|
|
e59116d69e | ||
|
|
4376ad269d | ||
|
|
674ba8b8c9 | ||
|
|
d11614bd50 | ||
|
|
5925f9c4d4 | ||
|
|
507526b01c | ||
|
|
81771f0e2c | ||
|
|
451c9aea70 | ||
|
|
e82d66a56b | ||
|
|
d602498d4f | ||
|
|
15fa64e838 | ||
|
|
cd7e66c454 | ||
|
|
f7fc11192d | ||
|
|
91b0a4ad00 | ||
|
|
e1f721f39b | ||
|
|
2f816534da | ||
|
|
9ab50f6feb | ||
|
|
d8b3273161 | ||
|
|
d1da450dc9 | ||
|
|
0ed012a16b | ||
|
|
ef356c56de | ||
|
|
2021cb23da | ||
|
|
e844659f8f | ||
|
|
88ad80c096 | ||
|
|
ba3d81cd20 | ||
|
|
0c625d5e71 | ||
|
|
b787d66665 | ||
|
|
627ebb5ab6 | ||
|
|
da56f1b26e | ||
|
|
081ab67c14 | ||
|
|
61f0d78a93 | ||
|
|
b18d0838b9 | ||
|
|
bb9829883b | ||
|
|
f3a2c3cbbc | ||
|
|
29057e00a2 | ||
|
|
6577443afb | ||
|
|
81ff14518d | ||
|
|
14f670c7c4 | ||
|
|
864b50891b | ||
|
|
e9fad47842 | ||
|
|
9258d77b12 | ||
|
|
f4698b1e5f | ||
|
|
f07d950cd9 | ||
|
|
7bca464cd6 | ||
|
|
d40e7c7619 | ||
|
|
5822176870 | ||
|
|
5171614175 | ||
|
|
1077c49a15 | ||
|
|
50a7923695 | ||
|
|
13e46bafcf | ||
|
|
10fa2ebd35 | ||
|
|
151176e142 | ||
|
|
1110b7a560 | ||
|
|
e907c8c218 | ||
|
|
09a7cb820b | ||
|
|
d6976a5290 | ||
|
|
453e4993b9 | ||
|
|
3bac8ed944 | ||
|
|
d956ded91c | ||
|
|
2fd010d955 | ||
|
|
b2eb07f839 | ||
|
|
f8c688cce0 | ||
|
|
f6817bdb3a | ||
|
|
46eac4e22c | ||
|
|
9263eb6505 | ||
|
|
fb0bcb4921 | ||
|
|
c587d70c49 | ||
|
|
b7f22a3904 | ||
|
|
777fc95818 | ||
|
|
9bf3b5bb58 | ||
|
|
daea399ffd | ||
|
|
b81b8d7a00 | ||
|
|
4557c96858 | ||
|
|
201eac3809 | ||
|
|
965696813b | ||
|
|
3a676c2549 | ||
|
|
11fef8aec9 | ||
|
|
23c11bfddd | ||
|
|
1af6da45e9 | ||
|
|
bfc0f18759 | ||
|
|
9df82c58da | ||
|
|
ee2d2f10f7 | ||
|
|
9f3d24ca9f | ||
|
|
6128801308 | ||
|
|
8edb644d11 | ||
|
|
3181bb114e | ||
|
|
b722939dbb | ||
|
|
7b7da09a76 | ||
|
|
17f3ce2188 | ||
|
|
746b276202 | ||
|
|
bbc7b0fc71 | ||
|
|
f9e5067aa8 | ||
|
|
c4b69d2e17 | ||
|
|
70265e03a7 | ||
|
|
5500dc41e7 | ||
|
|
5e951257ce | ||
|
|
f4e66990c5 | ||
|
|
bceebc1e9c | ||
|
|
6accb9cbda | ||
|
|
a925fe66de | ||
|
|
3a03ed7b92 | ||
|
|
16fa2b1189 | ||
|
|
afb21619f6 | ||
|
|
fb5c34158b | ||
|
|
ad22989894 | ||
|
|
d68fee775d | ||
|
|
7922f0582f | ||
|
|
60869897f0 | ||
|
|
df8f917a04 | ||
|
|
81cb9b79c5 | ||
|
|
09926fbecd |
22
.github/workflows/ci.yml
vendored
22
.github/workflows/ci.yml
vendored
@@ -5,7 +5,7 @@ name: CI
|
|||||||
on:
|
on:
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- '*'
|
- "*"
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
- master
|
||||||
@@ -17,18 +17,18 @@ concurrency:
|
|||||||
jobs:
|
jobs:
|
||||||
unit-tests-master:
|
unit-tests-master:
|
||||||
name: unit-tests
|
name: unit-tests
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-24.04
|
||||||
env:
|
env:
|
||||||
DOKKU_VERSION: master
|
DOKKU_VERSION: master
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
- uses: actions/setup-python@v4
|
- uses: actions/setup-python@v5
|
||||||
with:
|
with:
|
||||||
python-version: '3.7.x'
|
python-version: "3.13"
|
||||||
|
|
||||||
- run: make setup
|
- run: make setup
|
||||||
|
|
||||||
@@ -51,7 +51,7 @@ jobs:
|
|||||||
|
|
||||||
- run: make test
|
- run: make test
|
||||||
|
|
||||||
- uses: actions/upload-artifact@v3
|
- uses: actions/upload-artifact@v4
|
||||||
if: failure()
|
if: failure()
|
||||||
with:
|
with:
|
||||||
name: tmp/test-results
|
name: tmp/test-results
|
||||||
@@ -59,18 +59,18 @@ jobs:
|
|||||||
|
|
||||||
unit-tests-0_19_0:
|
unit-tests-0_19_0:
|
||||||
name: unit-tests-0.19.0
|
name: unit-tests-0.19.0
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-24.04
|
||||||
env:
|
env:
|
||||||
DOKKU_TAG: v0.19.0
|
DOKKU_TAG: v0.19.0
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
- uses: actions/setup-python@v4
|
- uses: actions/setup-python@v5
|
||||||
with:
|
with:
|
||||||
python-version: '3.7.x'
|
python-version: "3.13"
|
||||||
|
|
||||||
- run: make setup
|
- run: make setup
|
||||||
|
|
||||||
@@ -93,7 +93,7 @@ jobs:
|
|||||||
|
|
||||||
- run: make test
|
- run: make test
|
||||||
|
|
||||||
- uses: actions/upload-artifact@v3
|
- uses: actions/upload-artifact@v4
|
||||||
if: failure()
|
if: failure()
|
||||||
with:
|
with:
|
||||||
name: tmp/test-results
|
name: tmp/test-results
|
||||||
|
|||||||
20
.github/workflows/tagged-release.yml
vendored
Normal file
20
.github/workflows/tagged-release.yml
vendored
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
name: "tagged-release"
|
||||||
|
|
||||||
|
# yamllint disable-line rule:truthy
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- "*"
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
tagged-release:
|
||||||
|
name: tagged-release
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Release
|
||||||
|
uses: softprops/action-gh-release@v2.2.2
|
||||||
|
with:
|
||||||
|
generate_release_notes: true
|
||||||
|
make_latest: "true"
|
||||||
@@ -1 +1 @@
|
|||||||
FROM postgres:14.5
|
FROM postgres:17.4
|
||||||
|
|||||||
7
Makefile
7
Makefile
@@ -1,5 +1,6 @@
|
|||||||
HARDWARE = $(shell uname -m)
|
HARDWARE = $(shell uname -m)
|
||||||
SYSTEM_NAME = $(shell uname -s | tr '[:upper:]' '[:lower:]')
|
SYSTEM_NAME = $(shell uname -s | tr '[:upper:]' '[:lower:]')
|
||||||
|
ARCH = $(shell dpkg --print-architecture)
|
||||||
SHFMT_VERSION = 3.0.2
|
SHFMT_VERSION = 3.0.2
|
||||||
XUNIT_TO_GITHUB_VERSION = 0.3.0
|
XUNIT_TO_GITHUB_VERSION = 0.3.0
|
||||||
XUNIT_READER_VERSION = 0.1.0
|
XUNIT_READER_VERSION = 0.1.0
|
||||||
@@ -21,7 +22,11 @@ ifneq ($(shell shellcheck --version >/dev/null 2>&1 ; echo $$?),0)
|
|||||||
ifeq ($(SYSTEM_NAME),darwin)
|
ifeq ($(SYSTEM_NAME),darwin)
|
||||||
brew install shellcheck
|
brew install shellcheck
|
||||||
else
|
else
|
||||||
sudo add-apt-repository 'deb http://archive.ubuntu.com/ubuntu trusty-backports main restricted universe multiverse'
|
ifeq ($(ARCH),arm64)
|
||||||
|
sudo add-apt-repository 'deb http://ports.ubuntu.com/ubuntu-ports jammy-backports main restricted universe multiverse'
|
||||||
|
else
|
||||||
|
sudo add-apt-repository 'deb http://archive.ubuntu.com/ubuntu jammy-backports main restricted universe multiverse'
|
||||||
|
endif
|
||||||
sudo rm -rf /var/lib/apt/lists/* && sudo apt-get clean
|
sudo rm -rf /var/lib/apt/lists/* && sudo apt-get clean
|
||||||
sudo apt-get update -qq && sudo apt-get install -qq -y shellcheck
|
sudo apt-get update -qq && sudo apt-get install -qq -y shellcheck
|
||||||
endif
|
endif
|
||||||
|
|||||||
63
README.md
63
README.md
@@ -1,6 +1,6 @@
|
|||||||
# dokku postgres [](https://github.com/dokku/dokku-postgres/actions/workflows/ci.yml?query=branch%3Amaster) [](https://webchat.libera.chat/?channels=dokku)
|
# dokku postgres [](https://github.com/dokku/dokku-postgres/actions/workflows/ci.yml?query=branch%3Amaster) [](https://webchat.libera.chat/?channels=dokku)
|
||||||
|
|
||||||
Official postgres plugin for dokku. Currently defaults to installing [postgres 14.5](https://hub.docker.com/_/postgres/).
|
Official postgres plugin for dokku. Currently defaults to installing [postgres 17.4](https://hub.docker.com/_/postgres/).
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
@@ -11,7 +11,7 @@ Official postgres plugin for dokku. Currently defaults to installing [postgres 1
|
|||||||
|
|
||||||
```shell
|
```shell
|
||||||
# on 0.19.x+
|
# on 0.19.x+
|
||||||
sudo dokku plugin:install https://github.com/dokku/dokku-postgres.git postgres
|
sudo dokku plugin:install https://github.com/dokku/dokku-postgres.git --name postgres
|
||||||
```
|
```
|
||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
@@ -24,8 +24,10 @@ postgres:backup-deauth <service> # remove backup authenticatio
|
|||||||
postgres:backup-schedule <service> <schedule> <bucket-name> [--use-iam] # schedule a backup of the postgres service
|
postgres:backup-schedule <service> <schedule> <bucket-name> [--use-iam] # schedule a backup of the postgres service
|
||||||
postgres:backup-schedule-cat <service> # cat the contents of the configured backup cronfile for the service
|
postgres:backup-schedule-cat <service> # cat the contents of the configured backup cronfile for the service
|
||||||
postgres:backup-set-encryption <service> <passphrase> # set encryption for all future backups of postgres service
|
postgres:backup-set-encryption <service> <passphrase> # set encryption for all future backups of postgres service
|
||||||
|
postgres:backup-set-public-key-encryption <service> <public-key-id> # set GPG Public Key encryption for all future backups of postgres service
|
||||||
postgres:backup-unschedule <service> # unschedule the backup of the postgres service
|
postgres:backup-unschedule <service> # unschedule the backup of the postgres service
|
||||||
postgres:backup-unset-encryption <service> # unset encryption for future backups of the postgres service
|
postgres:backup-unset-encryption <service> # unset encryption for future backups of the postgres service
|
||||||
|
postgres:backup-unset-public-key-encryption <service> # unset GPG Public Key encryption for future backups of the postgres service
|
||||||
postgres:clone <service> <new-service> [--clone-flags...] # create container <new-name> then copy data from <name> into <new-name>
|
postgres:clone <service> <new-service> [--clone-flags...] # create container <new-name> then copy data from <name> into <new-name>
|
||||||
postgres:connect <service> # connect to the service via the postgres connection tool
|
postgres:connect <service> # connect to the service via the postgres connection tool
|
||||||
postgres:create <service> [--create-flags...] # create a postgres service
|
postgres:create <service> [--create-flags...] # create a postgres service
|
||||||
@@ -74,9 +76,9 @@ flags:
|
|||||||
- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
|
- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
|
||||||
- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
|
- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
|
||||||
- `-p|--password PASSWORD`: override the user-level service password
|
- `-p|--password PASSWORD`: override the user-level service password
|
||||||
- `-P|--post-create-network NETWORKS`: a comman-separated list of networks to attach the service container to after service creation
|
- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation
|
||||||
- `-r|--root-password PASSWORD`: override the root-level service password
|
- `-r|--root-password PASSWORD`: override the root-level service password
|
||||||
- `-S|--post-start-network NETWORKS`: a comman-separated list of networks to attach the service container to after service start
|
- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start
|
||||||
- `-s|--shm-size SHM_SIZE`: override shared memory size for postgres docker container
|
- `-s|--shm-size SHM_SIZE`: override shared memory size for postgres docker container
|
||||||
|
|
||||||
Create a postgres service named lollipop:
|
Create a postgres service named lollipop:
|
||||||
@@ -93,7 +95,7 @@ export POSTGRES_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
|
|||||||
dokku postgres:create lollipop
|
dokku postgres:create lollipop
|
||||||
```
|
```
|
||||||
|
|
||||||
You can also specify custom environment variables to start the postgres service in semi-colon separated form.
|
You can also specify custom environment variables to start the postgres service in semicolon-separated form.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
export POSTGRES_CUSTOM_ENV="USER=alpha;HOST=beta"
|
export POSTGRES_CUSTOM_ENV="USER=alpha;HOST=beta"
|
||||||
@@ -103,9 +105,17 @@ dokku postgres:create lollipop
|
|||||||
Official Postgres "$DOCKER_BIN" image ls does not include postgis extension (amongst others). The following example creates a new postgres service using `postgis/postgis:13-3.1` image, which includes the `postgis` extension.
|
Official Postgres "$DOCKER_BIN" image ls does not include postgis extension (amongst others). The following example creates a new postgres service using `postgis/postgis:13-3.1` image, which includes the `postgis` extension.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
# use the appropriate image-version for your use-case
|
||||||
dokku postgres:create postgis-database --image "postgis/postgis" --image-version "13-3.1"
|
dokku postgres:create postgis-database --image "postgis/postgis" --image-version "13-3.1"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
To use pgvector instead, run the following:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# use the appropriate image-version for your use-case
|
||||||
|
dokku postgres:create pgvector-database --image "pgvector/pgvector" --image-version "pg17"
|
||||||
|
```
|
||||||
|
|
||||||
### print the service information
|
### print the service information
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
@@ -206,6 +216,7 @@ flags:
|
|||||||
|
|
||||||
- `-a|--alias "BLUE_DATABASE"`: an alternative alias to use for linking to an app via environment variable
|
- `-a|--alias "BLUE_DATABASE"`: an alternative alias to use for linking to an app via environment variable
|
||||||
- `-q|--querystring "pool=5"`: ampersand delimited querystring arguments to append to the service link
|
- `-q|--querystring "pool=5"`: ampersand delimited querystring arguments to append to the service link
|
||||||
|
- `-n|--no-restart "false"`: whether or not to restart the app on link (default: true)
|
||||||
|
|
||||||
A postgres service can be linked to a container. This will use native docker links via the docker-options plugin. Here we link it to our `playground` app.
|
A postgres service can be linked to a container. This will use native docker links via the docker-options plugin. Here we link it to our `playground` app.
|
||||||
|
|
||||||
@@ -258,6 +269,10 @@ postgres2://lollipop:SOME_PASSWORD@dokku-postgres-lollipop:5432/lollipop
|
|||||||
dokku postgres:unlink <service> <app>
|
dokku postgres:unlink <service> <app>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
flags:
|
||||||
|
|
||||||
|
- `-n|--no-restart "false"`: whether or not to restart the app on unlink (default: true)
|
||||||
|
|
||||||
You can unlink a postgres service:
|
You can unlink a postgres service:
|
||||||
|
|
||||||
> NOTE: this will restart your app and unset related environment variables
|
> NOTE: this will restart your app and unset related environment variables
|
||||||
@@ -344,7 +359,7 @@ Expose the service on the service's normal ports, allowing access to it from the
|
|||||||
dokku postgres:expose lollipop 5432
|
dokku postgres:expose lollipop 5432
|
||||||
```
|
```
|
||||||
|
|
||||||
Expose the service on the service's normal ports, with the first on a specified ip adddress (127.0.0.1):
|
Expose the service on the service's normal ports, with the first on a specified ip address (127.0.0.1):
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
dokku postgres:expose lollipop 127.0.0.1:5432
|
dokku postgres:expose lollipop 127.0.0.1:5432
|
||||||
@@ -458,9 +473,9 @@ flags:
|
|||||||
- `-i|--image IMAGE`: the image name to start the service with
|
- `-i|--image IMAGE`: the image name to start the service with
|
||||||
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
|
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
|
||||||
- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
|
- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
|
||||||
- `-P|--post-create-network NETWORKS`: a comman-separated list of networks to attach the service container to after service creation
|
- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation
|
||||||
- `-R|--restart-apps "true"`: whether to force an app restart
|
- `-R|--restart-apps "true"`: whether or not to force an app restart (default: false)
|
||||||
- `-S|--post-start-network NETWORKS`: a comman-separated list of networks to attach the service container to after service start
|
- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start
|
||||||
- `-s|--shm-size SHM_SIZE`: override shared memory size for postgres docker container
|
- `-s|--shm-size SHM_SIZE`: override shared memory size for postgres docker container
|
||||||
|
|
||||||
You can upgrade an existing service to a new image or image-version:
|
You can upgrade an existing service to a new image or image-version:
|
||||||
@@ -533,9 +548,9 @@ flags:
|
|||||||
- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
|
- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
|
||||||
- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
|
- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
|
||||||
- `-p|--password PASSWORD`: override the user-level service password
|
- `-p|--password PASSWORD`: override the user-level service password
|
||||||
- `-P|--post-create-network NETWORKS`: a comman-separated list of networks to attach the service container to after service creation
|
- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation
|
||||||
- `-r|--root-password PASSWORD`: override the root-level service password
|
- `-r|--root-password PASSWORD`: override the root-level service password
|
||||||
- `-S|--post-start-network NETWORKS`: a comman-separated list of networks to attach the service container to after service start
|
- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start
|
||||||
- `-s|--shm-size SHM_SIZE`: override shared memory size for postgres docker container
|
- `-s|--shm-size SHM_SIZE`: override shared memory size for postgres docker container
|
||||||
|
|
||||||
You can clone an existing service to a new one:
|
You can clone an existing service to a new one:
|
||||||
@@ -713,6 +728,19 @@ Set the GPG-compatible passphrase for encrypting backups for backups:
|
|||||||
dokku postgres:backup-set-encryption lollipop
|
dokku postgres:backup-set-encryption lollipop
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### set GPG Public Key encryption for all future backups of postgres service
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:backup-set-public-key-encryption <service> <public-key-id>
|
||||||
|
```
|
||||||
|
|
||||||
|
Set the `GPG` Public Key for encrypting backups:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:backup-set-public-key-encryption lollipop
|
||||||
|
```
|
||||||
|
|
||||||
### unset encryption for future backups of the postgres service
|
### unset encryption for future backups of the postgres service
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
@@ -726,6 +754,19 @@ Unset the `GPG` encryption passphrase for backups:
|
|||||||
dokku postgres:backup-unset-encryption lollipop
|
dokku postgres:backup-unset-encryption lollipop
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### unset GPG Public Key encryption for future backups of the postgres service
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# usage
|
||||||
|
dokku postgres:backup-unset-public-key-encryption <service>
|
||||||
|
```
|
||||||
|
|
||||||
|
Unset the `GPG` Public Key encryption for backups:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku postgres:backup-unset-public-key-encryption lollipop
|
||||||
|
```
|
||||||
|
|
||||||
### schedule a backup of the postgres service
|
### schedule a backup of the postgres service
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
|||||||
2
Vagrantfile
vendored
2
Vagrantfile
vendored
@@ -1,7 +1,7 @@
|
|||||||
# -*- mode: ruby -*-
|
# -*- mode: ruby -*-
|
||||||
# vi: set ft=ruby :
|
# vi: set ft=ruby :
|
||||||
|
|
||||||
BOX_NAME = ENV["BOX_NAME"] || "bento/ubuntu-20.04"
|
BOX_NAME = ENV["BOX_NAME"] || "bento/ubuntu-24.04"
|
||||||
BOX_MEMORY = ENV["BOX_MEMORY"] || "2048"
|
BOX_MEMORY = ENV["BOX_MEMORY"] || "2048"
|
||||||
DOKKU_VERSION = "master"
|
DOKKU_VERSION = "master"
|
||||||
|
|
||||||
|
|||||||
226
bin/generate
226
bin/generate
@@ -1,15 +1,30 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
from __future__ import print_function
|
from __future__ import print_function
|
||||||
|
|
||||||
import os
|
import os
|
||||||
import re
|
import re
|
||||||
|
|
||||||
|
|
||||||
def compile(service, version, variable, alias, image, scheme, ports, sponsors, options, unimplemented, dokku_version):
|
def compile(
|
||||||
prefix = "\n\n".join([
|
service,
|
||||||
header(service),
|
version,
|
||||||
description(service, image, version),
|
variable,
|
||||||
])
|
alias,
|
||||||
|
image,
|
||||||
|
scheme,
|
||||||
|
ports,
|
||||||
|
sponsors,
|
||||||
|
options,
|
||||||
|
unimplemented,
|
||||||
|
dokku_version,
|
||||||
|
):
|
||||||
|
prefix = "\n\n".join(
|
||||||
|
[
|
||||||
|
header(service),
|
||||||
|
description(service, image, version),
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
if len(sponsors) > 0:
|
if len(sponsors) > 0:
|
||||||
prefix += "\n\n"
|
prefix += "\n\n"
|
||||||
@@ -21,8 +36,19 @@ def compile(service, version, variable, alias, image, scheme, ports, sponsors, o
|
|||||||
prefix,
|
prefix,
|
||||||
requirements_section(dokku_version),
|
requirements_section(dokku_version),
|
||||||
installation_section(service, dokku_version),
|
installation_section(service, dokku_version),
|
||||||
commands_section(service, variable, alias, image, scheme, ports, unimplemented),
|
commands_section(
|
||||||
usage_section(service, variable, alias, image, scheme, ports, options, unimplemented),
|
service, variable, alias, image, scheme, ports, unimplemented
|
||||||
|
),
|
||||||
|
usage_section(
|
||||||
|
service,
|
||||||
|
variable,
|
||||||
|
alias,
|
||||||
|
image,
|
||||||
|
scheme,
|
||||||
|
ports,
|
||||||
|
options,
|
||||||
|
unimplemented,
|
||||||
|
),
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
.replace("\n\n\n\n\n", "\n")
|
.replace("\n\n\n\n\n", "\n")
|
||||||
@@ -55,17 +81,25 @@ def sponsors_section(service, sponsors):
|
|||||||
if len(sponsors) == 0:
|
if len(sponsors) == 0:
|
||||||
return ""
|
return ""
|
||||||
|
|
||||||
sponsor_data = ["## Sponsors", "", f"The {service} plugin was generously sponsored by the following:", ""]
|
sponsor_data = [
|
||||||
|
"## Sponsors",
|
||||||
|
"",
|
||||||
|
f"The {service} plugin was generously sponsored by the following:",
|
||||||
|
"",
|
||||||
|
]
|
||||||
sponsor_data.extend([f"- [{s}](https://github.com/{s})" for s in sponsors])
|
sponsor_data.extend([f"- [{s}](https://github.com/{s})" for s in sponsors])
|
||||||
|
|
||||||
return "\n".join(
|
return "\n".join(sponsor_data)
|
||||||
sponsor_data
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def requirements_section(dokku_version):
|
def requirements_section(dokku_version):
|
||||||
return "\n".join(
|
return "\n".join(
|
||||||
["## Requirements", "", f"- dokku {dokku_version}", "- docker 1.8.x",]
|
[
|
||||||
|
"## Requirements",
|
||||||
|
"",
|
||||||
|
f"- dokku {dokku_version}",
|
||||||
|
"- docker 1.8.x",
|
||||||
|
]
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -76,7 +110,7 @@ def installation_section(service, dokku_version):
|
|||||||
"",
|
"",
|
||||||
"```shell",
|
"```shell",
|
||||||
f"# on {dokku_version}",
|
f"# on {dokku_version}",
|
||||||
f"sudo dokku plugin:install https://github.com/dokku/dokku-{service}.git {service}",
|
f"sudo dokku plugin:install https://github.com/dokku/dokku-{service}.git --name {service}",
|
||||||
"```",
|
"```",
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
@@ -115,17 +149,31 @@ def commands_section(service, variable, alias, image, scheme, ports, unimplement
|
|||||||
return "\n".join(content)
|
return "\n".join(content)
|
||||||
|
|
||||||
|
|
||||||
def usage_section(service, variable, alias, image, scheme, ports, options, unimplemented):
|
def usage_section(
|
||||||
|
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||||
|
):
|
||||||
return "\n\n".join(
|
return "\n\n".join(
|
||||||
[
|
[
|
||||||
"## Usage",
|
"## Usage",
|
||||||
f"Help for any commands can be displayed by specifying the command as an argument to {service}:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `{service}:help` command for any undocumented commands.",
|
f"Help for any commands can be displayed by specifying the command as an argument to {service}:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `{service}:help` command for any undocumented commands.",
|
||||||
usage_intro(service, variable, alias, image, scheme, ports, options, unimplemented),
|
usage_intro(
|
||||||
usage_lifecycle(service, variable, alias, image, scheme, ports, options, unimplemented),
|
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||||
usage_automation(service, variable, alias, image, scheme, ports, options, unimplemented),
|
),
|
||||||
usage_data_management(service, variable, alias, image, scheme, ports, options, unimplemented),
|
usage_lifecycle(
|
||||||
usage_backup(service, variable, alias, image, scheme, ports, options, unimplemented),
|
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||||
usage_docker_pull(service, variable, alias, image, scheme, ports, options, unimplemented),
|
),
|
||||||
|
usage_automation(
|
||||||
|
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||||
|
),
|
||||||
|
usage_data_management(
|
||||||
|
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||||
|
),
|
||||||
|
usage_backup(
|
||||||
|
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||||
|
),
|
||||||
|
usage_docker_pull(
|
||||||
|
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||||
|
),
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -135,11 +183,22 @@ def usage_intro(service, variable, alias, image, scheme, ports, options, unimple
|
|||||||
content = ["### Basic Usage"]
|
content = ["### Basic Usage"]
|
||||||
|
|
||||||
return fetch_commands_content(
|
return fetch_commands_content(
|
||||||
service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
|
service,
|
||||||
|
variable,
|
||||||
|
alias,
|
||||||
|
image,
|
||||||
|
scheme,
|
||||||
|
ports,
|
||||||
|
options,
|
||||||
|
unimplemented,
|
||||||
|
commands,
|
||||||
|
content,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def usage_lifecycle(service, variable, alias, image, scheme, ports, options, unimplemented):
|
def usage_lifecycle(
|
||||||
|
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||||
|
):
|
||||||
commands = [
|
commands = [
|
||||||
"connect",
|
"connect",
|
||||||
"enter",
|
"enter",
|
||||||
@@ -160,11 +219,22 @@ def usage_lifecycle(service, variable, alias, image, scheme, ports, options, uni
|
|||||||
]
|
]
|
||||||
|
|
||||||
return fetch_commands_content(
|
return fetch_commands_content(
|
||||||
service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
|
service,
|
||||||
|
variable,
|
||||||
|
alias,
|
||||||
|
image,
|
||||||
|
scheme,
|
||||||
|
ports,
|
||||||
|
options,
|
||||||
|
unimplemented,
|
||||||
|
commands,
|
||||||
|
content,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def usage_automation(service, variable, alias, image, scheme, ports, options, unimplemented):
|
def usage_automation(
|
||||||
|
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||||
|
):
|
||||||
commands = ["app-links", "clone", "exists", "linked", "links"]
|
commands = ["app-links", "clone", "exists", "linked", "links"]
|
||||||
content = [
|
content = [
|
||||||
"### Service Automation",
|
"### Service Automation",
|
||||||
@@ -174,11 +244,22 @@ def usage_automation(service, variable, alias, image, scheme, ports, options, un
|
|||||||
]
|
]
|
||||||
|
|
||||||
return fetch_commands_content(
|
return fetch_commands_content(
|
||||||
service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
|
service,
|
||||||
|
variable,
|
||||||
|
alias,
|
||||||
|
image,
|
||||||
|
scheme,
|
||||||
|
ports,
|
||||||
|
options,
|
||||||
|
unimplemented,
|
||||||
|
commands,
|
||||||
|
content,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def usage_data_management(service, variable, alias, image, scheme, ports, options, unimplemented):
|
def usage_data_management(
|
||||||
|
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||||
|
):
|
||||||
commands = ["import", "export"]
|
commands = ["import", "export"]
|
||||||
content = [
|
content = [
|
||||||
"### Data Management",
|
"### Data Management",
|
||||||
@@ -188,17 +269,30 @@ def usage_data_management(service, variable, alias, image, scheme, ports, option
|
|||||||
]
|
]
|
||||||
|
|
||||||
return fetch_commands_content(
|
return fetch_commands_content(
|
||||||
service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
|
service,
|
||||||
|
variable,
|
||||||
|
alias,
|
||||||
|
image,
|
||||||
|
scheme,
|
||||||
|
ports,
|
||||||
|
options,
|
||||||
|
unimplemented,
|
||||||
|
commands,
|
||||||
|
content,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def usage_backup(service, variable, alias, image, scheme, ports, options, unimplemented):
|
def usage_backup(
|
||||||
|
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||||
|
):
|
||||||
commands = [
|
commands = [
|
||||||
"backup-auth",
|
"backup-auth",
|
||||||
"backup-deauth",
|
"backup-deauth",
|
||||||
"backup",
|
"backup",
|
||||||
"backup-set-encryption",
|
"backup-set-encryption",
|
||||||
|
"backup-set-public-key-encryption",
|
||||||
"backup-unset-encryption",
|
"backup-unset-encryption",
|
||||||
|
"backup-unset-public-key-encryption",
|
||||||
"backup-schedule",
|
"backup-schedule",
|
||||||
"backup-schedule-cat",
|
"backup-schedule-cat",
|
||||||
"backup-unschedule",
|
"backup-unschedule",
|
||||||
@@ -215,11 +309,22 @@ def usage_backup(service, variable, alias, image, scheme, ports, options, unimpl
|
|||||||
]
|
]
|
||||||
|
|
||||||
return fetch_commands_content(
|
return fetch_commands_content(
|
||||||
service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
|
service,
|
||||||
|
variable,
|
||||||
|
alias,
|
||||||
|
image,
|
||||||
|
scheme,
|
||||||
|
ports,
|
||||||
|
options,
|
||||||
|
unimplemented,
|
||||||
|
commands,
|
||||||
|
content,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def usage_docker_pull(service, variable, alias, image, scheme, ports, options, unimplemented):
|
def usage_docker_pull(
|
||||||
|
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||||
|
):
|
||||||
service_prefix = service.upper()
|
service_prefix = service.upper()
|
||||||
return "\n".join(
|
return "\n".join(
|
||||||
[
|
[
|
||||||
@@ -233,11 +338,30 @@ def usage_docker_pull(service, variable, alias, image, scheme, ports, options, u
|
|||||||
|
|
||||||
|
|
||||||
def fetch_commands_content(
|
def fetch_commands_content(
|
||||||
service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
|
service,
|
||||||
|
variable,
|
||||||
|
alias,
|
||||||
|
image,
|
||||||
|
scheme,
|
||||||
|
ports,
|
||||||
|
options,
|
||||||
|
unimplemented,
|
||||||
|
commands,
|
||||||
|
content,
|
||||||
):
|
):
|
||||||
i = 0
|
i = 0
|
||||||
for command in commands:
|
for command in commands:
|
||||||
output = command_help(command, service, variable, alias, image, scheme, ports, options, unimplemented)
|
output = command_help(
|
||||||
|
command,
|
||||||
|
service,
|
||||||
|
variable,
|
||||||
|
alias,
|
||||||
|
image,
|
||||||
|
scheme,
|
||||||
|
ports,
|
||||||
|
options,
|
||||||
|
unimplemented,
|
||||||
|
)
|
||||||
if output == "":
|
if output == "":
|
||||||
continue
|
continue
|
||||||
content.append(output)
|
content.append(output)
|
||||||
@@ -275,7 +399,9 @@ def parse_args(line):
|
|||||||
return " ".join(arguments)
|
return " ".join(arguments)
|
||||||
|
|
||||||
|
|
||||||
def command_help(command, service, variable, alias, image, scheme, ports, options, unimplemented):
|
def command_help(
|
||||||
|
command, service, variable, alias, image, scheme, ports, options, unimplemented
|
||||||
|
):
|
||||||
if command in unimplemented:
|
if command in unimplemented:
|
||||||
return ""
|
return ""
|
||||||
|
|
||||||
@@ -285,7 +411,7 @@ def command_help(command, service, variable, alias, image, scheme, ports, option
|
|||||||
"",
|
"",
|
||||||
"```shell",
|
"```shell",
|
||||||
"# usage",
|
"# usage",
|
||||||
f"dokku {service}:{command} {data['arguments_string']}",
|
f"dokku {service}:{command} {data['arguments_string']}".strip(),
|
||||||
"```",
|
"```",
|
||||||
]
|
]
|
||||||
|
|
||||||
@@ -442,11 +568,11 @@ def process_sentence(sentence_lines):
|
|||||||
parts = []
|
parts = []
|
||||||
for word in sentence.strip().split(" "):
|
for word in sentence.strip().split(" "):
|
||||||
if word.isupper() and len(word) > 1:
|
if word.isupper() and len(word) > 1:
|
||||||
for ending in [':', '.']:
|
for ending in [":", "."]:
|
||||||
if word.endswith(ending):
|
if word.endswith(ending):
|
||||||
word = '`{0}`{1}'.format(word[:-1], ending)
|
word = "`{0}`{1}".format(word[:-1], ending)
|
||||||
else:
|
else:
|
||||||
word = '`{0}`'.format(word)
|
word = "`{0}`".format(word)
|
||||||
parts.append(word)
|
parts.append(word)
|
||||||
text.append(" ".join(parts))
|
text.append(" ".join(parts))
|
||||||
|
|
||||||
@@ -491,10 +617,10 @@ def main():
|
|||||||
|
|
||||||
with open("Dockerfile") as f:
|
with open("Dockerfile") as f:
|
||||||
for line in f.readlines():
|
for line in f.readlines():
|
||||||
if "FROM " in line:
|
if "FROM " in line:
|
||||||
image, version = line.split(" ")[1].split(":")
|
image, version = line.split(" ")[1].split(":")
|
||||||
image = image.strip()
|
image = image.strip()
|
||||||
version = version.strip()
|
version = version.strip()
|
||||||
|
|
||||||
with open("config") as f:
|
with open("config") as f:
|
||||||
for line in f.readlines():
|
for line in f.readlines():
|
||||||
@@ -524,10 +650,22 @@ def main():
|
|||||||
with open("plugin.toml") as f:
|
with open("plugin.toml") as f:
|
||||||
for line in f.readlines():
|
for line in f.readlines():
|
||||||
if line.startswith("sponsors"):
|
if line.startswith("sponsors"):
|
||||||
sponsors = re.search("\[([\"\w\s,_-]+)\]", line).group(1)
|
sponsors = re.search('\[(["\w\s,_-]+)\]', line).group(1)
|
||||||
sponsors = [s.strip("\"") for s in sponsors.split(",")]
|
sponsors = [s.strip('"') for s in sponsors.split(",")]
|
||||||
|
|
||||||
text = compile(service, version, variable, alias, image, scheme, ports, sponsors, options, unimplemented, "0.19.x+")
|
text = compile(
|
||||||
|
service,
|
||||||
|
version,
|
||||||
|
variable,
|
||||||
|
alias,
|
||||||
|
image,
|
||||||
|
scheme,
|
||||||
|
ports,
|
||||||
|
sponsors,
|
||||||
|
options,
|
||||||
|
unimplemented,
|
||||||
|
"0.19.x+",
|
||||||
|
)
|
||||||
|
|
||||||
base_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
|
base_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
|
||||||
readme_file = os.path.join(base_path, "README.md")
|
readme_file = os.path.join(base_path, "README.md")
|
||||||
|
|||||||
142
common-functions
142
common-functions
@@ -62,7 +62,7 @@ fn-services-list() {
|
|||||||
[[ -d $f ]] || continue
|
[[ -d $f ]] || continue
|
||||||
services+=("$f")
|
services+=("$f")
|
||||||
done
|
done
|
||||||
popd &>/dev/null || pushd "/tmp" >/dev/null
|
popd >/dev/null 2>&1 || pushd "/tmp" >/dev/null
|
||||||
|
|
||||||
if [[ "${#services[@]}" -eq 0 ]]; then
|
if [[ "${#services[@]}" -eq 0 ]]; then
|
||||||
return
|
return
|
||||||
@@ -282,7 +282,7 @@ service_backup() {
|
|||||||
BACKUP_TMPDIR=$(mktemp -d --tmpdir)
|
BACKUP_TMPDIR=$(mktemp -d --tmpdir)
|
||||||
trap 'rm -rf "$BACKUP_TMPDIR" > /dev/null' RETURN INT TERM EXIT
|
trap 'rm -rf "$BACKUP_TMPDIR" > /dev/null' RETURN INT TERM EXIT
|
||||||
|
|
||||||
"$DOCKER_BIN" container inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist"
|
"$DOCKER_BIN" container inspect "$ID" >/dev/null 2>&1 || dokku_log_fail "Service container does not exist"
|
||||||
is_container_status "$ID" "Running" || dokku_log_fail "Service container is not running"
|
is_container_status "$ID" "Running" || dokku_log_fail "Service container is not running"
|
||||||
|
|
||||||
(service_export "$SERVICE" >"${BACKUP_TMPDIR}/export")
|
(service_export "$SERVICE" >"${BACKUP_TMPDIR}/export")
|
||||||
@@ -308,6 +308,10 @@ service_backup() {
|
|||||||
BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e ENCRYPTION_KEY=$(cat "$BACKUP_ENCRYPTION_CONFIG_ROOT/ENCRYPTION_KEY")"
|
BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e ENCRYPTION_KEY=$(cat "$BACKUP_ENCRYPTION_CONFIG_ROOT/ENCRYPTION_KEY")"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
if [[ -f "$BACKUP_ENCRYPTION_CONFIG_ROOT/ENCRYPT_WITH_PUBLIC_KEY_ID" ]]; then
|
||||||
|
BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e ENCRYPT_WITH_PUBLIC_KEY_ID=$(cat "$BACKUP_ENCRYPTION_CONFIG_ROOT/ENCRYPT_WITH_PUBLIC_KEY_ID")"
|
||||||
|
fi
|
||||||
|
|
||||||
# shellcheck disable=SC2086
|
# shellcheck disable=SC2086
|
||||||
"$DOCKER_BIN" container run --rm $BACKUP_PARAMETERS "$PLUGIN_S3BACKUP_IMAGE"
|
"$DOCKER_BIN" container run --rm $BACKUP_PARAMETERS "$PLUGIN_S3BACKUP_IMAGE"
|
||||||
}
|
}
|
||||||
@@ -433,6 +437,16 @@ service_backup_set_encryption() {
|
|||||||
echo "$ENCRYPTION_KEY" >"${SERVICE_BACKUP_ENCRYPTION_ROOT}/ENCRYPTION_KEY"
|
echo "$ENCRYPTION_KEY" >"${SERVICE_BACKUP_ENCRYPTION_ROOT}/ENCRYPTION_KEY"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
service_backup_set_public_key_encryption() {
|
||||||
|
declare desc="set up backup GPG Public Key encryption"
|
||||||
|
declare SERVICE="$1" ENCRYPT_WITH_PUBLIC_KEY_ID="$2"
|
||||||
|
local SERVICE_ROOT="${PLUGIN_DATA_ROOT}/${SERVICE}"
|
||||||
|
local SERVICE_BACKUP_ENCRYPTION_ROOT="${SERVICE_ROOT}/backup-encryption/"
|
||||||
|
|
||||||
|
mkdir "$SERVICE_BACKUP_ENCRYPTION_ROOT"
|
||||||
|
echo "$ENCRYPT_WITH_PUBLIC_KEY_ID" >"${SERVICE_BACKUP_ENCRYPTION_ROOT}/ENCRYPT_WITH_PUBLIC_KEY_ID"
|
||||||
|
}
|
||||||
|
|
||||||
service_backup_unschedule() {
|
service_backup_unschedule() {
|
||||||
declare desc="unschedule the backup of the service"
|
declare desc="unschedule the backup of the service"
|
||||||
declare SERVICE="$1"
|
declare SERVICE="$1"
|
||||||
@@ -450,6 +464,15 @@ service_backup_unset_encryption() {
|
|||||||
rm -rf "$SERVICE_BACKUP_ENCRYPTION_ROOT"
|
rm -rf "$SERVICE_BACKUP_ENCRYPTION_ROOT"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
service_backup_unset_encryption() {
|
||||||
|
declare desc="remove backup encryption"
|
||||||
|
declare SERVICE="$1"
|
||||||
|
local SERVICE_ROOT="${PLUGIN_DATA_ROOT}/${SERVICE}"
|
||||||
|
local SERVICE_BACKUP_ENCRYPTION_ROOT="${SERVICE_ROOT}/backup-encryption/"
|
||||||
|
|
||||||
|
rm -rf "$SERVICE_BACKUP_ENCRYPTION_ROOT"
|
||||||
|
}
|
||||||
|
|
||||||
service_container_rm() {
|
service_container_rm() {
|
||||||
declare desc="stop a service and remove the running container"
|
declare desc="stop a service and remove the running container"
|
||||||
declare SERVICE="$1"
|
declare SERVICE="$1"
|
||||||
@@ -457,7 +480,7 @@ service_container_rm() {
|
|||||||
local ID
|
local ID
|
||||||
|
|
||||||
service_pause "$SERVICE"
|
service_pause "$SERVICE"
|
||||||
ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
|
ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$") || true
|
||||||
# this may be 'true' in tests...
|
# this may be 'true' in tests...
|
||||||
if [[ -z "$ID" ]] || [[ "$ID" == "true" ]]; then
|
if [[ -z "$ID" ]] || [[ "$ID" == "true" ]]; then
|
||||||
return 0
|
return 0
|
||||||
@@ -483,7 +506,7 @@ service_enter() {
|
|||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
local ID="$(cat "$SERVICE_ROOT/ID")"
|
local ID="$(cat "$SERVICE_ROOT/ID")"
|
||||||
|
|
||||||
"$DOCKER_BIN" container inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist"
|
"$DOCKER_BIN" container inspect "$ID" >/dev/null 2>&1 || dokku_log_fail "Service container does not exist"
|
||||||
is_container_status "$ID" "Running" || dokku_log_fail "Service container is not running"
|
is_container_status "$ID" "Running" || dokku_log_fail "Service container is not running"
|
||||||
|
|
||||||
local EXEC_CMD=""
|
local EXEC_CMD=""
|
||||||
@@ -631,8 +654,9 @@ service_link() {
|
|||||||
fi
|
fi
|
||||||
[[ -n "$SERVICE_QUERYSTRING" ]] && SERVICE_URL="${SERVICE_URL}?${SERVICE_QUERYSTRING}"
|
[[ -n "$SERVICE_QUERYSTRING" ]] && SERVICE_URL="${SERVICE_URL}?${SERVICE_QUERYSTRING}"
|
||||||
plugn trigger service-action post-link "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
|
plugn trigger service-action post-link "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
|
||||||
if [[ "$DOKKU_GLOBAL_FLAGS" == *"--no-restart"* ]]; then
|
if [[ "$DOKKU_GLOBAL_FLAGS" == *"--no-restart"* ]] || [[ "$SERVICE_RESTART_APPS" == "false" ]]; then
|
||||||
config_set --no-restart "$APP" "${ALIAS}_URL=$SERVICE_URL"
|
config_set --no-restart "$APP" "${ALIAS}_URL=$SERVICE_URL"
|
||||||
|
dokku_log_verbose "Skipping restart of linked app"
|
||||||
else
|
else
|
||||||
config_set "$APP" "${ALIAS}_URL=$SERVICE_URL"
|
config_set "$APP" "${ALIAS}_URL=$SERVICE_URL"
|
||||||
fi
|
fi
|
||||||
@@ -690,7 +714,7 @@ service_logs() {
|
|||||||
DOKKU_LOGS_ARGS+=" --follow"
|
DOKKU_LOGS_ARGS+=" --follow"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
"$DOCKER_BIN" container inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist"
|
"$DOCKER_BIN" container inspect "$ID" >/dev/null 2>&1 || dokku_log_fail "Service container does not exist"
|
||||||
is_container_status "$ID" "Running" || dokku_log_warn "Service logs may not be output as service is not running"
|
is_container_status "$ID" "Running" || dokku_log_warn "Service logs may not be output as service is not running"
|
||||||
|
|
||||||
# shellcheck disable=SC2086
|
# shellcheck disable=SC2086
|
||||||
@@ -714,6 +738,7 @@ service_parse_args() {
|
|||||||
"--initial-network") set -- "$@" "-N" ;;
|
"--initial-network") set -- "$@" "-N" ;;
|
||||||
"--image") set -- "$@" "-i" ;;
|
"--image") set -- "$@" "-i" ;;
|
||||||
"--memory") set -- "$@" "-m" ;;
|
"--memory") set -- "$@" "-m" ;;
|
||||||
|
"--no-restart") set -- "$@" "-n" ;;
|
||||||
"--password") set -- "$@" "-p" ;;
|
"--password") set -- "$@" "-p" ;;
|
||||||
"--post-create-network") set -- "$@" "-P" ;;
|
"--post-create-network") set -- "$@" "-P" ;;
|
||||||
"--post-start-network") set -- "$@" "-S" ;;
|
"--post-start-network") set -- "$@" "-S" ;;
|
||||||
@@ -727,7 +752,7 @@ service_parse_args() {
|
|||||||
done
|
done
|
||||||
|
|
||||||
OPTIND=1
|
OPTIND=1
|
||||||
while getopts "a:c:C:d:i:I:m:n:N:p:P:q:R:r:s:S:u:" opt; do
|
while getopts "na:c:C:d:i:I:m:n:N:p:P:q:R:r:s:S:u:" opt; do
|
||||||
case "$opt" in
|
case "$opt" in
|
||||||
a)
|
a)
|
||||||
SERVICE_ALIAS="${OPTARG^^}"
|
SERVICE_ALIAS="${OPTARG^^}"
|
||||||
@@ -751,6 +776,9 @@ service_parse_args() {
|
|||||||
m)
|
m)
|
||||||
export SERVICE_MEMORY=$OPTARG
|
export SERVICE_MEMORY=$OPTARG
|
||||||
;;
|
;;
|
||||||
|
n)
|
||||||
|
export SERVICE_RESTART_APPS=false
|
||||||
|
;;
|
||||||
N)
|
N)
|
||||||
export SERVICE_INITIAL_NETWORK=$OPTARG
|
export SERVICE_INITIAL_NETWORK=$OPTARG
|
||||||
;;
|
;;
|
||||||
@@ -805,39 +833,36 @@ service_root_password() {
|
|||||||
|
|
||||||
service_port_expose() {
|
service_port_expose() {
|
||||||
declare desc="wrapper for exposing service ports"
|
declare desc="wrapper for exposing service ports"
|
||||||
declare SERVICE="$1"
|
declare SERVICE="$1" PORTS=(${@:2})
|
||||||
service_start "$SERVICE" "true"
|
|
||||||
service_port_unpause "$SERVICE" "true" "${@:2}"
|
|
||||||
}
|
|
||||||
|
|
||||||
service_port_pause() {
|
|
||||||
declare desc="pause service exposure"
|
|
||||||
declare SERVICE="$1" LOG_FAIL="$2"
|
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
local EXPOSED_NAME="$(get_service_name "$SERVICE").ambassador"
|
|
||||||
local PORT_FILE="$SERVICE_ROOT/PORT"
|
local PORT_FILE="$SERVICE_ROOT/PORT"
|
||||||
|
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||||
|
local EXPOSED_NAME="$SERVICE_NAME.ambassador"
|
||||||
|
|
||||||
if [[ "$LOG_FAIL" == "true" ]]; then
|
if [[ ${#PORTS[@]} -eq 0 ]]; then
|
||||||
[[ ! -f "$PORT_FILE" ]] && dokku_log_fail "Service not exposed"
|
# shellcheck disable=SC2206
|
||||||
else
|
PORTS=(${PORTS[@]:-$(get_random_ports ${#PLUGIN_DATASTORE_PORTS[@]})})
|
||||||
[[ ! -f "$PORT_FILE" ]] && return 0
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
local GREP_NAME="^/${EXPOSED_NAME}$"
|
[[ "${#PORTS[@]}" != "${#PLUGIN_DATASTORE_PORTS[@]}" ]] && dokku_log_fail "${#PLUGIN_DATASTORE_PORTS[@]} ports to be exposed need to be provided in the following order: ${PLUGIN_DATASTORE_PORTS[*]}"
|
||||||
local CONTAINER_NAME="$("$DOCKER_BIN" container ps -f name="$GREP_NAME" --format "{{.Names}}")"
|
|
||||||
if [[ -z "$CONTAINER_NAME" ]]; then
|
|
||||||
if [[ "$LOG_FAIL" == "true" ]]; then
|
|
||||||
dokku_log_info1 "Service $SERVICE unexposed"
|
|
||||||
fi
|
|
||||||
|
|
||||||
return
|
if [[ -s "$PORT_FILE" ]]; then
|
||||||
|
# shellcheck disable=SC2207
|
||||||
|
PORTS=($(cat "$PORT_FILE"))
|
||||||
|
dokku_log_fail "Service $SERVICE already exposed on port(s) ${PORTS[*]}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
"$DOCKER_BIN" container stop "$EXPOSED_NAME" >/dev/null 2>&1 || true
|
if "$DOCKER_BIN" container inspect "$EXPOSED_NAME" >/dev/null 2>&1; then
|
||||||
"$DOCKER_BIN" container rm "$EXPOSED_NAME" >/dev/null 2>&1 || true
|
dokku_log_warn "Service $SERVICE has an untracked expose container, removing"
|
||||||
if [[ "$LOG_FAIL" == "true" ]]; then
|
"$DOCKER_BIN" container stop "$EXPOSED_NAME" >/dev/null 2>&1 || true
|
||||||
dokku_log_info1 "Service $SERVICE unexposed"
|
suppress_output "$DOCKER_BIN" container rm "$EXPOSED_NAME"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
echo "${PORTS[@]}" >"$PORT_FILE"
|
||||||
|
|
||||||
|
service_start "$SERVICE" "true"
|
||||||
|
service_port_reconcile_status "$SERVICE"
|
||||||
|
dokku_log_info1 "Service $SERVICE exposed on port(s) [container->host]: $(service_exposed_ports "$SERVICE")"
|
||||||
}
|
}
|
||||||
|
|
||||||
service_port_unexpose() {
|
service_port_unexpose() {
|
||||||
@@ -845,39 +870,41 @@ service_port_unexpose() {
|
|||||||
declare SERVICE="$1"
|
declare SERVICE="$1"
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
local PORT_FILE="$SERVICE_ROOT/PORT"
|
local PORT_FILE="$SERVICE_ROOT/PORT"
|
||||||
service_port_pause "$SERVICE" "true"
|
|
||||||
rm -rf "$PORT_FILE"
|
rm -rf "$PORT_FILE"
|
||||||
|
service_port_reconcile_status "$SERVICE"
|
||||||
|
dokku_log_info1 "Service $SERVICE unexposed"
|
||||||
}
|
}
|
||||||
|
|
||||||
service_port_unpause() {
|
service_port_reconcile_status() {
|
||||||
declare desc="start service exposure"
|
declare SERVICE="$1"
|
||||||
declare SERVICE="$1" LOG_FAIL="$2"
|
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
|
||||||
local EXPOSED_NAME="${SERVICE_NAME}.ambassador"
|
|
||||||
local PORT_FILE="$SERVICE_ROOT/PORT"
|
local PORT_FILE="$SERVICE_ROOT/PORT"
|
||||||
# shellcheck disable=SC2068
|
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||||
local PORTS=(${@:3})
|
local EXPOSED_NAME="$SERVICE_NAME.ambassador"
|
||||||
# shellcheck disable=SC2068
|
|
||||||
PORTS=(${PORTS[@]:-$(get_random_ports ${#PLUGIN_DATASTORE_PORTS[@]})})
|
|
||||||
local ID=$(cat "$SERVICE_ROOT/ID")
|
|
||||||
|
|
||||||
[[ "${#PORTS[@]}" != "${#PLUGIN_DATASTORE_PORTS[@]}" ]] && dokku_log_fail "${#PLUGIN_DATASTORE_PORTS[@]} ports to be exposed need to be provided in the following order: ${PLUGIN_DATASTORE_PORTS[*]}"
|
if [[ ! -s "$PORT_FILE" ]]; then
|
||||||
|
if "$DOCKER_BIN" container inspect "$EXPOSED_NAME" >/dev/null 2>&1; then
|
||||||
if [[ "$LOG_FAIL" == "true" ]]; then
|
"$DOCKER_BIN" container stop "$EXPOSED_NAME" >/dev/null 2>&1 || true
|
||||||
[[ -f "$PORT_FILE" ]] && PORTS=($(cat "$PORT_FILE")) && dokku_log_fail "Service $SERVICE already exposed on port(s) ${PORTS[*]}"
|
suppress_output "$DOCKER_BIN" container rm "$EXPOSED_NAME"
|
||||||
else
|
return $?
|
||||||
[[ ! -f "$PORT_FILE" ]] && return 0
|
fi
|
||||||
PORTS=($(cat "$PORT_FILE"))
|
return
|
||||||
fi
|
fi
|
||||||
|
|
||||||
echo "${PORTS[@]}" >"$PORT_FILE"
|
if is_container_status "$EXPOSED_NAME" "Running"; then
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
if "$DOCKER_BIN" container inspect "$EXPOSED_NAME" >/dev/null 2>&1; then
|
||||||
|
suppress_output "$DOCKER_BIN" container start "$EXPOSED_NAME"
|
||||||
|
return $?
|
||||||
|
fi
|
||||||
|
|
||||||
|
# shellcheck disable=SC2207
|
||||||
|
PORTS=($(cat "$PORT_FILE"))
|
||||||
# shellcheck disable=SC2046
|
# shellcheck disable=SC2046
|
||||||
"$DOCKER_BIN" container run -d --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" --name "$EXPOSED_NAME" $(docker_ports_options "${PORTS[@]}") --restart always --label dokku=ambassador --label "dokku.ambassador=$PLUGIN_COMMAND_PREFIX" "$PLUGIN_AMBASSADOR_IMAGE" >/dev/null
|
"$DOCKER_BIN" container run -d --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" --name "$EXPOSED_NAME" $(docker_ports_options "${PORTS[@]}") --restart always --label dokku=ambassador --label "dokku.ambassador=$PLUGIN_COMMAND_PREFIX" "$PLUGIN_AMBASSADOR_IMAGE" >/dev/null
|
||||||
if [[ "$LOG_FAIL" == "true" ]]; then
|
|
||||||
dokku_log_info1 "Service $SERVICE exposed on port(s) [container->host]: $(service_exposed_ports "$SERVICE")"
|
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|
||||||
service_promote() {
|
service_promote() {
|
||||||
@@ -935,13 +962,15 @@ service_pause() {
|
|||||||
declare SERVICE="$1"
|
declare SERVICE="$1"
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||||
local ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
|
local ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$") || true
|
||||||
[[ -z $ID ]] && dokku_log_warn "Service is already paused" && return 0
|
[[ -z $ID ]] && dokku_log_warn "Service is already paused" && return 0
|
||||||
|
|
||||||
if [[ -n $ID ]]; then
|
if [[ -n $ID ]]; then
|
||||||
dokku_log_info2_quiet "Pausing container"
|
dokku_log_info2_quiet "Pausing container"
|
||||||
"$DOCKER_BIN" container stop "$SERVICE_NAME" >/dev/null
|
"$DOCKER_BIN" container stop "$SERVICE_NAME" >/dev/null
|
||||||
service_port_pause "$SERVICE"
|
if "$DOCKER_BIN" container inspect "$ID" >/dev/null 2>&1; then
|
||||||
|
"$DOCKER_BIN" container stop "$SERVICE_NAME.ambassador" >/dev/null 2>&1 || true
|
||||||
|
fi
|
||||||
dokku_log_verbose_quiet "Container paused"
|
dokku_log_verbose_quiet "Container paused"
|
||||||
else
|
else
|
||||||
dokku_log_verbose_quiet "No container exists for $SERVICE"
|
dokku_log_verbose_quiet "No container exists for $SERVICE"
|
||||||
@@ -971,8 +1000,9 @@ service_unlink() {
|
|||||||
|
|
||||||
[[ -z ${LINK[*]} ]] && dokku_log_fail "Not linked to app $APP"
|
[[ -z ${LINK[*]} ]] && dokku_log_fail "Not linked to app $APP"
|
||||||
plugn trigger service-action post-unlink "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
|
plugn trigger service-action post-unlink "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
|
||||||
if [[ "$DOKKU_GLOBAL_FLAGS" == *"--no-restart"* ]]; then
|
if [[ "$DOKKU_GLOBAL_FLAGS" == *"--no-restart"* ]] || [[ "$SERVICE_RESTART_APPS" == "false" ]]; then
|
||||||
config_unset --no-restart "$APP" "${LINK[@]}"
|
config_unset --no-restart "$APP" "${LINK[@]}"
|
||||||
|
dokku_log_verbose "Skipping restart of linked app"
|
||||||
else
|
else
|
||||||
config_unset "$APP" "${LINK[@]}"
|
config_unset "$APP" "${LINK[@]}"
|
||||||
fi
|
fi
|
||||||
|
|||||||
8
config
8
config
@@ -28,9 +28,9 @@ if [[ -n $DOKKU_API_VERSION ]]; then
|
|||||||
export PLUGIN_BASE_PATH="$PLUGIN_ENABLED_PATH"
|
export PLUGIN_BASE_PATH="$PLUGIN_ENABLED_PATH"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
export PLUGIN_BUSYBOX_IMAGE="busybox:1.34.1-uclibc"
|
export PLUGIN_BUSYBOX_IMAGE=${PLUGIN_BUSYBOX_IMAGE:=busybox:1.37.0-uclibc}
|
||||||
export PLUGIN_AMBASSADOR_IMAGE="dokku/ambassador:0.5.0"
|
export PLUGIN_AMBASSADOR_IMAGE=${PLUGIN_AMBASSADOR_IMAGE:=dokku/ambassador:0.8.2}
|
||||||
export PLUGIN_S3BACKUP_IMAGE="dokku/s3backup:0.14.0"
|
export PLUGIN_S3BACKUP_IMAGE=${PLUGIN_S3BACKUP_IMAGE:=dokku/s3backup:0.18.0}
|
||||||
export PLUGIN_WAIT_IMAGE="dokku/wait:0.6.0"
|
export PLUGIN_WAIT_IMAGE=${PLUGIN_WAIT_IMAGE:=dokku/wait:0.9.3}
|
||||||
|
|
||||||
export POSTGRES_CONFIG_OPTIONS=${POSTGRES_CONFIG_OPTIONS:=""}
|
export POSTGRES_CONFIG_OPTIONS=${POSTGRES_CONFIG_OPTIONS:=""}
|
||||||
|
|||||||
@@ -1,5 +1,13 @@
|
|||||||
Official Postgres "$DOCKER_BIN" image ls does not include postgis extension (amongst others). The following example creates a new postgres service using `postgis/postgis:13-3.1` image, which includes the `postgis` extension.
|
Official Postgres "$DOCKER_BIN" image ls does not include postgis extension (amongst others). The following example creates a new postgres service using `postgis/postgis:13-3.1` image, which includes the `postgis` extension.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
# use the appropriate image-version for your use-case
|
||||||
dokku postgres:create postgis-database --image "postgis/postgis" --image-version "13-3.1"
|
dokku postgres:create postgis-database --image "postgis/postgis" --image-version "13-3.1"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
To use pgvector instead, run the following:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# use the appropriate image-version for your use-case
|
||||||
|
dokku postgres:create pgvector-database --image "pgvector/pgvector" --image-version "pg17"
|
||||||
|
```
|
||||||
|
|||||||
16
functions
16
functions
@@ -18,7 +18,7 @@ service_connect() {
|
|||||||
local SERVICE_TTY_OPTS
|
local SERVICE_TTY_OPTS
|
||||||
has_tty && SERVICE_TTY_OPTS="-t"
|
has_tty && SERVICE_TTY_OPTS="-t"
|
||||||
|
|
||||||
"$DOCKER_BIN" container exec --env=LANG=C.UTF-8 --env=LC_ALL=C.UTF-8 -i $SERVICE_TTY_OPTS "$SERVICE_NAME" psql -h localhost -U postgres "$DATABASE_NAME"
|
"$DOCKER_BIN" container exec --env=LANG=C.UTF-8 --env=LC_ALL=C.UTF-8 -i $SERVICE_TTY_OPTS "$SERVICE_NAME" psql -v ON_ERROR_STOP=1 -h localhost -U postgres "$DATABASE_NAME"
|
||||||
}
|
}
|
||||||
|
|
||||||
service_create() {
|
service_create() {
|
||||||
@@ -126,6 +126,8 @@ service_create_container() {
|
|||||||
done < <(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-create-network" | tr "," "\n")
|
done < <(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-create-network" | tr "," "\n")
|
||||||
fi
|
fi
|
||||||
suppress_output "$DOCKER_BIN" container start "$(cat "$SERVICE_ROOT/ID")"
|
suppress_output "$DOCKER_BIN" container start "$(cat "$SERVICE_ROOT/ID")"
|
||||||
|
service_port_reconcile_status "$SERVICE"
|
||||||
|
|
||||||
if [[ -n "$(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-start-network")" ]]; then
|
if [[ -n "$(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-start-network")" ]]; then
|
||||||
dokku_log_verbose_quiet "Connecting to networks after container start"
|
dokku_log_verbose_quiet "Connecting to networks after container start"
|
||||||
while read -r line || [[ -n "$line" ]]; do
|
while read -r line || [[ -n "$line" ]]; do
|
||||||
@@ -147,10 +149,12 @@ service_create_container() {
|
|||||||
|
|
||||||
dokku_log_verbose_quiet "Securing connection to database"
|
dokku_log_verbose_quiet "Securing connection to database"
|
||||||
service_pause "$SERVICE" >/dev/null
|
service_pause "$SERVICE" >/dev/null
|
||||||
"$DOCKER_BIN" container run --rm -i -v "$SERVICE_HOST_ROOT/data:/var/lib/postgresql/data" "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" bash -s <"$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/scripts/enable_ssl.sh" &>/dev/null
|
"$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/scripts/create_ssl_certs.sh" "$SERVICE_ROOT" &>/dev/null
|
||||||
|
"$DOCKER_BIN" container run --rm -i -v "$SERVICE_HOST_ROOT/data:/var/lib/postgresql/data" -v "$SERVICE_HOST_ROOT/certs:/var/lib/postgresql/certs" "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" bash -s <"$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/scripts/enable_ssl.sh" &>/dev/null
|
||||||
|
rm -rf "$SERVICE_HOST_ROOT/certs"
|
||||||
|
|
||||||
suppress_output "$DOCKER_BIN" container start "$(cat "$SERVICE_ROOT/ID")"
|
suppress_output "$DOCKER_BIN" container start "$(cat "$SERVICE_ROOT/ID")"
|
||||||
service_port_unpause "$SERVICE"
|
service_port_reconcile_status "$SERVICE"
|
||||||
|
|
||||||
dokku_log_info2 "$PLUGIN_SERVICE container created: $SERVICE"
|
dokku_log_info2 "$PLUGIN_SERVICE container created: $SERVICE"
|
||||||
service_info "$SERVICE"
|
service_info "$SERVICE"
|
||||||
@@ -189,7 +193,7 @@ service_start() {
|
|||||||
local QUIET="$2"
|
local QUIET="$2"
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||||
local ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "status=running" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
|
local ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "status=running" --filter "name=^/$SERVICE_NAME$") || true
|
||||||
if [[ -n $ID ]]; then
|
if [[ -n $ID ]]; then
|
||||||
[[ -z $QUIET ]] && dokku_log_warn "Service is already started"
|
[[ -z $QUIET ]] && dokku_log_warn "Service is already started"
|
||||||
if [[ ! -f "$SERVICE_ROOT/ID" ]] || [[ "$(cat "$SERVICE_ROOT/ID")" != "$ID" ]]; then
|
if [[ ! -f "$SERVICE_ROOT/ID" ]] || [[ "$(cat "$SERVICE_ROOT/ID")" != "$ID" ]]; then
|
||||||
@@ -200,12 +204,12 @@ service_start() {
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
dokku_log_info2_quiet "Starting container"
|
dokku_log_info2_quiet "Starting container"
|
||||||
local PREVIOUS_ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "status=exited" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
|
local PREVIOUS_ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "status=exited" --filter "name=^/$SERVICE_NAME$") || true
|
||||||
local PASSWORD="$(service_password "$SERVICE")"
|
local PASSWORD="$(service_password "$SERVICE")"
|
||||||
|
|
||||||
if [[ -n $PREVIOUS_ID ]]; then
|
if [[ -n $PREVIOUS_ID ]]; then
|
||||||
"$DOCKER_BIN" container start "$PREVIOUS_ID" >/dev/null
|
"$DOCKER_BIN" container start "$PREVIOUS_ID" >/dev/null
|
||||||
service_port_unpause "$SERVICE"
|
service_port_reconcile_status "$SERVICE"
|
||||||
dokku_log_info2 "Container started"
|
dokku_log_info2 "Container started"
|
||||||
elif service_image_exists "$SERVICE" && [[ -n "$PASSWORD" ]]; then
|
elif service_image_exists "$SERVICE" && [[ -n "$PASSWORD" ]]; then
|
||||||
service_create_container "$SERVICE"
|
service_create_container "$SERVICE"
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
[plugin]
|
[plugin]
|
||||||
description = "dokku postgres service plugin"
|
description = "dokku postgres service plugin"
|
||||||
version = "1.28.0"
|
version = "1.43.1"
|
||||||
[plugin.config]
|
[plugin.config]
|
||||||
|
|||||||
9
scripts/create_ssl_certs.sh
Executable file
9
scripts/create_ssl_certs.sh
Executable file
@@ -0,0 +1,9 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
set -e
|
||||||
|
|
||||||
|
postgres_service_dir="$1"
|
||||||
|
|
||||||
|
cd "$postgres_service_dir"
|
||||||
|
mkdir certs && cd certs
|
||||||
|
openssl req -new -newkey rsa:4096 -x509 -days 365000 -nodes -out server.crt -keyout server.key -batch
|
||||||
@@ -1,7 +1,12 @@
|
|||||||
#!/bin/bash
|
#!/bin/sh
|
||||||
pushd /var/lib/postgresql/data >/dev/null
|
|
||||||
openssl req -new -newkey rsa:4096 -x509 -days 365000 -nodes -out server.crt -keyout server.key -batch
|
set -e
|
||||||
|
|
||||||
|
cd /var/lib/postgresql/data
|
||||||
|
|
||||||
|
cp ../certs/* .
|
||||||
|
chown postgres:postgres server.key
|
||||||
chmod 600 server.key
|
chmod 600 server.key
|
||||||
|
|
||||||
sed -i "s/^#ssl = off/ssl = on/" postgresql.conf
|
sed -i "s/^#ssl = off/ssl = on/" postgresql.conf
|
||||||
sed -i "s/^#ssl_ciphers =.*/ssl_ciphers = 'AES256+EECDH:AES256+EDH'/" postgresql.conf
|
sed -i "s/^#ssl_ciphers =.*/ssl_ciphers = 'AES256+EECDH:AES256+EDH'/" postgresql.conf
|
||||||
popd >/dev/null
|
|
||||||
|
|||||||
25
subcommands/backup-set-public-key-encryption
Executable file
25
subcommands/backup-set-public-key-encryption
Executable file
@@ -0,0 +1,25 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
|
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
|
||||||
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||||
|
|
||||||
|
service-backup-set-public-key-encryption-cmd() {
|
||||||
|
#E set the GPG Public Key for encrypting backups
|
||||||
|
#E dokku $PLUGIN_COMMAND_PREFIX:backup-set-public-key-encryption lollipop
|
||||||
|
#A service, service to run command against
|
||||||
|
#A public-key-id, a GPG Public Key ID (or fingerprint) to use for encryption. Must be uploaded to the GPG keyserver beforehand.
|
||||||
|
declare desc="set GPG Public Key encryption for all future backups of $PLUGIN_SERVICE service"
|
||||||
|
local cmd="$PLUGIN_COMMAND_PREFIX:backup-set-public-key-encryption" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
|
declare SERVICE="$1" PUBLIC_KEY_ID="$2"
|
||||||
|
is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
|
||||||
|
|
||||||
|
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
|
||||||
|
[[ -z "$PUBLIC_KEY_ID" ]] && dokku_log_fail "Please specify a valid GPG Public Key ID (or fingerprint)"
|
||||||
|
verify_service_name "$SERVICE"
|
||||||
|
service_backup_set_public_key_encryption "$SERVICE" "$PUBLIC_KEY_ID"
|
||||||
|
}
|
||||||
|
|
||||||
|
service-backup-set-public-key-encryption-cmd "$@"
|
||||||
23
subcommands/backup-unset-public-key-encryption
Executable file
23
subcommands/backup-unset-public-key-encryption
Executable file
@@ -0,0 +1,23 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
|
||||||
|
set -eo pipefail
|
||||||
|
[[ $DOKKU_TRACE ]] && set -x
|
||||||
|
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
|
||||||
|
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
||||||
|
|
||||||
|
service-backup-unset-public-key-encryption-cmd() {
|
||||||
|
#E unset the GPG Public Key encryption for backups
|
||||||
|
#E dokku $PLUGIN_COMMAND_PREFIX:backup-unset-public-key-encryption lollipop
|
||||||
|
#A service, service to run command against
|
||||||
|
declare desc="unset GPG Public Key encryption for future backups of the $PLUGIN_SERVICE service"
|
||||||
|
local cmd="$PLUGIN_COMMAND_PREFIX:backup-unset-public-key-encryption" argv=("$@")
|
||||||
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
|
declare SERVICE="$1"
|
||||||
|
is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented" # TODO: [22.03.2024 by Mykola]
|
||||||
|
|
||||||
|
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
|
||||||
|
verify_service_name "$SERVICE"
|
||||||
|
service_backup_unset_public_key_encryption "$SERVICE" # TODO: [22.03.2024 by Mykola]
|
||||||
|
}
|
||||||
|
|
||||||
|
service-backup-unset-encryption-cmd "$@"
|
||||||
@@ -17,9 +17,9 @@ service-clone-cmd() {
|
|||||||
#F -m|--memory MEMORY, container memory limit in megabytes (default: unlimited)
|
#F -m|--memory MEMORY, container memory limit in megabytes (default: unlimited)
|
||||||
#F -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to
|
#F -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to
|
||||||
#F -p|--password PASSWORD, override the user-level service password
|
#F -p|--password PASSWORD, override the user-level service password
|
||||||
#F -P|--post-create-network NETWORKS, a comman-separated list of networks to attach the service container to after service creation
|
#F -P|--post-create-network NETWORKS, a comma-separated list of networks to attach the service container to after service creation
|
||||||
#F -r|--root-password PASSWORD, override the root-level service password
|
#F -r|--root-password PASSWORD, override the root-level service password
|
||||||
#F -S|--post-start-network NETWORKS, a comman-separated list of networks to attach the service container to after service start
|
#F -S|--post-start-network NETWORKS, a comma-separated list of networks to attach the service container to after service start
|
||||||
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
|
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
|
||||||
declare desc="create container <new-name> then copy data from <name> into <new-name>"
|
declare desc="create container <new-name> then copy data from <name> into <new-name>"
|
||||||
local cmd="$PLUGIN_COMMAND_PREFIX:clone" argv=("$@")
|
local cmd="$PLUGIN_COMMAND_PREFIX:clone" argv=("$@")
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ service-create-cmd() {
|
|||||||
#E export ${PLUGIN_VARIABLE}_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
|
#E export ${PLUGIN_VARIABLE}_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
|
||||||
#E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
|
#E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
|
||||||
#E you can also specify custom environment variables to start
|
#E you can also specify custom environment variables to start
|
||||||
#E the ${PLUGIN_COMMAND_PREFIX} service in semi-colon separated form.
|
#E the ${PLUGIN_COMMAND_PREFIX} service in semicolon-separated form.
|
||||||
#E export ${PLUGIN_VARIABLE}_CUSTOM_ENV="USER=alpha;HOST=beta"
|
#E export ${PLUGIN_VARIABLE}_CUSTOM_ENV="USER=alpha;HOST=beta"
|
||||||
#E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
|
#E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
|
||||||
#A service, service to run command against
|
#A service, service to run command against
|
||||||
@@ -25,9 +25,9 @@ service-create-cmd() {
|
|||||||
#F -m|--memory MEMORY, container memory limit in megabytes (default: unlimited)
|
#F -m|--memory MEMORY, container memory limit in megabytes (default: unlimited)
|
||||||
#F -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to
|
#F -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to
|
||||||
#F -p|--password PASSWORD, override the user-level service password
|
#F -p|--password PASSWORD, override the user-level service password
|
||||||
#F -P|--post-create-network NETWORKS, a comman-separated list of networks to attach the service container to after service creation
|
#F -P|--post-create-network NETWORKS, a comma-separated list of networks to attach the service container to after service creation
|
||||||
#F -r|--root-password PASSWORD, override the root-level service password
|
#F -r|--root-password PASSWORD, override the root-level service password
|
||||||
#F -S|--post-start-network NETWORKS, a comman-separated list of networks to attach the service container to after service start
|
#F -S|--post-start-network NETWORKS, a comma-separated list of networks to attach the service container to after service start
|
||||||
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
|
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
|
||||||
declare desc="create a $PLUGIN_SERVICE service"
|
declare desc="create a $PLUGIN_SERVICE service"
|
||||||
local cmd="$PLUGIN_COMMAND_PREFIX:create" argv=("$@")
|
local cmd="$PLUGIN_COMMAND_PREFIX:create" argv=("$@")
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
|
|||||||
service-expose-cmd() {
|
service-expose-cmd() {
|
||||||
#E expose the service on the service's normal ports, allowing access to it from the public interface (0.0.0.0)
|
#E expose the service on the service's normal ports, allowing access to it from the public interface (0.0.0.0)
|
||||||
#E dokku $PLUGIN_COMMAND_PREFIX:expose lollipop ${PLUGIN_DATASTORE_PORTS[@]}
|
#E dokku $PLUGIN_COMMAND_PREFIX:expose lollipop ${PLUGIN_DATASTORE_PORTS[@]}
|
||||||
#E expose the service on the service's normal ports, with the first on a specified ip adddress (127.0.0.1)
|
#E expose the service on the service's normal ports, with the first on a specified ip address (127.0.0.1)
|
||||||
#E dokku $PLUGIN_COMMAND_PREFIX:expose lollipop 127.0.0.1:${PLUGIN_DATASTORE_PORTS[@]}
|
#E dokku $PLUGIN_COMMAND_PREFIX:expose lollipop 127.0.0.1:${PLUGIN_DATASTORE_PORTS[@]}
|
||||||
#A service, service to run command against
|
#A service, service to run command against
|
||||||
#A ports, a list of ports to run against
|
#A ports, a list of ports to run against
|
||||||
|
|||||||
@@ -42,6 +42,7 @@ service-link-cmd() {
|
|||||||
#A app, app to run command against
|
#A app, app to run command against
|
||||||
#F -a|--alias "BLUE_DATABASE", an alternative alias to use for linking to an app via environment variable
|
#F -a|--alias "BLUE_DATABASE", an alternative alias to use for linking to an app via environment variable
|
||||||
#F -q|--querystring "pool=5", ampersand delimited querystring arguments to append to the service link
|
#F -q|--querystring "pool=5", ampersand delimited querystring arguments to append to the service link
|
||||||
|
#F -n|--no-restart "false", whether or not to restart the app on link (default: true)
|
||||||
declare desc="link the $PLUGIN_SERVICE service to the app"
|
declare desc="link the $PLUGIN_SERVICE service to the app"
|
||||||
local cmd="$PLUGIN_COMMAND_PREFIX:link" argv=("$@")
|
local cmd="$PLUGIN_COMMAND_PREFIX:link" argv=("$@")
|
||||||
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ service-unlink-cmd() {
|
|||||||
#E dokku $PLUGIN_COMMAND_PREFIX:unlink lollipop playground
|
#E dokku $PLUGIN_COMMAND_PREFIX:unlink lollipop playground
|
||||||
#A service, service to run command against
|
#A service, service to run command against
|
||||||
#A app, app to run command against
|
#A app, app to run command against
|
||||||
|
#F -n|--no-restart "false", whether or not to restart the app on unlink (default: true)
|
||||||
declare desc="unlink the $PLUGIN_SERVICE service from the app"
|
declare desc="unlink the $PLUGIN_SERVICE service from the app"
|
||||||
local cmd="$PLUGIN_COMMAND_PREFIX:unlink" argv=("$@")
|
local cmd="$PLUGIN_COMMAND_PREFIX:unlink" argv=("$@")
|
||||||
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
[[ ${argv[0]} == "$cmd" ]] && shift 1
|
||||||
|
|||||||
@@ -15,9 +15,9 @@ service-upgrade-cmd() {
|
|||||||
#F -i|--image IMAGE, the image name to start the service with
|
#F -i|--image IMAGE, the image name to start the service with
|
||||||
#F -I|--image-version IMAGE_VERSION, the image version to start the service with
|
#F -I|--image-version IMAGE_VERSION, the image version to start the service with
|
||||||
#F -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to
|
#F -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to
|
||||||
#F -P|--post-create-network NETWORKS, a comman-separated list of networks to attach the service container to after service creation
|
#F -P|--post-create-network NETWORKS, a comma-separated list of networks to attach the service container to after service creation
|
||||||
#F -R|--restart-apps "true", whether to force an app restart
|
#F -R|--restart-apps "true", whether or not to force an app restart (default: false)
|
||||||
#F -S|--post-start-network NETWORKS, a comman-separated list of networks to attach the service container to after service start
|
#F -S|--post-start-network NETWORKS, a comma-separated list of networks to attach the service container to after service start
|
||||||
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
|
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
|
||||||
declare desc="upgrade service <service> to the specified versions"
|
declare desc="upgrade service <service> to the specified versions"
|
||||||
local cmd="$PLUGIN_COMMAND_PREFIX:upgrade" argv=("$@")
|
local cmd="$PLUGIN_COMMAND_PREFIX:upgrade" argv=("$@")
|
||||||
|
|||||||
@@ -48,7 +48,7 @@ teardown() {
|
|||||||
assert_output_contains bridge 0
|
assert_output_contains bridge 0
|
||||||
assert_output_contains custom-network
|
assert_output_contains custom-network
|
||||||
|
|
||||||
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.Aliases}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
|
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.DNSNames}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
|
||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
assert_success
|
assert_success
|
||||||
@@ -120,7 +120,7 @@ teardown() {
|
|||||||
assert_output_contains custom-network
|
assert_output_contains custom-network
|
||||||
assert_output_contains bridge
|
assert_output_contains bridge
|
||||||
|
|
||||||
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.Aliases}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
|
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.DNSNames}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
|
||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
assert_success
|
assert_success
|
||||||
@@ -192,7 +192,7 @@ teardown() {
|
|||||||
assert_output_contains bridge
|
assert_output_contains bridge
|
||||||
assert_output_contains custom-network
|
assert_output_contains custom-network
|
||||||
|
|
||||||
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.Aliases}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
|
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.DNSNames}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
|
||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
assert_success
|
assert_success
|
||||||
@@ -258,7 +258,7 @@ teardown() {
|
|||||||
assert_output_contains bridge
|
assert_output_contains bridge
|
||||||
assert_output_contains custom-network
|
assert_output_contains custom-network
|
||||||
|
|
||||||
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.lsa -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.Aliases}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
|
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.lsa -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.DNSNames}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
|
||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
assert_success
|
assert_success
|
||||||
|
|||||||
@@ -2,29 +2,65 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
dokku "$PLUGIN_COMMAND_PREFIX:create" ls
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" ls
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:expose) error when there are no arguments" {
|
@test "($PLUGIN_COMMAND_PREFIX:expose) error when there are no arguments" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:expose"
|
run dokku "$PLUGIN_COMMAND_PREFIX:expose"
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_failure
|
||||||
assert_contains "${lines[*]}" "Please specify a valid name for the service"
|
assert_contains "${lines[*]}" "Please specify a valid name for the service"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:expose) error when service does not exist" {
|
@test "($PLUGIN_COMMAND_PREFIX:expose) error when service does not exist" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:expose" not_existing_service
|
run dokku "$PLUGIN_COMMAND_PREFIX:expose" not_existing_service
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_failure
|
||||||
assert_contains "${lines[*]}" "service not_existing_service does not exist"
|
assert_contains "${lines[*]}" "service not_existing_service does not exist"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@test "($PLUGIN_COMMAND_PREFIX:expose) error when already exposed" {
|
||||||
|
run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_failure
|
||||||
|
assert_contains "${lines[*]}" "Service ls already exposed on port(s)"
|
||||||
|
|
||||||
|
run sudo rm "$PLUGIN_DATA_ROOT/ls/PORT"
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_contains "${lines[*]}" "Service ls has an untracked expose container, removing"
|
||||||
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:expose) success when not providing custom ports" {
|
@test "($PLUGIN_COMMAND_PREFIX:expose) success when not providing custom ports" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:expose" l
|
run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
[[ "${lines[*]}" =~ exposed\ on\ port\(s\)\ \[container\-\>host\]\:\ [[:digit:]]+ ]]
|
[[ "${lines[*]}" =~ exposed\ on\ port\(s\)\ \[container\-\>host\]\:\ [[:digit:]]+ ]]
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:expose) success when providing custom ports" {
|
@test "($PLUGIN_COMMAND_PREFIX:expose) success when providing custom ports" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:expose" l 4242
|
run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls 4242
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
assert_contains "${lines[*]}" "exposed on port(s) [container->host]: 5432->4242"
|
assert_contains "${lines[*]}" "exposed on port(s) [container->host]: 5432->4242"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,14 +2,14 @@
|
|||||||
load test_helper
|
load test_helper
|
||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
dokku "$PLUGIN_COMMAND_PREFIX:create" ls
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" m
|
dokku "$PLUGIN_COMMAND_PREFIX:create" ms
|
||||||
dokku apps:create my-app
|
dokku apps:create my-app
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" m
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" ms
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" ls
|
||||||
dokku --force apps:destroy my-app
|
dokku --force apps:destroy my-app
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -22,7 +22,7 @@ teardown() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:link) error when the app argument is missing" {
|
@test "($PLUGIN_COMMAND_PREFIX:link) error when the app argument is missing" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:link" l
|
run dokku "$PLUGIN_COMMAND_PREFIX:link" ls
|
||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
assert_contains "${lines[*]}" "Please specify an app to run the command on"
|
assert_contains "${lines[*]}" "Please specify an app to run the command on"
|
||||||
@@ -30,7 +30,7 @@ teardown() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:link) error when the app does not exist" {
|
@test "($PLUGIN_COMMAND_PREFIX:link) error when the app does not exist" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:link" l not_existing_app
|
run dokku "$PLUGIN_COMMAND_PREFIX:link" ls not_existing_app
|
||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
assert_contains "${lines[*]}" "App not_existing_app does not exist"
|
assert_contains "${lines[*]}" "App not_existing_app does not exist"
|
||||||
@@ -46,73 +46,97 @@ teardown() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:link) error when the service is already linked to app" {
|
@test "($PLUGIN_COMMAND_PREFIX:link) error when the service is already linked to app" {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
|
dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
|
run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
|
||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
assert_contains "${lines[*]}" "Already linked as DATABASE_URL"
|
assert_contains "${lines[*]}" "Already linked as DATABASE_URL"
|
||||||
assert_failure
|
assert_failure
|
||||||
|
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:link) exports DATABASE_URL to app" {
|
@test "($PLUGIN_COMMAND_PREFIX:link) exports DATABASE_URL to app" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
|
run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
|
||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
url=$(dokku config:get my-app DATABASE_URL)
|
url=$(dokku config:get my-app DATABASE_URL)
|
||||||
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
password="$(sudo cat "$PLUGIN_DATA_ROOT/ls/PASSWORD")"
|
||||||
assert_contains "$url" "postgres://postgres:$password@dokku-postgres-l:5432/l"
|
assert_contains "$url" "postgres://postgres:$password@dokku-postgres-ls:5432/ls"
|
||||||
assert_success
|
assert_success
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:link) generates an alternate config url when DATABASE_URL already in use" {
|
@test "($PLUGIN_COMMAND_PREFIX:link) generates an alternate config url when DATABASE_URL already in use" {
|
||||||
dokku config:set my-app DATABASE_URL=postgres://user:pass@host:5432/db
|
dokku config:set my-app DATABASE_URL=postgres://user:pass@host:5432/db
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
|
dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
|
||||||
run dokku config my-app
|
run dokku config my-app
|
||||||
assert_contains "${lines[*]}" "DOKKU_POSTGRES_AQUA_URL"
|
assert_contains "${lines[*]}" "DOKKU_POSTGRES_AQUA_URL"
|
||||||
assert_success
|
assert_success
|
||||||
|
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:link" m my-app
|
dokku "$PLUGIN_COMMAND_PREFIX:link" ms my-app
|
||||||
run dokku config my-app
|
run dokku config my-app
|
||||||
assert_contains "${lines[*]}" "DOKKU_POSTGRES_BLACK_URL"
|
assert_contains "${lines[*]}" "DOKKU_POSTGRES_BLACK_URL"
|
||||||
assert_success
|
assert_success
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" m my-app
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" ms my-app
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:link) links to app with docker-options" {
|
@test "($PLUGIN_COMMAND_PREFIX:link) links to app with docker-options" {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
|
dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
|
||||||
run dokku docker-options:report my-app
|
run dokku docker-options:report my-app
|
||||||
assert_contains "${lines[*]}" "--link dokku.postgres.l:dokku-postgres-l"
|
assert_contains "${lines[*]}" "--link dokku.postgres.ls:dokku-postgres-ls"
|
||||||
assert_success
|
assert_success
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:link) uses apps POSTGRES_DATABASE_SCHEME variable" {
|
@test "($PLUGIN_COMMAND_PREFIX:link) uses apps POSTGRES_DATABASE_SCHEME variable" {
|
||||||
dokku config:set my-app POSTGRES_DATABASE_SCHEME=postgres2
|
dokku config:set my-app POSTGRES_DATABASE_SCHEME=postgres2
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
|
dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
|
||||||
url=$(dokku config:get my-app DATABASE_URL)
|
url=$(dokku config:get my-app DATABASE_URL)
|
||||||
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
password="$(sudo cat "$PLUGIN_DATA_ROOT/ls/PASSWORD")"
|
||||||
assert_contains "$url" "postgres2://postgres:$password@dokku-postgres-l:5432/l"
|
assert_contains "$url" "postgres2://postgres:$password@dokku-postgres-ls:5432/ls"
|
||||||
assert_success
|
assert_success
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:link) adds a querystring" {
|
@test "($PLUGIN_COMMAND_PREFIX:link) adds a querystring" {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app --querystring "pool=5"
|
dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app --querystring "pool=5"
|
||||||
url=$(dokku config:get my-app DATABASE_URL)
|
url=$(dokku config:get my-app DATABASE_URL)
|
||||||
assert_contains "$url" "?pool=5"
|
assert_contains "$url" "?pool=5"
|
||||||
assert_success
|
assert_success
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:link) uses a specified config url when alias is specified" {
|
@test "($PLUGIN_COMMAND_PREFIX:link) uses a specified config url when alias is specified" {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app --alias "ALIAS"
|
dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app --alias "ALIAS"
|
||||||
url=$(dokku config:get my-app ALIAS_URL)
|
url=$(dokku config:get my-app ALIAS_URL)
|
||||||
password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
|
password="$(sudo cat "$PLUGIN_DATA_ROOT/ls/PASSWORD")"
|
||||||
assert_contains "$url" "postgres://postgres:$password@dokku-postgres-l:5432/l"
|
assert_contains "$url" "postgres://postgres:$password@dokku-postgres-ls:5432/ls"
|
||||||
|
assert_success
|
||||||
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "($PLUGIN_COMMAND_PREFIX:link) respects --no-restart" {
|
||||||
|
run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_output_contains "Skipping restart of linked app" 0
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app --no-restart
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_output_contains "Skipping restart of linked app"
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
assert_success
|
assert_success
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,11 +3,11 @@ load test_helper
|
|||||||
|
|
||||||
setup() {
|
setup() {
|
||||||
dokku apps:create my-app
|
dokku apps:create my-app
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:create" l
|
dokku "$PLUGIN_COMMAND_PREFIX:create" ls
|
||||||
}
|
}
|
||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
|
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" ls
|
||||||
dokku --force apps:destroy my-app
|
dokku --force apps:destroy my-app
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -17,12 +17,12 @@ teardown() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:unlink) error when the app argument is missing" {
|
@test "($PLUGIN_COMMAND_PREFIX:unlink) error when the app argument is missing" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" l
|
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls
|
||||||
assert_contains "${lines[*]}" "Please specify an app to run the command on"
|
assert_contains "${lines[*]}" "Please specify an app to run the command on"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:unlink) error when the app does not exist" {
|
@test "($PLUGIN_COMMAND_PREFIX:unlink) error when the app does not exist" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" l not_existing_app
|
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls not_existing_app
|
||||||
assert_contains "${lines[*]}" "App not_existing_app does not exist"
|
assert_contains "${lines[*]}" "App not_existing_app does not exist"
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -32,13 +32,13 @@ teardown() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:unlink) error when service not linked to app" {
|
@test "($PLUGIN_COMMAND_PREFIX:unlink) error when service not linked to app" {
|
||||||
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
|
||||||
assert_contains "${lines[*]}" "Not linked to app my-app"
|
assert_contains "${lines[*]}" "Not linked to app my-app"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:unlink) removes link from docker-options" {
|
@test "($PLUGIN_COMMAND_PREFIX:unlink) removes link from docker-options" {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app >&2
|
dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app >&2
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
|
||||||
|
|
||||||
check_value="Docker options build: Docker options deploy: --restart=on-failure:10 Docker options run:"
|
check_value="Docker options build: Docker options deploy: --restart=on-failure:10 Docker options run:"
|
||||||
options=$(dokku --quiet docker-options:report my-app | xargs)
|
options=$(dokku --quiet docker-options:report my-app | xargs)
|
||||||
@@ -46,8 +46,32 @@ teardown() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@test "($PLUGIN_COMMAND_PREFIX:unlink) unsets config url from app" {
|
@test "($PLUGIN_COMMAND_PREFIX:unlink) unsets config url from app" {
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app >&2
|
dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app >&2
|
||||||
dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
|
dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
|
||||||
config=$(dokku config:get my-app DATABASE_URL || true)
|
config=$(dokku config:get my-app DATABASE_URL || true)
|
||||||
assert_equal "$config" ""
|
assert_equal "$config" ""
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@test "($PLUGIN_COMMAND_PREFIX:unlink) respects --no-restart" {
|
||||||
|
run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_output_contains "Skipping restart of linked app" 0
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app --no-restart
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_output_contains "Skipping restart of linked app"
|
||||||
|
assert_success
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,4 +1,5 @@
|
|||||||
# SC1090 - Can't follow non-constant source. Use a directive to specify location - https://github.com/koalaman/shellcheck/wiki/SC1090
|
# SC1090 - Can't follow non-constant source. Use a directive to specify location - https://github.com/koalaman/shellcheck/wiki/SC1090
|
||||||
|
# SC1091 - Not following - <https://github.com/koalaman/shellcheck/wiki/SC1091>
|
||||||
# SC2034 - Variable appears unused. Verify it or export it - https://github.com/koalaman/shellcheck/wiki/SC2034
|
# SC2034 - Variable appears unused. Verify it or export it - https://github.com/koalaman/shellcheck/wiki/SC2034
|
||||||
# SC2155 - Declare and assign separately to avoid masking return values - https://github.com/koalaman/shellcheck/wiki/SC2155
|
# SC2155 - Declare and assign separately to avoid masking return values - https://github.com/koalaman/shellcheck/wiki/SC2155
|
||||||
# SC2206 - Quote to prevent word splitting/globbing, or split robustly with mapfile or read -a - https://github.com/koalaman/shellcheck/wiki/SC2206
|
# SC2206 - Quote to prevent word splitting/globbing, or split robustly with mapfile or read -a - https://github.com/koalaman/shellcheck/wiki/SC2206
|
||||||
|
|||||||
Reference in New Issue
Block a user