Config
Config custom resource schema.
The Config CRD holds cluster-wide defaults applied when Nodes do not reference an explicit
LauncherProfile.
Config
SPEC
ConfigSpec is the spec for a Config resource.
-
Deployment holds clabernetes deployment related configuration settings.
-
ContainerlabDebug sets the
--debugflag when invoking containerlab in the launcher pods. This is disabled by default. -
ContainerlabTimeout sets the
--timeoutflag when invoking containerlab in the launcher pods. -
ContainerlabVersion sets a custom version to use for containerlab -- when set this will cause the launcher pods to download and use this specific version of containerlab. Setting a bad version (version that doesn't exist/typo/etc.) will cause pods to fail to launch, so be careful! You never "need" to this as the publicly available launcher image will always be built with a (reasonably) up to date containerlab version, this setting exists in case you want to pin back to an older version for some reason or you want to be bleeding edge with some new feature (but do note that just because it exists in containerlab doesn't necessarily mean it will be auto-working in clabernetes! 0.78.0 is the floor -- the Node vocabulary includes fields older releases reject outright.
-
ExtraEnv is a list of additional environment variables to set on the launcher container. The values here are applied to all launchers since this is the global config after all!
-
EnvVar represents an environment variable present in a Container.
-
Name of the environment variable. May consist of any printable ASCII characters except '='.
-
Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
-
Source for the environment variable's value. Cannot be used if value is not empty.
-
Selects a key of a ConfigMap.
-
The key to select.
-
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
default: "" -
Specify whether the ConfigMap or its key must be defined
-
-
Selects a field of the pod: supports metadata.name, metadata.namespace,
metadata.labels['<KEY>'],metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.-
Version of the schema the FieldPath is written in terms of, defaults to "v1".
-
Path of the field to select in the specified API version.
-
-
FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.
-
The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except '='. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.
-
Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod's containers.
If optional is set to false and the specified key does not exist, an error will be returned during Pod creation.
default: false -
The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'.
-
The name of the volume mount containing the env file.
-
-
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
-
Container name: required for volumes, optional for env vars
-
Specifies the output format of the exposed resources, defaults to "1"
-
Required: resource to select
-
-
Selects a key of a secret in the pod's namespace
-
The key of the secret to select from. Must be a valid secret key.
-
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
default: "" -
Specify whether the Secret or its key must be defined
-
-
-
-
-
LauncherImage sets the default launcher image to use when spawning launcher deployments.
default: "ghcr.io/clabernetes/clabernetes/clabernetes-launcher:latest" -
LauncherImagePullPolicy sets the default launcher image pull policy to use when spawning launcher deployments.
default: "IfNotPresent"enum: "IfNotPresent", "Always", "Never" -
LauncherLogLevel sets the launcher clabernetes worker log level -- this overrides whatever is set on the controllers env vars for this topology. Note: omitempty because empty str does not satisfy enum of course.
enum: "disabled", "critical", "warn", +2 more -
NodeSelectorsByImage is a mapping of image glob pattern as key and node selectors (value) to apply to each deployment. Note that in case of multiple matches, the longest (with most characters) will take precedence. A config example: { "internal.io/nokia_sros*": {"node-flavour": "baremetal"}, "ghcr.io/nokia/srlinux*": {"node-flavour": "amd64"}, "default": {"node-flavour": "cheap"}, }.
-
PrivilegedLauncher, when true, sets the launcher containers to privileged. By default, we do our best to not need this/set this, and instead set only the capabilities we need, however its possible that some containers launched by the launcher may need/want more capabilities, so this flag exists for users to bypass the default settings and enable fully privileged launcher pods.
-
ResourcesByContainerlabKind is a mapping of container lab kind -> type -> default resource settings. Note that a key value of "default" in the inner map will apply the given resources for any pod of that containerlab kind. For example: { "srl": { "default": DEFAULT RESOURCES FOR KIND "srl", "ixr10": RESOURCES FOR KIND "srl", TYPE "ixr10" } Given resources as above, a containerlab node of kind "srl" and "type" ixr10" would get the specific resources as allocated in the ixr10 key, whereas a containerlab kind of "srl" and "type" unset or "ixr6" would get the "default" resource settings. To apply global default resources, regardless of containerlab kind/type, use the
resourcesDefaultfield.-
Schema for additional map entries.
-
ResourceRequirements describes the compute resource requirements.
-
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This field depends on the DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
-
ResourceClaim references one entry in PodSpec.ResourceClaims.
-
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
-
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
-
-
-
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
-
Schema for additional map entries.
-
-
-
-
-
ResourcesDefault is the default set of resources for clabernetes launcher pods. This is used only as a last option if a Topology does not have resources, and there are no resources for the given containerlab kind/type
-
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This field depends on the DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
-
ResourceClaim references one entry in PodSpec.ResourceClaims.
-
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
-
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
-
-
-
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
-
Schema for additional map entries.
-
-
-
-
ImagePull holds configurations relevant to how clabernetes launcher pods handle pulling images.
-
CRIHostsDir is an optional host directory containing containerd registry hosts configuration. When set and the effective CRI is containerd, the directory is mounted read-only into pull-through launchers both at its original path (so certificate paths rooted in this directory remain valid) and at containerd's conventional certs.d path used by nerdctl.
-
CRIKindOverride allows for overriding the auto discovered cri flavor of the cluster -- this may be useful if we fail to parse the cri kind for some reason, or in mixed cri flavor clusters -- however in the latter case, make sure that if you are using image pull through that clabernetes workloads are only run on the nodes of the cri kind specified here!
enum: "containerd" -
CRISockOverride allows for overriding the path of the CRI sock that is mounted in the launcher pods (if/when image pull through mode is auto or always). This can be useful if, for example, the CRI sock is in a "non-standard" location like K3s which puts the containerd sock at
/run/k3s/containerd/containerd.sockrather than the "normal" (whatever that means) location of/run/containerd/containerd.sock. The value must end with "containerd.sock" for now, in the future maybe crio support will be added. -
DockerConfig allows for setting the docker user (for root) config for all launchers in this topology. The secret must be present in the namespace of this topology. The secret must contain a key "config.json" -- as this secret will be mounted to /root/.docker/config.json and as such wil be utilized when doing docker-y things -- this means you can put auth things in here in the event your cluster doesn't support the preferred image pull through option.
-
DockerDaemonConfig allows for setting a default docker daemon config for launcher pods with the specified secret. The secret must be present in the namespace of any given topology -- so if you are configuring this at the "global config" level, ensure that you are deploying topologies into a specific namespace, or have ensured there is a secret of the given name in every namespace you wish to deploy a topology to. When set, insecure registries config option is ignored as it is assumed you are handling that in the given docker config. Note that the secret must contain a key "daemon.json" -- as this secret will be mounted to /etc/docker and docker will be expecting the config at /etc/docker/daemon.json.
-
PullThroughOverride allows for overriding the image pull through mode for this particular topology.
enum: "auto", "always", "never"
-
-
InClusterDNSSuffix overrides the default in cluster dns suffix used when resolving services.
-
Metadata holds "global" metadata -- that is, metadata that is applied to all objects created by the clabernetes controller.
-
Naming holds the global override for the "naming" setting for Topology objects -- this controls whether the Topology resources have the containerlab topology name as a prefix. Of course this is ignored if a Topology sets its Naming field to something not "global".
default: "prefixed"enum: "prefixed", "non-prefixed"
STATUS
ConfigStatus is the status for a Config resource.