feat: add json output format support to storage:list
This will allow the command to be used in a programmatic fashion.
This commit is contained in:
@@ -6,7 +6,7 @@ The preferred method to mount external containers to a Dokku managed container,
|
|||||||
|
|
||||||
```
|
```
|
||||||
storage:ensure-directory [--chown option] <directory> # Creates a persistent storage directory in the recommended storage path
|
storage:ensure-directory [--chown option] <directory> # Creates a persistent storage directory in the recommended storage path
|
||||||
storage:list <app> # List bind mounts for app's container(s) (host:container)
|
storage:list <app> [--format text|json] # List bind mounts for app's container(s) (host:container)
|
||||||
storage:mount <app> <host-dir:container-dir> # Create a new bind mount
|
storage:mount <app> <host-dir:container-dir> # Create a new bind mount
|
||||||
storage:report [<app>] [<flag>] # Displays a checks report for one or more apps
|
storage:report [<app>] [<flag>] # Displays a checks report for one or more apps
|
||||||
storage:unmount <app> <host-dir:container-dir> # Remove an existing bind mount
|
storage:unmount <app> <host-dir:container-dir> # Remove an existing bind mount
|
||||||
@@ -34,6 +34,23 @@ dokku storage:list node-js-app
|
|||||||
/var/lib/dokku/data/storage/node-js-app:/app/storage
|
/var/lib/dokku/data/storage/node-js-app:/app/storage
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The output format can also be set to `json` for programmatic access:
|
||||||
|
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku storage:list node-js-app --format json
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"host_path": "/var/lib/dokku/data/storage/node-js-app",
|
||||||
|
"container_path": "/app/storage",
|
||||||
|
"volume_options": ""
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
### Creating storage directories
|
### Creating storage directories
|
||||||
|
|
||||||
> New as of 0.25.5
|
> New as of 0.25.5
|
||||||
|
|||||||
@@ -2424,7 +2424,7 @@ DOKKU_SCHEDULER="$1"; APP="$2"; REMOVE_CONTAINERS="$3";
|
|||||||
|
|
||||||
- Description: Returns a list of storage mounts
|
- Description: Returns a list of storage mounts
|
||||||
- Invoked by: `dokku storage:list` and `dokku deploy`
|
- Invoked by: `dokku storage:list` and `dokku deploy`
|
||||||
- Arguments: `$APP`
|
- Arguments: `$APP $PHASE $FORMAT`
|
||||||
- Example:
|
- Example:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
|||||||
@@ -26,6 +26,6 @@ get_bind_mounts() {
|
|||||||
declare desc="strips docker options and prints mounts"
|
declare desc="strips docker options and prints mounts"
|
||||||
local -r phase_file_path=$1
|
local -r phase_file_path=$1
|
||||||
if [[ -r "$phase_file_path" ]]; then
|
if [[ -r "$phase_file_path" ]]; then
|
||||||
sed -e '/^-v/!d' -e 's/^-v/ /' <"$phase_file_path"
|
sed -e '/^-v/!d' -e 's/^-v //' <"$phase_file_path"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ fn-help-content() {
|
|||||||
declare desc="return help content"
|
declare desc="return help content"
|
||||||
cat <<help_content
|
cat <<help_content
|
||||||
storage:ensure-directory [--chown option] <directory>, Creates a persistent storage directory in the recommended storage path
|
storage:ensure-directory [--chown option] <directory>, Creates a persistent storage directory in the recommended storage path
|
||||||
storage:list <app>, List bind mounts for app's container(s) (host:container)
|
storage:list <app> [--format text|json], List bind mounts for app's container(s) (host:container)
|
||||||
storage:mount <app> <host-dir:container-dir>, Create a new bind mount
|
storage:mount <app> <host-dir:container-dir>, Create a new bind mount
|
||||||
storage:report [<app>] [<flag>], Displays a checks report for one or more apps
|
storage:report [<app>] [<flag>], Displays a checks report for one or more apps
|
||||||
storage:unmount <app> <host-dir:container-dir>, Remove an existing bind mount
|
storage:unmount <app> <host-dir:container-dir>, Remove an existing bind mount
|
||||||
|
|||||||
@@ -135,10 +135,24 @@ cmd-storage-list() {
|
|||||||
declare desc="List all bound mounts"
|
declare desc="List all bound mounts"
|
||||||
declare cmd="storage:list"
|
declare cmd="storage:list"
|
||||||
[[ "$1" == "$cmd" ]] && shift 1
|
[[ "$1" == "$cmd" ]] && shift 1
|
||||||
declare APP="$1"
|
declare APP="$1" FORMAT_FLAG="$2" FORMAT_FLAG_VALUE="$3"
|
||||||
local phase="deploy"
|
local phase="deploy" format="text"
|
||||||
|
|
||||||
|
if [[ "$FORMAT_FLAG" == "--format" ]]; then
|
||||||
|
if [[ "$FORMAT_FLAG_VALUE" == "json" ]] || [[ "$FORMAT_FLAG_VALUE" == "text" ]]; then
|
||||||
|
format="$FORMAT_FLAG_VALUE"
|
||||||
|
else
|
||||||
|
dokku_log_fail "Invalid --format value specified"
|
||||||
|
fi
|
||||||
|
elif [[ -n "$FORMAT_FLAG" ]]; then
|
||||||
|
dokku_log_fail "Invalid argument specified"
|
||||||
|
fi
|
||||||
|
|
||||||
verify_app_name "$APP"
|
verify_app_name "$APP"
|
||||||
dokku_log_quiet "$APP volume bind-mounts:"
|
if [[ "$FORMAT_FLAG_VALUE" == "text" ]]; then
|
||||||
plugn trigger storage-list "$APP" "$phase"
|
dokku_log_info1_quiet "$APP volume bind-mounts:"
|
||||||
|
plugn trigger storage-list "$APP" "$phase" "$format" | sed "s/^/ /"
|
||||||
|
else
|
||||||
|
plugn trigger storage-list "$APP" "$phase" "$format"
|
||||||
|
fi
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,9 +7,18 @@ source "$PLUGIN_AVAILABLE_PATH/storage/functions"
|
|||||||
trigger-storage-storage-list() {
|
trigger-storage-storage-list() {
|
||||||
declare desc="storage storage-list trigger"
|
declare desc="storage storage-list trigger"
|
||||||
declare trigger="storage-list"
|
declare trigger="storage-list"
|
||||||
declare APP="$1" PHASE="$2"
|
declare APP="$1" PHASE="$2" FORMAT="$3"
|
||||||
|
|
||||||
get_bind_mounts "$(fn-get-phase-file-path "$APP" "$PHASE")"
|
if [[ "$FORMAT" != "json" ]]; then
|
||||||
|
get_bind_mounts "$(fn-get-phase-file-path "$APP" "$PHASE")"
|
||||||
|
else
|
||||||
|
while read -r line; do
|
||||||
|
local host_path="$(awk -F: '{print $1}' <<< "$line")"
|
||||||
|
local container_path="$(awk -F: '{print $2}' <<< "$line")"
|
||||||
|
local volume_options="$(awk -F: '{print $3}' <<< "$line")"
|
||||||
|
jq -n --arg host_path "$host_path" --arg container_path "$container_path" --arg volume_options "$volume_options" '{host_path: $host_path, container_path: $container_path, volume_options: $volume_options}'
|
||||||
|
done < <(get_bind_mounts "$(fn-get-phase-file-path "$APP" "$PHASE")") | jq -M -n '[inputs]'
|
||||||
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
trigger-storage-storage-list "$@"
|
trigger-storage-storage-list "$@"
|
||||||
|
|||||||
@@ -112,30 +112,74 @@ teardown() {
|
|||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
assert_success
|
assert_success
|
||||||
run /bin/bash -c "dokku storage:list $TEST_APP | grep -qe '^\s*/tmp/mount:/mount'"
|
|
||||||
|
run /bin/bash -c "dokku --quiet storage:list $TEST_APP"
|
||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
assert_success
|
assert_success
|
||||||
|
assert_output "/tmp/mount:/mount"
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku storage:list $TEST_APP --format json | jq -r '. | length'"
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output "1"
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku storage:list $TEST_APP --format json | jq -r '.[].host_path'"
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output "/tmp/mount"
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku storage:list $TEST_APP --format json | jq -r '.[].container_path'"
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output "/mount"
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku storage:list $TEST_APP --format json | jq -r '.[].volume_options'"
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output ""
|
||||||
|
|
||||||
run /bin/bash -c "dokku storage:mount $TEST_APP /tmp/mount:/mount"
|
run /bin/bash -c "dokku storage:mount $TEST_APP /tmp/mount:/mount"
|
||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
assert_output " ! Mount path already exists."
|
assert_output " ! Mount path already exists."
|
||||||
assert_failure
|
assert_failure
|
||||||
|
|
||||||
run /bin/bash -c "dokku storage:unmount $TEST_APP /tmp/mount:/mount"
|
run /bin/bash -c "dokku storage:unmount $TEST_APP /tmp/mount:/mount"
|
||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
assert_success
|
assert_success
|
||||||
run /bin/bash -c "dokku storage:list $TEST_APP | grep -vqe '^\s*/tmp/mount:/mount'"
|
|
||||||
|
run /bin/bash -c "dokku --quiet storage:list $TEST_APP"
|
||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
assert_success
|
assert_success
|
||||||
|
assert_output ""
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku storage:list $TEST_APP --format json | jq -r '. | length'"
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output "0"
|
||||||
|
|
||||||
run /bin/bash -c "dokku storage:unmount $TEST_APP /tmp/mount:/mount"
|
run /bin/bash -c "dokku storage:unmount $TEST_APP /tmp/mount:/mount"
|
||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
assert_output " ! Mount path does not exist."
|
assert_output " ! Mount path does not exist."
|
||||||
assert_failure
|
assert_failure
|
||||||
|
|
||||||
run /bin/bash -c "dokku storage:mount $TEST_APP mount_volume:/mount"
|
run /bin/bash -c "dokku storage:mount $TEST_APP mount_volume:/mount"
|
||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
assert_success
|
assert_success
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku --quiet storage:list $TEST_APP"
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output "mount_volume:/mount"
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user