Submodules

 

submodules.defaults
DescriptionList of defaults to apply to submodule instances
Type
list of (submodule)
Default
[ ]
Declared inmodules/submodules.nix
submodules.defaults.*.default
DescriptionDefault to apply to submodule instance
Type
unspecified value
Default
{ }
Declared inmodules/submodules.nix
submodules.defaults.*.features
DescriptionList of features that submodule has to have to apply defaults
Type
list of string
Default
[ ]
Declared inmodules/submodules.nix
submodules.defaults.*.name
DescriptionName of the submodule to apply defaults for
Type
null or string
Default
null
Declared inmodules/submodules.nix
submodules.defaults.*.tags
DescriptionList of tags to apply defaults for
Type
list of string
Default
[ ]
Declared inmodules/submodules.nix
submodules.defaults.*.version
DescriptionVersion of submodule to apply defaults for. If version starts with “~” it is threated as regex pattern for example “~1.0.*
Type
null or string
Default
null
Declared inmodules/submodules.nix
submodules.imports
DescriptionList of submodule imports
Type
list of ((submodule) or absolute path convertible to it)
Default
[ ]
Declared inmodules/submodules.nix
submodules.imports.*.definition
DescriptionSubmodule definition
Type
attribute set
Default
 
Declared inmodules/submodules.nix
submodules.imports.*.exportAs
DescriptionName under which to register exports
Type
null or string
Default
null
Declared inmodules/submodules.nix
submodules.imports.*.features
DescriptionList of features exposed by submodule
Type
list of string
Default
 
Declared inmodules/submodules.nix
submodules.imports.*.module
DescriptionModule defining submodule
Type
unspecified value
Default
 
Declared inmodules/submodules.nix
submodules.imports.*.modules
DescriptionList of modules defining submodule
Type
list of unspecified value
Default
[ config.module ]
Declared inmodules/submodules.nix
submodules.instances
DescriptionAttribute set of submodule instances
Type
attribute set of (submodule)
Default
{ }
Declared inmodules/submodules.nix
submodules.instances.<name>.args
DescriptionSubmodule arguments (alias of config.submodule.args)
Type
unspecified value
Default
 
Declared inmodules/submodules.nix
submodules.instances.<name>.config
DescriptionN/A
Type
submodule
Default
{ }
Declared inmodules/submodules.nix
submodules.instances.<name>.name
DescriptionSubmodule instance name
Type
string
Default
"‹name›"
Declared inmodules/submodules.nix
submodules.instances.<name>.passthru.enable
DescriptionWhether to passthru submodule resources
Type
boolean
Default
true
Declared inmodules/submodules.nix
submodules.instances.<name>.submodule
DescriptionName of the submodule to use
Type
string
Default
"‹name›"
Declared inmodules/submodules.nix
submodules.instances.<name>.version
DescriptionVersion of submodule to use, if version starts with “~” it is threated as regex pattern for example “~1.0.*”
Type
null or string
Default
null
Declared inmodules/submodules.nix
submodules.propagate.enable
DescriptionWhether to propagate defaults and imports from parent to child
Type
boolean
Default
true
Declared inmodules/submodules.nix
submodules.specialArgs
DescriptionSpecial args to pass to submodules. These arguments can be used for imports
Type
attribute set
Default
{ }
Declared inmodules/submodules.nix