feat: add parameter for keep-daemon and keep-state when removing Builder Instance

Author: tomowatt

README.md

@@ -386,6 +386,18 @@ Commas separated, Key-Value pairs of driver-specific options to configure the Bu
 
 Example: `memory=100m,cpuset-cpus=1`
 
+##### `keep-daemon` (boolean)
+
+If set to true, will keep the BuildKit daemon running after the buildx context (Builder) is removed. This is useful when you manage BuildKit daemons and buildx contexts independently. Only supported by the `docker-container` and `kubernetes` drivers. Optional when using `remove`.
+
+The default is `false`.
+
+##### `keep-state` (boolean)
+
+If set to true, will keep BuildKit state so it can be reused by a new Builder with the same name, persisting the driver's cache. Currently, only supported by the `docker-container` driver. Optional when using `remove`.
+
+The default is `false`.
+
 ##### `name`
 
 Sets the name of the Builder instance to create or use. Required when using `create` or `use` builder paramaters.

hooks/pre-exit

@@ -13,7 +13,7 @@ rm -f "docker-compose.buildkite-${BUILDKITE_BUILD_NUMBER}-override.yml"
 
 # clean up resources after a run command. we do this here so that it will
 # run after a job is cancelled
-if [[ -n "$(plugin_read_list RUN)" ]] && [[ "$(plugin_read_config CLEANUP "true")" == "true" ]] ; then
+if [[ -n "$(plugin_read_list RUN)" ]] && [[ "$(plugin_read_config CLEANUP "true")" == "true" ]]; then
   # shellcheck source=lib/run.bash
   . "$DIR/../lib/run.bash"
 
@@ -27,9 +27,20 @@ builder_remove="$(plugin_read_config BUILDER_REMOVE "false")"
 
 if [[ "${builder_remove}" == true ]]; then
   if builder_instance_exists "${builder_name}"; then
+
+    builder_remove_args=()
+
+    if [[ "$(plugin_read_config BUILDER_KEEP_DAEMON "false")" == "true" ]]; then
+      builder_remove_args+=("--keep-daemon")
+    fi
+
+    if [[ "$(plugin_read_config BUILDER_KEEP_STATE "false")" == "true" ]]; then
+      builder_remove_args+=("--keep-state")
+    fi
+
     echo "~~~ :docker: Cleaning up Builder Instance '${builder_name}"
     docker buildx stop "${builder_name}"
-    docker buildx rm "${builder_name}"
+    docker buildx rm "${builder_name}" ${builder_remove_args:+${builder_remove_args[@]}}
   else
     echo "~~~ :docker: Cannot remove Builder Instance '${builder_name}' as does not exist"
   fi

plugin.yml

@@ -37,6 +37,10 @@ configuration:
           enum: [ "docker-container", "kubernetes", "remote" ]
         driver-opt:
           type: string
+        keep-daemon:
+          type: boolean
+        keep-state:
+          type: boolean
         name:
           type: string
         platform: