Skip to content
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.

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

Document Resource Deletion concept #2470

Merged
merged 8 commits into from
Aug 30, 2023
Merged

Conversation

remcowesterhoud
Copy link
Contributor

@remcowesterhoud remcowesterhoud commented Aug 21, 2023

Description

With the 8.3 release we will support resource deletion. This PR adds documentation about this feature.
closes #2264

It also adds a warning to the upgrade guide regarding a larger than usual migration which could impact some users.
closes #2384

When should this change go live?

  • This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
  • There is no urgency with this change.
  • This change or page is part of a marketing blog, conference talk, or something else on a schedule.
  • This functionality is already available but undocumented.
  • This is a bug fix or security concern.

PR Checklist

  • I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
  • I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
  • My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
  • My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

Adds a warning to indicate users that Zeebe will run a mgiration when updating to 8.3 that may take longer than usual.
It mentions how the user could notice this and that it causes some downtime when there is  large state.
Adds the DeleteResource RPC to Zeebe's gRPC api docs.
Adds documentation regarding the new resource deletion feature.
@remcowesterhoud
Copy link
Contributor Author

remcowesterhoud commented Aug 24, 2023

@abbasadel FYI, I don't know if you noticed. I requested your review here. I think it's good to have a review from someone less experienced with Zeebe to see if the documentation makes sense 😄

Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

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

Technical review in latest commit, and a few questions for clarity.

docs/components/concepts/resource-deletion.md Outdated Show resolved Hide resolved
1. Process definitions
2. Decision Requirements Graphs (DRG)

You can delete a resource using [Operate](../../components/operate/operate-introduction.md), or by sending
Copy link
Contributor

Choose a reason for hiding this comment

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

Would briefly mention how you can delete a resource using Operate.

Copy link
Contributor Author

@remcowesterhoud remcowesterhoud Aug 24, 2023

Choose a reason for hiding this comment

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

@mihail-ca Do you have an issue to document how to use the feature using Operate? If so, could you make sure the link on this page is updated accordingly when this page is created?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hello, this is our Operate epic for this topic: https://github.com/camunda/operate/issues/3972
The relevant issues for documentation are on the front-end side, since the back-end changes are only available via Operate UI. I think this issue explains how to do it: https://github.com/camunda/operate/issues/4019

Copy link
Contributor

Choose a reason for hiding this comment

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

The above is for deleting decision definition - BTW this can be a point of confusion. In Operate one cannot select decision requirements, only a decision definition.

For Process Definition Deletion, the relevant epic and issue on Operate are:
https://github.com/camunda/operate/issues/3971
https://github.com/camunda/operate/issues/4126

Note though that Process Definition Deletion is still work in progress.

Copy link
Contributor Author

@remcowesterhoud remcowesterhoud Aug 25, 2023

Choose a reason for hiding this comment

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

@mihail-ca Will there be a page similar to this one, but for deleting? https://docs.camunda.io/docs/components/operate/userguide/process-instance-modification/

Where can I find the issue for this?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hello, I am not sure about this. Maybe @pedesen knows, he is DRI for resource deletion on Operate side.

Copy link
Contributor

Choose a reason for hiding this comment

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

@remcowesterhoud @mihail-ca I will create an issue for this in the camunda-platform-docs repo

Copy link
Contributor

Choose a reason for hiding this comment

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

docs/components/concepts/resource-deletion.md Outdated Show resolved Hide resolved
docs/components/concepts/resource-deletion.md Show resolved Hide resolved
docs/components/concepts/resource-deletion.md Outdated Show resolved Hide resolved
remcowesterhoud and others added 2 commits August 24, 2023 17:06
Processed some feedback:

- Moved the why before the how
- Added more links
- Clarified how to delete a process with running instances.
@christinaausley
Copy link
Contributor

Hi @remcowesterhoud -- let me know if you would like additional review or if you need any help with the build this week 👍

@remcowesterhoud
Copy link
Contributor Author

@christinaausley I've applied your suggestions, there's one open discussion which I'm trying to get a response to. In the meantime you can give it a 2nd review. Let me request this officially 😄

After @abbasadel also had a look I think I can merge it.

Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

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

👍

@abbasadel
Copy link
Contributor

Nice work @remcowesterhoud

abbasadel
abbasadel previously approved these changes Aug 30, 2023
@remcowesterhoud remcowesterhoud enabled auto-merge (squash) August 30, 2023 08:40
@remcowesterhoud remcowesterhoud merged commit 733ceed into main Aug 30, 2023
3 checks passed
@remcowesterhoud remcowesterhoud deleted the 2264_resource_deletion branch August 30, 2023 09:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Add Zeebe migration impact to the update guide Document resource deletion
5 participants