Skip to content

chore(docs): update Plugin resource annotations doc snippet #1632

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

Open
ibakshay wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore(docs): update Plugin resource annotations doc snippet #1632

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions docs/reference/components/plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,15 +91,15 @@ spec:

### 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`.
Copy link
Contributor

@IvoGoman IvoGoman Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The supported values are mentioned later in the sentence


### 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.
Copy link
Contributor

@abhijith-darshan abhijith-darshan Dec 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

better to give boolean string values example here as we may enforce value validation in future

Copy link
Contributor Author

@ibakshay ibakshay Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Boolean field is not supported in Kubernetes Annotations . You mean greenhouse.sap/suspend: "true"?

Copy link
Contributor

@abhijith-darshan abhijith-darshan Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Contributor

@abhijith-darshan abhijith-darshan Dec 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

better to mention timestamp here "2025-12-03 11:14:00" in golang datetime format (No enforcement but internal automation will do only this)


## Next Steps

Expand Down
Loading