OpenFactory Infrastructure Schemas

Pydantic schemas for validating OpenFactory infrastructure configuration files.

class openfactory.schemas.infra.IPAM(**data)

Bases: BaseModel

IPAM Schema.

config: list[IPAMConfig]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class openfactory.schemas.infra.IPAMConfig(**data)

Bases: BaseModel

IPAM Configuration Schema.

aux_addresses: Optional[Dict[str, str]]

gateway: Optional[str]

ip_range: Optional[str]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

subnet: str

class openfactory.schemas.infra.InfrastructureSchema(**data)

Bases: BaseModel

Infrastructure Schema.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

networks: Optional[Dict[str, Network]]

nodes: Nodes

volumes: Optional[Volumes]

class openfactory.schemas.infra.Managers(root=PydanticUndefined, **data)

Bases: RootModel[Dict[str, Node]]

Docker Swarm Managers Schema.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class openfactory.schemas.infra.Network(**data)

Bases: BaseModel

Network Schema.

ipam: IPAM

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[str]

class openfactory.schemas.infra.Networks(**data)

Bases: BaseModel

Networks Schema.

docker_ingress_network: Network

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

openfactory_network: Network

class openfactory.schemas.infra.Node(**data)

Bases: BaseModel

Docker Swarm Node Schema.

ip: IPv4Address

labels: Optional[Dict[str, str]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class openfactory.schemas.infra.Nodes(**data)

Bases: BaseModel

Docker Swarm Nodes Schema.

classmethod check_unique_ips(values)

Validates that IP addresses are unique across managers and workers.

Return type:

Dict

Parameters:

values (Dict) – Dictionary of values to validate.

Returns:

Dict – Validated values.

Raises:

ValueError – If IP addresses are not unique.

managers: Optional[Dict[str, Node]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

workers: Optional[Dict[str, Node]]

class openfactory.schemas.infra.Volume(**data)

Bases: BaseModel

Volume Schema.

driver_opts: Optional[Dict[str, str]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class openfactory.schemas.infra.Volumes(root=PydanticUndefined, **data)

Bases: RootModel[Dict[str, Union[Volume, NoneType]]]

Volumes Schema.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class openfactory.schemas.infra.Workers(root=PydanticUndefined, **data)

Bases: RootModel[Dict[str, Node]]

Docker Swarm Workers Schema.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

openfactory.schemas.infra.get_infrastructure_from_config_file(infra_yaml_config_file)

Load and validate infrastructure configuration from a YAML file.

This function reads a YAML file containing infrastructure configuration, validates its content using the InfrastructureSchema Pydantic model, and returns the parsed data as a dictionary.

Return type:

Optional[Dict[str, InfrastructureSchema]]

Parameters:

infra_yaml_config_file (str) – Path to the YAML file defining the infrastructure configuration.

Returns:

Optional[Dict[str, InfrastructureSchema]] –

A dictionary of validated infrastructure configuration data,

or None if validation fails.

Note

In case of validation errors, user notifications will be triggered and None will be returned.