这是indexloc提供的服务，不要输入任何密码
Skip to content

Warn when publish ports if scaling up or zero downtime is enabled #6725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 15, 2024
Merged

Warn when publish ports if scaling up or zero downtime is enabled #6725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
43c2554
feat: warn when publish ports if scaling up or zero downtime is enabled
josegonzalez Mar 14, 2024
36ade1e
tests: add test for port publishing warning
josegonzalez Mar 14, 2024
6e3631a
fix: correct warning placement and update tests to account for parall…
josegonzalez Mar 14, 2024
c9b9c2a
chore: run shfmt
josegonzalez Mar 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions plugins/scheduler-docker-local/bin/scheduler-deploy-process
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,33 @@ fn-scheduler-deploy-process() {
fi
fi

local DOCKER_ARGS
DOCKER_ARGS=$(: | plugn trigger docker-args-deploy "$APP" "$IMAGE_TAG" "$PROC_TYPE")
DOCKER_ARGS+=$(: | plugn trigger docker-args-process-deploy "$APP" "$IMAGE_SOURCE_TYPE" "$IMAGE_TAG" "$PROC_TYPE")
DOCKER_ARGS=" $DOCKER_ARGS "
declare -a ARG_ARRAY
eval "ARG_ARRAY=($DOCKER_ARGS)"

local port_published=false
for arg in "${ARG_ARRAY[@]}"; do
if [[ "$arg" == "-p "* ]] || [[ "$arg" =~ "--publish "* ]] || [[ "$arg" == "-P" ]] || [[ "$arg" =~ "--publish-all"* ]]; then
port_published=true
break
fi
done

if [[ "$port_published" == "true" ]]; then
local warned_on_publish=false
if [[ "$PROC_COUNT" -gt 1 ]]; then
warned_on_publish=true
dokku_log_warn "Deploys may fail when publishing ports and scaling to multiple containers. Consider scaling process type $PROC_TYPE to 1."
fi
if [[ "$DOKKU_CHECKS_DISABLED" != "true" ]] && [[ "$warned_on_publish" == "false" ]]; then
warned_on_publish=true
dokku_log_warn "Deploys may fail when publishing ports and enabling zero downtime. Consider disabling zero downtime for process type $PROC_TYPE."
fi
fi

PARALLEL_DEPLOY_COUNT="$(plugn trigger "app-json-process-deploy-parallelism" "$APP" "$PROC_TYPE")"
DOKKU_CHECKS_DISABLED="$DOKKU_CHECKS_DISABLED" INJECT_INIT_FLAG="$INJECT_INIT_FLAG" parallel --will-cite --halt soon,fail=1 --jobs "$PARALLEL_DEPLOY_COUNT" --ungroup <"$PROCESS_TMP_FILE"

Expand Down
56 changes: 56 additions & 0 deletions tests/unit/scheduler-docker-local.bats
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,3 +119,59 @@ teardown() {
assert_success
assert_output_contains "docker-init" 0
}

@test "(scheduler-docker-local) publish ports" {
run create_app
echo "output: $output"
echo "status: $status"
assert_success

run deploy_app
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains "Deploys may fail when publishing ports and scaling to multiple containers" 0
assert_output_contains "Deploys may fail when publishing ports and enabling zero downtime" 0

run /bin/bash -c "dokku docker-options:add $TEST_APP deploy '--publish 5000:5000'"
echo "output: $output"
echo "status: $status"
assert_success

run /bin/bash -c "dokku ps:scale --skip-deploy $TEST_APP web=2"
echo "output: $output"
echo "status: $status"
assert_success

# the expected output will be seen twice due to how parallel re-outputs stderr in its own output...
run /bin/bash -c "dokku ps:rebuild $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_failure
assert_output_contains "Deploys may fail when publishing ports and scaling to multiple containers" 2
assert_output_contains "Deploys may fail when publishing ports and enabling zero downtime" 0

run /bin/bash -c "dokku ps:scale --skip-deploy $TEST_APP web=1"
echo "output: $output"
echo "status: $status"
assert_success

run /bin/bash -c "dokku ps:rebuild $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_failure
assert_output_contains "Deploys may fail when publishing ports and scaling to multiple containers" 0
assert_output_contains "Deploys may fail when publishing ports and enabling zero downtime" 2

run /bin/bash -c "dokku checks:disable $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success

run /bin/bash -c "dokku ps:rebuild $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains "Deploys may fail when publishing ports and scaling to multiple containers" 0
assert_output_contains "Deploys may fail when publishing ports and enabling zero downtime" 0
}