github/dokku
0
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

Merge pull request #6791 from dokku/release-script-refactor

Browse Source 
Correct issue where pre-deploy scripts do not have root access
This commit is contained in:
Jose Diaz-Gonzalez
2024-04-04 03:39:20 -04:00
committed by GitHub
parent 08a136f73f 9d6201985e
commit c3d5d6e646
13 changed files with 70 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/appendices/0.34.0-migration-guide.md
View File

@@ -17,3 +17,7 @@
```shell ```shell
dokku scheduler-k3s:set --global ingress-class traefik dokku scheduler-k3s:set --global ingress-class traefik
``` ```
## Deprecations
The `pre-deploy` plugin trigger is deprecated as of `0.34.4`. It is currently invoked during the `post-release-builder` plugin trigger, where image mutation is heavily discouraged. Users should instead move any trigger usage to the `pre-release-builder` plugin trigger. The `pre-deploy` plugin trigger will be removed in a future release.

3
docs/development/plugin-triggers.md
View File

@@ -1934,6 +1934,9 @@ fi
### `pre-deploy` ### `pre-deploy`
> [!WARNING]
> Deprecated, please use `pre-release-builder` instead
- Description: Allows the running of code before the app's processes are scaled up and after the docker images are prepared. - Description: Allows the running of code before the app's processes are scaled up and after the docker images are prepared.
- Invoked by: `dokku deploy` - Invoked by: `dokku deploy`
- Arguments: `$APP $IMAGE_TAG` - Arguments: `$APP $IMAGE_TAG`

2
plugins/app-json/Makefile
View File

@@ -1,5 +1,5 @@
SUBCOMMANDS = subcommands/report subcommands/set SUBCOMMANDS = subcommands/report subcommands/set
TRIGGERS = triggers/app-json-process-deploy-parallelism triggers/app-json-get-content triggers/core-post-deploy triggers/core-post-extract triggers/install triggers/post-app-clone-setup triggers/post-app-rename triggers/post-app-rename-setup triggers/post-create triggers/post-delete triggers/post-deploy triggers/pre-deploy triggers/report TRIGGERS = triggers/app-json-process-deploy-parallelism triggers/app-json-get-content triggers/core-post-deploy triggers/core-post-extract triggers/install triggers/post-app-clone-setup triggers/post-app-rename triggers/post-app-rename-setup triggers/post-create triggers/post-delete triggers/post-deploy triggers/post-release-builder triggers/pre-release-builder triggers/report
BUILD = commands subcommands triggers BUILD = commands subcommands triggers
PLUGIN_NAME = app-json PLUGIN_NAME = app-json

14
plugins/app-json/src/triggers/triggers.go
View File

@@ -56,10 +56,16 @@ func main() {
appName := flag.Arg(0) appName := flag.Arg(0)
imageTag := flag.Arg(3) imageTag := flag.Arg(3)
err = appjson.TriggerPostDeploy(appName, imageTag) err = appjson.TriggerPostDeploy(appName, imageTag)
case "pre-deploy": case "post-release-builder":
appName := flag.Arg(0) builderType := flag.Arg(0)
imageTag := flag.Arg(1) appName := flag.Arg(1)
err = appjson.TriggerPreDeploy(appName, imageTag) image := flag.Arg(2)
err = appjson.TriggerPostReleaseBuilder(builderType, appName, image)
case "pre-release-builder":
builderType := flag.Arg(0)
appName := flag.Arg(1)
image := flag.Arg(2)
err = appjson.TriggerPreReleaseBuilder(builderType, appName, image)
case "report": case "report":
appName := flag.Arg(0) appName := flag.Arg(0)
err = appjson.ReportSingleApp(appName, "", "") err = appjson.ReportSingleApp(appName, "", "")

15
plugins/app-json/triggers.go
View File

@@ -212,13 +212,16 @@ func TriggerPostDeploy(appName string, imageTag string) error {
return executeScript(appName, image, imageTag, "postdeploy") return executeScript(appName, image, imageTag, "postdeploy")
} }
// TriggerPreDeploy is a trigger to execute predeploy and release deployment tasks func TriggerPreReleaseBuilder(builderType string, appName string, image string) error {
func TriggerPreDeploy(appName string, imageTag string) error { parts := strings.Split(image, ":")
image := common.GetAppImageName(appName, imageTag, "") imageTag := parts[len(parts)-1]
if err := executeScript(appName, image, imageTag, "predeploy"); err != nil { return executeScript(appName, image, imageTag, "predeploy")
return err }
}
// TriggerPostReleaseBuilder is a trigger to execute predeploy and release deployment tasks
func TriggerPostReleaseBuilder(builderType string, appName string, image string) error {
parts := strings.Split(image, ":")
imageTag := parts[len(parts)-1]
if err := executeScript(appName, image, imageTag, "release"); err != nil { if err := executeScript(appName, image, imageTag, "release"); err != nil {
return err return err
} }

17
plugins/builder-herokuish/builder-release
View File

@@ -14,12 +14,6 @@ trigger-builder-herokuish-builder-release() {
fi fi
local IMAGE=$(get_app_image_name "$APP" "$IMAGE_TAG") local IMAGE=$(get_app_image_name "$APP" "$IMAGE_TAG")
if fn-plugn-trigger-exists "pre-release-buildpack"; then
dokku_log_warn "Deprecated: please upgrade plugin to use 'pre-release-builder' plugin trigger instead of pre-release-buildpack"
plugn trigger pre-release-buildpack "$APP" "$IMAGE_TAG"
fi
plugn trigger pre-release-builder "$BUILDER_TYPE" "$APP" "$IMAGE"
TMP_WORK_DIR="$(mktemp -d "/tmp/dokku-${DOKKU_PID}-${FUNCNAME[0]}.XXXXXX")" TMP_WORK_DIR="$(mktemp -d "/tmp/dokku-${DOKKU_PID}-${FUNCNAME[0]}.XXXXXX")"
trap "rm -rf '$TMP_WORK_DIR' >/dev/null" RETURN INT TERM EXIT trap "rm -rf '$TMP_WORK_DIR' >/dev/null" RETURN INT TERM EXIT
@@ -36,6 +30,17 @@ trigger-builder-herokuish-builder-release() {
DOKKU_APP_USER=$(config_get "$APP" DOKKU_APP_USER || true) DOKKU_APP_USER=$(config_get "$APP" DOKKU_APP_USER || true)
DOKKU_APP_USER=${DOKKU_APP_USER:="herokuishuser"} DOKKU_APP_USER=${DOKKU_APP_USER:="herokuishuser"}
if ! suppress_output "$DOCKER_BIN" image build "${DOCKER_BUILD_ARGS[@]}" $DOKKU_GLOBAL_BUILD_ARGS -f "$PLUGIN_AVAILABLE_PATH/builder-herokuish/dockerfiles/builder-pre-release.Dockerfile" --build-arg APP_IMAGE="$IMAGE" --build-arg "DOKKU_APP_USER=$DOKKU_APP_USER" -t "$IMAGE" "$TMP_WORK_DIR"; then
dokku_log_warn "Failure injecting environment variables"
return 1
fi
if fn-plugn-trigger-exists "pre-release-buildpack"; then
dokku_log_warn "Deprecated: please upgrade plugin to use 'pre-release-builder' plugin trigger instead of pre-release-buildpack"
plugn trigger pre-release-buildpack "$APP" "$IMAGE_TAG"
fi
plugn trigger pre-release-builder "$BUILDER_TYPE" "$APP" "$IMAGE"
if ! suppress_output "$DOCKER_BIN" image build "${DOCKER_BUILD_ARGS[@]}" $DOKKU_GLOBAL_BUILD_ARGS -f "$PLUGIN_AVAILABLE_PATH/builder-herokuish/dockerfiles/builder-release.Dockerfile" --build-arg APP_IMAGE="$IMAGE" --build-arg "DOKKU_APP_USER=$DOKKU_APP_USER" -t "$IMAGE" "$TMP_WORK_DIR"; then if ! suppress_output "$DOCKER_BIN" image build "${DOCKER_BUILD_ARGS[@]}" $DOKKU_GLOBAL_BUILD_ARGS -f "$PLUGIN_AVAILABLE_PATH/builder-herokuish/dockerfiles/builder-release.Dockerfile" --build-arg APP_IMAGE="$IMAGE" --build-arg "DOKKU_APP_USER=$DOKKU_APP_USER" -t "$IMAGE" "$TMP_WORK_DIR"; then
dokku_log_warn "Failure injecting environment variables" dokku_log_warn "Failure injecting environment variables"
return 1 return 1

5
plugins/builder-herokuish/dockerfiles/builder-pre-release.Dockerfile Normal file
View File

@@ -0,0 +1,5 @@
ARG APP_IMAGE
FROM $APP_IMAGE
ARG DOKKU_APP_USER herokuishuser
COPY --chown=$DOKKU_APP_USER 00-global-env.sh 01-app-env.sh /app/.profile.d/

1
plugins/builder-herokuish/dockerfiles/builder-release.Dockerfile
View File

@@ -3,5 +3,6 @@ FROM $APP_IMAGE
ARG DOKKU_APP_USER herokuishuser ARG DOKKU_APP_USER herokuishuser
COPY --chown=$DOKKU_APP_USER 00-global-env.sh 01-app-env.sh /app/.profile.d/ COPY --chown=$DOKKU_APP_USER 00-global-env.sh 01-app-env.sh /app/.profile.d/
RUN TRACE=$TRACE USER=$DOKKU_APP_USER HEROKUISH_DISABLE_CHOWN=false /exec true
USER $DOKKU_APP_USER USER $DOKKU_APP_USER
ENV HEROKUISH_SETUIDGUID false ENV HEROKUISH_SETUIDGUID false

2
plugins/ps/Makefile
View File

@@ -1,5 +1,5 @@
SUBCOMMANDS = subcommands/inspect subcommands/rebuild subcommands/report subcommands/restart subcommands/restore subcommands/retire subcommands/scale subcommands/set subcommands/start subcommands/stop SUBCOMMANDS = subcommands/inspect subcommands/rebuild subcommands/report subcommands/restart subcommands/restore subcommands/retire subcommands/scale subcommands/set subcommands/start subcommands/stop
TRIGGERS = triggers/app-restart triggers/core-post-deploy triggers/core-post-extract triggers/install triggers/post-app-clone triggers/post-app-clone-setup triggers/post-app-rename triggers/post-app-rename-setup triggers/post-create triggers/post-delete triggers/post-stop triggers/pre-deploy triggers/procfile-get-command triggers/procfile-exists triggers/ps-can-scale triggers/ps-current-scale triggers/ps-set-scale triggers/report TRIGGERS = triggers/app-restart triggers/core-post-deploy triggers/core-post-extract triggers/install triggers/post-app-clone triggers/post-app-clone-setup triggers/post-app-rename triggers/post-app-rename-setup triggers/post-create triggers/post-delete triggers/post-release-builder triggers/post-stop triggers/procfile-get-command triggers/procfile-exists triggers/ps-can-scale triggers/ps-current-scale triggers/ps-set-scale triggers/report
BUILD = commands subcommands triggers BUILD = commands subcommands triggers
PLUGIN_NAME = ps PLUGIN_NAME = ps

9
plugins/ps/src/triggers/triggers.go
View File

@@ -55,10 +55,11 @@ func main() {
case "post-stop": case "post-stop":
appName := flag.Arg(0) appName := flag.Arg(0)
err = ps.TriggerPostStop(appName) err = ps.TriggerPostStop(appName)
case "pre-deploy": case "post-release-builder":
appName := flag.Arg(0) builderType := flag.Arg(0)
imageTag := flag.Arg(1) appName := flag.Arg(1)
err = ps.TriggerPreDeploy(appName, imageTag) image := flag.Arg(2)
err = ps.TriggerPostReleaseBuilder(builderType, appName, image)
case "procfile-get-command": case "procfile-get-command":
appName := flag.Arg(0) appName := flag.Arg(0)
processType := flag.Arg(1) processType := flag.Arg(1)

4
plugins/ps/triggers.go
View File

@@ -257,8 +257,8 @@ func TriggerPostStop(appName string) error {
}) })
} }
// TriggerPreDeploy ensures an app has an up to date scale parameters // TriggerPostReleaseBuilder ensures an app has an up to date scale parameters
func TriggerPreDeploy(appName string, imageTag string) error { func TriggerPostReleaseBuilder(builderType string, appName string, image string) error {
if err := updateScale(appName, false, FormationSlice{}); err != nil { if err := updateScale(appName, false, FormationSlice{}); err != nil {
common.LogDebug(fmt.Sprintf("Error generating scale file: %s", err.Error())) common.LogDebug(fmt.Sprintf("Error generating scale file: %s", err.Error()))
return err return err

17
plugins/registry/triggers.go
View File

@@ -90,13 +90,16 @@ func TriggerPostDelete(appName string) error {
func TriggerPostReleaseBuilder(appName string, image string) error { func TriggerPostReleaseBuilder(appName string, image string) error {
parts := strings.Split(image, ":") parts := strings.Split(image, ":")
imageTag := parts[len(parts)-1] imageTag := parts[len(parts)-1]
_, err := common.CallPlugnTrigger(common.PlugnTriggerInput{ if common.PlugnTriggerExists("pre-deploy") {
Trigger: "pre-deploy", common.LogWarn("Deprecated: please upgrade plugin to use 'pre-release-builder' plugin trigger instead of pre-deploy")
Args: []string{appName, imageTag}, _, err := common.CallPlugnTrigger(common.PlugnTriggerInput{
StreamStdio: true, Trigger: "pre-deploy",
}) Args: []string{appName, imageTag},
if err != nil { StreamStdio: true,
return err })
if err != nil {
return err
}
} }
imageID, _ := common.DockerInspect(image, "{{ .Id }}") imageID, _ := common.DockerInspect(image, "{{ .Id }}")

16
plugins/scheduler-docker-local/pre-deploy → plugins/scheduler-docker-local/post-release-builder
View File

@@ -6,20 +6,20 @@ source "$PLUGIN_CORE_AVAILABLE_PATH/common/property-functions"
source "$PLUGIN_AVAILABLE_PATH/config/functions" source "$PLUGIN_AVAILABLE_PATH/config/functions"
source "$PLUGIN_AVAILABLE_PATH/scheduler-docker-local/internal-functions" source "$PLUGIN_AVAILABLE_PATH/scheduler-docker-local/internal-functions"
trigger-scheduler-docker-local-pre-deploy() { trigger-scheduler-docker-local-post-release-builder() {
declare desc="scheduler-docker-local pre-deploy plugin trigger" declare desc="scheduler-docker-local post-release-builder plugin trigger"
declare trigger="pre-deploy" declare trigger="post-release-builder"
declare APP="$1" IMAGE_TAG="$2" declare BUILDER_TYPE="$1" APP="$2" IMAGE="$3"
local DOKKU_SCHEDULER=$(get_app_scheduler "$APP") local DOKKU_SCHEDULER="$(get_app_scheduler "$APP")"
if [[ "$DOKKU_SCHEDULER" != "docker-local" ]]; then if [[ "$DOKKU_SCHEDULER" != "docker-local" ]]; then
return return
fi fi
scheduler-docker-local-pre-deploy-precheck "$APP" scheduler-docker-local-post-release-builder-precheck "$APP"
} }
scheduler-docker-local-pre-deploy-precheck() { scheduler-docker-local-post-release-builder-precheck() {
declare desc="Outputs the checks messages if necessary" declare desc="Outputs the checks messages if necessary"
declare APP="$1" declare APP="$1"
@@ -36,4 +36,4 @@ scheduler-docker-local-pre-deploy-precheck() {
fi fi
} }
trigger-scheduler-docker-local-pre-deploy "$@" trigger-scheduler-docker-local-post-release-builder "$@"