Add hashed configs to pod annotations

[hoyhbx]

Change log description

• Automatically trigger statefulSet rolling update when config is changed
• Add hashed zookeeper configuration as the pod annotation in the statefulSet

Purpose of the change

Fixes #454

What the code does

Add hashed zookeeper configuration as the pod annotation in the statefulSet.
The makeZkPodAnnotations function computes the hash for the zookeeper config string and calls mergeAnnotations to merge with the annotations from the CR.

There are several possible improvements regarding the patch:

1. I was not sure whether to start the function name with capital case or lower case (e.g. makeZkPodAnnotations or MakeZkPodAnnotations), since both code styles exist in the code base.
2. The mergeAnnotations function encodes the same logic as the mergeLabels function, we could reduce these two into a general mergeMap function to reduce the code redundency.
3. I am not sure if the changes in the env.sh could reflect to the zookeeper cluster without a restart. If that also requires a restart, then we can add the hash of result of makeZkEnvConfigString to the annotation map too.

How to verify it

Similar to the steps mentioned in #454

1. Deploy a default zookeeper cluster
2. Change one of the fields in the config field, and observe that the statefulSet performed a rolling update, and the config used by the zookeeper cluster is updated.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.03%. Comparing base (2c8bfec) to head (5967165).
⚠️ Report is 4 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #469      +/-   ##
==========================================
+ Coverage   85.91%   86.03%   +0.11%     
==========================================
  Files          12       12              
  Lines        1633     1647      +14     
==========================================
+ Hits         1403     1417      +14     
  Misses        145      145              
  Partials       85       85              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[anishakj]

@hoyhbx Could you please add an end-to-end test to validate this?

[anishakj]

Change log description

• Automatically trigger statefulSet rolling update when config is changed
• Add hashed zookeeper configuration as the pod annotation in the statefulSet

Purpose of the change

Fixes #454

What the code does

Add hashed zookeeper configuration as the pod annotation in the statefulSet. The makeZkPodAnnotations function computes the hash for the zookeeper config string and calls mergeAnnotations to merge with the annotations from the CR.

There are several possible improvements regarding the patch:

1. I was not sure whether to start the function name with capital case or lower case (e.g. makeZkPodAnnotations or MakeZkPodAnnotations), since both code styles exist in the code base.
2. The mergeAnnotations function encodes the same logic as the mergeLabels function, we could reduce these two into a general mergeMap function to reduce the code redundency.
3. I am not sure if the changes in the env.sh could reflect to the zookeeper cluster without a restart. If that also requires a restart, then we can add the hash of result of makeZkEnvConfigString to the annotation map too.

How to verify it

Similar to the steps mentioned in #454

1. Deploy a default zookeeper cluster
2. Change one of the fields in the config field, and observe that the statefulSet performed a rolling update, and the config used by the zookeeper cluster is updated.

For the functions that are local name is starting with small letter
It is better to combine mergeAnootations and mergeLabels