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] Describe copy volume options #16991

Merged
merged 1 commit into from
Jan 5, 2023

Conversation

rhatdan
Copy link
Member

@rhatdan rhatdan commented Jan 4, 2023

Fixes: #16961

Signed-off-by: Daniel J Walsh [email protected]

Does this PR introduce a user-facing change?

Improved man pages describing volume options. 

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Jan 4, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rhatdan

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 Jan 4, 2023
@rhatdan
Copy link
Member Author

rhatdan commented Jan 4, 2023

Comment on lines 162 to 163
content when the volume is used on different containers. The **copy** option
is ignored on bind mounts ,`/HOST-DIR`, and has no effect.
Copy link
Member

Choose a reason for hiding this comment

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

The last sentence does not parse. Did you mean something like this?

has no effect on bind mounts or /HOST-DIR

Copy link
Member Author

Choose a reason for hiding this comment

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

Above, we describe the bind mounts based on /HOST-DIR.

   --volume, -v=[[SOURCE-VOLUME|HOST-DIR:]CONTAINER-DIR[:OPTIONS]]
       Create  a bind mount. If -v /HOST-DIR:/CONTAINER-DIR is specified, Podman bind mounts /HOST-DIR from the host into /CONTAINER-DIR in the Podman container. Similarly, -v SOURCE-VOLUME:/CONTAINER-DIR will mount the named volume
       from the host into the container. If no such named volume exists, Podman will create one. If no source is given, the volume will be created as an anonymously named volume with a randomly generated name, and  will  be  removed
       when the container is removed via the --rm flag or the podman rm --volumes command.

So I am trying to bring users attention back to this.

Copy link
Member Author

Choose a reason for hiding this comment

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

Removed since it caused confusion, and adds little value.

@@ -63,7 +63,7 @@ var _ = Describe("Podman run with volumes", func() {
session.WaitWithDefaultTimeout()
Expect(session).Should(Exit(0))

// All files should be in permament store, volatile
// All files should be in permanent store, volatile
Copy link
Member

Choose a reason for hiding this comment

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

Uh, not actually part of this PR, but is there a missing "not" here ("not volatile")? I'm confused about the difference between this comment and the one on line 52.

Copy link
Member Author

Choose a reason for hiding this comment

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

Me too, I just got these by running codespell, since I wanted to make sure I did not add a spelling mistake. I fixes the second one to be not volatile.

@@ -63,7 +63,7 @@ var _ = Describe("Podman run with volumes", func() {
session.WaitWithDefaultTimeout()
Expect(session).Should(Exit(0))

// All files should be in permament store, volatile
// All files should not be in permanent store, not volatile
Copy link
Member

Choose a reason for hiding this comment

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

Now I think there's an extra not?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think they are both needed.
All files should not be in the permanent store, because the program --rm (removed) them.
Also this is not on a volatile store.

Copy link
Member

Choose a reason for hiding this comment

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

I'm having a lot of trouble parsing the comment... but that's beyond the scope of this PR.

@@ -156,6 +156,12 @@ To recursively mount a volume and all of its submounts into a
used, and submounts of the source directory will not be mounted into the
<<container|pod>>.

Mounting the volume with the **copy** options tells podman to copy content from
Copy link
Member

Choose a reason for hiding this comment

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

I think this should be option, singular, not plural. LGTM other than this and the "not" question below.

Fixes: containers#16961

Signed-off-by: Daniel J Walsh <[email protected]>
@edsantiago
Copy link
Member

Restarted networking flake #16973
/lgtm
/hold
I'd still like more eyeballs on this one. @containers/podman-maintainers PTAL

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 4, 2023
@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 4, 2023
@rhatdan
Copy link
Member Author

rhatdan commented Jan 4, 2023

Yes I want to talk to @mheon about this and whether we throw an error if the user attempts to use the copy option with a bind mount.

@umohnani8
Copy link
Member

changes LGTM

@rhatdan
Copy link
Member Author

rhatdan commented Jan 5, 2023

/hold cancel

@openshift-ci openshift-ci bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 5, 2023
@openshift-merge-robot openshift-merge-robot merged commit 8e80c19 into containers:main Jan 5, 2023
@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 16, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 16, 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs imply copy option should work for host directory mounts.
4 participants