Add --wait to helm tests and other improvements to support CD tools #8738

davidjumani · 2023-09-29T16:13:41Z

Description

Most CI tools wait until resources are ready to mark a release as successful. Eg. ArgoCD and Flux
We can emulate this by passing the --wait flag to helm rather than individually adding support for every CD tool out there.
This PR adds this flag to the helm tests as well as some tweaks to support ArgoCD

Context

Users ran into this bug doing ... \ Users needed this feature to ...

See slack conversation here

Interesting decisions

We chose to do things this way because ...

Testing steps

I manually verified behavior by ...

Notes for reviewers

Be sure to verify intended behavior by ...

Please proofread comments on ...

This is a complex PR and may require a huddle to discuss ...

Checklist:

I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works

sam-heilbron

This is awesome!

We also have an upgrade suite, which doesn't run on PRs, but will run nightly and is intended to identify regressions with upgrading from an old version of Gloo to a newer one. Do you think it would be valuable to add this functionality to that suite as well? (example: https://github.com/solo-io/gloo/blob/main/test/kube2e/upgrade/upgrade_test.go#L302)

davidjumani · 2023-09-29T16:36:59Z

install/helm/gloo/templates/19-gloo-mtls-certgen-job.yaml

+{{- /* With ArgoCD, there is no concept or installs or upgrades. Everything is a sync. */}}
+{{- /* This causes an issue when a hook must run on an install but not an upgrade based on a flag. */}}
+{{- /* We address this by creating the job definition for an upgrade only if the flag says so */}}
+{{- /* This is done in the next two lines */}}
+{{- $shouldJobRunOnUpgrade := and .Release.IsUpgrade .Values.gateway.certGenJob.runOnUpdate }}
+{{- if or .Release.IsInstall $shouldJobRunOnUpgrade }}


This would not work as argo doesn't template with --is-install or --is-upgrade. This would be a good callout in the docs that if a user is using ArgoCD and global.glooMtls.enabled=true, it will run on every sync irrespective of the value of gateway.certGenJob.runOnUpdate

github-actions · 2023-09-29T16:44:49Z

Visit the preview URL for this PR (updated for commit ca5e859):

https://gloo-edge--pr8738-helm-wait-u96iay90.web.app

_{(expires Tue, 10 Oct 2023 16:13:44 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 77c2b86e287749579b7ff9cadb81e099042ef677}

davidjumani · 2023-09-29T16:48:26Z

install/helm/gloo/templates/19-gloo-mtls-certgen-job.yaml

+    {{- /* With ArgoCD, there is no concept or installs or upgrades. Everything is a sync. */}}
+    {{- /* Due to this behavour of ArgoCD, the value of `gateway.certGenJob.runOnUpdate` can not be respected and will run on every sync. */}}


This would need to be called out in the docs

Is that something you plan on doing as part of this work?

I've added a reference to this in #8724
There might be other instances which might need to be called out because of the way Argo works
Once I've addressed the issues mentioned in https://github.com/solo-io/solo-projects/issues/5293 we'll have confirmed what works and what doesn't in Argo (or have workarounds available) and can start with the docs

sam-heilbron

Love the comments!

sam-heilbron · 2023-10-03T15:31:34Z

install/helm/gloo/templates/19-gloo-mtls-certgen-job.yaml

+    {{- /* With ArgoCD, there is no concept or installs or upgrades. Everything is a sync. */}}
+    {{- /* Due to this behavour of ArgoCD, the value of `gateway.certGenJob.runOnUpdate` can not be respected and will run on every sync. */}}


Is that something you plan on doing as part of this work?

…8738) * Add --wait to helm tests and other improvements to support CD tools * Adding changelog * Adding upgrade tests * Adding changelog file to new location * Deleting changelog file from old location --------- Co-authored-by: soloio-bulldozer[bot] <48420018+soloio-bulldozer[bot]@users.noreply.github.com> Co-authored-by: changelog-bot <changelog-bot>

…tools (#8742) * Add --wait to helm tests and other improvements to support CD tools (#8738) * Add --wait to helm tests and other improvements to support CD tools * Adding changelog * Adding upgrade tests * Adding changelog file to new location * Deleting changelog file from old location --------- Co-authored-by: soloio-bulldozer[bot] <48420018+soloio-bulldozer[bot]@users.noreply.github.com> Co-authored-by: changelog-bot <changelog-bot> * Move changelog --------- Co-authored-by: soloio-bulldozer[bot] <48420018+soloio-bulldozer[bot]@users.noreply.github.com>

…tools (#8743) * Add --wait to helm tests and other improvements to support CD tools (#8738) * Add --wait to helm tests and other improvements to support CD tools * Adding changelog * Adding upgrade tests * Adding changelog file to new location * Deleting changelog file from old location --------- Co-authored-by: soloio-bulldozer[bot] <48420018+soloio-bulldozer[bot]@users.noreply.github.com> Co-authored-by: changelog-bot <changelog-bot> * Moving changelog --------- Co-authored-by: soloio-bulldozer[bot] <48420018+soloio-bulldozer[bot]@users.noreply.github.com>

…tools (#8744) * Add --wait to helm tests and other improvements to support CD tools (#8738) * Add --wait to helm tests and other improvements to support CD tools * Adding changelog * Adding upgrade tests * Adding changelog file to new location * Deleting changelog file from old location --------- Co-authored-by: soloio-bulldozer[bot] <48420018+soloio-bulldozer[bot]@users.noreply.github.com> Co-authored-by: changelog-bot <changelog-bot> * Moving changelog --------- Co-authored-by: soloio-bulldozer[bot] <48420018+soloio-bulldozer[bot]@users.noreply.github.com>

davidjumani added 2 commits September 29, 2023 12:06

Add --wait to helm tests and other improvements to support CD tools

fa49e23

Adding changelog

5169bd4

github-actions bot added the keep pr updated signals bulldozer to keep pr up to date with base branch label Sep 29, 2023

sam-heilbron reviewed Sep 29, 2023

View reviewed changes

davidjumani commented Sep 29, 2023

View reviewed changes

Adding upgrade tests

648abde

davidjumani commented Sep 29, 2023

View reviewed changes

davidjumani mentioned this pull request Oct 2, 2023

Test ArgoCD installs with Production recommendations for Zero-downtime Gateway rollout #8722

Closed

Merge refs/heads/main into helm-wait

2a5333e

davidjumani mentioned this pull request Oct 2, 2023

fix: custom readiness probe with custom healthCheck path not working #8698

Merged

4 tasks

sam-heilbron previously approved these changes Oct 3, 2023

View reviewed changes

soloio-bulldozer bot and others added 3 commits October 3, 2023 15:33

Merge refs/heads/main into helm-wait

2e929d6

Adding changelog file to new location

9cd4ee5

Deleting changelog file from old location

ca5e859

solo-changelog-bot bot dismissed sam-heilbron’s stale review via ca5e859 October 3, 2023 15:43

davidjumani mentioned this pull request Oct 3, 2023

[WIP] Add argodcd tests #8725

Closed

4 tasks

jenshu approved these changes Oct 3, 2023

View reviewed changes

sam-heilbron approved these changes Oct 3, 2023

View reviewed changes

soloio-bulldozer bot merged commit 55ad3e9 into main Oct 3, 2023
14 checks passed

soloio-bulldozer bot deleted the helm-wait branch October 3, 2023 17:33

davidjumani mentioned this pull request Oct 3, 2023

[1.15] Add --wait to helm tests and other improvements to support CD tools #8742

Merged

4 tasks

davidjumani mentioned this pull request Oct 3, 2023

[1.14] Add --wait to helm tests and other improvements to support CD tools #8743

Merged

4 tasks

davidjumani mentioned this pull request Oct 3, 2023

[1.13] Add --wait to helm tests and other improvements to support CD tools #8744

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add --wait to helm tests and other improvements to support CD tools #8738

Add --wait to helm tests and other improvements to support CD tools #8738

davidjumani commented Sep 29, 2023

sam-heilbron left a comment

davidjumani Sep 29, 2023

github-actions bot commented Sep 29, 2023 •

edited

Loading

davidjumani Sep 29, 2023

sam-heilbron Oct 3, 2023

davidjumani Oct 3, 2023 •

edited

Loading

sam-heilbron left a comment

sam-heilbron Oct 3, 2023

		{{- /* With ArgoCD, there is no concept or installs or upgrades. Everything is a sync. */}}
		{{- /* Due to this behavour of ArgoCD, the value of `gateway.certGenJob.runOnUpdate` can not be respected and will run on every sync. */}}

Add --wait to helm tests and other improvements to support CD tools #8738

Add --wait to helm tests and other improvements to support CD tools #8738

Conversation

davidjumani commented Sep 29, 2023

Description

Context

Interesting decisions

Testing steps

Notes for reviewers

Checklist:

sam-heilbron left a comment

Choose a reason for hiding this comment

davidjumani Sep 29, 2023

Choose a reason for hiding this comment

github-actions bot commented Sep 29, 2023 • edited Loading

davidjumani Sep 29, 2023

Choose a reason for hiding this comment

sam-heilbron Oct 3, 2023

Choose a reason for hiding this comment

davidjumani Oct 3, 2023 • edited Loading

Choose a reason for hiding this comment

sam-heilbron left a comment

Choose a reason for hiding this comment

sam-heilbron Oct 3, 2023

Choose a reason for hiding this comment

github-actions bot commented Sep 29, 2023 •

edited

Loading

davidjumani Oct 3, 2023 •

edited

Loading