add documentation on imagestore and add a warning if set #1695
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
kannon92
force-pushed
the
imageroot-warning
branch
from
b0fb599
to
b405fe6
Compare
flouthoc
reviewed
Aug 25, 2023
docs/containers-storage.conf.5.md
Outdated
| @@ -56,10 +56,13 @@ $ restorecon -R -v /NEWSTORAGEPATH | |||
| A common use case for this field is to provide a local storage directory when user home directories are NFS-mounted (podman does not support container storage over NFS). | |||
|
|
|||
| **imagestore**="" | |||
| image storage path (default is assumed to be same as `graphroot`). | |||
There was a problem hiding this comment.
Ah when I am reading at to me this string looks unnecessary , imagestore is either used or not and if it is used then path must be different from graphRoot.
I think last line is okay.
There was a problem hiding this comment.
Yea I wanted to follow a similar pattern as other values. The first sentence describes what the field is.
There was a problem hiding this comment.
For example, graphroot:
graphroot="" container storage graph dir (default: "/var/lib/containers/storage")
flouthoc
reviewed
Aug 25, 2023
flouthoc
reviewed
Aug 25, 2023
kannon92
force-pushed
the
imageroot-warning
branch
from
b405fe6
to
49bceb8
Compare
kannon92
force-pushed
the
imageroot-warning
branch
from
49bceb8
to
0559809
Compare
rhatdan
reviewed
Aug 28, 2023
docs/containers-storage.conf.5.md
Outdated
| Path of imagestore different from `graphroot`, by default storage library stores all images in `graphroot` but if `imagestore` is provided it will store newly pulled images in provided `imagestore` but will keep using `graphroot` for everything else. If user is using `overlay` driver then images which were already part of `graphroot` will still be accessible ( Internally storage library will mount `graphroot` as an `additionalImageStore` to allow this behaviour ). | ||
|
|
||
| A common use case for this field is for the users who want to split the file-system in different parts i.e disk which stores images vs disk used by the container created by the image. | ||
|
|
||
| Imagestore must be different from `graphroot`. |
There was a problem hiding this comment.
Imagestor, if set, must be different from graphroot.
rhatdan
reviewed
Aug 28, 2023
types/options.go
Outdated
| @@ -179,6 +179,10 @@ func defaultStoreOptionsIsolated(rootless bool, rootlessUID int, storageConf str | |||
| storageOpts.RootlessStoragePath = storagePath | |||
| } | |||
|
|
|||
| if storageOpts.ImageStore != "" && storageOpts.ImageStore == storageOpts.GraphRoot { | |||
| return storageOpts, fmt.Errorf("imagestore if set must be a different location than graphroot") | |||
There was a problem hiding this comment.
It is set, o error should be.
return fmt..Errorf("imagestore %s must either be not set or be different then graphroot", storageOpts.ImageStore)
Signed-off-by: Kevin Hannon <kehannon@redhat.com>
kannon92
force-pushed
the
imageroot-warning
branch
from
0559809
to
91da0c2
Compare
|
LGTM |
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.
Fixes #1694
During testing of imagestore in CRIO, I found this error. Added some documentation and add an error if set to the same value.