Compare commits

...

19 Commits

Author SHA1 Message Date
Jose Diaz-Gonzalez
dae1a32275 Release 1.20.3 2022-07-06 01:49:06 -04:00
Jose Diaz-Gonzalez
9e5bf61dc0 fix: ensure the new service does not exist when cloning an existing service 2022-07-06 01:47:31 -04:00
Jose Diaz-Gonzalez
e8416285d2 Release 1.20.2 2022-07-06 01:38:21 -04:00
Jose Diaz-Gonzalez
7e1301d6d4 fix: ensure we check if the service exists before entering it 2022-07-06 01:36:40 -04:00
Jose Diaz-Gonzalez
dacc0c2236 Release 1.20.1 2022-07-05 22:15:43 -04:00
Jose Diaz-Gonzalez
7992ce90e2 Merge pull request #179 from dokku/dependabot/docker/redis-7.0.2
chore(deps): bump redis from 7.0.0 to 7.0.2
2022-07-05 22:14:25 -04:00
dependabot[bot]
5ff5d82ef8 chore(deps): bump redis from 7.0.0 to 7.0.2
Bumps redis from 7.0.0 to 7.0.2.

---
updated-dependencies:
- dependency-name: redis
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-06-14 15:09:28 +00:00
Jose Diaz-Gonzalez
28af22d5ee Release 1.20.0 2022-05-29 16:17:24 -04:00
Jose Diaz-Gonzalez
0bcf1a2e32 Merge pull request #177 from dokku/dependabot/docker/redis-7.0.0
chore(deps): bump redis from 6.2.6 to 7.0.0
2022-05-29 16:17:01 -04:00
dependabot[bot]
4b4f28a7db chore(deps): bump redis from 6.2.6 to 7.0.0
Bumps redis from 6.2.6 to 7.0.0.

---
updated-dependencies:
- dependency-name: redis
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-04-28 15:12:49 +00:00
Jose Diaz-Gonzalez
b9071721c0 Release 1.19.2 2022-02-03 10:31:17 -05:00
Jose Diaz-Gonzalez
93415ced00 fix: always chown the image files 2022-02-03 10:30:27 -05:00
Jose Diaz-Gonzalez
ac4fee6acb docs: clarify unit for container memory limit 2022-01-22 04:31:53 -05:00
Jose Diaz-Gonzalez
43348c4297 Release 1.19.1 2022-01-22 04:24:39 -05:00
Jose Diaz-Gonzalez
60d46920d4 fix: ensure service config files are owned by the dokku system user
Refs dokku/dokku-postgres#245
2022-01-22 04:23:53 -05:00
Jose Diaz-Gonzalez
3dce1632fd Release 1.19.0 2021-12-25 16:50:21 -05:00
Jose Diaz-Gonzalez
8c89467123 feat: add ability to skip restarts when linking datastores
This allows multiple datastores to be linked at a given time, thus decreasing provisioning times.
2021-12-25 16:44:16 -05:00
Jose Diaz-Gonzalez
134442bd73 Release 1.18.0 2021-10-26 22:28:10 -04:00
Jose Diaz-Gonzalez
88e6d790e1 feat: allow tailing a specific number of log lines 2021-10-26 22:27:15 -04:00
10 changed files with 54 additions and 20 deletions

View File

@@ -1 +1 @@
FROM redis:6.2.6
FROM redis:7.0.2

View File

@@ -1,6 +1,6 @@
# dokku redis [![Build Status](https://img.shields.io/github/workflow/status/dokku/dokku-redis/CI/master?style=flat-square "Build Status")](https://github.com/dokku/dokku-redis/actions/workflows/ci.yml?query=branch%3Amaster) [![IRC Network](https://img.shields.io/badge/irc-libera-blue.svg?style=flat-square "IRC Libera")](https://webchat.libera.chat/?channels=dokku)
Official redis plugin for dokku. Currently defaults to installing [redis 6.2.6](https://hub.docker.com/_/redis/).
Official redis plugin for dokku. Currently defaults to installing [redis 7.0.2](https://hub.docker.com/_/redis/).
## Requirements
@@ -40,7 +40,7 @@ redis:link <service> <app> [--link-flags...] # link the redis service to t
redis:linked <service> <app> # check if the redis service is linked to an app
redis:links <service> # list all apps linked to the redis service
redis:list # list all redis services
redis:logs <service> [-t|--tail] # print the most recent log(s) for this service
redis:logs <service> [-t|--tail] <tail-num-optional> # print the most recent log(s) for this service
redis:promote <service> <app> # promote service <service> as REDIS_URL in <app>
redis:restart <service> # graceful shutdown and restart of the redis service container
redis:start <service> # start a previously stopped redis service
@@ -69,7 +69,7 @@ flags:
- `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with
- `-i|--image IMAGE`: the image name to start the service with
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
- `-m|--memory MEMORY`: container memory limit (default: unlimited)
- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
- `-p|--password PASSWORD`: override the user-level service password
- `-r|--root-password PASSWORD`: override the root-level service password
- `-s|--shm-size SHM_SIZE`: override shared memory size for redis docker container
@@ -153,12 +153,12 @@ dokku redis:list
```shell
# usage
dokku redis:logs <service> [-t|--tail]
dokku redis:logs <service> [-t|--tail] <tail-num-optional>
```
flags:
- `-t|--tail`: do not stop when end of the logs are reached and wait for additional output
- `-t|--tail [<tail-num>]`: do not stop when end of the logs are reached and wait for additional output
You can tail logs for a particular service:
@@ -172,6 +172,12 @@ By default, logs will not be tailed, but you can do this with the --tail flag:
dokku redis:logs lollipop --tail
```
The default tail setting is to show all logs, but an initial count can also be specified:
```shell
dokku redis:logs lollipop --tail 5
```
### link the redis service to the app
```shell
@@ -435,7 +441,7 @@ flags:
- `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with
- `-i|--image IMAGE`: the image name to start the service with
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
- `-m|--memory MEMORY`: container memory limit (default: unlimited)
- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
- `-p|--password PASSWORD`: override the user-level service password
- `-r|--root-password PASSWORD`: override the root-level service password
- `-s|--shm-size SHM_SIZE`: override shared memory size for redis docker container

View File

@@ -411,6 +411,14 @@ service_enter() {
docker exec $DOKKU_RUN_OPTS $ID $EXEC_CMD "${@:-/bin/bash}"
}
service_exists() {
declare desc="returns 0 or 1 depending on whether service exists or not"
declare SERVICE="$1"
[[ -z "$SERVICE" ]] && return 1
[[ -d "$PLUGIN_DATA_ROOT/$SERVICE" ]] && return 0
return 1
}
service_exposed_ports() {
declare desc="list exposed ports for a service"
declare SERVICE="$1"
@@ -533,7 +541,11 @@ service_link() {
fi
[[ -n "$SERVICE_QUERYSTRING" ]] && SERVICE_URL="${SERVICE_URL}?${SERVICE_QUERYSTRING}"
plugn trigger service-action post-link "$SERVICE" "$APP"
config_set "$APP" "${ALIAS}_URL=$SERVICE_URL"
if [[ "$DOKKU_GLOBAL_FLAGS" == *"--no-restart"* ]]; then
config_set --no-restart "$APP" "${ALIAS}_URL=$SERVICE_URL"
else
config_set "$APP" "${ALIAS}_URL=$SERVICE_URL"
fi
plugn trigger service-action post-link-complete "$SERVICE" "$APP"
}
@@ -578,14 +590,14 @@ service_list() {
service_logs() {
declare desc="display logs for a service"
declare SERVICE="$1" TAIL_FLAG="$2"
declare SERVICE="$1" TAIL_FLAG="$2" TAIL_COUNT="$3"
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local ID=$(cat "$SERVICE_ROOT/ID")
local RE_INTEGER='^[0-9]+$'
DOKKU_LOGS_ARGS="--tail 100"
DOKKU_LOGS_ARGS="--tail $TAIL_COUNT"
if [[ "$TAIL_FLAG" == "-t" ]] || [[ "$TAIL_FLAG" == "--tail" ]]; then
DOKKU_LOGS_ARGS="--follow"
DOKKU_LOGS_ARGS+=" --follow"
fi
docker inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist"
@@ -857,7 +869,11 @@ service_unlink() {
[[ -z ${LINK[*]} ]] && dokku_log_fail "Not linked to app $APP"
plugn trigger service-action post-unlink "$SERVICE" "$APP"
config_unset "$APP" "${LINK[@]}"
if [[ "$DOKKU_GLOBAL_FLAGS" == *"--no-restart"* ]]; then
config_unset --no-restart "$APP" "${LINK[@]}"
else
config_unset "$APP" "${LINK[@]}"
fi
plugn trigger service-action post-unlink-complete "$SERVICE" "$APP"
}

View File

@@ -202,6 +202,9 @@ fn-help-subcommand-args() {
elif [[ "$arg" == *_LIST ]]; then
arg=${arg%_*}
args+=" <${arg//_/-}...>"
elif [[ "$arg" == *_OPTIONAL ]]; then
argName="${arg/_OPTIONAL/}"
args+=" [<${argName//_/-}>]"
else
args+=" <${arg//_/-}>"
fi

View File

@@ -24,10 +24,10 @@ plugin-install() {
pull-docker-image "$PLUGIN_WAIT_IMAGE"
mkdir -p "$PLUGIN_DATA_ROOT" || echo "Failed to create $PLUGIN_SERVICE data directory"
chown dokku:dokku "$PLUGIN_DATA_ROOT"
chown "${DOKKU_SYSTEM_USER}:${DOKKU_SYSTEM_GROUP}" "$PLUGIN_DATA_ROOT"
mkdir -p "$PLUGIN_CONFIG_ROOT" || echo "Failed to create $PLUGIN_SERVICE config directory"
chown dokku:dokku "$PLUGIN_CONFIG_ROOT"
chown "${DOKKU_SYSTEM_USER}:${DOKKU_SYSTEM_GROUP}" "$PLUGIN_CONFIG_ROOT"
rm -f "/etc/sudoers.d/dokku-${PLUGIN_COMMAND_PREFIX}*"
_SUDOERS_FILE="/etc/sudoers.d/dokku-${PLUGIN_COMMAND_PREFIX}"
@@ -56,8 +56,11 @@ EOL
fi
fi
chown "${DOKKU_SYSTEM_USER}:${DOKKU_SYSTEM_GROUP}" "$SERVICE_ROOT/IMAGE" "$SERVICE_ROOT/IMAGE_VERSION"
if [[ -f "$SERVICE_ROOT/${PLUGIN_VARIABLE}_CONFIG_OPTIONS" ]]; then
mv "$SERVICE_ROOT/${PLUGIN_VARIABLE}_CONFIG_OPTIONS" "$SERVICE_ROOT/CONFIG_OPTIONS"
chown "${DOKKU_SYSTEM_USER}:${DOKKU_SYSTEM_GROUP}" "$SERVICE_ROOT/CONFIG_OPTIONS"
fi
done
}

View File

@@ -1,4 +1,4 @@
[plugin]
description = "dokku redis service plugin"
version = "1.17.1"
version = "1.20.3"
[plugin.config]

View File

@@ -14,7 +14,7 @@ service-clone-cmd() {
#F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
#F -i|--image IMAGE, the image name to start the service with
#F -I|--image-version IMAGE_VERSION, the image version to start the service with
#F -m|--memory MEMORY, container memory limit (default: unlimited)
#F -m|--memory MEMORY, container memory limit in megabytes (default: unlimited)
#F -p|--password PASSWORD, override the user-level service password
#F -r|--root-password PASSWORD, override the root-level service password
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
@@ -27,6 +27,9 @@ service-clone-cmd() {
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
[[ -z "$NEW_SERVICE" ]] && dokku_log_fail "Please specify a name for the new service"
verify_service_name "$SERVICE"
if service_exists "$NEW_SERVICE"; then
dokku_log_fail "Invalid service name $NEW_SERVICE. Verify the service name is not already in use."
fi
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
local ID="$(cat "$SERVICE_ROOT/ID")"

View File

@@ -22,7 +22,7 @@ service-create-cmd() {
#F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
#F -i|--image IMAGE, the image name to start the service with
#F -I|--image-version IMAGE_VERSION, the image version to start the service with
#F -m|--memory MEMORY, container memory limit (default: unlimited)
#F -m|--memory MEMORY, container memory limit in megabytes (default: unlimited)
#F -p|--password PASSWORD, override the user-level service password
#F -r|--root-password PASSWORD, override the root-level service password
#F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container

View File

@@ -20,6 +20,7 @@ service-enter-cmd() {
declare SERVICE="$1"
dokku_log_info1_quiet "Filesystem changes may not persist after container restarts"
verify_service_name "$SERVICE"
service_enter "$SERVICE" "${@:2}"
}

View File

@@ -10,16 +10,18 @@ service-logs-cmd() {
#E dokku $PLUGIN_COMMAND_PREFIX:logs lollipop
#E by default, logs will not be tailed, but you can do this with the --tail flag:
#E dokku $PLUGIN_COMMAND_PREFIX:logs lollipop --tail
#E the default tail setting is to show all logs, but an initial count can also be specified
#E dokku $PLUGIN_COMMAND_PREFIX:logs lollipop --tail 5
#A service, service to run command against
#F -t|--tail, do not stop when end of the logs are reached and wait for additional output
#F -t|--tail [<tail-num>], do not stop when end of the logs are reached and wait for additional output
declare desc="print the most recent log(s) for this service"
local cmd="$PLUGIN_COMMAND_PREFIX:logs" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" TAIL_FLAG="$2"
declare SERVICE="$1" TAIL_FLAG="$2" TAIL_NUM_OPTIONAL="${3:-all}"
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
verify_service_name "$SERVICE"
service_logs "$SERVICE" "$TAIL_FLAG"
service_logs "$SERVICE" "$TAIL_FLAG" "$TAIL_NUM_OPTIONAL"
}
service-logs-cmd "$@"