Support Configuration of Duplicate Filtering in Camunda Run

[ThorbenLindhauer]

This issue was imported from JIRA:

Field	Value
JIRA Link	CAM-14529
Reporter	@jonathanlukas
Has restricted visibility comments	true

---

User Story (Required on creation):

As a system administrator, I want Camunda Run to be configurable regarding filtering of resource deployments so that I can properly deploy resources that depend on each other inside one deployment.

Functional Requirements (Required before implementation):

• Configuration option in Run to enable/disable duplicate filtering on deployments

Technical Requirements (Required before implementation):

• Add a configuration property to Run for "deployChangedOnly"
• Pass on the configured value to the SpringProcessEngineConfiguration (currently "setDeployChangedOnly" is called with "true" in the constructor of CamundaBpmRunProcessEngineConfiguration)

Limitations of Scope (Optional):

This only applies to Camunda Platform Run

Hints (optional):

Links:

• is related to https://jira.camunda.com/browse/CAMTEAM-233

Breakdown

Code & Docs

Beta Give feedback

1. feat(distro/run): Make deployChangedOnly Configurable #4607
   ci:run +1
   
2. chore(user-guide): Add Deployment Docs to Camunda Run camunda-docs-manual#1681
   +0
   

Dev2QA handover

• Does this ticket need a QA test and the testing goals are not clear from the description? Add a Dev2QA handover comment

Testing instructions:

The deployChangedOnly=true flag is currently populated in default.yml, production.yml.
The goal of this testing is to ensure that the the configuration and the behaviour of filtering resources works in camunda-run. Please find below two test cases that verify the above, along with example steps to follow for doing the testing.

Scenario # 1

• When deployChangedOnly is set to true, Then a resource of a deployment without changes should not be redeployed upon restart
  • Example Steps:
    • Build and Extract camunda-run in /camunda-bpm-platform/distro/run/distro/target/camunda-bpm-run-7.22.0-SNAPSHOT/ folder
    • Place two resources e.g two text files: text1.txt -> "This is text1", text2.txt -> "This is text2"
    • Startup camunda-run (invoke start.sh)
    • Check Cockpit; a SpringAutoDeployment should exist under deployments containing both files.
    • Shutdown camunda-run (invoke shutdown.sh)
    • Change only text1.txt
    • Start the application again
    • Check cockpit; a new deployment called SpringAutoDeployment should exist that contains only the changed resource text1.txt

Scenario # 2

• When deployChangedOnly is set to false, Then all resources of a deployment should be redeployed upon a restart
  • Example steps:
    • Build and Extract camunda-run in /camunda-bpm-platform/distro/run/distro/target/camunda-bpm-run-7.22.0-SNAPSHOT/ folder
    • Place two resources e.g two text files: text1.txt -> "This is text1", text2.txt -> "This is text2"
    • Startup camunda-run (invoke start.sh)
    • Check Cockpit; a SpringAutoDeployment should exist under deployments containing both files.
    • Shutdown camunda-run (invoke shutdown.sh)
    • Change only text1.txt
    • Start the application again
    • Check cockpit; a new deployment called SpringAutoDeployment should exist that contains both files text1.txt and text2.txt, despite that only text1.txt changed

[ThorbenLindhauer]

This comment was imported from JIRA and written by user @tmetzke

---

Hey @jonathanlukas,

thanks for creating this proposal. We'll look into it as soon as possible and get back with proper feedback.

Best,
Tobias

[ThorbenLindhauer]

This comment was imported from JIRA and written by user @tmetzke

---

Hey @jonathanlukas,

thanks again for bringing this up. I think this makes a lot of sense in the scope of the product.
It will allow for more flexibility in the configuration of Run, as this is currently hardwired in the application code.

I will forward your proposal to product management to consider this in our roadmap planning.
Be aware that this does not yet mean that we will work on this in the near future.
If you would like to speed up the process and provide a code contribution, feel free to create an appropriate Pull Request in our GitHub repository. If you intend to go this way, please also make sure your changes are covered with tests.

In order to make an informed decision on the priority, please let us know if there are any existing (customer) use cases you are aware of that would benefit from this.

Best,
Tobias

[psavidis]

The code and documentation are done. Assigning the ticket to @gbetances089 for doing the QA tests (see Dev2QA handover section)

[gbetances089]

Verified on camunda-bpm-run-ee-7.22.0-20240923.090257-103