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

[CI:DOCS] Clarify secret target behavior #16743

Merged
merged 1 commit into from
Dec 9, 2022

Conversation

ashley-cui
Copy link
Member

Add documentation on how the the target option works when adding a secret to a container

Signed-off-by: Ashley Cui [email protected]

Closes: #16649

Does this PR introduce a user-facing change?

None

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Dec 5, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ashley-cui

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 5, 2022
@ashley-cui ashley-cui force-pushed the secdocs branch 2 times, most recently from 9ac5ca5 to 444c41a Compare December 5, 2022 16:11
- `uid=0` : UID of secret. Defaults to 0. Mount secret type only.
- `gid=0` : GID of secret. Defaults to 0. Mount secret type only.
- `mode=0` : Mode of secret. Defaults to 0444. Mount secret type only.


Examples
Copy link
Member

Choose a reason for hiding this comment

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

Usually we do a ## before this, and surround individual examples with triple-backticks

Copy link
Member Author

Choose a reason for hiding this comment

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

Changed the triple backticks! I think this is under a #### section for in a flag doc though, so I think leaving Examples as-is might be the move?

@ashley-cui
Copy link
Member Author

@containers/podman-maintainers PTAL

Copy link
Member

@vrothberg vrothberg left a comment

Choose a reason for hiding this comment

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

Just a nit to explain the values.

Other than that, LGTM

docs/source/markdown/options/secret.md Outdated Show resolved Hide resolved
Add documentation on how the the target option works when adding a secret to a container

Signed-off-by: Ashley Cui <[email protected]>
@ashley-cui
Copy link
Member Author

@containers/podman-maintainers PTAL

@rhatdan
Copy link
Member

rhatdan commented Dec 9, 2022

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Dec 9, 2022
@openshift-merge-robot openshift-merge-robot merged commit 6f1bc98 into containers:main Dec 9, 2022
@ashley-cui ashley-cui deleted the secdocs branch February 9, 2023 20:10
@github-actions github-actions bot added the locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. label Sep 10, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 10, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. release-note-none
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS REQUEST] Mount secret at different location
5 participants