Skip to content

Commit

Permalink
doc: add init task doc
Browse files Browse the repository at this point in the history
  • Loading branch information
iocanel committed Sep 13, 2023
1 parent 76842a2 commit 055a22d
Showing 1 changed file with 83 additions and 0 deletions.
83 changes: 83 additions & 0 deletions docs/src/main/asciidoc/init-tasks.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
////
This guide is maintained in the main Quarkus repository
and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Initialization tasks
:categories: initialization
:summary: This 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
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

Check warning on line 16 in docs/src/main/asciidoc/init-tasks.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'. Raw Output: {"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.", "location": {"path": "docs/src/main/asciidoc/init-tasks.adoc", "range": {"start": {"line": 16, "column": 46}}}, "severity": "INFO"}
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.

This approach is reflected in the manifests generated by xref:kubernetes.adoc[Kubernetes extension].

== Disabling the feature

The feature can be explictily disabled per task (enabled by default).

Check warning on line 24 in docs/src/main/asciidoc/init-tasks.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.Spelling] Use correct American English spelling. Did you really mean 'explictily'? Raw Output: {"message": "[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'explictily'?", "location": {"path": "docs/src/main/asciidoc/init-tasks.adoc", "range": {"start": {"line": 24, "column": 20}}}, "severity": "WARNING"}
The default behavior can change setting the following property to `false`:

[source,properties]
----
quarkus.openshift.init-task-defaults.enabled=false
----

In the case where we need to disable a particular task, we can use the following property:

Check warning on line 32 in docs/src/main/asciidoc/init-tasks.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'. Raw Output: {"message": "[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.", "location": {"path": "docs/src/main/asciidoc/init-tasks.adoc", "range": {"start": {"line": 32, "column": 22}}}, "severity": "INFO"}

[source,properties]
----
quarkus.openshift.init-tasks."<task name>".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

Check warning on line 42 in docs/src/main/asciidoc/init-tasks.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.Headings] Use sentence-style capitalization in 'Controlling the generated Job'. Raw Output: {"message": "[Quarkus.Headings] Use sentence-style capitalization in 'Controlling the generated Job'.", "location": {"path": "docs/src/main/asciidoc/init-tasks.adoc", "range": {"start": {"line": 42, "column": 4}}}, "severity": "INFO"}

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.

Check warning on line 53 in docs/src/main/asciidoc/init-tasks.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.TermsWarnings] Consider using 'through', 'by', 'from', 'on', or 'by using' rather than 'via' unless updating existing content that uses the term. Raw Output: {"message": "[Quarkus.TermsWarnings] Consider using 'through', 'by', 'from', 'on', or 'by using' rather than 'via' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/init-tasks.adoc", "range": {"start": {"line": 53, "column": 69}}}, "severity": "WARNING"}

== Coordination between Job and deployment

The deploymnet resource should not start until the Job has succesfully completed. The common pattern that is used among Kubernetes users is the

Check warning on line 57 in docs/src/main/asciidoc/init-tasks.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.Spelling] Use correct American English spelling. Did you really mean 'deploymnet'? Raw Output: {"message": "[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'deploymnet'?", "location": {"path": "docs/src/main/asciidoc/init-tasks.adoc", "range": {"start": {"line": 57, "column": 5}}}, "severity": "WARNING"}
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

To change the `wait-for` image which by default is `groundnuty/k8s-wait-for:no-root-v1.7` you can use:

Check warning on line 62 in docs/src/main/asciidoc/init-tasks.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.TermsSuggestions] Depending on the context, consider using ', which (non restrictive clause preceded by a comma)' or 'that (restrictive clause without a comma)' rather than 'which'. Raw Output: {"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using ', which (non restrictive clause preceded by a comma)' or 'that (restrictive clause without a comma)' rather than 'which'.", "location": {"path": "docs/src/main/asciidoc/init-tasks.adoc", "range": {"start": {"line": 62, "column": 31}}}, "severity": "INFO"}

[source,properties]
----
quarkus.openshift.init-task-defaults.wait-for-image=my/wait-for-image:1.0
----

=== Configuring permissions

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.

Check failure on line 71 in docs/src/main/asciidoc/init-tasks.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.RepeatedWords] 'to' is repeated! Raw Output: {"message": "[Quarkus.RepeatedWords] 'to' is repeated!", "location": {"path": "docs/src/main/asciidoc/init-tasks.adoc", "range": {"start": {"line": 71, "column": 34}}}, "severity": "ERROR"}

Check warning on line 71 in docs/src/main/asciidoc/init-tasks.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'needs to'. Raw Output: {"message": "[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'needs to'.", "location": {"path": "docs/src/main/asciidoc/init-tasks.adoc", "range": {"start": {"line": 71, "column": 70}}}, "severity": "INFO"}
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].

Check warning on line 74 in docs/src/main/asciidoc/init-tasks.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.Spelling] Use correct American English spelling. Did you really mean 'additiona'? Raw Output: {"message": "[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'additiona'?", "location": {"path": "docs/src/main/asciidoc/init-tasks.adoc", "range": {"start": {"line": 74, "column": 19}}}, "severity": "WARNING"}

**Note**: Both the application, the init container and the `Job` use the same `ServiceAccount` and therefore share the same permissions.

== Extension providing Initialization Tasks

Check warning on line 78 in docs/src/main/asciidoc/init-tasks.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.Headings] Use sentence-style capitalization in 'Extension providing Initialization Tasks'. Raw Output: {"message": "[Quarkus.Headings] Use sentence-style capitalization in 'Extension providing Initialization Tasks'.", "location": {"path": "docs/src/main/asciidoc/init-tasks.adoc", "range": {"start": {"line": 78, "column": 4}}}, "severity": "INFO"}

Currently this feature is used by the following extensions:
- xref:flyway.adoc[Flyway]
- xref:liquibase.adoc[Liquibase]
- xref:liquibase-mongodb.adoc[Liquibase MongoDB]

0 comments on commit 055a22d

Please sign in to comment.