Add docs tags to acceptance test #256
Merged
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
JakeSCahill
requested review from
RafalKorepta,
chrisseto and
andrewstucki
as code owners
|
|
| Given there is no user "jason" in cluster "sasl" | ||
| And there are already the following ACLs in cluster "sasl": | ||
| | user | acls | | ||
| | jason | [{"type":"allow","resource":{"type":"cluster"},"operations":["Read"]}] | | ||
| When I apply Kubernetes manifest: | ||
| """ | ||
| # tag::manage-authn-only-manifest[] | ||
| # In this example manifest, a user called "jason" is created in a cluster called "sasl". | ||
| # The user's password is defined in a Secret called "jason-password". |
There was a problem hiding this comment.
Can this sentence be more specific as behavior would be different based on the Secret created apriori the User custom resource.
- If Secret exist and key exist within that Secret that password would be used.
- If Secret exist but key does not exist then Secret is updated with autogenerated password.
- If Secret does not exist Secret with that key is created with autogenerated password.
@andrewstucki Maybe we should create more test cases to expose/show behavior?
There was a problem hiding this comment.
oh, nice! I didn't know about 2 and 3 👀
RafalKorepta
approved these changes
Sep 26, 2024
Co-authored-by: Rafal Korepta <[email protected]>
JakeSCahill
commented
Sep 26, 2024
4 tasks
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.
Adds Asciidoc tagged regions to the user acceptance tests in code comments to allow docs to display the example manifests.
A GitHub Action defined in redpanda-data/docs#773 will pull all files in the
acceptance/featuresdirectory into the docs repository whenever a change occurs or a run is triggered manually.For an example of how these tags get used, see:
https://github.com/redpanda-data/docs/blob/6bc505bf00d0a6653748b408b4850cde0c29e57b/modules/manage/pages/kubernetes/security/authentication/k-user-controller.adoc?plain=1#L36