Thanks to visit codestin.com
Credit goes to github.com

Skip to content

doc: adding a full example of overriding the startup probe timeout #37096

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
vmuzikar merged 3 commits into from
Feb 17, 2025
Merged

doc: adding a full example of overriding the startup probe timeout #37096

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
deb0b03
doc: adding a full example of overriding the startup probe timeout
shawkins Feb 5, 2025
4d85095
Update docs/guides/operator/advanced-configuration.adoc
shawkins Feb 14, 2025
80e2302
Update docs/guides/operator/advanced-configuration.adoc
shawkins Feb 14, 2025
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
33 changes: 33 additions & 0 deletions docs/guides/operator/advanced-configuration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,39 @@ spec:
secretName: keycloak-additional-secret
----

===== Probe Timeouts

The unsupported podTemplate may be used to override the default probes.

In particular the default startup probe timeout of 10 minutes may be too short in scenarios where there is a long-running migration.

If your instances encounter this startup failure or if you wish to proactively prevent such a startup failure from occurring, then the startup probe timeout should be increased.

With otherwise default settings, something like the following increases the timeout to 20 minutes:

[source,yaml]
----
apiVersion: k8s.keycloak.org/v2alpha1
kind: Keycloak
metadata:
name: example-kc
spec:
...
unsupported:
podTemplate:
spec:
containers:
startupProbe:
httpGet:
path: "/health/started"
port: 9000
scheme: "HTTPS"
failureThreshold: 1200
periodSeconds: 1
----

Note that the usage of a relative HTTP path, or an alternative management port, require changes to the probe configuration.

=== Disabling required options

{project_name} and the {project_name} Operator provide the best production-ready experience with security in mind.
Expand Down