litmuschaos / chaos-operator

chaos engineering via kubernetes operator
Apache License 2.0
136 stars 94 forks source link

spec.components.runner.runnerAnnotations of ChaosEngine CR seems not working #503

Closed aek-dsk closed 1 month ago

aek-dsk commented 1 month ago

Is this a BUG REPORT or FEATURE REQUEST?

BUG REPORT

What happened: Applying spec.components.runner.runnerAnnotations of the ChaosEngine CR in litmuschaos.io/v1alpha1 does not generate the requested annotation on the runner pod. The functionality seems to be broken. In addition, some inconsistencies between documentation, CRD, source code were found, e.g. here: https://litmuschaos.github.io/litmus/experiments/concepts/chaos-resources/chaos-engine/runner-components/ in the schema description - runnerAnnotations vs runnerAnnotation, or the source code https://github.com/litmuschaos/chaos-operator/blob/9fb5e5a384853db554c83f3e6c02aa0c8b37c3e6/controllers/chaosengine_controller.go#L211

What you expected to happen: runner annotations to be correctly applied

How to reproduce it (as minimally and precisely as possible): by trying to apply this option

Anything else we need to know?: Could you please check?

aek-dsk commented 1 month ago

Example:


spec:
  components:
    runner:
      runnerAnnotations:
        sidecar.istio.io/inject: "false"
aek-dsk commented 1 month ago

For anybody stumbling upon this: there is an undocumented option in the chaosengine CRD that can be used instead: runnerLabels


spec:
  components:
    runner:
      runnerLabels:
        sidecar.istio.io/inject: "false"