gufo.thor.config

Config data structures.

CliConfig dataclass

Bases: object

Config populated during runtime.

Should not be set by user. Populated from CLI options.

Config dataclass

Bases: object

The Gufo Thor config.

Attributes:

Name	Type	Description
project	Optional[str]	Optional project name used to prefix the services and volumes. If not set - directory name is used. Should be unique within Thor projects on same host.
noc	NocConfig	The noc section of the config.
expose	ExposeConfig	The expose section of the config.
services	Dict[str, ServiceConfig]	The services section of the config.
labs	Dict[str, LabConfig]	The labs section of the config.

default() staticmethod

Generate default config.

Returns:

Type	Description
Config	An Config instance

from_file(path) staticmethod

Read file and return instance of the Config.

Dies if config contains errors.

Parameters:

Name	Type	Description	Default
path	Union[Path, str]	File path.	required

Returns:

Type	Description
Config	Config instance.

from_yaml(data) staticmethod

Parse YAML file and return an instance of the Config.

Dies if config contains errors.

Parameters:

Name	Type	Description	Default
data	str	String containing YAML config.	required

Returns:

Type	Description
Config	An Config instance.

ExposeConfig dataclass

Bases: object

The expose section of the config.

Attributes:

Name	Type	Description
domain_name	str	A domain name through which the NOC's user interface will be accessed in browser.
web	Optional[Listen]	Web listener configuration.
port	Optional[Listen]	An HTTPS port of the NOC's user interface (deprecated).
open_browser	bool	Open browser on startup.

default() staticmethod

Get default ExposeConfig.

Returns:

Type	Description
ExposeConfig	ExposeConfig instance.

from_dict(data) staticmethod

Generate ExposeConfig instance from a dictionary.

Parameters:

Name	Type	Description	Default
data	Dict[str, Any]	Incoming data.	required

Returns:

Type	Description
ExposeConfig	A configured ExposeConfig instance.

IsisLinkProtocolConfig dataclass

Bases: object

ISIS protocol configuration for link.

from_dict(data) staticmethod

Generate IsisLinkProtocolConfig from dict.

Parameters:

Name	Type	Description	Default
data	Dict[str, Any]	Incoming data.	required

Returns:

Type	Description
IsisLinkProtocolConfig	IsisLinkProtocolConfig instance.

LabConfig dataclass

Bases: object

The labs section of the config.

Attributes:

Name	Type	Description
name	str	lab name.
nodes	Dict[str, LabNodeConfig]	Nodes configuration.
pool	Optional[str]	Lab pool.

check()

Check config.

from_dict(name, data) staticmethod

Generate LabConfig instance from a dictionary.

Parameters:

Name	Type	Description	Default
name	str	Lab name.	required
data	Dict[str, Any]	Incoming data.	required

Returns:

Type	Description
LabConfig	A configured LabConfig instance.

LabLinkConfig dataclass

Bases: object

Link item.

from_dict(data) staticmethod

Create link item from config.

LabNodeConfig dataclass

Bases: object

The labs.nodes section of config.

from_dict(name, data) staticmethod

Generate LabNodeConfig from dict.

Parameters:

Name	Type	Description	Default
name	str	Node name.	required
data	Dict[str, Optional[str]]	Incoming data.	required

Returns:

Type	Description
LabNodeConfig	LabNodeConfig instance.

LabNodeSnmpV2cCredentials dataclass

Bases: TypedDict

SNMP v2c Credentials.

LabNodeUserCredentials dataclass

Bases: object

User credentials.

Attributes:

Name	Type	Description
user	str	Local user name.
password	str	Plain-text password.

from_dict(data) staticmethod

Get user credentials from dict.

LinkProtocolConfig

Bases: TypedDict

Protocol settings.

Listen dataclass

Bases: object

Listener configuration.

Used to proxy host's ports into the container.

Accepts formats:

* <port>
* "<port>"
* "<address>:<port>"
* {"port": <port>}
* {"address": "<address>", "port": <port>}

Attributes:

Name	Type	Description
address	str	Listen address.
port	int	Listen port.

docker_compose_port(container_port)

Generate configuration for port forwarding.

Parameters:

Name	Type	Description	Default
container_port	int	Port in the container.	required

Returns:

Type	Description
str	Port configuration for docker compose.

from_dict(data) staticmethod

Generate listener from data.

Parameters:

Name	Type	Description	Default
data	Union[dict[str, Any], int, str]	Incoming data.	required

Returns:

Type	Description
Listen	A configured Listener instance.

NocConfig dataclass

Bases: object

The noc section of the config.

Attributes:

Name	Type	Description
tag	str	NOC image tag
path	Optional[str]	An optional path to the NOC source code. If not empty, image's /opt/nocvwill be replaced with path
custom	Optional[str]	Optional path to the custom, will be mounted in the /opt/noc_custom directory.
installation_name	str	The installation name which will be shown in the interface.
theme	Literal['noc', 'gray']	Web interface theme. One of: noc, gray.
migrate	bool	Run migrations on start
config	Optional[Dict[str, Any]]	User-defined config.

default() staticmethod

Get default NocConfig.

Returns:

Type	Description
NocConfig	NocConfig instance.

from_dict(data) staticmethod

Generate NocConfig instance from a dictionary.

Parameters:

Name	Type	Description	Default
data	Dict[str, Any]	Incoming data.	required

Returns:

Type	Description
NocConfig	A configured NocConfig instance.

PoolAddressConfig dataclass

Bases: object

Pool addresses configuration.

Attributes:

Name	Type	Description
gw	Optional[IPv4Address]	Gateway address for pool-gw.
syslog	Optional[IPv4Address]	Syslog collector address.
trap	Optional[IPv4Address]	SNMP trap address.

from_dict(data) staticmethod

Get addresses config from dict.

iter_used()

Iterate all used addresses.

PoolConfig dataclass

Bases: object

The pools section of config.

Attributes:

Name	Type	Description
name	str	Pool name.
subnet	IPv4Prefix	Allocated subnet.

from_dict(name, data) staticmethod

Generate PoolConfig instance from a dictionary.

Parameters:

Name	Type	Description	Default
name	str	Pool name.	required
data	Dict[str, Any]	Incoming data.	required

Returns:

Type	Description
PoolConfig	A configured PoolConfig instance.

ServiceConfig dataclass

Bases: object

The services section of the config.

Attributes:

Name	Type	Description
tag	Optional[str]	Override noc.tag setting for a service if not empty.
scale	int	Number of concurrently running servers. 0 - disable.

default() staticmethod

Get default ServiceConfig.

from_dict(data) staticmethod

Generate ServiceConfig instance from a dictionary.

Parameters:

Name	Type	Description	Default
data	Dict[str, Any]	Incoming data.	required

Returns:

Type	Description
ServiceConfig	A configured ServiceConfig instance.

get_sample(name)

Get preconfigured config sample by name.

All samples are preserved in samples directory.

Parameters:

Name	Type	Description	Default
name	str	Sample name, without .yml extension.	required

Returns:

Type	Description
str	A string containinng sample code.