zarf-dev / zarf

DevSecOps for Air Gap & Limited-Connection Systems. https://zarf.dev/
Apache License 2.0
1.35k stars 162 forks source link

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

Closed supcom234 closed 1 month ago

supcom234 commented 1 month ago

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 commented 1 month ago

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 commented 1 month ago

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 commented 1 month ago

Agreed we should update documentation on this :)