Compare commits

...

7 Commits

Author SHA1 Message Date
Jose Diaz-Gonzalez
32a4978593 Release 1.26.1 2022-12-26 19:14:15 -05:00
josegonzalez
e3c62b8e52 Merge pull request #187 from dokku/dependabot/docker/redis-7.0.7
chore(deps): bump redis from 7.0.5 to 7.0.7
2022-12-26 19:14:08 -05:00
Jose Diaz-Gonzalez
a0ea546461 Release 1.26.0 2022-12-26 19:02:32 -05:00
josegonzalez
ba2e12f95e Merge pull request #188 from dokku/pause-stop-rm
Add :pause subcommand and make :stop subcommand actually remove the container
2022-12-26 18:44:49 -05:00
Jose Diaz-Gonzalez
9ef9985d4a feat: add :pause subcommand and make :stop subcommand actually remove the container 2022-12-26 17:39:50 -05:00
Jose Diaz-Gonzalez
478fd1276a docs: update readme 2022-12-26 17:27:30 -05:00
dependabot[bot]
865322510f chore(deps): bump redis from 7.0.5 to 7.0.7
Bumps redis from 7.0.5 to 7.0.7.

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

Signed-off-by: dependabot[bot] <support@github.com>
2022-12-19 15:03:37 +00:00
9 changed files with 75 additions and 13 deletions

View File

@@ -1 +1 @@
FROM redis:7.0.5 FROM redis:7.0.7

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) # 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 7.0.2](https://hub.docker.com/_/redis/). Official redis plugin for dokku. Currently defaults to installing [redis 7.0.5](https://hub.docker.com/_/redis/).
## Requirements ## Requirements
@@ -41,6 +41,7 @@ redis:linked <service> <app> # check if the redis service
redis:links <service> # list all apps linked to the redis service redis:links <service> # list all apps linked to the redis service
redis:list # list all redis services redis:list # list all redis services
redis:logs <service> [-t|--tail] <tail-num-optional> # 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:pause <service> # pause a running redis service
redis:promote <service> <app> # promote service <service> as REDIS_URL in <app> 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:restart <service> # graceful shutdown and restart of the redis service container
redis:start <service> # start a previously stopped redis service redis:start <service> # start a previously stopped redis service
@@ -370,12 +371,25 @@ dokku redis:start lollipop
dokku redis:stop <service> dokku redis:stop <service>
``` ```
Stop the service and the running container: Stop the service and removes the running container:
```shell ```shell
dokku redis:stop lollipop dokku redis:stop lollipop
``` ```
### pause a running redis service
```shell
# usage
dokku redis:pause <service>
```
Pause the running container for the service:
```shell
dokku redis:pause lollipop
```
### graceful shutdown and restart of the redis service container ### graceful shutdown and restart of the redis service container
```shell ```shell

View File

@@ -148,6 +148,7 @@ def usage_lifecycle(service, variable, alias, image, scheme, ports, options, uni
"promote", "promote",
"start", "start",
"stop", "stop",
"pause",
"restart", "restart",
"upgrade", "upgrade",
] ]

View File

@@ -443,7 +443,7 @@ service_container_rm() {
local SERVICE_NAME="$(get_service_name "$SERVICE")" local SERVICE_NAME="$(get_service_name "$SERVICE")"
local ID local ID
service_stop "$SERVICE" service_pause "$SERVICE"
ID=$(docker ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true ID=$(docker ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || 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
@@ -896,19 +896,19 @@ service_status() {
echo "missing" && return 0 echo "missing" && return 0
} }
service_stop() { service_pause() {
declare desc="stop a running service" declare desc="pause a running service"
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 ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true local ID=$(docker ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
[[ -z $ID ]] && dokku_log_warn "Service is already stopped" && 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 "Stopping container" dokku_log_info2_quiet "Pausing container"
docker stop "$SERVICE_NAME" >/dev/null docker stop "$SERVICE_NAME" >/dev/null
service_port_pause "$SERVICE" service_port_pause "$SERVICE"
dokku_log_verbose_quiet "Container stopped" 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"
fi fi

View File

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

22
subcommands/pause Executable file
View File

@@ -0,0 +1,22 @@
#!/usr/bin/env bash
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_BASE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-pause-cmd() {
#E pause the running container for the service
#E dokku $PLUGIN_COMMAND_PREFIX:pause lollipop
#A service, service to run command against
declare desc="pause a running $PLUGIN_SERVICE service"
local cmd="$PLUGIN_COMMAND_PREFIX:pause" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1"
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
verify_service_name "$SERVICE"
service_pause "$SERVICE"
}
service-pause-cmd "$@"

View File

@@ -16,7 +16,7 @@ service-restart-cmd() {
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service" [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
verify_service_name "$SERVICE" verify_service_name "$SERVICE"
service_stop "$SERVICE" service_pause "$SERVICE"
service_start "$SERVICE" service_start "$SERVICE"
dokku_log_info1 "Please call dokku ps:restart on all linked apps" dokku_log_info1 "Please call dokku ps:restart on all linked apps"
} }

View File

@@ -6,7 +6,7 @@ source "$PLUGIN_BASE_PATH/common/functions"
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-stop-cmd() { service-stop-cmd() {
#E stop the service and the running container #E stop the service and removes the running container
#E dokku $PLUGIN_COMMAND_PREFIX:stop lollipop #E dokku $PLUGIN_COMMAND_PREFIX:stop lollipop
#A service, service to run command against #A service, service to run command against
declare desc="stop a running $PLUGIN_SERVICE service" declare desc="stop a running $PLUGIN_SERVICE service"
@@ -16,7 +16,7 @@ service-stop-cmd() {
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service" [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
verify_service_name "$SERVICE" verify_service_name "$SERVICE"
service_stop "$SERVICE" service_container_rm "$SERVICE"
} }
service-stop-cmd "$@" service-stop-cmd "$@"

25
tests/service_pause.bats Executable file
View File

@@ -0,0 +1,25 @@
#!/usr/bin/env bats
load test_helper
setup() {
dokku "$PLUGIN_COMMAND_PREFIX:create" l
}
teardown() {
dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
}
@test "($PLUGIN_COMMAND_PREFIX:pause) error when there are no arguments" {
run dokku "$PLUGIN_COMMAND_PREFIX:pause"
assert_contains "${lines[*]}" "Please specify a valid name for the service"
}
@test "($PLUGIN_COMMAND_PREFIX:pause) error when service does not exist" {
run dokku "$PLUGIN_COMMAND_PREFIX:pause" not_existing_service
assert_contains "${lines[*]}" "service not_existing_service does not exist"
}
@test "($PLUGIN_COMMAND_PREFIX:pause) success" {
run dokku "$PLUGIN_COMMAND_PREFIX:pause" l
assert_success
}