Rename topology module to dynamic.configuration

camunda / zeebe

Distributed Workflow Engine for Microservices Orchestration

https://zeebe.io

3.05k stars 549 forks source link

Rename topology module to dynamic.configuration #18157

Closed deepthidevaki closed 1 week ago

deepthidevaki commented 2 weeks ago

Description

We decided to add configurations that can be changed dynamically to the cluster topology and make use of the same infrastructure to apply changes in a systematic way. Hence the name topology or ClusterTopology is not meaningful anymore. This PR renames most of the references to topology to configuration or ClusterConfiguration.

The package topology is renamed to dynamic.configuration
The module is renamed to dynamic-config
All classes have renamed
Most reference to topology in the comments, variables and method names have been renamed. There might be some still left which we can fix as we go.

The protobuf messages are not renamed to minimize the impact in this PR. This will be done in a follow up. The gateway rest API responses are also untouched.

Related issues

closes #18032

github-actions[bot] commented 2 weeks ago

Operate Test Results

803 tests 788 :white_check_mark: 12m 48s :stopwatch: 137 suites 15 :zzz: 137 files 0 :x:

Results for commit d956572f.

:recycle: This comment has been updated with latest results.

github-actions[bot] commented 2 weeks ago

Tasklist Test Results

545 tests 539 :white_check_mark: 1h 35m 4s :stopwatch: 141 suites 6 :zzz: 141 files 0 :x:

Results for commit d956572f.

:recycle: This comment has been updated with latest results.

deepthidevaki commented 2 weeks ago

@npepinpe Sorry, this is a big PR :see_no_evil: But I guess you don't have to go through every change. Please check mainly the renaming for package and module.

Also realized that it will be a pain to backport any bug fixes after this :sob:

deepthidevaki commented 1 week ago

💭 dynamic.configuration is quite long 😄 I would've just named it cluster.config or something 🤷 After all, most classes after are just called ClusterConfiguration something. Plus, the artifact is called zeebe-cluster-configuration (could be shortened to zeebe-cluster-config). Not a big deal though, and I can't articulate a better argument, so it's fine.

Done. Renamed to dynamic.config.

💭 I think we may want a topology listener interface in the future for consumers who only care about topology updates, and not more general config, but it's still too early to say.

It might be useful. Let's add it when it is needed.

deepthidevaki commented 1 week ago

Rebasing on main.