Compare commits
60 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
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 |
16
.github/workflows/ci.yml
vendored
16
.github/workflows/ci.yml
vendored
@@ -17,16 +17,16 @@ concurrency:
|
||||
jobs:
|
||||
unit-tests-master:
|
||||
name: unit-tests
|
||||
runs-on: ubuntu-20.04
|
||||
runs-on: ubuntu-22.04
|
||||
env:
|
||||
DOKKU_VERSION: master
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- uses: actions/setup-python@v4
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.7.x'
|
||||
|
||||
@@ -51,7 +51,7 @@ jobs:
|
||||
|
||||
- run: make test
|
||||
|
||||
- uses: actions/upload-artifact@v3
|
||||
- uses: actions/upload-artifact@v4
|
||||
if: failure()
|
||||
with:
|
||||
name: tmp/test-results
|
||||
@@ -59,16 +59,16 @@ jobs:
|
||||
|
||||
unit-tests-0_19_0:
|
||||
name: unit-tests-0.19.0
|
||||
runs-on: ubuntu-20.04
|
||||
runs-on: ubuntu-22.04
|
||||
env:
|
||||
DOKKU_TAG: v0.19.0
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- uses: actions/setup-python@v4
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.7.x'
|
||||
|
||||
@@ -93,7 +93,7 @@ jobs:
|
||||
|
||||
- run: make test
|
||||
|
||||
- uses: actions/upload-artifact@v3
|
||||
- uses: actions/upload-artifact@v4
|
||||
if: failure()
|
||||
with:
|
||||
name: tmp/test-results
|
||||
|
||||
2
.github/workflows/tagged-release.yml
vendored
2
.github/workflows/tagged-release.yml
vendored
@@ -10,7 +10,7 @@ on:
|
||||
jobs:
|
||||
tagged-release:
|
||||
name: tagged-release
|
||||
runs-on: ubuntu-20.04
|
||||
runs-on: ubuntu-22.04
|
||||
|
||||
steps:
|
||||
- uses: "marvinpinto/action-automatic-releases@v1.2.1"
|
||||
|
||||
@@ -1 +1 @@
|
||||
FROM postgres:15.4
|
||||
FROM postgres:17.3
|
||||
|
||||
7
Makefile
7
Makefile
@@ -1,5 +1,6 @@
|
||||
HARDWARE = $(shell uname -m)
|
||||
SYSTEM_NAME = $(shell uname -s | tr '[:upper:]' '[:lower:]')
|
||||
ARCH = $(shell dpkg --print-architecture)
|
||||
SHFMT_VERSION = 3.0.2
|
||||
XUNIT_TO_GITHUB_VERSION = 0.3.0
|
||||
XUNIT_READER_VERSION = 0.1.0
|
||||
@@ -21,7 +22,11 @@ ifneq ($(shell shellcheck --version >/dev/null 2>&1 ; echo $$?),0)
|
||||
ifeq ($(SYSTEM_NAME),darwin)
|
||||
brew install shellcheck
|
||||
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 apt-get update -qq && sudo apt-get install -qq -y shellcheck
|
||||
endif
|
||||
|
||||
52
README.md
52
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)
|
||||
|
||||
Official postgres plugin for dokku. Currently defaults to installing [postgres 15.4](https://hub.docker.com/_/postgres/).
|
||||
Official postgres plugin for dokku. Currently defaults to installing [postgres 17.3](https://hub.docker.com/_/postgres/).
|
||||
|
||||
## Requirements
|
||||
|
||||
@@ -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-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-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-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:connect <service> # connect to the service via the postgres connection tool
|
||||
postgres:create <service> [--create-flags...] # create a postgres service
|
||||
@@ -74,9 +76,9 @@ flags:
|
||||
- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
|
||||
- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
|
||||
- `-p|--password PASSWORD`: override the user-level service password
|
||||
- `-P|--post-create-network NETWORKS`: a 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
|
||||
- `-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
|
||||
|
||||
Create a postgres service named lollipop:
|
||||
@@ -93,7 +95,7 @@ export POSTGRES_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
|
||||
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
|
||||
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.
|
||||
|
||||
```shell
|
||||
# use the appropriate image-version for your use-case
|
||||
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
|
||||
|
||||
```shell
|
||||
@@ -463,9 +473,9 @@ flags:
|
||||
- `-i|--image IMAGE`: the image name to start the service with
|
||||
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
|
||||
- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
|
||||
- `-P|--post-create-network NETWORKS`: a 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 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
|
||||
|
||||
You can upgrade an existing service to a new image or image-version:
|
||||
@@ -538,9 +548,9 @@ flags:
|
||||
- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
|
||||
- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
|
||||
- `-p|--password PASSWORD`: override the user-level service password
|
||||
- `-P|--post-create-network NETWORKS`: a 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
|
||||
- `-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
|
||||
|
||||
You can clone an existing service to a new one:
|
||||
@@ -718,6 +728,19 @@ Set the GPG-compatible passphrase for encrypting backups for backups:
|
||||
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
|
||||
|
||||
```shell
|
||||
@@ -731,6 +754,19 @@ Unset the `GPG` encryption passphrase for backups:
|
||||
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
|
||||
|
||||
```shell
|
||||
|
||||
2
Vagrantfile
vendored
2
Vagrantfile
vendored
@@ -1,7 +1,7 @@
|
||||
# -*- mode: ruby -*-
|
||||
# vi: set ft=ruby :
|
||||
|
||||
BOX_NAME = ENV["BOX_NAME"] || "bento/ubuntu-20.04"
|
||||
BOX_NAME = ENV["BOX_NAME"] || "bento/ubuntu-22.04"
|
||||
BOX_MEMORY = ENV["BOX_MEMORY"] || "2048"
|
||||
DOKKU_VERSION = "master"
|
||||
|
||||
|
||||
224
bin/generate
224
bin/generate
@@ -1,15 +1,30 @@
|
||||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
from __future__ import print_function
|
||||
|
||||
import os
|
||||
import re
|
||||
|
||||
|
||||
def compile(service, version, variable, alias, image, scheme, ports, sponsors, options, unimplemented, dokku_version):
|
||||
prefix = "\n\n".join([
|
||||
header(service),
|
||||
description(service, image, version),
|
||||
])
|
||||
def compile(
|
||||
service,
|
||||
version,
|
||||
variable,
|
||||
alias,
|
||||
image,
|
||||
scheme,
|
||||
ports,
|
||||
sponsors,
|
||||
options,
|
||||
unimplemented,
|
||||
dokku_version,
|
||||
):
|
||||
prefix = "\n\n".join(
|
||||
[
|
||||
header(service),
|
||||
description(service, image, version),
|
||||
]
|
||||
)
|
||||
|
||||
if len(sponsors) > 0:
|
||||
prefix += "\n\n"
|
||||
@@ -21,8 +36,19 @@ def compile(service, version, variable, alias, image, scheme, ports, sponsors, o
|
||||
prefix,
|
||||
requirements_section(dokku_version),
|
||||
installation_section(service, dokku_version),
|
||||
commands_section(service, variable, alias, image, scheme, ports, unimplemented),
|
||||
usage_section(service, variable, alias, image, scheme, ports, options, unimplemented),
|
||||
commands_section(
|
||||
service, variable, alias, image, scheme, ports, unimplemented
|
||||
),
|
||||
usage_section(
|
||||
service,
|
||||
variable,
|
||||
alias,
|
||||
image,
|
||||
scheme,
|
||||
ports,
|
||||
options,
|
||||
unimplemented,
|
||||
),
|
||||
]
|
||||
)
|
||||
.replace("\n\n\n\n\n", "\n")
|
||||
@@ -55,17 +81,25 @@ def sponsors_section(service, sponsors):
|
||||
if len(sponsors) == 0:
|
||||
return ""
|
||||
|
||||
sponsor_data = ["## Sponsors", "", f"The {service} plugin was generously sponsored by the following:", ""]
|
||||
sponsor_data = [
|
||||
"## Sponsors",
|
||||
"",
|
||||
f"The {service} plugin was generously sponsored by the following:",
|
||||
"",
|
||||
]
|
||||
sponsor_data.extend([f"- [{s}](https://github.com/{s})" for s in sponsors])
|
||||
|
||||
return "\n".join(
|
||||
sponsor_data
|
||||
)
|
||||
return "\n".join(sponsor_data)
|
||||
|
||||
|
||||
def requirements_section(dokku_version):
|
||||
return "\n".join(
|
||||
["## Requirements", "", f"- dokku {dokku_version}", "- docker 1.8.x",]
|
||||
[
|
||||
"## Requirements",
|
||||
"",
|
||||
f"- dokku {dokku_version}",
|
||||
"- docker 1.8.x",
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
@@ -115,17 +149,31 @@ def commands_section(service, variable, alias, image, scheme, ports, unimplement
|
||||
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(
|
||||
[
|
||||
"## Usage",
|
||||
f"Help for any commands can be displayed by specifying the command as an argument to {service}:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `{service}:help` command for any undocumented commands.",
|
||||
usage_intro(service, variable, alias, image, scheme, ports, options, unimplemented),
|
||||
usage_lifecycle(service, variable, alias, image, scheme, ports, options, unimplemented),
|
||||
usage_automation(service, variable, alias, image, scheme, ports, options, unimplemented),
|
||||
usage_data_management(service, variable, alias, image, scheme, ports, options, unimplemented),
|
||||
usage_backup(service, variable, alias, image, scheme, ports, options, unimplemented),
|
||||
usage_docker_pull(service, variable, alias, image, scheme, ports, options, unimplemented),
|
||||
usage_intro(
|
||||
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||
),
|
||||
usage_lifecycle(
|
||||
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||
),
|
||||
usage_automation(
|
||||
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||
),
|
||||
usage_data_management(
|
||||
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||
),
|
||||
usage_backup(
|
||||
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||
),
|
||||
usage_docker_pull(
|
||||
service, variable, alias, image, scheme, ports, options, unimplemented
|
||||
),
|
||||
]
|
||||
)
|
||||
|
||||
@@ -135,11 +183,22 @@ def usage_intro(service, variable, alias, image, scheme, ports, options, unimple
|
||||
content = ["### Basic Usage"]
|
||||
|
||||
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 = [
|
||||
"connect",
|
||||
"enter",
|
||||
@@ -160,11 +219,22 @@ def usage_lifecycle(service, variable, alias, image, scheme, ports, options, uni
|
||||
]
|
||||
|
||||
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"]
|
||||
content = [
|
||||
"### Service Automation",
|
||||
@@ -174,11 +244,22 @@ def usage_automation(service, variable, alias, image, scheme, ports, options, un
|
||||
]
|
||||
|
||||
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"]
|
||||
content = [
|
||||
"### Data Management",
|
||||
@@ -188,17 +269,30 @@ def usage_data_management(service, variable, alias, image, scheme, ports, option
|
||||
]
|
||||
|
||||
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 = [
|
||||
"backup-auth",
|
||||
"backup-deauth",
|
||||
"backup",
|
||||
"backup-set-encryption",
|
||||
"backup-set-public-key-encryption",
|
||||
"backup-unset-encryption",
|
||||
"backup-unset-public-key-encryption",
|
||||
"backup-schedule",
|
||||
"backup-schedule-cat",
|
||||
"backup-unschedule",
|
||||
@@ -215,11 +309,22 @@ def usage_backup(service, variable, alias, image, scheme, ports, options, unimpl
|
||||
]
|
||||
|
||||
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()
|
||||
return "\n".join(
|
||||
[
|
||||
@@ -233,11 +338,30 @@ def usage_docker_pull(service, variable, alias, image, scheme, ports, options, u
|
||||
|
||||
|
||||
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
|
||||
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 == "":
|
||||
continue
|
||||
content.append(output)
|
||||
@@ -275,7 +399,9 @@ def parse_args(line):
|
||||
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:
|
||||
return ""
|
||||
|
||||
@@ -285,7 +411,7 @@ def command_help(command, service, variable, alias, image, scheme, ports, option
|
||||
"",
|
||||
"```shell",
|
||||
"# 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 = []
|
||||
for word in sentence.strip().split(" "):
|
||||
if word.isupper() and len(word) > 1:
|
||||
for ending in [':', '.']:
|
||||
for ending in [":", "."]:
|
||||
if word.endswith(ending):
|
||||
word = '`{0}`{1}'.format(word[:-1], ending)
|
||||
word = "`{0}`{1}".format(word[:-1], ending)
|
||||
else:
|
||||
word = '`{0}`'.format(word)
|
||||
word = "`{0}`".format(word)
|
||||
parts.append(word)
|
||||
text.append(" ".join(parts))
|
||||
|
||||
@@ -491,10 +617,10 @@ def main():
|
||||
|
||||
with open("Dockerfile") as f:
|
||||
for line in f.readlines():
|
||||
if "FROM " in line:
|
||||
image, version = line.split(" ")[1].split(":")
|
||||
image = image.strip()
|
||||
version = version.strip()
|
||||
if "FROM " in line:
|
||||
image, version = line.split(" ")[1].split(":")
|
||||
image = image.strip()
|
||||
version = version.strip()
|
||||
|
||||
with open("config") as f:
|
||||
for line in f.readlines():
|
||||
@@ -524,10 +650,22 @@ def main():
|
||||
with open("plugin.toml") as f:
|
||||
for line in f.readlines():
|
||||
if line.startswith("sponsors"):
|
||||
sponsors = re.search("\[([\"\w\s,_-]+)\]", line).group(1)
|
||||
sponsors = [s.strip("\"") for s in sponsors.split(",")]
|
||||
sponsors = re.search('\[(["\w\s,_-]+)\]', line).group(1)
|
||||
sponsors = [s.strip('"') for s in sponsors.split(",")]
|
||||
|
||||
text = compile(service, version, variable, alias, image, scheme, ports, sponsors, options, unimplemented, "0.19.x+")
|
||||
text = compile(
|
||||
service,
|
||||
version,
|
||||
variable,
|
||||
alias,
|
||||
image,
|
||||
scheme,
|
||||
ports,
|
||||
sponsors,
|
||||
options,
|
||||
unimplemented,
|
||||
"0.19.x+",
|
||||
)
|
||||
|
||||
base_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
|
||||
readme_file = os.path.join(base_path, "README.md")
|
||||
|
||||
@@ -308,6 +308,10 @@ service_backup() {
|
||||
BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e ENCRYPTION_KEY=$(cat "$BACKUP_ENCRYPTION_CONFIG_ROOT/ENCRYPTION_KEY")"
|
||||
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
|
||||
"$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"
|
||||
}
|
||||
|
||||
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() {
|
||||
declare desc="unschedule the backup of the service"
|
||||
declare SERVICE="$1"
|
||||
@@ -450,6 +464,15 @@ service_backup_unset_encryption() {
|
||||
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() {
|
||||
declare desc="stop a service and remove the running container"
|
||||
declare SERVICE="$1"
|
||||
|
||||
8
config
8
config
@@ -28,9 +28,9 @@ if [[ -n $DOKKU_API_VERSION ]]; then
|
||||
export PLUGIN_BASE_PATH="$PLUGIN_ENABLED_PATH"
|
||||
fi
|
||||
|
||||
export PLUGIN_BUSYBOX_IMAGE="busybox:1.34.1-uclibc"
|
||||
export PLUGIN_AMBASSADOR_IMAGE="dokku/ambassador:0.5.0"
|
||||
export PLUGIN_S3BACKUP_IMAGE="dokku/s3backup:0.14.0"
|
||||
export PLUGIN_WAIT_IMAGE="dokku/wait:0.6.0"
|
||||
export PLUGIN_BUSYBOX_IMAGE=${PLUGIN_BUSYBOX_IMAGE:=busybox:1.37.0-uclibc}
|
||||
export PLUGIN_AMBASSADOR_IMAGE=${PLUGIN_AMBASSADOR_IMAGE:=dokku/ambassador:0.8.2}
|
||||
export PLUGIN_S3BACKUP_IMAGE=${PLUGIN_S3BACKUP_IMAGE:=dokku/s3backup:0.18.0}
|
||||
export PLUGIN_WAIT_IMAGE=${PLUGIN_WAIT_IMAGE:=dokku/wait:0.9.3}
|
||||
|
||||
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.
|
||||
|
||||
```shell
|
||||
# use the appropriate image-version for your use-case
|
||||
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"
|
||||
```
|
||||
|
||||
@@ -18,7 +18,7 @@ service_connect() {
|
||||
local SERVICE_TTY_OPTS
|
||||
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() {
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[plugin]
|
||||
description = "dokku postgres service plugin"
|
||||
version = "1.34.2"
|
||||
version = "1.42.0"
|
||||
[plugin.config]
|
||||
|
||||
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 -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|--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 -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
|
||||
declare desc="create container <new-name> then copy data from <name> into <new-name>"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:clone" argv=("$@")
|
||||
|
||||
@@ -14,7 +14,7 @@ service-create-cmd() {
|
||||
#E export ${PLUGIN_VARIABLE}_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
|
||||
#E you can also specify custom environment variables to start
|
||||
#E the ${PLUGIN_COMMAND_PREFIX} service in semi-colon separated form.
|
||||
#E the ${PLUGIN_COMMAND_PREFIX} service in semicolon-separated form.
|
||||
#E export ${PLUGIN_VARIABLE}_CUSTOM_ENV="USER=alpha;HOST=beta"
|
||||
#E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
|
||||
#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 -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|--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 -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
|
||||
declare desc="create a $PLUGIN_SERVICE service"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:create" argv=("$@")
|
||||
|
||||
@@ -15,9 +15,9 @@ service-upgrade-cmd() {
|
||||
#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 -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 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
|
||||
declare desc="upgrade service <service> to the specified versions"
|
||||
local cmd="$PLUGIN_COMMAND_PREFIX:upgrade" argv=("$@")
|
||||
|
||||
@@ -48,7 +48,7 @@ teardown() {
|
||||
assert_output_contains bridge 0
|
||||
assert_output_contains custom-network
|
||||
|
||||
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.Aliases}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
|
||||
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 "status: $status"
|
||||
assert_success
|
||||
@@ -120,7 +120,7 @@ teardown() {
|
||||
assert_output_contains custom-network
|
||||
assert_output_contains bridge
|
||||
|
||||
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.Aliases}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
|
||||
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 "status: $status"
|
||||
assert_success
|
||||
@@ -192,7 +192,7 @@ teardown() {
|
||||
assert_output_contains bridge
|
||||
assert_output_contains custom-network
|
||||
|
||||
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.Aliases}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
|
||||
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 "status: $status"
|
||||
assert_success
|
||||
@@ -258,7 +258,7 @@ teardown() {
|
||||
assert_output_contains bridge
|
||||
assert_output_contains custom-network
|
||||
|
||||
run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.lsa -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.Aliases}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
|
||||
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 "status: $status"
|
||||
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
|
||||
# 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
|
||||
# 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
|
||||
|
||||
Reference in New Issue
Block a user