upstream/keycloak
1
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-04-26 00:30:35 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Document limitations when updating workflows

Browse source 
Closes #45134

Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com>
This commit is contained in:
Pedro Igor 2026-01-05 10:10:03 -03:00 committed by GitHub
parent 014fae99c4
commit 3c0b308bb7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 21 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/documentation/server_admin/topics/workflows/managing-workflows.adoc
View file

@ -37,5 +37,26 @@ From the workflows list, you can perform the following actions:
* **Copy**: Click on the *Copy* button next to a workflow to create a copy of it. This is useful if you want to create a new workflow based on an existing one.
* **Delete**: Click on the *Delete* button next to a workflow to delete it.
=== Updating a workflow
To update a workflow, click on its name in the workflows list. This will open the workflow in edit mode, where you can modify its YAML definition.
After making your changes, click *Save* to apply the updates.
There are limitations when updating workflows if they have scheduled steps. In such cases, you are not able to change the step chain of a workflow
if there are active instances of the workflow being updated. This limitation is in place to ensure the integrity of ongoing workflow instances
where updates to the step chain could lead to an expensive operation of migrating existing instances to the new step chain,
which could impact system performance as well as lead to inconsistencies and an unexpected behavior.
In future releases, we plan to introduce a more flexible approach to updating workflows with scheduled steps, so that administrators
are going to be allowed to migrate realm resources scheduled for a specific step to a different step in the updated workflow.
For now, the only option is to either wait for all active instances to complete or to delete the workflow and create a new one.
Note that deleting a workflow will also delete all its active instances, therefore, realm resources associated with those instances
will not be processed further, and they would need to be re-associated with a new workflow instance if needed.