github.com/kata-containers/tests@v0.0.0-20240307153542-772105b56064/integration/nydus/snapshotter-config.toml (about)

     1  version = 1
     2  # Snapshotter's own home directory where it stores and creates necessary resources
     3  root = "/var/lib/containerd-nydus"
     4  # The snapshotter's GRPC server socket, containerd will connect to plugin on this socket
     5  address = "/run/containerd-nydus/containerd-nydus-grpc.sock"
     6  daemon_mode = "dedicated"
     7  # Whether snapshotter should try to clean up resources when it is closed
     8  cleanup_on_close = false
     9  
    10  [system]
    11  # Snapshotter's debug and trace HTTP server interface
    12  enable = true
    13  # Unix domain socket path where system controller is listening on
    14  address = "/run/containerd-nydus/system.sock"
    15  
    16  [system.debug]
    17  # Snapshotter can profile the CPU utilization of each nydusd daemon when it is being started.
    18  # This option specifies the profile duration when nydusd is downloading and uncomproessing data.
    19  daemon_cpu_profile_duration_secs = 5
    20  # Enable by assigning an address, empty indicates pprof server is disabled
    21  pprof_address = ""
    22  
    23  [daemon]
    24  # Specify a configuration file for nydusd
    25  nydusd_config = "/etc/nydusd-config.json"
    26  nydusd_path = "/usr/local/bin/nydusd"
    27  nydusimage_path = "/usr/local/bin/nydus-image"
    28  # fusedev or fscache
    29  fs_driver = "fusedev"
    30  # How to process when daemon dies: "none", "restart" or "failover"
    31  recover_policy = "restart"
    32  # Nydusd worker thread number to handle FUSE or fscache requests, [0-1024].
    33  # Setting to 0 will use the default configuration of nydusd.
    34  threads_number = 4
    35  # Log rotation size for nydusd, in unit MB(megabytes)
    36  log_rotation_size = 100
    37  
    38  
    39  [cgroup]
    40  # Whether to use separate cgroup for nydusd.
    41  enable = true
    42  # The memory limit for nydusd cgroup, which contains all nydusd processes.
    43  # Percentage is supported as well, please ensure it is end with "%".
    44  # The default unit is bytes. Acceptable values include "209715200", "200MiB", "200Mi" and "10%".
    45  memory_limit = ""
    46  
    47  [log]
    48  # Print logs to stdout rather than logging files
    49  log_to_stdout = false
    50  # Snapshotter's log level
    51  level = "info"
    52  log_rotation_compress = true
    53  log_rotation_local_time = true
    54  # Max number of days to retain logs
    55  log_rotation_max_age = 7
    56  log_rotation_max_backups = 5
    57  # In unit MB(megabytes)
    58  log_rotation_max_size = 100
    59  
    60  [metrics]
    61  # Enable by assigning an address, empty indicates metrics server is disabled
    62  address = ":9110"
    63  
    64  [remote]
    65  convert_vpc_registry = false
    66  
    67  [remote.mirrors_config]
    68  # Snapshotter will overwrite daemon's mirrors configuration
    69  # if the values loaded from this driectory are not null before starting a daemon.
    70  # Set to "" or an empty directory to disable it.
    71  #dir = "/etc/nydus/certs.d"
    72  
    73  [remote.auth]
    74  # Fetch the private registry auth by listening to K8s API server
    75  enable_kubeconfig_keychain = false
    76  # synchronize `kubernetes.io/dockerconfigjson` secret from kubernetes API server with specified kubeconfig (default `$KUBECONFIG` or `~/.kube/config`)
    77  kubeconfig_path = ""
    78  # Fetch the private registry auth as CRI image service proxy
    79  enable_cri_keychain = false
    80  # the target image service when using image proxy
    81  #image_service_address = "/run/containerd/containerd.sock"
    82  
    83  [snapshot]
    84  # Let containerd use nydus-overlayfs mount helper
    85  enable_nydus_overlayfs = true
    86  # Insert Kata Virtual Volume option to `Mount.Options`
    87  enable_kata_volume = false
    88  # Whether to remove resources when a snapshot is removed
    89  sync_remove = false
    90  
    91  [cache_manager]
    92  disable = false
    93  gc_period = "24h"
    94  # Directory to host cached files
    95  cache_dir = ""
    96  
    97  [image]
    98  public_key_file = ""
    99  validate_signature = false
   100  
   101  # The configuraions for features that are not production ready
   102  [experimental]
   103  # Whether to enable stargz support
   104  enable_stargz = false
   105  # Whether to enable referrers support
   106  # The option enables trying to fetch the Nydus image associated with the OCI image and run it.
   107  # Also see https://github.com/opencontainers/distribution-spec/blob/main/spec.md#listing-referrers
   108  enable_referrer_detect = false
   109  [experimental.tarfs]
   110  # Whether to enable nydus tarfs mode. Tarfs is supported by:
   111  # - The EROFS filesystem driver since Linux 6.4
   112  # - Nydus Image Service release v2.3
   113  enable_tarfs = false
   114  # Mount rafs on host by loopdev and EROFS
   115  mount_tarfs_on_host = false
   116  # Only enable nydus tarfs mode for images with `tarfs hint` label when true
   117  tarfs_hint = false
   118  # Maximum of concurrence to converting OCIv1 images to tarfs, 0 means default
   119  max_concurrent_proc = 0
   120  # Mode to export tarfs images:
   121  # - "none" or "": do not export tarfs
   122  # - "layer_verity_only": only generate disk verity information for a layer blob
   123  # - "image_verity_only": only generate disk verity information for all blobs of an image
   124  # - "layer_block": generate a raw block disk image with tarfs for a layer
   125  # - "image_block": generate a raw block disk image with tarfs for an image
   126  # - "layer_block_with_verity": generate a raw block disk image with tarfs for a layer with dm-verity info
   127  # - "image_block_with_verity": generate a raw block disk image with tarfs for an image with dm-verity info
   128  export_mode = ""