Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix invalid hubble yaml if cilium_hubble_tls_generate is enabled #10430

Merged
merged 1 commit into from
Sep 13, 2023

Conversation

toonalbers
Copy link
Contributor

@toonalbers toonalbers commented Sep 12, 2023

What type of PR is this?
/kind bug

What this PR does / why we need it:
Fix errors in the Hubble template when cilium_hubble_tls_generate due to whitespace issues.

Which issue(s) this PR fixes:
Fixes #10429

Does this PR introduce a user-facing change?:

[Cilium] Fix invalid hubble yaml if `cilium_hubble_tls_generate` is enabled

@k8s-ci-robot k8s-ci-robot added the kind/bug Categorizes issue or PR as related to a bug. label Sep 12, 2023
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Sep 12, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: toonalbers / name: Toon Albers (cf8f373)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Sep 12, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @toonalbers!

It looks like this is your first PR to kubernetes-sigs/kubespray 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kubespray has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @toonalbers. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Sep 12, 2023
@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Sep 12, 2023
Copy link
Contributor

@mzaian mzaian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @toonalbers

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 12, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mzaian, toonalbers

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 12, 2023
@@ -61,6 +61,7 @@ spec:
name: tls
readOnly: true
{% endif %}

Copy link
Member

@yankay yankay Sep 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HI @toonalbers

Thanks for the fix :-)

It seems an issue about the whitespace-control of jinjia.

It can be solve by the code:

          {%- if cilium_hubble_tls_generate %}
          - mountPath: /var/lib/hubble-relay/tls
            name: tls
            readOnly: true
         {%- endif %}

There are simplar usage in the kubespray code :-)
we can check the template in the https://j2live.ttl255.com/

Copy link
Contributor Author

@toonalbers toonalbers Sep 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @yankay,

Thank you for the review! I agree that adding the minus does result in neater YAML, but the newline is also still required. On https://j2live.ttl255.com/ it works fine without a newline, but in practice (at least with the Ansible version from requirements.txt) the result is malformed YAML.

Minus only:

$ kubectl apply -f /etc/kubernetes/addons/hubble/hubble-deploy.yml --dry-run=server
error: error parsing /etc/kubernetes/addons/hubble/hubble-deploy.yml: error converting YAML to JSON: yaml: line 61: mapping values are not allowed in this context

With the offending line 61:

59           - mountPath: /var/lib/hubble-relay/tls
60             name: tls
61             readOnly: true      restartPolicy: Always
62       serviceAccount: hubble-relay
63       serviceAccountName: hubble-relay

Newline only:

59           - mountPath: /var/lib/hubble-relay/tls
60             name: tls
61             readOnly: true
62
63       restartPolicy: Always
64       serviceAccount: hubble-relay
65       serviceAccountName: hubble-relay

Newline and minus:

59           - mountPath: /var/lib/hubble-relay/tls
60             name: tls
61             readOnly: true
62       restartPolicy: Always
63       serviceAccount: hubble-relay
64       serviceAccountName: hubble-relay

I will update the PR to add the minus to the front of the tags.

@@ -97,6 +98,7 @@ spec:
path: server.key
name: tls
{% endif %}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can be solved by the {%- like the code before :-)

@yankay
Copy link
Member

yankay commented Sep 13, 2023

Thanks @toonalbers

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 13, 2023
@k8s-ci-robot k8s-ci-robot merged commit 31f6d38 into kubernetes-sigs:master Sep 13, 2023
@floryut floryut added kind/network Network section in the release note and removed kind/bug Categorizes issue or PR as related to a bug. labels Sep 18, 2023
@hassenius
Copy link

@yankay @floryut can we cherry-pick this one into the release-2.23 branch too?

@floryut
Copy link
Member

floryut commented Sep 22, 2023

@yankay @floryut can we cherry-pick this one into the release-2.23 branch too?

Yes, if you can do it that's great, otherwise I'll do it in the coming days 👍

guytet pushed a commit to guytet/kubespray that referenced this pull request Oct 30, 2023
@yankay yankay mentioned this pull request Dec 15, 2023
pedro-peter pushed a commit to pedro-peter/kubespray that referenced this pull request May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/network Network section in the release note lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cilium hubble deployment is rendered incorrect if cilium_hubble_tls_generate is enabled
6 participants