fix: Fixing Helm chart flower ingress service reference

[andormarkus]

closes #41175

What happened

We are sub charting the official airflow chart and for this reason we need to use fullnameOverride: "airflow" settings to achieve the desired k8s resource names. However when we are using it the flower ingress becomes invalid because it want's to connect to non existing service name. Root cause are in the ingress.yaml. The webserver ingress can handle it with no problem.

Incorrect code section

flower-ingress.yaml - code section

spec:
  rules:
    - http:
        paths:
          - backend:
              service:
                name: {{ $.Release.Name }}-flower
                port:
                  name: flower-ui

While in the correct code section

webserver-ingress.yaml - code section

spec:
  rules:
    - http:
        paths:
          - backend:
              service:
                name: {{ $fullname }}-webserver
                port:
                  name: airflow-ui

To overcome this issue we need to run this command on every deployment

kubectl patch ingress airflow-flower-ingress \
    --namespace "airflow" \
    --type='json' \
    -p='[{"op": "replace", "path": "/spec/rules/0/http/paths/0/backend/service/name", "value":"airflow-flower"}]'

What you think should happen instead

The following code should be updated to match how webserver ingress works
flower-ingress.yaml - code section

spec:
  rules:
    - http:
        paths:
          - backend:
              service:
                name: {{ $fullname }}-flower
                port:
                  name: flower-ui

[andormarkus]

Can someone help my why this test failing?
https://github.com/apache/airflow/actions/runs/10195595534/job/28204650305?pr=41179

[romsharon98]

Can someone help my why this test failing? https://github.com/apache/airflow/actions/runs/10195595534/job/28204650305?pr=41179

rebase solved it 😄

[romsharon98]

can you add tests for your change?

need to add tests

[andormarkus]

Hi @romsharon98

I'm happy to add helm test for the modified ingress object, however the helm test framework is fully missing from the helm chart and we need to add the automated test runs to the CI/CD pipelines as well.

Helm testing documentation,

[romsharon98]

You can add your tests here
You can see more in helm unit tests docs

[andormarkus]

Hi @romsharon98

Sorry for the late reply I was on extended vacation.

I have run into to a problem when I added the "fullnameOverride": "test-basic" it looks like the chart/templates/_helpers.yaml is not executed when I run the tests.

Here are my tests
helm_tests/webserver/test_ingress_web.py

    def test_backend_service_name(self):
        docs = render_chart(
            values={"ingress": {"web": {"enabled": True}}},
            show_only=["templates/webserver/webserver-ingress.yaml"],
        )

        assert "release-name-webserver" == jmespath.search("spec.rules[0].http.paths[0].backend.service.name", docs[0])

    def test_backend_service_name_with_fullname_override(self):
        docs = render_chart(
            values={"fullnameOverride": "test-basic",
                    "ingress": {"web": {"enabled": True}}},
            show_only=["templates/webserver/webserver-ingress.yaml"],

        )

        assert "test-basic-webserver" == jmespath.search("spec.rules[0].http.paths[0].backend.service.name", docs[0])

helm_tests/webserver/test_ingress_flower.py

    def test_backend_service_name(self):
        docs = render_chart(
            values={"ingress": {"enabled": True}, "flower": {"enabled": True}},
            show_only=["templates/flower/flower-ingress.yaml"],
        )

        assert "release-name-flower" == jmespath.search("spec.rules[0].http.paths[0].backend.service.name", docs[0])

    def test_backend_service_name_with_fullname_override(self):
        docs = render_chart(
            values={"fullnameOverride": "test-basic",
                    "ingress": {"enabled": True}, "flower": {"enabled": True}},
            show_only=["templates/flower/flower-ingress.yaml"],

        )

        assert "test-basic-flower" == jmespath.search("spec.rules[0].http.paths[0].backend.service.name", docs[0])

I run the test using the following command

 breeze testing helm-tests --helm-test-package webserver  

FAILED helm_tests/webserver/test_ingress_flower.py::TestIngressFlower::test_backend_service_name_with_fullname_override - AssertionError: assert equals failed
  'test-basic-flower'    'release-name-flower'
FAILED helm_tests/webserver/test_ingress_web.py::TestIngressWeb::test_backend_service_name_with_fullname_override - AssertionError: assert equals failed
  'test-basic-webserver'    'release-name-webserver'

[romsharon98]

Hi @romsharon98

Sorry for the late reply I was on extended vacation.

I have run into to a problem when I added the "fullnameOverride": "test-basic" it looks like the chart/templates/_helpers.yaml is not executed when I run the tests.

Here are my tests helm_tests/webserver/test_ingress_web.py

    def test_backend_service_name(self):
        docs = render_chart(
            values={"ingress": {"web": {"enabled": True}}},
            show_only=["templates/webserver/webserver-ingress.yaml"],
        )

        assert "release-name-webserver" == jmespath.search("spec.rules[0].http.paths[0].backend.service.name", docs[0])

    def test_backend_service_name_with_fullname_override(self):
        docs = render_chart(
            values={"fullnameOverride": "test-basic",
                    "ingress": {"web": {"enabled": True}}},
            show_only=["templates/webserver/webserver-ingress.yaml"],

        )

        assert "test-basic-webserver" == jmespath.search("spec.rules[0].http.paths[0].backend.service.name", docs[0])

helm_tests/webserver/test_ingress_flower.py

    def test_backend_service_name(self):
        docs = render_chart(
            values={"ingress": {"enabled": True}, "flower": {"enabled": True}},
            show_only=["templates/flower/flower-ingress.yaml"],
        )

        assert "release-name-flower" == jmespath.search("spec.rules[0].http.paths[0].backend.service.name", docs[0])

    def test_backend_service_name_with_fullname_override(self):
        docs = render_chart(
            values={"fullnameOverride": "test-basic",
                    "ingress": {"enabled": True}, "flower": {"enabled": True}},
            show_only=["templates/flower/flower-ingress.yaml"],

        )

        assert "test-basic-flower" == jmespath.search("spec.rules[0].http.paths[0].backend.service.name", docs[0])

I run the test using the following command

 breeze testing helm-tests --helm-test-package webserver  

FAILED helm_tests/webserver/test_ingress_flower.py::TestIngressFlower::test_backend_service_name_with_fullname_override - AssertionError: assert equals failed
  'test-basic-flower'    'release-name-flower'
FAILED helm_tests/webserver/test_ingress_web.py::TestIngressWeb::test_backend_service_name_with_fullname_override - AssertionError: assert equals failed
  'test-basic-webserver'    'release-name-webserver'

for this to be applied you need to set useStandardNaming to be true

[andormarkus]

Hi @romsharon98

Thank you so much the help. Now my tests are passing.
Please let me know If I need to more test of where to adjust the code?

Thanks,
Andor

[romsharon98]

Hi @romsharon98

Thank you so much the help. Now my tests are passing.

Please let me know If I need to more test of where to adjust the code?

Thanks,

Andor

You have static checks fail.
Better work with pre commit to see those errors before you commit.

You can see how to install it here

https://github.com/apache/airflow/blob/main/contributing-docs/08_static_code_checks.rst#installing-pre-commit-hooks

[andormarkus]

Hi @romsharon98
All checks are now passing.

Thanks,
Andor

[andormarkus]

Hi @romsharon98

When is the helm chart 1.16.0 scheduled for release?

Thanks,
Andor

[romsharon98]

Hi @romsharon98

When is the helm chart 1.16.0 scheduled for release?

Thanks,

Andor

I think @jedcunningham will know better