chore(docs): update Plugin resource annotations doc snippet #1632
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
documentation
ibakshay
changed the title
ibakshay
changed the title
IvoGoman
reviewed
Dec 3, 2025
| ### Choosing the deployment tool | ||
|
|
||
| The annotation `greenhouse.sap/deployment-tool` can be added to a Plugin resource to choose the deployment tool used to deploy the Helm release. Supported values are `flux` and `legacy`. | ||
| The annotation `greenhouse.sap/deployment-tool: <some-string>` can be added to a Plugin resource to choose the deployment tool used to deploy the Helm release. Supported values are `flux` and `legacy`. |
Contributor
There was a problem hiding this comment.
The supported values are mentioned later in the sentence
abhijith-darshan
requested changes
Dec 3, 2025
| ### Suspending the Plugin's reconciliation | ||
|
|
||
| The annotation `greenhouse.sap/suspend` can be added to a Plugin resource to temporarily suspend the reconciliation of the Plugin. This results in no changes on the Plugin or referenced resources being applied until the annotation is removed. This also includes upgrades of the Helm release on the target cluster. This also blocks the deletion of the Plugin resource until the annotation is removed. | ||
| The annotation `greenhouse.sap/suspend: <some-string>` can be added to a Plugin resource to temporarily suspend the reconciliation of the Plugin. This results in no changes on the Plugin or referenced resources being applied until the annotation is removed. This also includes upgrades of the Helm release on the target cluster. This also blocks the deletion of the Plugin resource until the annotation is removed. |
Contributor
There was a problem hiding this comment.
better to give boolean string values example here as we may enforce value validation in future
Contributor
Author
There was a problem hiding this comment.
Boolean field is not supported in Kubernetes Annotations . You mean greenhouse.sap/suspend: "true"?
Contributor
There was a problem hiding this comment.
better to give boolean string values example here as we may enforce value validation in future
yes boolean string
| ### Triggering reconciliation of the Plugin's managed resources | ||
|
|
||
| The annotation `greenhouse.sap/reconcile` can be added to a Plugin resource to trigger a reconciliation of the Plugin and its managed resources. When the Plugin is deployed using FluxCD this annotation is propagated to the Flux HelmRelease resource and triggers a reconciliation of the Helm release on the target cluster. This can be useful to trigger a reconciliation even if no changes were made to the Plugin resource. | ||
| The annotation `greenhouse.sap/reconcile: <some-string>` can be added to a Plugin resource to trigger a reconciliation of the Plugin and its managed resources. When the Plugin is deployed using FluxCD this annotation is propagated to the Flux HelmRelease resource and triggers a reconciliation of the Helm release on the target cluster. This can be useful to trigger a reconciliation even if no changes were made to the Plugin resource. |
Contributor
There was a problem hiding this comment.
better to mention timestamp here "2025-12-03 11:14:00" in golang datetime format (No enforcement but internal automation will do only this)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
What type of PR is this? (check all applicable)
Related Tickets & Documents
Added tests?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Added to documentation?
Checklist