github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-04-30 04:34:27 +00:00
Code Issues Projects Releases Wiki Activity

config: Add better comments in the template files

Browse Source 
When there is a default value from the code (usually empty) that
differs from a possible suggested value from the distro, then the
wording "default: empty" is confusing.

Fixes: #901

Suggested-by: Julio Montes <julio.montes@intel.com>
Signed-off-by: Christophe de Dinechin <dinechin@redhat.com>
This commit is contained in:
Christophe de Dinechin 2020-09-03 13:42:12 +02:00
parent 7c6aede5d4
commit d65a7d1083
5 changed files with 47 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/runtime/cli/config/configuration-acrn.toml.in
View File

@ -21,11 +21,15 @@ image = "@IMAGEPATH@"
# of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path" # of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path"
enable_annotations = @DEFENABLEANNOTATIONS@ enable_annotations = @DEFENABLEANNOTATIONS@
# List of valid annotations values for the hypervisor (default: empty) # List of valid annotations values for the hypervisor
# Each member of the list is a path pattern as described by glob(3). # Each member of the list is a path pattern as described by glob(3).
# The default if not set is empty (all annotations rejected.)
# Your distribution recommends: @ACRNPATHLIST@
path_list = @ACRNPATHLIST@ path_list = @ACRNPATHLIST@
# List of valid annotations values for ctlpath (default: empty) # List of valid annotations values for ctlpath
# The default if not set is empty (all annotations rejected.)
# Your distribution recommends: @ACRNCTLPATHLIST@
ctlpath_list = @ACRNCTLPATHLIST@ ctlpath_list = @ACRNCTLPATHLIST@
# Optional space-separated list of options to pass to the guest kernel. # Optional space-separated list of options to pass to the guest kernel.

8
src/runtime/cli/config/configuration-clh.toml.in
View File

@ -20,8 +20,10 @@ image = "@IMAGEPATH@"
# of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path" # of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path"
enable_annotations = @DEFENABLEANNOTATIONS@ enable_annotations = @DEFENABLEANNOTATIONS@
# List of valid annotations values for the hypervisor (default: empty) # List of valid annotations values for the hypervisor
# Each member of the list is a path pattern as described by glob(3). # Each member of the list is a path pattern as described by glob(3).
# The default if not set is empty (all annotations rejected.)
# Your distribution recommends: @CLHPATHLIST@
path_list = @CLHPATHLIST@ path_list = @CLHPATHLIST@
# Optional space-separated list of options to pass to the guest kernel. # Optional space-separated list of options to pass to the guest kernel.
@ -71,7 +73,9 @@ default_memory = @DEFMEMSZ@
# Path to vhost-user-fs daemon. # Path to vhost-user-fs daemon.
virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@" virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@"
# List of valid annotations values for the virtiofs daemon (default: empty) # List of valid annotations values for the virtiofs daemon
# The default if not set is empty (all annotations rejected.)
# Your distribution recommends: @DEFVIRTIOFSDAEMONLIST@
virtio_fs_daemon_list = @DEFVIRTIOFSDAEMONLIST@ virtio_fs_daemon_list = @DEFVIRTIOFSDAEMONLIST@
# Default size of DAX cache in MiB # Default size of DAX cache in MiB

10
src/runtime/cli/config/configuration-fc.toml.in
View File

@ -20,8 +20,10 @@ image = "@IMAGEPATH@"
# of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path" # of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path"
enable_annotations = @DEFENABLEANNOTATIONS@ enable_annotations = @DEFENABLEANNOTATIONS@
# List of valid annotations values for the hypervisor (default: empty) # List of valid annotations values for the hypervisor
# Each member of the list is a path pattern as described by glob(3). # Each member of the list is a path pattern as described by glob(3).
# The default if not set is empty (all annotations rejected.)
# Your distribution recommends: @FCPATHLIST@
path_list = @FCPATHLIST@ path_list = @FCPATHLIST@
# Path for the jailer specific to firecracker # Path for the jailer specific to firecracker
@ -32,9 +34,11 @@ path_list = @FCPATHLIST@
# for this feature today. # for this feature today.
#jailer_path = "@FCJAILERPATH@" #jailer_path = "@FCJAILERPATH@"
# List of valid jailer path values for the hypervisor (default: empty) # List of valid jailer path values for the hypervisor
# Each member of the list can be a regular expression # Each member of the list can be a regular expression
# jailer_path_list = @FCJAILERPATHLIST@ # The default if not set is empty (all annotations rejected.)
# Your distribution recommends: @FCJAILERPATHLIST@
jailer_path_list = @FCJAILERPATHLIST@
# Optional space-separated list of options to pass to the guest kernel. # Optional space-separated list of options to pass to the guest kernel.

20
src/runtime/cli/config/configuration-qemu-virtiofs.toml.in
View File

@ -19,10 +19,14 @@ machine_type = "@MACHINETYPE@"
# List of valid annotation names for the hypervisor # List of valid annotation names for the hypervisor
# Each member of the list is a regular expression, which is the base name # Each member of the list is a regular expression, which is the base name
# of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path" # of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path"
# The default if not set is empty (all annotations rejected.)
# Your distribution recommends: @DEFENABLEANNOTATIONS@
enable_annotations = @DEFENABLEANNOTATIONS@ enable_annotations = @DEFENABLEANNOTATIONS@
# List of valid annotations values for the hypervisor (default: empty) # List of valid annotations values for the hypervisor
# Each member of the list is a path pattern as described by glob(3). # Each member of the list is a path pattern as described by glob(3).
# The default if not set is empty (all annotations rejected.)
# Your distribution recommends: @QEMUVIRTIOFSPATHLIST@
path_list = @QEMUVIRTIOFSPATHLIST@ path_list = @QEMUVIRTIOFSPATHLIST@
# Optional space-separated list of options to pass to the guest kernel. # Optional space-separated list of options to pass to the guest kernel.
@ -119,7 +123,9 @@ shared_fs = "@DEFSHAREDFS_QEMU_VIRTIOFS@"
# Path to vhost-user-fs daemon. # Path to vhost-user-fs daemon.
virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@" virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@"
# List of valid annotations values for the virtiofs daemon (default: empty) # List of valid annotations values for the virtiofs daemon
# The default if not set is empty (all annotations rejected.)
# Your distribution recommends: @DEFVIRTIOFSDAEMONLIST@
virtio_fs_daemon_list = @DEFVIRTIOFSDAEMONLIST@ virtio_fs_daemon_list = @DEFVIRTIOFSDAEMONLIST@
# Default size of DAX cache in MiB # Default size of DAX cache in MiB
@ -211,7 +217,9 @@ vhost_user_store_path = "@DEFVHOSTUSERSTOREPATH@"
# Enabling this will result in the VM device having iommu_platform=on set # Enabling this will result in the VM device having iommu_platform=on set
#enable_iommu_platform = true #enable_iommu_platform = true
# List of valid annotations values for the virtiofs daemon (default: empty) # List of valid annotations values for the virtiofs daemon
# The default if not set is empty (all annotations rejected.)
# Your distribution recommends: @DEFVHOSTUSERSTOREPATHLIST@
vhost_user_store_path_list = @DEFVHOSTUSERSTOREPATHLIST@ vhost_user_store_path_list = @DEFVHOSTUSERSTOREPATHLIST@
# Enable file based guest memory support. The default is an empty string which # Enable file based guest memory support. The default is an empty string which
@ -220,8 +228,10 @@ vhost_user_store_path_list = @DEFVHOSTUSERSTOREPATHLIST@
# This option will be ignored if VM templating is enabled. # This option will be ignored if VM templating is enabled.
#file_mem_backend = "@DEFFILEMEMBACKEND@" #file_mem_backend = "@DEFFILEMEMBACKEND@"
# List of valid annotations values for the file_mem_backend annotation (default: empty) # List of valid annotations values for the file_mem_backend annotation
#file_mem_backend_list = @DEFFILEMEMBACKENDLIST@ # The default if not set is empty (all annotations rejected.)
# Your distribution recommends: @DEFFILEMEMBACKENDLIST@
file_mem_backend_list = @DEFFILEMEMBACKENDLIST@
# Enable swap of vm memory. Default false. # Enable swap of vm memory. Default false.
# The behaviour is undefined if mem_prealloc is also set to true # The behaviour is undefined if mem_prealloc is also set to true

18
src/runtime/cli/config/configuration-qemu.toml.in
View File

@ -21,8 +21,10 @@ machine_type = "@MACHINETYPE@"
# of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path" # of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path"
enable_annotations = @DEFENABLEANNOTATIONS@ enable_annotations = @DEFENABLEANNOTATIONS@
# List of valid annotations values for the hypervisor (default: empty) # List of valid annotations values for the hypervisor
# Each member of the list is a path pattern as described by glob(3). # Each member of the list is a path pattern as described by glob(3).
# The default if not set is empty (all annotations rejected.)
# Your distribution recommends: @QEMUPATHLIST@
path_list = @QEMUPATHLIST@ path_list = @QEMUPATHLIST@
# Optional space-separated list of options to pass to the guest kernel. # Optional space-separated list of options to pass to the guest kernel.
@ -125,7 +127,9 @@ shared_fs = "@DEFSHAREDFS@"
# Path to vhost-user-fs daemon. # Path to vhost-user-fs daemon.
virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@" virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@"
# List of valid annotations values for the virtiofs daemon (default: empty) # List of valid annotations values for the virtiofs daemon
# The default if not set is empty (all annotations rejected.)
# Your distribution recommends: @DEFVIRTIOFSDAEMONLIST@
virtio_fs_daemon_list = @DEFVIRTIOFSDAEMONLIST@ virtio_fs_daemon_list = @DEFVIRTIOFSDAEMONLIST@
# Default size of DAX cache in MiB # Default size of DAX cache in MiB
@ -217,7 +221,9 @@ vhost_user_store_path = "@DEFVHOSTUSERSTOREPATH@"
# Enabling this will result in the VM device having iommu_platform=on set # Enabling this will result in the VM device having iommu_platform=on set
#enable_iommu_platform = true #enable_iommu_platform = true
# List of valid annotations values for the vhost user store path (default: empty) # List of valid annotations values for the vhost user store path
# The default if not set is empty (all annotations rejected.)
# Your distribution recommends: @DEFVHOSTUSERSTOREPATHLIST@
vhost_user_store_path_list = @DEFVHOSTUSERSTOREPATHLIST@ vhost_user_store_path_list = @DEFVHOSTUSERSTOREPATHLIST@
# Enable file based guest memory support. The default is an empty string which # Enable file based guest memory support. The default is an empty string which
@ -226,8 +232,10 @@ vhost_user_store_path_list = @DEFVHOSTUSERSTOREPATHLIST@
# This option will be ignored if VM templating is enabled. # This option will be ignored if VM templating is enabled.
#file_mem_backend = "@DEFFILEMEMBACKEND@" #file_mem_backend = "@DEFFILEMEMBACKEND@"
# List of valid annotations values for the file_mem_backend annotation (default: empty) # List of valid annotations values for the file_mem_backend annotation
#file_mem_backend_list = @DEFFILEMEMBACKENDLIST@ # The default if not set is empty (all annotations rejected.)
# Your distribution recommends: @DEFFILEMEMBACKENDLIST@
file_mem_backend_list = @DEFFILEMEMBACKENDLIST@
# Enable swap of vm memory. Default false. # Enable swap of vm memory. Default false.
# The behaviour is undefined if mem_prealloc is also set to true # The behaviour is undefined if mem_prealloc is also set to true