add support for custom environment variables to the server deployment

[andrewrothstein]

a corporate L7 proxy sits between my kiali deployment and my prometheus server. I need to specify the (HTTP|HTTPS|NO)_PROXY environment variables in my helm chart deployment.

part of: kiali/kiali#7569

[jmazzitelli]

Please review the community contribution document for the process that is in place before submitting any PRs. We ask that a github issue be created first which describes the details of the bug or enhancement request being asked for. The issue provides a chance for the Kiali maintainers to have a dialogue with you before you submit any PRs.

For example, this is not complete without an accompanying operator PR.

In addition, I believe this request has been asked for before - though I can't remember the resolution (if there was one). Did you search in the github issues/discussions for a request for proxy settings?

[jmazzitelli]

there is no accompanying operator PR that goes with this server helm chart PR. We cannot merge this without that additional work. See checklists:

• https://github.com/kiali/kiali-operator/blob/master/DEVELOPING.adoc#are-you-altering-a-kiali-server-configuration-setting
• https://github.com/kiali/kiali-operator/blob/master/DEVELOPING.adoc#are-you-altering-a-kiali-server-resource

[jmazzitelli]

see:

• Support http no_proxy (NO_PROXY) configuration kiali#6386
• Support for additional environment variables in deployment kiali#7569

[jmazzitelli]

This PR looks correct as-is. Since we need feature parity with the operator, here's other places to touch for the new operator PR we need:

• operator defaults: https://github.com/kiali/kiali-operator/blob/v1.89.7/roles/default/kiali-deploy/defaults/main.yml#L72
• CRD Schema (for docs and validator): https://github.com/kiali/kiali-operator/blob/v1.89.7/crd-docs/crd/kiali.io_kialis.yaml#L305
• CR example (for docs): https://github.com/kiali/kiali-operator/blob/v1.89.7/crd-docs/cr/kiali.io_v1alpha1_kiali.yaml#L111
• non-OpenShift Kubernetes deployment template: https://github.com/kiali/kiali-operator/blob/v1.89.7/roles/default/kiali-deploy/templates/kubernetes/deployment.yaml#L116
• OpenShift deployment template: https://github.com/kiali/kiali-operator/blob/v1.89.7/roles/default/kiali-deploy/templates/openshift/deployment.yaml#L116
• Molecule test update (config-values-test):
  • add some custom env vars similar to the way custom secrets are done: https://github.com/kiali/kiali-operator/blob/v1.89.7/molecule/config-values-test/converge.yml#L157-L167
  • check that the custom env vars made it to the pod spec, similar to how the securityContext is checked: https://github.com/kiali/kiali-operator/blob/v1.89.7/molecule/config-values-test/converge.yml#L324-L333

[jmazzitelli]

I'm going to work on the operator implementation. Should be done today. This is going to be done as part of kiali/kiali#7569

[jmazzitelli]

Test procedures for this PR:

1. Build the helm charts: make build-helm-charts
2. Run "helm template" and set some custom envs - confirm the envs are being set in the deployment, ensuring things like booleans and numbers are properly quoted:

helm template \
  --set deployment.custom_envs[0].name="FOO1" \
  --set deployment.custom_envs[0].value="http://aa.example.com:123" \
  --set deployment.custom_envs[1].name="FOO2" \
  --set deployment.custom_envs[1].value=123 \
  --set deployment.custom_envs[2].name="FOO3" \
  --set deployment.custom_envs[2].value=true \
  -n istio-system kiali-server _output/charts/kiali-server-*.tgz

should result in the following within the Deployment:

        - name: "FOO1"
          value: "http://aa.example.com:123"
        - name: "FOO2"
          value: "123"
        - name: "FOO3"
          value: "true"

And to see it actually deploy, use "helm install" and look at the pod yaml:

helm install \
  --set deployment.custom_envs[0].name="FOO1"  \
  --set deployment.custom_envs[0].value="http://aa.example.com:123" \
  --set deployment.custom_envs[1].name="FOO2" \
  --set deployment.custom_envs[1].value=123 \
  --set deployment.custom_envs[2].name="FOO3" \
  --set deployment.custom_envs[2].value=true  \
  -n istio-system kiali-server _output/charts/kiali-server-*.tgz

After the pod deploys, look at the envs and confirm the three custom ones are there:

kubectl get pods -n istio-system -l app.kubernetes.io/name=kiali -ojsonpath='{..spec.containers[0].env}' | jq

results in

[
  {
    "name": "ACTIVE_NAMESPACE",
    "valueFrom": {
      "fieldRef": {
        "apiVersion": "v1",
        "fieldPath": "metadata.namespace"
      }
    }
  },
  {
    "name": "LOG_LEVEL",
    "value": "info"
  },
  {
    "name": "LOG_FORMAT",
    "value": "text"
  },
  {
    "name": "LOG_TIME_FIELD_FORMAT",
    "value": "2006-01-02T15:04:05Z07:00"
  },
  {
    "name": "LOG_SAMPLER_RATE",
    "value": "1"
  },
  {
    "name": "FOO1",
    "value": "http://aa.example.com:123"
  },
  {
    "name": "FOO2",
    "value": "123"
  },
  {
    "name": "FOO3",
    "value": "true"
  }
]

I created the operator PR for this functionality.

[jmazzitelli]

operator PR that introduces this functionality: kiali/kiali-operator#829

[jshaughn]

Ran through the test steps and it worked. I'll approve and merge (assuming the operator part works as well). We can remove the bad comment iin a trivial follow-up, not sure the original author will get to it.

[jmazzitelli]

We can remove the bad comment in a trivial follow-up

I was able to commit it - github allows maintainers to commit suggestions so I had permission from the github UI to do it.

[jshaughn]

re-approving after trivial change