Kubernetes

 

kubernetes.addHashLabel
DescriptionDisable adding ‘kubenix/hash’ label to every object. Note: When disabling this, you may want to use enableHashedNames. See https://github.com/hall/kubenix/pull/33.
Type
boolean
Default
true
Declared inmodules/k8s.nix
kubernetes.api
Description
Type
submodule
Default
{ }
Declared inmodules/k8s.nix
kubernetes.api.defaults
DescriptionKubernetes defaults to apply to resources
Type
list of (submodule)
Default
[ ]
Declared inmodules/k8s.nix
kubernetes.api.defaults.*.default
DescriptionDefault to apply
Type
unspecified value
Default
{ }
Declared inmodules/k8s.nix
kubernetes.api.defaults.*.group
DescriptionGroup to apply default to (all by default)
Type
null or string
Default
null
Declared inmodules/k8s.nix
kubernetes.api.defaults.*.kind
DescriptionKind to apply default to (all by default)
Type
null or string
Default
null
Declared inmodules/k8s.nix
kubernetes.api.defaults.*.propagate
DescriptionWhether to propagate defaults
Type
boolean
Default
false
Declared inmodules/k8s.nix
kubernetes.api.defaults.*.resource
DescriptionResource to apply default to (all by default)
Type
null or string
Default
null
Declared inmodules/k8s.nix
kubernetes.api.defaults.*.version
DescriptionVersion to apply default to (all by default)
Type
null or string
Default
null
Declared inmodules/k8s.nix
kubernetes.api.definitions
DescriptionAttribute set of kubernetes definitions
Type
unspecified value
Default
 
Declared inmodules/k8s.nix
kubernetes.api.types
DescriptionList of registered kubernetes types
Type
attribute set of (submodule) or list of (submodule)
Default
{ }
Declared inmodules/k8s.nix
kubernetes.api.types.<name>.attrName
DescriptionName of the nixified attribute
Type
string
Default
 
Declared inmodules/k8s.nix
kubernetes.api.types.<name>.group
DescriptionResource type group
Type
string
Default
 
Declared inmodules/k8s.nix
kubernetes.api.types.<name>.kind
DescriptionResource type kind
Type
string
Default
 
Declared inmodules/k8s.nix
kubernetes.api.types.<name>.name
DescriptionResource type name
Type
null or string
Default
 
Declared inmodules/k8s.nix
kubernetes.api.types.<name>.version
DescriptionResource type version
Type
string
Default
 
Declared inmodules/k8s.nix
kubernetes.customResources
DescriptionSetup custom resources
Type
list of (attribute set)
Default
[ ]
Declared inmodules/k8s.nix
kubernetes.customTypes
DescriptionCustom resource types to make API for
Type
attribute set of (submodule) or list of (submodule)
Default
{ }
Example
{
  helmchartconfig = {
    attrName = "helmchartconfig";
    group = "helm.cattle.io";
    kind = "HelmChartConfig";
    version = "v1";
  };
}
Declared inmodules/k8s.nix
kubernetes.customTypes.<name>.attrName
DescriptionName of the nixified attribute
Type
string
Default
 
Declared inmodules/k8s.nix
kubernetes.customTypes.<name>.description
DescriptionCustom type description
Type
string
Default
""
Declared inmodules/k8s.nix
kubernetes.customTypes.<name>.group
DescriptionCustom type group
Type
string
Default
 
Example
"helm.cattle.io"
Declared inmodules/k8s.nix
kubernetes.customTypes.<name>.kind
DescriptionCustom type kind
Type
string
Default
 
Example
"HelmChartConfig"
Declared inmodules/k8s.nix
kubernetes.customTypes.<name>.module
DescriptionCustom type module
Type
module
Default
"freeformType = types.attrs"
Declared inmodules/k8s.nix
kubernetes.customTypes.<name>.name
DescriptionCustom type resource name
Type
null or string
Default
null
Declared inmodules/k8s.nix
kubernetes.customTypes.<name>.version
DescriptionCustom type version
Type
string
Default
 
Example
"v1"
Declared inmodules/k8s.nix
kubernetes.customTypesModuleDefinesCRDSpec
DescriptionWhether customTypes.module defines the CRD spec or the whole CRD module
Type
boolean
Default
true
Declared inmodules/k8s.nix
kubernetes.enableHashedNames
DescriptionEnable hashing of resource (ConfigMap,Secret) names
Type
boolean
Default
false
Declared inmodules/k8s.nix
kubernetes.generated
DescriptionGenerated kubernetes list object
Type
attribute set
Default
 
Declared inmodules/k8s.nix
kubernetes.imports
DescriptionList of resources to import
Type
list of (package or absolute path)
Default
[ ]
Declared inmodules/k8s.nix
kubernetes.kubeconfig
Descriptionpath to kubeconfig file (default: use $KUBECONFIG)
Type
null or string
Default
null
Example
"/run/secrets/kubeconfig"
Declared inmodules/k8s.nix
kubernetes.namespace
DescriptionDefault namespace where to deploy kubernetes resources
Type
null or string
Default
null
Example
"default"
Declared inmodules/k8s.nix
kubernetes.objects
DescriptionList of generated kubernetes objects
Type
list of (attribute set)
Default
[ ]
Declared inmodules/k8s.nix
kubernetes.resourceOrder
DescriptionPreferred resource order
Type
list of string
Default
[
  "CustomResourceDefinition"
  "Namespace"
]
Declared inmodules/k8s.nix
kubernetes.resources
DescriptionAlias for config.kubernetes.api.resources options
Type
attribute set of (attribute set)
Default
{ }
Declared inmodules/k8s.nix
kubernetes.result
DescriptionGenerated kubernetes JSON file
Type
package
Default
 
Declared inmodules/k8s.nix
kubernetes.resultYAML
DescriptionGenerated kubernetes YAML file
Type
package
Default
 
Declared inmodules/k8s.nix
kubernetes.version
DescriptionKubernetes version to use
Type
one of "1.19", "1.20", "1.21", "1.22", "1.23", "1.24", "1.25", "1.26", "1.27", "1.28", "1.29", "1.30", "1.31", "1.32", "1.33", "1.34"
Default
"1.34"
Example
"1.24"
Declared inmodules/k8s.nix