-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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: clarify + improve Workflow Restrictions page #11807
Merged
terrytangyuan
merged 5 commits into
argoproj:master
from
agilgur5:docs-clarify-workflow-restrictions
Oct 20, 2023
Merged
docs: clarify + improve Workflow Restrictions page #11807
terrytangyuan
merged 5 commits into
argoproj:master
from
agilgur5:docs-clarify-workflow-restrictions
Oct 20, 2023
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- clarify what `Secure` means by "between operations" and "enforce" - a number of people, including me, have been confused by the ambiguous language before - see current Workflow Restrictions feature code, specifically, [`MustNotChangeSpec` function](https://github.com/argoproj/argo-workflows/blob/6399ac70619ff037793b773d44131c7a1f9e7fb6/config/config.go#L292) - if a Workflow `MustNotChangeSpec`, then it will be [marked as errored](https://github.com/argoproj/argo-workflows/blob/bcb5a3e0e984727947ae132ba712c27cc0ec82c2/workflow/controller/operator.go#L3844) if its underlying WorkflowTemplate changes during execution - marking the Workflow as errored [stops it](https://github.com/argoproj/argo-workflows/blob/2f5af0ab21463aeb250aa6f1a31cca522aec7408/workflow/controller/operator.go#L2239) - clarify that `Secure` is a superset of `Strict` by rewording to say "Same as `Strict` _plus_ [...]" - [`MustUseRference`](https://github.com/argoproj/argo-workflows/blob/bcb5a3e0e984727947ae132ba712c27cc0ec82c2/config/config.go#L285) checks for _either_ `Secure` or `Strict` - remove duplicate language on arbitrary Workflows that was uniquely worded and made it seem like `Secure` acted differently (it does not other than the one additional feature) - change the example to use `Strict` because it only uses that feature and does not specify a reason to use `Secure` - makes it less confusing about that the overlap. `Secure` is a strict superset - clarify the word "limiting" by instead saying "disallowing" - with `templateRestrictions`, you _must_ use a `workflowTemplateRef` with _no_ exceptions - use simpler and more direct language, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language) - use active voice, [per k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-active-voice) - consistently refer to the reader as "you", [per k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#address-the-reader-as-you) - previously the doc referred to the admin as you initially, but then refers to the admin again in third-person - also consistently use "users" instead of "users" and then "operators", which made it very ambiguous who the subject was Signed-off-by: Anton Gilgur <[email protected]>
Signed-off-by: Anton Gilgur <[email protected]>
- surprised these weren't already in there Signed-off-by: Anton Gilgur <[email protected]>
Unrelated unit test failure. If that's a flake, I actually haven't seen that one before -- might be an actual race error, but not sure as the test diff is really hard to read. Will need a CI retry 😕 |
Unit test failure should have been fixed by #11816, so merged |
jmeridth
approved these changes
Oct 16, 2023
juliev0
approved these changes
Oct 19, 2023
terrytangyuan
approved these changes
Oct 20, 2023
ah I need to merge |
agilgur5
added a commit
that referenced
this pull request
May 4, 2024
Signed-off-by: Anton Gilgur <[email protected]> (cherry picked from commit b38c6fd)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
A number of people, including me, have been confused by the ambiguous language on this page.
Modifications
clarify what
Secure
means by "between operations" and "enforce"MustNotChangeSpec
functionMustNotChangeSpec
, then it will be marked as errored if its underlying WorkflowTemplate changes during executionclarify that
Secure
is a superset ofStrict
by rewording to say "Same asStrict
plus [...]"MustUseRference
checks for eitherSecure
orStrict
Secure
acted differently (it does not other than the one additional feature)Strict
because it only uses that feature and does not specify a reason to useSecure
Secure
is a strict supersetclarify the word "limiting" by instead saying "disallowing"
templateRestrictions
, you must use aworkflowTemplateRef
with no exceptionsuse simpler and more direct language, per k8s style guide
use active voice, per k8s style guide
consistently refer to the reader as "you", per k8s style guide
Verification
n/a