From e15f94b03d509e1320edb3f663b888e68f7321be Mon Sep 17 00:00:00 2001 From: Ioannis Canellos Date: Fri, 22 Sep 2023 13:39:08 +0300 Subject: [PATCH] doc: apply feedback --- docs/src/main/asciidoc/init-tasks.adoc | 92 +++++++++++++++++++++----- 1 file changed, 77 insertions(+), 15 deletions(-) diff --git a/docs/src/main/asciidoc/init-tasks.adoc b/docs/src/main/asciidoc/init-tasks.adoc index bd3a7c6891d08..cdddda35591ea 100644 --- a/docs/src/main/asciidoc/init-tasks.adoc +++ b/docs/src/main/asciidoc/init-tasks.adoc @@ -5,15 +5,15 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Initialization tasks :categories: initialization -:summary: This guide explains how to configure initialization tasks +:summary: This reference guide explains how to configure initialization tasks There are often initialization tasks performed by Quarkus extensions that are meant to be run once. -For example Flyway or Liquibase initialization fall into that category. But what happens when the scaling +For example, Flyway or Liquibase initialization falls into that category. But what happens when the scaling needs of an application requires more instances of the application to run? Or what happens when the application restarts ? A common environment where both of these cases are pretty common is Kubernetes. To address these challenges, -Quarkus allows externalization of such tasks as Kubernetes Jobs and uses init containers to ensure that an +Quarkus allows externalization of such tasks as Kubernetes https://kubernetes.io/docs/concepts/workloads/controllers/job/[Jobs] and uses https://kubernetes.io/docs/concepts/workloads/pods/init-containers/[init containers] to ensure that an application instance only starts once the initialization jobs have finished. With this approach even if an application has multiple replicas, the initialization logic will only run once. @@ -24,38 +24,93 @@ This approach is reflected in the manifests generated by xref:kubernetes.adoc[Ku The feature can be explictily disabled per task (enabled by default). The default behavior can change setting the following property to `false`: +[source,properties] +---- +quarkus.kubernetes.init-task-defaults.enabled=false +---- + +or on Openshift: + [source,properties] ---- quarkus.openshift.init-task-defaults.enabled=false ---- +**Note**: All the configuration options in this guide are available on both OpenShift and Kubernetes. The rest of the guide will use Kubernetes(`quarkus.kubernetes` prefix) +configuration prefix, but all the configuration options are also available for OpenShift(`quarkus.openshift` prefix) too. + In the case where we need to disable a particular task, we can use the following property: [source,properties] ---- -quarkus.openshift.init-tasks."".enabled=false +quarkus.kubernetes.init-tasks."".enabled=false +---- + +The task name is the name of the extension that performs the initialization. +Examples: + +For Flyway: + +[source,properties] +---- +quarkus.kubernetes.init-tasks.flyway.enabled=false +---- + +For Liquibase: + +[source,properties] +---- +quarkus.kubernets.init-tasks.liquibase.enabled=false +---- + +For Liquibase Mongodb: + +[source,properties] +---- +quarkus.kubernetes.init-tasks.liquibase-mongodb.enabled=false ---- -The task name is the name of the Kubernetes Job resource that follows the convention `${quarkus.appliction.name}-${extension}-init`. -If the convention is hard to remember you can always peek at the generated manifests. == Controlling the generated Job -The Job container is pretty similar to the application container and the only thing that changes is the configured environment variables. -More specifically, the following environment variable is added, to tell the Job to exit right after initialization. +The job container is pretty similar to the application container, and the only thing that changes is the configured environment variables. +More specifically, the following environment variable is added, to tell the job to exit right after initialization. [source,properties] ---- QUARKUS_INIT_AND_EXIT=true ---- -The image, image pull policy, service account, volumes, mounts and additional environment variables are inherited from the deployment resource. -Any customization that happens to the original deployment resource (via configuration or extension) will be reflected in the Job too. +The image, image pull policy, service account, volumes, mounts and additional environment variables are inherited/copied from the deployment resource. +Any customization to the original deployment resource (via configuration or extension) will also be reflected in the job too. + +== Controlling the generated Init Container + +The name of the generated init container is `wait-for-${task name}` by default. +Given that the init container is part of the same pod as the actual application it will get the same service account (and therefore permissions) and volumes as the application. +Further customization to the container can be done using using the configuration options for init containers (see `quarkus.kubernetes.init-containers` or `quarkus.openshift.init-containers`). + +Examples: + +To set the imagePullPolicy to `IfNotPresent` on the init container that waits for the `flyway` job: + +[source,properties] +---- +quarkus.kubernetes.init-containers.wait-for-flyway.image-pull-policy=IfNotPresent +---- + +To set custom command (say `custom-wait-for`) on the init container that waits for the `flyway` job: -== Coordination between Job and deployment +[source,properties] +---- +quarkus.kubernetes.init-containers.wait-for-flyway.command=custom-wait-for +---- + + +== Orchestration of the initialization tasks -The deploymnet resource should not start until the Job has succesfully completed. The common pattern that is used among Kubernetes users is the -use of init containers to achieve this. An init container that `wait for` the Job to complete is enough to enforce that requirement. +The deployment resource should not start until the job has been completed. The typical pattern that is used among Kubernetes users is the +use of init containers to achieve this. An init container that `wait for` the job to complete is enough to enforce that requirement. === Using a custom wait for image @@ -63,7 +118,14 @@ To change the `wait-for` image which by default is `groundnuty/k8s-wait-for:no-r [source,properties] ---- -quarkus.openshift.init-task-defaults.wait-for-image=my/wait-for-image:1.0 +quarkus.kubernetes.init-task-defaults.wait-for-image=my/wait-for-image:1.0 +---- + +To change the `wait-for` image for a particular init container (e.g. `wait-for-flway`) you can use: + +[source,properties] +---- +quarkus.kubernetes.init-containers.wait-for-flyway=my/wait-for-image:1.0 ---- === Configuring permissions @@ -71,7 +133,7 @@ quarkus.openshift.init-task-defaults.wait-for-image=my/wait-for-image:1.0 For an init container to be able to to perform the `wait for job` it needs to be able to perform `get` operations on the `Job` resource. This is done automatically and the generated manifests include the required `Role` and `RoleBinding` resources. -If for any reason additiona permissions are required either by the init container or the `Job`, they can be configured with through the xref:deploying-to-kuberentes.adoc#generating-rbac-resources[Kubernetes RBAC configuration]. +If for any reason additional permissions are required either by the init container or the `Job`, they can be configured with through the xref:deploying-to-kuberentes.adoc#generating-rbac-resources[Kubernetes RBAC configuration]. **Note**: Both the application, the init container and the `Job` use the same `ServiceAccount` and therefore share the same permissions.