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: add 3.6 upgrading notes for postgres archive and ARGO_TEMPLATE #13803

Merged
merged 1 commit into from
Oct 24, 2024

Conversation

Joibel
Copy link
Member

@Joibel Joibel commented Oct 24, 2024

This adds documentation for the breaking changes in #13779 and #13761

Signed-off-by: Alan Clucas <alan@clucas.org>
@Joibel Joibel changed the title docs: upgrading notes (postgres archive and ARGO_TEMPLATE) docs: upgrading notes (postgres archive and ARGO_TEMPLATE) Oct 24, 2024
@Joibel Joibel marked this pull request as ready for review October 24, 2024 08:24
Copy link
Member

@isubasinghe isubasinghe left a comment

Choose a reason for hiding this comment

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

LGTM

@isubasinghe isubasinghe merged commit 2cc6b32 into argoproj:main Oct 24, 2024
17 checks passed
@Joibel Joibel deleted the upgrading-36 branch October 24, 2024 11:24
@agilgur5 agilgur5 changed the title docs: upgrading notes (postgres archive and ARGO_TEMPLATE) docs: add 3.6 upgrading notes for postgres archive and ARGO_TEMPLATE Oct 24, 2024
@agilgur5 agilgur5 added this to the v3.6.0 milestone Oct 24, 2024
@agilgur5 agilgur5 added the area/docs Incorrect, missing, or mistakes in docs label Oct 24, 2024
@@ -2,7 +2,7 @@

> v2.5 and after

If you want to keep completed workflows for a long time, you can use the workflow archive to save them in a Postgres or MySQL (>= 5.7.8) database.
If you want to keep completed workflows for a long time, you can use the workflow archive to save them in a Postgres (>=9.4) or MySQL (>= 5.7.8) database.

Choose a reason for hiding this comment

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

Thanks for adding this 👍 . I mentioned this part of the docs in #13295 (comment) et al too

Copy link

@agilgur5 agilgur5 Oct 24, 2024

Choose a reason for hiding this comment

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

It might be good to add an optional Job to the Helm Charts or within the CLI or manifests that tests for compatibility before a deployment -- i.e. min postgres, mysql, and k8s versions as all the external deps. We had these kinds of "compatibility tests" this for many flexible charts we had at my last job (esp for things that often version conflicted, like Kubeflow's deps on older Argo or older Istio)

Comment on lines +107 to +108
The environment variable `ARGO_TEMPLATE` which is an internal implementation detail is no longer available inside the `main` container of your workflow pods.
This is documented here as we are aware that some users of Argo Workflows use this.
Copy link

@agilgur5 agilgur5 Oct 24, 2024

Choose a reason for hiding this comment

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

Suggested change
The environment variable `ARGO_TEMPLATE` which is an internal implementation detail is no longer available inside the `main` container of your workflow pods.
This is documented here as we are aware that some users of Argo Workflows use this.
The environment variable `ARGO_TEMPLATE` is no longer available inside the `main` container of your workflow pods.
This is an internal implementation detail, but is documented here as we are aware that some Argo users have utilized this.
  • Clarify by modifying the sentence structure a bit - 1 sentence for the change, the other sentence for the internal piece
    • also, without commas surrounding it, "which is an internal implementation detail" is grammatically incorrect
  • The docs conventionally refer to "Argo Workflows" as "Argo", which I've noted in various places elsewhere too

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Incorrect, missing, or mistakes in docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants