containers
/
storage
mirror of https://github.com/containers/storage.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Synchronise documentation for convert_images flag 

Synchronise documentation around the configuration file to accurately
reflect new `convert_images` flag.

Signed-off-by: Ed Baunton <edbaunton@gmail.com>
This commit is contained in:
Ed Baunton 2024-02-16 05:57:41 -05:00
parent 875fc464a3
commit 8f93fc5578
No known key found for this signature in database
2 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/containers-storage.conf.5.md
View File

@ -95,7 +95,7 @@ container registry. These options can deduplicate pulling of content, disk
storage of content and can allow the kernel to use less memory when running storage of content and can allow the kernel to use less memory when running
containers. containers.
containers/storage supports three keys containers/storage supports four keys
* enable_partial_images="true" | "false" * enable_partial_images="true" | "false"
Tells containers/storage to look for files previously pulled in storage Tells containers/storage to look for files previously pulled in storage
rather then always pulling them from the container registry. rather then always pulling them from the container registry.
@ -107,7 +107,7 @@ containers/storage supports three keys
previously pulled content which can be used when attempting to avoid previously pulled content which can be used when attempting to avoid
pulling content from the container registry pulling content from the container registry
* convert_images = "false" | "true" * convert_images = "false" | "true"
If set to true, containers/storage will convert images to the a format compatible with If set to true, containers/storage will convert images to a format compatible with
partial pulls in order to take advantage of local deduplication and hardlinking. It is an partial pulls in order to take advantage of local deduplication and hardlinking. It is an
expensive operation so it is not enabled by default. expensive operation so it is not enabled by default.

7
storage.conf
View File

@ -59,7 +59,7 @@ additionalimagestores = [
# can deduplicate pulling of content, disk storage of content and can allow the # can deduplicate pulling of content, disk storage of content and can allow the
# kernel to use less memory when running containers. # kernel to use less memory when running containers.
# containers/storage supports three keys # containers/storage supports four keys
# * enable_partial_images="true" | "false" # * enable_partial_images="true" | "false"
# Tells containers/storage to look for files previously pulled in storage # Tells containers/storage to look for files previously pulled in storage
# rather then always pulling them from the container registry. # rather then always pulling them from the container registry.
@ -70,6 +70,11 @@ additionalimagestores = [
# Tells containers/storage where an ostree repository exists that might have # Tells containers/storage where an ostree repository exists that might have
# previously pulled content which can be used when attempting to avoid # previously pulled content which can be used when attempting to avoid
# pulling content from the container registry # pulling content from the container registry
# * convert_images = "false" | "true"
# If set to true, containers/storage will convert images to a
# format compatible with partial pulls in order to take advantage
# of local deduplication and hardlinking. It is an expensive
# operation so it is not enabled by default.
pull_options = {enable_partial_images = "true", use_hard_links = "false", ostree_repos=""} pull_options = {enable_partial_images = "true", use_hard_links = "false", ostree_repos=""}
# Remap-UIDs/GIDs is the mapping from UIDs/GIDs as they should appear inside of # Remap-UIDs/GIDs is the mapping from UIDs/GIDs as they should appear inside of