kubernetes.api
Description Type submodule
Default { }Declared in modules/k8s.nix kubernetes.api.defaults
Description Kubernetes defaults to apply to resources Type list of (submodule)
Default [ ]Declared in modules/k8s.nix kubernetes.api.defaults.*.default
Description Default to apply Type unspecified value
Default { }Declared in modules/k8s.nix kubernetes.api.defaults.*.group
Description Group to apply default to (all by default) Type null or string
Default nullDeclared in modules/k8s.nix kubernetes.api.defaults.*.kind
Description Kind to apply default to (all by default) Type null or string
Default nullDeclared in modules/k8s.nix kubernetes.api.defaults.*.propagate
Description Whether to propagate defaults Type boolean
Default falseDeclared in modules/k8s.nix kubernetes.api.defaults.*.resource
Description Resource to apply default to (all by default) Type null or string
Default nullDeclared in modules/k8s.nix kubernetes.api.defaults.*.version
Description Version to apply default to (all by default) Type null or string
Default nullDeclared in modules/k8s.nix kubernetes.api.definitions
Description Attribute set of kubernetes definitions Type unspecified value
Default Declared in modules/k8s.nix kubernetes.api.types
Description List of registered kubernetes types Type attribute set of (submodule) or list of (submodule)
Default { }Declared in modules/k8s.nix kubernetes.api.types.<name>.attrName
Description Name of the nixified attribute Type string
Default Declared in modules/k8s.nix kubernetes.api.types.<name>.group
Description Resource type group Type string
Default Declared in modules/k8s.nix kubernetes.api.types.<name>.kind
Description Resource type kind Type string
Default Declared in modules/k8s.nix kubernetes.api.types.<name>.name
Description Resource type name Type null or string
Default Declared in modules/k8s.nix kubernetes.api.types.<name>.version
Description Resoruce type version Type string
Default Declared in modules/k8s.nix kubernetes.customResources
Description Setup custom resources Type list of (attribute set)
Default [ ]Declared in modules/k8s.nix kubernetes.customTypes
Description Custom 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 in modules/k8s.nix kubernetes.customTypes.<name>.attrName
Description Name of the nixified attribute Type string
Default Declared in modules/k8s.nix kubernetes.customTypes.<name>.description
Description Custom type description Type string
Default ""Declared in modules/k8s.nix kubernetes.customTypes.<name>.group
Description Custom type group Type string
Default Example "helm.cattle.io"Declared in modules/k8s.nix kubernetes.customTypes.<name>.kind
Description Custom type kind Type string
Default Example "HelmChartConfig"Declared in modules/k8s.nix kubernetes.customTypes.<name>.module
Description Custom type module Type unspecified value
Default { }Declared in modules/k8s.nix kubernetes.customTypes.<name>.name
Description Custom type resource name Type null or string
Default nullDeclared in modules/k8s.nix kubernetes.customTypes.<name>.version
Description Custom type version Type string
Default Example "v1"Declared in modules/k8s.nix kubernetes.enableHashedNames
Description Enable hashing of resource (ConfigMap,Secret) names Type boolean
Default falseDeclared in modules/k8s.nix kubernetes.generated
Description Generated kubernetes list object Type attribute set
Default Declared in modules/k8s.nix kubernetes.imports
Description List of resources to import Type list of (package or path)
Default [ ]Declared in modules/k8s.nix kubernetes.kubeconfig
Description path to kubeconfig file (default: use $KUBECONFIG) Type null or string
Default nullExample "/run/secrets/kubeconfig"Declared in modules/k8s.nix kubernetes.namespace
Description Default namespace where to deploy kubernetes resources Type null or string
Default nullExample "default"Declared in modules/k8s.nix kubernetes.objects
Description List of generated kubernetes objects Type list of (attribute set)
Default [ ]Declared in modules/k8s.nix kubernetes.resourceOrder
Description Preffered resource order Type list of string
Default [
"CustomResourceDefinition"
"Namespace"
]Declared in modules/k8s.nix kubernetes.resources
Description Alias for `config.kubernetes.api.resources` options Type attribute set of (attribute set)
Default { }Declared in modules/k8s.nix kubernetes.result
Description Generated kubernetes JSON file Type package
Default Declared in modules/k8s.nix kubernetes.resultYAML
Description Genrated kubernetes YAML file Type package
Default Declared in modules/k8s.nix kubernetes.version
Description Kubernetes version to use Type one of "1.19", "1.20", "1.21", "1.22", "1.23", "1.24", "1.25", "1.26", "1.27"
Default "1.27"Example "1.24"Declared in modules/k8s.nix
Kubernetes