package
0.57.0
Repository: https://github.com/srl-labs/containerlab.git
Documentation: pkg.go.dev

# Functions

FilterFromLabelStrings creates a GenericFilter based on the list of label=value pairs or just label entries.
GetWaitForStages returns list of wait for stages that are used to init Waitgroups for all the states.
NewBind creates a new bind mount.
NewHostRequirements is the constructor for new HostRequirements structs.
No description provided by the author
NewStages returns a new Stages instance.
No description provided by the author
NewTopoPaths constructs a new TopoPaths instance.
ParsePullPolicyValue parses the given string and tries to map it to a valid PullPolicyValue.

# Constants

No description provided by the author
env var containing the expected number of interfaces injected into every container.
CommandTypeEnter represents a command to be executed when the node enters the stage.
CommandTypeExit represents a command to be executed when the node exits the stage.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
LicensePolicyNone means a node doesn't care about a license.
LicensePolicyRequired means a node should exit if no license provided.
LicensePolicyWarn means a node should warn (but not exit) if no license provided.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WaitForConfigure is the wait stage name for a node configure stage.
WaitForCreate is the wait stage name for a node creation stage.
WaitForCreateLinks is the wait stage name for a node create-links stage.
WaitForExit is the wait stage name for a node exit stage.
WaitForHealthy is the wait stage name for a node healthy stage.

# Structs

Bind represents a bind mount.
CertificateAuthority is the structure for global containerlab certificate authority settings.
CertificateConfig represents TLS parameters set for a node.
ConfigDispatcher represents the config of a configuration machine that is responsible to execute configuration commands on the nodes after they started.
ContainerDetails contains information that is commonly outputted to tables or graphs.
DNSConfig represents DNS configuration options a node has.
Endpoint is a struct that contains information of a link endpoint.
Execs represents configuration of commands to execute at a given stage.
Extras contains extra node parameters which are not entitled to be part of a generic node config.
No description provided by the author
GenericPortBinding represents a port binding.
HealthcheckConfig represents healthcheck parameters set for a container.
No description provided by the author
K8sKindDeployExtras represents the options used for the kind cluster creation.
K8sKindExtras represents the k8s-kind-specific extra options.
No description provided by the author
Link is a struct that contains the information of a link between 2 containers.
MgmtNet struct defines the management network options.
NodeConfig contains information of a container element.
NodeDefinition represents a configuration a given node can have in the lab definition file.
Settings is the structure for global containerlab settings.
SSHConfig is the SSH client configuration that a clab node requires.
StageBase represents a common configuration stage.
StageConfigure represents a stage of a given node when it enters configuration workflow.
StageCreate represents a creation stage of a given node.
StageCreateLinks represents a stage of a given node when links are getting added to it.
StageExit represents a stage of a given node when the node reaches exit state.
StageHealthy represents a stage of a given node when it reaches healthy status.
Stages represents a configuration of a given node deployment stage.
Topology represents a lab topology.
TopoPaths creates all the required absolute paths and filenames for a topology.
WaitFor represents the wait-for configuration for a node deployment stage.

# Type aliases

No description provided by the author
No description provided by the author
LicensePolicy is a value of LicensePolicy.
No description provided by the author
PullPolicyValue represents Image pull policy values.
WaitForList is a list of WaitFor configurations.
WaitForStage defines the stages that nodes go through during the deployment process.