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

docs: Update noWait to have a warning about helm hooks #2873

Closed
supcom234 opened this issue Aug 13, 2024 · 3 comments · Fixed by #2895
Closed

docs: Update noWait to have a warning about helm hooks #2873

supcom234 opened this issue Aug 13, 2024 · 3 comments · Fixed by #2895

Comments

@supcom234
Copy link

supcom234 commented Aug 13, 2024

Environment

zarf_version: v0.32.4
rke2_version: "v1.28.9+rke2r1"

Steps to reproduce

  1. Create a zarf package using a helm chart with a long running kubernetes job with noWait: true
  - name: misp-chart
    description: "MISP Open Source Threat Intelligence and Sharing Platform"
    required: true
    charts:
      - name: misp
        version: 1.5.0
        namespace: misp
        localPath: ../chart
        noWait: true
        valuesFiles:
          - values-override/misp-values.yaml
  1. Deploy the zarf package

Expected result

With noWait True set, the helm chart should deploy and not wait for the job to complete or fail.

Actual Result

With a long running job it takes forever for the helm chart to deploy and the zarf deployment will timeout.

Visual Proof (screenshots, videos, text, etc)

image

Severity/Priority

Should be a rather high. There should be a way to tell zarf to ignore long running Kubernetes jobs so the deployment will not timeout.

@AustinAbro321
Copy link
Contributor

The Zarf lifecycle relies heavily on helm. Are you able to get the functionality you're looking for through a regular helm install outside of Zarf? If so could you give us the options you send into helm?

@supcom234
Copy link
Author

supcom234 commented Aug 14, 2024

image

My helm chart had life cycle annotation which was causing the waits to occur. The noWait: true works as expected after I removed those annotations. I posted an example of those annotations below.

annotations:
"helm.sh/hook": post-install
"helm.sh/hook-weight": "-5"

I would recommend adding trouble shooting steps to the docs for anyone wanting to use the noWait true functionality.

@schristoff
Copy link
Contributor

Agreed we should update documentation on this :)

@schristoff schristoff changed the title Zarf noWait: True under charts not working as expected docs: Update noWait to have a warning about helm hooks Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants