orchestro.orche.params package#

Submodules#

orchestro.orche.params.child module#

Functions and routines associated with Enasis Network Orchestrations.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

pydantic model orchestro.orche.params.child.OrcheChildParams[source]#

Bases: OrcheParamsModel

Process and validate the Orche configuration parameters.

Show JSON schema

{
   "title": "OrcheChildParams",
   "description": "Process and validate the Orche configuration parameters.",
   "type": "object",
   "properties": {
      "enable": {
         "default": false,
         "description": "Determine whether child enabled",
         "title": "Enable",
         "type": "boolean"
      },
      "inherits": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Other configuration to inherit",
         "title": "Inherits"
      },
      "display": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Friendly name value for child",
         "title": "Display"
      },
      "memberof": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Groups child is a member of",
         "title": "Memberof"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid

Fields:

display (str | None)
enable (bool)
inherits (list[str] | None)
memberof (list[str] | None)

field display: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Friendly name value for child', metadata=[MinLen(min_length=1)])] = None#

Friendly name value for child

Constraints:

min_length = 1

field enable: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=False, description='Determine whether child enabled')] = False#: Determine whether child enabled

field inherits: Annotated[list[str] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Other configuration to inherit', metadata=[MinLen(min_length=1)])] = None#

Other configuration to inherit

Constraints:

min_length = 1

field memberof: Annotated[list[str] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Groups child is a member of', metadata=[MinLen(min_length=1)])] = None#

Groups child is a member of

Constraints:

min_length = 1

orchestro.orche.params.common module#

Functions and routines associated with Enasis Network Homie Automate.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

pydantic model orchestro.orche.params.common.OrcheParamsModel[source]#

Bases: BaseModel

Process and validate the Homie configuration parameters.

Show JSON schema

{
   "title": "OrcheParamsModel",
   "description": "Process and validate the Homie configuration parameters.",
   "type": "object",
   "properties": {},
   "additionalProperties": false
}

Config:

extra: str = forbid

orchestro.orche.params.group module#

Functions and routines associated with Enasis Network Orchestrations.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

pydantic model orchestro.orche.params.group.OrcheGroupAnsibleParams[source]#

Bases: OrcheParamsModel

Process and validate the Orche configuration parameters.

Show JSON schema

{
   "title": "OrcheGroupAnsibleParams",
   "description": "Process and validate the Orche configuration parameters.",
   "type": "object",
   "properties": {},
   "additionalProperties": true
}

Config:

extra: str = allow

pydantic model orchestro.orche.params.group.OrcheGroupParams[source]#

Bases: OrcheChildParams

Process and validate the Orche configuration parameters.

Show JSON schema

{
   "title": "OrcheGroupParams",
   "description": "Process and validate the Orche configuration parameters.",
   "type": "object",
   "properties": {
      "enable": {
         "default": false,
         "description": "Determine whether child enabled",
         "title": "Enable",
         "type": "boolean"
      },
      "inherits": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Other configuration to inherit",
         "title": "Inherits"
      },
      "display": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Friendly name value for child",
         "title": "Display"
      },
      "memberof": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Groups child is a member of",
         "title": "Memberof"
      },
      "realm": {
         "default": "ansible",
         "description": "Logical realm for the object",
         "enum": [
            "domain",
            "local",
            "site",
            "zone",
            "ansible",
            "psuedo"
         ],
         "title": "Realm",
         "type": "string"
      },
      "ansible": {
         "anyOf": [
            {
               "$ref": "#/$defs/OrcheGroupAnsibleParams"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Variables provided to Ansible"
      }
   },
   "$defs": {
      "OrcheGroupAnsibleParams": {
         "additionalProperties": true,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {},
         "title": "OrcheGroupAnsibleParams",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid

Fields:

ansible (Annotated[orchestro.orche.params.group.OrcheGroupAnsibleParams | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Variables provided to Ansible')])
display (Annotated[Optional[str], Field(None, description='Friendly name value for child', min_length=1)])
enable (Annotated[bool, Field(False, description='Determine whether child enabled')])
inherits (Annotated[Optional[list[str]], Field(None, description='Other configuration to inherit', min_length=1)])
memberof (Annotated[Optional[list[str]], Field(None, description='Groups child is a member of', min_length=1)])
realm (Annotated[Literal['domain', 'local', 'site', 'zone', 'ansible', 'psuedo'], FieldInfo(annotation=NoneType, required=False, default='ansible', description='Logical realm for the object')])

field ansible: Annotated[OrcheGroupAnsibleParams | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Variables provided to Ansible')] = None#: Variables provided to Ansible

field display: Annotated[str | None, Field(None, description='Friendly name value for child', min_length=1)] = None#

Friendly name value for child

Constraints:

min_length = 1

field enable: Annotated[bool, Field(False, description='Determine whether child enabled')] = False#: Determine whether child enabled

field inherits: Annotated[list[str] | None, Field(None, description='Other configuration to inherit', min_length=1)] = None#

Other configuration to inherit

Constraints:

min_length = 1

field memberof: Annotated[list[str] | None, Field(None, description='Groups child is a member of', min_length=1)] = None#

Groups child is a member of

Constraints:

min_length = 1

field realm: Annotated[Literal['domain', 'local', 'site', 'zone', 'ansible', 'psuedo'], FieldInfo(annotation=NoneType, required=False, default='ansible', description='Logical realm for the object')] = 'ansible'#: Logical realm for the object

orchestro.orche.params.orche module#

Functions and routines associated with Enasis Network Orchestrations.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

pydantic model orchestro.orche.params.orche.OrcheParams[source]#

Bases: Params

Process and validate the core configuration parameters.

Show JSON schema

{
   "title": "OrcheParams",
   "description": "Process and validate the core configuration parameters.",
   "type": "object",
   "properties": {
      "enconfig": {
         "anyOf": [
            {
               "$ref": "#/$defs/ConfigParams"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Config instance"
      },
      "enlogger": {
         "anyOf": [
            {
               "$ref": "#/$defs/LoggerParams"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Logger instance"
      },
      "encrypts": {
         "anyOf": [
            {
               "$ref": "#/$defs/CryptsParams"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Crypts instance"
      },
      "database": {
         "default": "sqlite:///:memory:",
         "description": "Database connection string",
         "minLength": 1,
         "title": "Database",
         "type": "string"
      },
      "dryrun": {
         "default": false,
         "description": "Determine if changes applied",
         "title": "Dryrun",
         "type": "boolean"
      },
      "systems": {
         "anyOf": [
            {
               "additionalProperties": {
                  "$ref": "#/$defs/OrcheSystemParams"
               },
               "minProperties": 1,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Orche systems",
         "title": "Systems"
      },
      "persons": {
         "anyOf": [
            {
               "additionalProperties": {
                  "$ref": "#/$defs/OrchePersonParams"
               },
               "minProperties": 1,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Orche persons",
         "title": "Persons"
      },
      "subnets": {
         "anyOf": [
            {
               "additionalProperties": {
                  "$ref": "#/$defs/OrcheSubnetParams"
               },
               "minProperties": 1,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Orche subnets",
         "title": "Subnets"
      },
      "groups": {
         "anyOf": [
            {
               "additionalProperties": {
                  "$ref": "#/$defs/OrcheGroupParams"
               },
               "minProperties": 1,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Orche groups",
         "title": "Groups"
      }
   },
   "$defs": {
      "ConfigParams": {
         "additionalProperties": false,
         "description": "Process and validate the core configuration parameters.",
         "properties": {
            "paths": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Location of configuration files",
               "title": "Paths"
            }
         },
         "title": "ConfigParams",
         "type": "object"
      },
      "CryptParams": {
         "additionalProperties": false,
         "description": "Process and validate the core configuration parameters.",
         "properties": {
            "phrase": {
               "description": "Passphrase for the operations",
               "minLength": 1,
               "title": "Phrase",
               "type": "string"
            }
         },
         "required": [
            "phrase"
         ],
         "title": "CryptParams",
         "type": "object"
      },
      "CryptsParams": {
         "additionalProperties": false,
         "description": "Process and validate the core configuration parameters.",
         "properties": {
            "phrases": {
               "additionalProperties": {
                  "$ref": "#/$defs/CryptParams"
               },
               "description": "Passphrases for the operations",
               "minProperties": 0,
               "title": "Phrases",
               "type": "object"
            }
         },
         "required": [
            "phrases"
         ],
         "title": "CryptsParams",
         "type": "object"
      },
      "LoggerParams": {
         "additionalProperties": false,
         "description": "Process and validate the core configuration parameters.",
         "properties": {
            "stdo_level": {
               "anyOf": [
                  {
                     "enum": [
                        "critical",
                        "debug",
                        "error",
                        "info",
                        "warning"
                     ],
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Minimum logging message level",
               "title": "Stdo Level"
            },
            "file_level": {
               "anyOf": [
                  {
                     "enum": [
                        "critical",
                        "debug",
                        "error",
                        "info",
                        "warning"
                     ],
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Minimum logging message level",
               "title": "File Level"
            },
            "file_path": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable output to the log file",
               "title": "File Path"
            }
         },
         "title": "LoggerParams",
         "type": "object"
      },
      "OrcheGroupAnsibleParams": {
         "additionalProperties": true,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {},
         "title": "OrcheGroupAnsibleParams",
         "type": "object"
      },
      "OrcheGroupParams": {
         "additionalProperties": false,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {
            "enable": {
               "default": false,
               "description": "Determine whether child enabled",
               "title": "Enable",
               "type": "boolean"
            },
            "inherits": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Other configuration to inherit",
               "title": "Inherits"
            },
            "display": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Friendly name value for child",
               "title": "Display"
            },
            "memberof": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Groups child is a member of",
               "title": "Memberof"
            },
            "realm": {
               "default": "ansible",
               "description": "Logical realm for the object",
               "enum": [
                  "domain",
                  "local",
                  "site",
                  "zone",
                  "ansible",
                  "psuedo"
               ],
               "title": "Realm",
               "type": "string"
            },
            "ansible": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OrcheGroupAnsibleParams"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Variables provided to Ansible"
            }
         },
         "title": "OrcheGroupParams",
         "type": "object"
      },
      "OrchePersonParams": {
         "additionalProperties": false,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {
            "enable": {
               "default": false,
               "description": "Determine whether child enabled",
               "title": "Enable",
               "type": "boolean"
            },
            "inherits": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Other configuration to inherit",
               "title": "Inherits"
            },
            "display": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Friendly name value for child",
               "title": "Display"
            },
            "memberof": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Groups child is a member of",
               "title": "Memberof"
            },
            "realm": {
               "default": "psuedo",
               "description": "Logical realm for the object",
               "enum": [
                  "domain",
                  "local",
                  "psuedo"
               ],
               "title": "Realm",
               "type": "string"
            },
            "domain": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Domain to which child belongs",
               "title": "Domain"
            },
            "first": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "First name for person account",
               "title": "First"
            },
            "last": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Last name for person account",
               "title": "Last"
            }
         },
         "title": "OrchePersonParams",
         "type": "object"
      },
      "OrcheSubnetParams": {
         "additionalProperties": false,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {
            "enable": {
               "default": false,
               "description": "Determine whether child enabled",
               "title": "Enable",
               "type": "boolean"
            },
            "inherits": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Other configuration to inherit",
               "title": "Inherits"
            },
            "display": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Friendly name value for child",
               "title": "Display"
            },
            "memberof": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Groups child is a member of",
               "title": "Memberof"
            },
            "subnet": {
               "description": "IPv4 or IPv6 network subnet",
               "minLength": 1,
               "title": "Subnet",
               "type": "string"
            }
         },
         "required": [
            "subnet"
         ],
         "title": "OrcheSubnetParams",
         "type": "object"
      },
      "OrcheSystemAnsibleParams": {
         "additionalProperties": true,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {},
         "title": "OrcheSystemAnsibleParams",
         "type": "object"
      },
      "OrcheSystemParams": {
         "additionalProperties": false,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {
            "enable": {
               "default": false,
               "description": "Determine whether child enabled",
               "title": "Enable",
               "type": "boolean"
            },
            "inherits": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Other configuration to inherit",
               "title": "Inherits"
            },
            "display": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Friendly name value for child",
               "title": "Display"
            },
            "memberof": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Groups child is a member of",
               "title": "Memberof"
            },
            "realm": {
               "default": "ansible",
               "description": "Logical realm for the object",
               "enum": [
                  "ansible",
                  "psuedo"
               ],
               "title": "Realm",
               "type": "string"
            },
            "domain": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Domain to which child belongs",
               "title": "Domain"
            },
            "ansible": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OrcheSystemAnsibleParams"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Variables provided to Ansible"
            }
         },
         "title": "OrcheSystemParams",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid

Fields:

database (Annotated[str, FieldInfo(annotation=NoneType, required=False, default='sqlite:///:memory:', description='Database connection string', metadata=[MinLen(min_length=1)])])
dryrun (Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=False, description='Determine if changes applied')])
enconfig (Annotated[Optional[ConfigParams], Field(None, description='Parameters for Config instance')])
encrypts (Annotated[Optional[CryptsParams], Field(None, description='Parameters for Crypts instance')])
enlogger (Annotated[Optional[LoggerParams], Field(None, description='Parameters for Logger instance')])
groups (Annotated[dict[str, orchestro.orche.params.group.OrcheGroupParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Parameters for Orche groups', metadata=[MinLen(min_length=1)])])
persons (Annotated[dict[str, orchestro.orche.params.person.OrchePersonParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Parameters for Orche persons', metadata=[MinLen(min_length=1)])])
subnets (Annotated[dict[str, orchestro.orche.params.subnet.OrcheSubnetParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Parameters for Orche subnets', metadata=[MinLen(min_length=1)])])
systems (Annotated[dict[str, orchestro.orche.params.system.OrcheSystemParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Parameters for Orche systems', metadata=[MinLen(min_length=1)])])

field database: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='sqlite:///:memory:', description='Database connection string', metadata=[MinLen(min_length=1)])] = 'sqlite:///:memory:'#

Database connection string

Constraints:

min_length = 1

field dryrun: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=False, description='Determine if changes applied')] = False#: Determine if changes applied

field enconfig: Annotated[ConfigParams | None, Field(None, description='Parameters for Config instance')] = None#: Parameters for Config instance

field encrypts: Annotated[CryptsParams | None, Field(None, description='Parameters for Crypts instance')] = None#: Parameters for Crypts instance

field enlogger: Annotated[LoggerParams | None, Field(None, description='Parameters for Logger instance')] = None#: Parameters for Logger instance

field groups: Annotated[dict[str, OrcheGroupParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Parameters for Orche groups', metadata=[MinLen(min_length=1)])] = None#

Parameters for Orche groups

Constraints:

min_length = 1

field persons: Annotated[dict[str, OrchePersonParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Parameters for Orche persons', metadata=[MinLen(min_length=1)])] = None#

Parameters for Orche persons

Constraints:

min_length = 1

field subnets: Annotated[dict[str, OrcheSubnetParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Parameters for Orche subnets', metadata=[MinLen(min_length=1)])] = None#

Parameters for Orche subnets

Constraints:

min_length = 1

field systems: Annotated[dict[str, OrcheSystemParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Parameters for Orche systems', metadata=[MinLen(min_length=1)])] = None#

Parameters for Orche systems

Constraints:

min_length = 1

orchestro.orche.params.person module#

Functions and routines associated with Enasis Network Orchestrations.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

pydantic model orchestro.orche.params.person.OrchePersonParams[source]#

Bases: OrcheChildParams

Process and validate the Orche configuration parameters.

Show JSON schema

{
   "title": "OrchePersonParams",
   "description": "Process and validate the Orche configuration parameters.",
   "type": "object",
   "properties": {
      "enable": {
         "default": false,
         "description": "Determine whether child enabled",
         "title": "Enable",
         "type": "boolean"
      },
      "inherits": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Other configuration to inherit",
         "title": "Inherits"
      },
      "display": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Friendly name value for child",
         "title": "Display"
      },
      "memberof": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Groups child is a member of",
         "title": "Memberof"
      },
      "realm": {
         "default": "psuedo",
         "description": "Logical realm for the object",
         "enum": [
            "domain",
            "local",
            "psuedo"
         ],
         "title": "Realm",
         "type": "string"
      },
      "domain": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Domain to which child belongs",
         "title": "Domain"
      },
      "first": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "First name for person account",
         "title": "First"
      },
      "last": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Last name for person account",
         "title": "Last"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid

Fields:

display (Annotated[Optional[str], Field(None, description='Friendly name value for child', min_length=1)])
domain (Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Domain to which child belongs', metadata=[MinLen(min_length=1)])])
enable (Annotated[bool, Field(False, description='Determine whether child enabled')])
first (Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='First name for person account', metadata=[MinLen(min_length=1)])])
inherits (Annotated[Optional[list[str]], Field(None, description='Other configuration to inherit', min_length=1)])
last (Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Last name for person account', metadata=[MinLen(min_length=1)])])
memberof (Annotated[Optional[list[str]], Field(None, description='Groups child is a member of', min_length=1)])
realm (Annotated[Literal['domain', 'local', 'psuedo'], FieldInfo(annotation=NoneType, required=False, default='psuedo', description='Logical realm for the object')])

field display: Annotated[str | None, Field(None, description='Friendly name value for child', min_length=1)] = None#

Friendly name value for child

Constraints:

min_length = 1

field domain: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Domain to which child belongs', metadata=[MinLen(min_length=1)])] = None#

Domain to which child belongs

Constraints:

min_length = 1

field enable: Annotated[bool, Field(False, description='Determine whether child enabled')] = False#: Determine whether child enabled

field first: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='First name for person account', metadata=[MinLen(min_length=1)])] = None#

First name for person account

Constraints:

min_length = 1

field inherits: Annotated[list[str] | None, Field(None, description='Other configuration to inherit', min_length=1)] = None#

Other configuration to inherit

Constraints:

min_length = 1

field last: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Last name for person account', metadata=[MinLen(min_length=1)])] = None#

Last name for person account

Constraints:

min_length = 1

field memberof: Annotated[list[str] | None, Field(None, description='Groups child is a member of', min_length=1)] = None#

Groups child is a member of

Constraints:

min_length = 1

field realm: Annotated[Literal['domain', 'local', 'psuedo'], FieldInfo(annotation=NoneType, required=False, default='psuedo', description='Logical realm for the object')] = 'psuedo'#: Logical realm for the object

orchestro.orche.params.subnet module#

Functions and routines associated with Enasis Network Orchestrations.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

pydantic model orchestro.orche.params.subnet.OrcheSubnetParams[source]#

Bases: OrcheChildParams

Process and validate the Orche configuration parameters.

Show JSON schema

{
   "title": "OrcheSubnetParams",
   "description": "Process and validate the Orche configuration parameters.",
   "type": "object",
   "properties": {
      "enable": {
         "default": false,
         "description": "Determine whether child enabled",
         "title": "Enable",
         "type": "boolean"
      },
      "inherits": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Other configuration to inherit",
         "title": "Inherits"
      },
      "display": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Friendly name value for child",
         "title": "Display"
      },
      "memberof": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Groups child is a member of",
         "title": "Memberof"
      },
      "subnet": {
         "description": "IPv4 or IPv6 network subnet",
         "minLength": 1,
         "title": "Subnet",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "subnet"
   ]
}

Config:

extra: str = forbid

Fields:

display (Annotated[Optional[str], Field(None, description='Friendly name value for child', min_length=1)])
enable (Annotated[bool, Field(False, description='Determine whether child enabled')])
inherits (Annotated[Optional[list[str]], Field(None, description='Other configuration to inherit', min_length=1)])
memberof (Annotated[Optional[list[str]], Field(None, description='Groups child is a member of', min_length=1)])
subnet (Annotated[str, FieldInfo(annotation=NoneType, required=True, description='IPv4 or IPv6 network subnet', metadata=[MinLen(min_length=1)])])

field display: Annotated[str | None, Field(None, description='Friendly name value for child', min_length=1)] = None#

Friendly name value for child

Constraints:

min_length = 1

field enable: Annotated[bool, Field(False, description='Determine whether child enabled')] = False#: Determine whether child enabled

field inherits: Annotated[list[str] | None, Field(None, description='Other configuration to inherit', min_length=1)] = None#

Other configuration to inherit

Constraints:

min_length = 1

field memberof: Annotated[list[str] | None, Field(None, description='Groups child is a member of', min_length=1)] = None#

Groups child is a member of

Constraints:

min_length = 1

field subnet: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='IPv4 or IPv6 network subnet', metadata=[MinLen(min_length=1)])] [Required]#

IPv4 or IPv6 network subnet

Constraints:

min_length = 1

orchestro.orche.params.system module#

Functions and routines associated with Enasis Network Orchestrations.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

pydantic model orchestro.orche.params.system.OrcheSystemAnsibleParams[source]#

Bases: OrcheParamsModel

Process and validate the Orche configuration parameters.

Show JSON schema

{
   "title": "OrcheSystemAnsibleParams",
   "description": "Process and validate the Orche configuration parameters.",
   "type": "object",
   "properties": {},
   "additionalProperties": true
}

Config:

extra: str = allow

pydantic model orchestro.orche.params.system.OrcheSystemParams[source]#

Bases: OrcheChildParams

Process and validate the Orche configuration parameters.

Show JSON schema

{
   "title": "OrcheSystemParams",
   "description": "Process and validate the Orche configuration parameters.",
   "type": "object",
   "properties": {
      "enable": {
         "default": false,
         "description": "Determine whether child enabled",
         "title": "Enable",
         "type": "boolean"
      },
      "inherits": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Other configuration to inherit",
         "title": "Inherits"
      },
      "display": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Friendly name value for child",
         "title": "Display"
      },
      "memberof": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Groups child is a member of",
         "title": "Memberof"
      },
      "realm": {
         "default": "ansible",
         "description": "Logical realm for the object",
         "enum": [
            "ansible",
            "psuedo"
         ],
         "title": "Realm",
         "type": "string"
      },
      "domain": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Domain to which child belongs",
         "title": "Domain"
      },
      "ansible": {
         "anyOf": [
            {
               "$ref": "#/$defs/OrcheSystemAnsibleParams"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Variables provided to Ansible"
      }
   },
   "$defs": {
      "OrcheSystemAnsibleParams": {
         "additionalProperties": true,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {},
         "title": "OrcheSystemAnsibleParams",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid

Fields:

ansible (Annotated[orchestro.orche.params.system.OrcheSystemAnsibleParams | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Variables provided to Ansible')])
display (Annotated[Optional[str], Field(None, description='Friendly name value for child', min_length=1)])
domain (Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Domain to which child belongs', metadata=[MinLen(min_length=1)])])
enable (Annotated[bool, Field(False, description='Determine whether child enabled')])
inherits (Annotated[Optional[list[str]], Field(None, description='Other configuration to inherit', min_length=1)])
memberof (Annotated[Optional[list[str]], Field(None, description='Groups child is a member of', min_length=1)])
realm (Annotated[Literal['ansible', 'psuedo'], FieldInfo(annotation=NoneType, required=False, default='ansible', description='Logical realm for the object')])

field ansible: Annotated[OrcheSystemAnsibleParams | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Variables provided to Ansible')] = None#: Variables provided to Ansible

field display: Annotated[str | None, Field(None, description='Friendly name value for child', min_length=1)] = None#

Friendly name value for child

Constraints:

min_length = 1

field domain: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Domain to which child belongs', metadata=[MinLen(min_length=1)])] = None#

Domain to which child belongs

Constraints:

min_length = 1

field enable: Annotated[bool, Field(False, description='Determine whether child enabled')] = False#: Determine whether child enabled

field inherits: Annotated[list[str] | None, Field(None, description='Other configuration to inherit', min_length=1)] = None#

Other configuration to inherit

Constraints:

min_length = 1

field memberof: Annotated[list[str] | None, Field(None, description='Groups child is a member of', min_length=1)] = None#

Groups child is a member of

Constraints:

min_length = 1

field realm: Annotated[Literal['ansible', 'psuedo'], FieldInfo(annotation=NoneType, required=False, default='ansible', description='Logical realm for the object')] = 'ansible'#: Logical realm for the object

Module contents#

Functions and routines associated with Enasis Network Orchestrations.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

pydantic model orchestro.orche.params.OrcheChildParams[source]#

Bases: OrcheParamsModel

Process and validate the Orche configuration parameters.

Show JSON schema

{
   "title": "OrcheChildParams",
   "description": "Process and validate the Orche configuration parameters.",
   "type": "object",
   "properties": {
      "enable": {
         "default": false,
         "description": "Determine whether child enabled",
         "title": "Enable",
         "type": "boolean"
      },
      "inherits": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Other configuration to inherit",
         "title": "Inherits"
      },
      "display": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Friendly name value for child",
         "title": "Display"
      },
      "memberof": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Groups child is a member of",
         "title": "Memberof"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid

Fields:

display (Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Friendly name value for child', metadata=[MinLen(min_length=1)])])
enable (Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=False, description='Determine whether child enabled')])
inherits (Annotated[list[str] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Other configuration to inherit', metadata=[MinLen(min_length=1)])])
memberof (Annotated[list[str] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Groups child is a member of', metadata=[MinLen(min_length=1)])])

field display: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Friendly name value for child', metadata=[MinLen(min_length=1)])] = None#

Friendly name value for child

Constraints:

min_length = 1

field enable: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=False, description='Determine whether child enabled')] = False#: Determine whether child enabled

Other configuration to inherit

Constraints:

min_length = 1

field memberof: Annotated[list[str] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Groups child is a member of', metadata=[MinLen(min_length=1)])] = None#

Groups child is a member of

Constraints:

min_length = 1

pydantic model orchestro.orche.params.OrcheGroupParams[source]#

Bases: OrcheChildParams

Process and validate the Orche configuration parameters.

Show JSON schema

{
   "title": "OrcheGroupParams",
   "description": "Process and validate the Orche configuration parameters.",
   "type": "object",
   "properties": {
      "enable": {
         "default": false,
         "description": "Determine whether child enabled",
         "title": "Enable",
         "type": "boolean"
      },
      "inherits": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Other configuration to inherit",
         "title": "Inherits"
      },
      "display": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Friendly name value for child",
         "title": "Display"
      },
      "memberof": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Groups child is a member of",
         "title": "Memberof"
      },
      "realm": {
         "default": "ansible",
         "description": "Logical realm for the object",
         "enum": [
            "domain",
            "local",
            "site",
            "zone",
            "ansible",
            "psuedo"
         ],
         "title": "Realm",
         "type": "string"
      },
      "ansible": {
         "anyOf": [
            {
               "$ref": "#/$defs/OrcheGroupAnsibleParams"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Variables provided to Ansible"
      }
   },
   "$defs": {
      "OrcheGroupAnsibleParams": {
         "additionalProperties": true,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {},
         "title": "OrcheGroupAnsibleParams",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid

Fields:

ansible (Annotated[orchestro.orche.params.group.OrcheGroupAnsibleParams | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Variables provided to Ansible')])
display (Annotated[Optional[str], Field(None, description='Friendly name value for child', min_length=1)])
enable (Annotated[bool, Field(False, description='Determine whether child enabled')])
inherits (Annotated[Optional[list[str]], Field(None, description='Other configuration to inherit', min_length=1)])
memberof (Annotated[Optional[list[str]], Field(None, description='Groups child is a member of', min_length=1)])
realm (Annotated[Literal['domain', 'local', 'site', 'zone', 'ansible', 'psuedo'], FieldInfo(annotation=NoneType, required=False, default='ansible', description='Logical realm for the object')])

field ansible: Annotated[OrcheGroupAnsibleParams | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Variables provided to Ansible')] = None#: Variables provided to Ansible

field display: Annotated[str | None, Field(None, description='Friendly name value for child', min_length=1)] = None#

Friendly name value for child

Constraints:

min_length = 1

field enable: Annotated[bool, Field(False, description='Determine whether child enabled')] = False#: Determine whether child enabled

field inherits: Annotated[list[str] | None, Field(None, description='Other configuration to inherit', min_length=1)] = None#

Other configuration to inherit

Constraints:

min_length = 1

field memberof: Annotated[list[str] | None, Field(None, description='Groups child is a member of', min_length=1)] = None#

Groups child is a member of

Constraints:

min_length = 1

field realm: Annotated[Literal['domain', 'local', 'site', 'zone', 'ansible', 'psuedo'], FieldInfo(annotation=NoneType, required=False, default='ansible', description='Logical realm for the object')] = 'ansible'#: Logical realm for the object

pydantic model orchestro.orche.params.OrcheParams[source]#

Bases: Params

Process and validate the core configuration parameters.

Show JSON schema

{
   "title": "OrcheParams",
   "description": "Process and validate the core configuration parameters.",
   "type": "object",
   "properties": {
      "enconfig": {
         "anyOf": [
            {
               "$ref": "#/$defs/ConfigParams"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Config instance"
      },
      "enlogger": {
         "anyOf": [
            {
               "$ref": "#/$defs/LoggerParams"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Logger instance"
      },
      "encrypts": {
         "anyOf": [
            {
               "$ref": "#/$defs/CryptsParams"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Crypts instance"
      },
      "database": {
         "default": "sqlite:///:memory:",
         "description": "Database connection string",
         "minLength": 1,
         "title": "Database",
         "type": "string"
      },
      "dryrun": {
         "default": false,
         "description": "Determine if changes applied",
         "title": "Dryrun",
         "type": "boolean"
      },
      "systems": {
         "anyOf": [
            {
               "additionalProperties": {
                  "$ref": "#/$defs/OrcheSystemParams"
               },
               "minProperties": 1,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Orche systems",
         "title": "Systems"
      },
      "persons": {
         "anyOf": [
            {
               "additionalProperties": {
                  "$ref": "#/$defs/OrchePersonParams"
               },
               "minProperties": 1,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Orche persons",
         "title": "Persons"
      },
      "subnets": {
         "anyOf": [
            {
               "additionalProperties": {
                  "$ref": "#/$defs/OrcheSubnetParams"
               },
               "minProperties": 1,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Orche subnets",
         "title": "Subnets"
      },
      "groups": {
         "anyOf": [
            {
               "additionalProperties": {
                  "$ref": "#/$defs/OrcheGroupParams"
               },
               "minProperties": 1,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Orche groups",
         "title": "Groups"
      }
   },
   "$defs": {
      "ConfigParams": {
         "additionalProperties": false,
         "description": "Process and validate the core configuration parameters.",
         "properties": {
            "paths": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Location of configuration files",
               "title": "Paths"
            }
         },
         "title": "ConfigParams",
         "type": "object"
      },
      "CryptParams": {
         "additionalProperties": false,
         "description": "Process and validate the core configuration parameters.",
         "properties": {
            "phrase": {
               "description": "Passphrase for the operations",
               "minLength": 1,
               "title": "Phrase",
               "type": "string"
            }
         },
         "required": [
            "phrase"
         ],
         "title": "CryptParams",
         "type": "object"
      },
      "CryptsParams": {
         "additionalProperties": false,
         "description": "Process and validate the core configuration parameters.",
         "properties": {
            "phrases": {
               "additionalProperties": {
                  "$ref": "#/$defs/CryptParams"
               },
               "description": "Passphrases for the operations",
               "minProperties": 0,
               "title": "Phrases",
               "type": "object"
            }
         },
         "required": [
            "phrases"
         ],
         "title": "CryptsParams",
         "type": "object"
      },
      "LoggerParams": {
         "additionalProperties": false,
         "description": "Process and validate the core configuration parameters.",
         "properties": {
            "stdo_level": {
               "anyOf": [
                  {
                     "enum": [
                        "critical",
                        "debug",
                        "error",
                        "info",
                        "warning"
                     ],
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Minimum logging message level",
               "title": "Stdo Level"
            },
            "file_level": {
               "anyOf": [
                  {
                     "enum": [
                        "critical",
                        "debug",
                        "error",
                        "info",
                        "warning"
                     ],
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Minimum logging message level",
               "title": "File Level"
            },
            "file_path": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable output to the log file",
               "title": "File Path"
            }
         },
         "title": "LoggerParams",
         "type": "object"
      },
      "OrcheGroupAnsibleParams": {
         "additionalProperties": true,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {},
         "title": "OrcheGroupAnsibleParams",
         "type": "object"
      },
      "OrcheGroupParams": {
         "additionalProperties": false,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {
            "enable": {
               "default": false,
               "description": "Determine whether child enabled",
               "title": "Enable",
               "type": "boolean"
            },
            "inherits": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Other configuration to inherit",
               "title": "Inherits"
            },
            "display": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Friendly name value for child",
               "title": "Display"
            },
            "memberof": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Groups child is a member of",
               "title": "Memberof"
            },
            "realm": {
               "default": "ansible",
               "description": "Logical realm for the object",
               "enum": [
                  "domain",
                  "local",
                  "site",
                  "zone",
                  "ansible",
                  "psuedo"
               ],
               "title": "Realm",
               "type": "string"
            },
            "ansible": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OrcheGroupAnsibleParams"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Variables provided to Ansible"
            }
         },
         "title": "OrcheGroupParams",
         "type": "object"
      },
      "OrchePersonParams": {
         "additionalProperties": false,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {
            "enable": {
               "default": false,
               "description": "Determine whether child enabled",
               "title": "Enable",
               "type": "boolean"
            },
            "inherits": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Other configuration to inherit",
               "title": "Inherits"
            },
            "display": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Friendly name value for child",
               "title": "Display"
            },
            "memberof": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Groups child is a member of",
               "title": "Memberof"
            },
            "realm": {
               "default": "psuedo",
               "description": "Logical realm for the object",
               "enum": [
                  "domain",
                  "local",
                  "psuedo"
               ],
               "title": "Realm",
               "type": "string"
            },
            "domain": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Domain to which child belongs",
               "title": "Domain"
            },
            "first": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "First name for person account",
               "title": "First"
            },
            "last": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Last name for person account",
               "title": "Last"
            }
         },
         "title": "OrchePersonParams",
         "type": "object"
      },
      "OrcheSubnetParams": {
         "additionalProperties": false,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {
            "enable": {
               "default": false,
               "description": "Determine whether child enabled",
               "title": "Enable",
               "type": "boolean"
            },
            "inherits": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Other configuration to inherit",
               "title": "Inherits"
            },
            "display": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Friendly name value for child",
               "title": "Display"
            },
            "memberof": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Groups child is a member of",
               "title": "Memberof"
            },
            "subnet": {
               "description": "IPv4 or IPv6 network subnet",
               "minLength": 1,
               "title": "Subnet",
               "type": "string"
            }
         },
         "required": [
            "subnet"
         ],
         "title": "OrcheSubnetParams",
         "type": "object"
      },
      "OrcheSystemAnsibleParams": {
         "additionalProperties": true,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {},
         "title": "OrcheSystemAnsibleParams",
         "type": "object"
      },
      "OrcheSystemParams": {
         "additionalProperties": false,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {
            "enable": {
               "default": false,
               "description": "Determine whether child enabled",
               "title": "Enable",
               "type": "boolean"
            },
            "inherits": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Other configuration to inherit",
               "title": "Inherits"
            },
            "display": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Friendly name value for child",
               "title": "Display"
            },
            "memberof": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Groups child is a member of",
               "title": "Memberof"
            },
            "realm": {
               "default": "ansible",
               "description": "Logical realm for the object",
               "enum": [
                  "ansible",
                  "psuedo"
               ],
               "title": "Realm",
               "type": "string"
            },
            "domain": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Domain to which child belongs",
               "title": "Domain"
            },
            "ansible": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OrcheSystemAnsibleParams"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Variables provided to Ansible"
            }
         },
         "title": "OrcheSystemParams",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid

Fields:

database (Annotated[str, FieldInfo(annotation=NoneType, required=False, default='sqlite:///:memory:', description='Database connection string', metadata=[MinLen(min_length=1)])])
dryrun (Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=False, description='Determine if changes applied')])
enconfig (Annotated[Optional[ConfigParams], Field(None, description='Parameters for Config instance')])
encrypts (Annotated[Optional[CryptsParams], Field(None, description='Parameters for Crypts instance')])
enlogger (Annotated[Optional[LoggerParams], Field(None, description='Parameters for Logger instance')])
groups (Annotated[dict[str, orchestro.orche.params.group.OrcheGroupParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Parameters for Orche groups', metadata=[MinLen(min_length=1)])])
persons (Annotated[dict[str, orchestro.orche.params.person.OrchePersonParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Parameters for Orche persons', metadata=[MinLen(min_length=1)])])
subnets (Annotated[dict[str, orchestro.orche.params.subnet.OrcheSubnetParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Parameters for Orche subnets', metadata=[MinLen(min_length=1)])])
systems (Annotated[dict[str, orchestro.orche.params.system.OrcheSystemParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Parameters for Orche systems', metadata=[MinLen(min_length=1)])])

Database connection string

Constraints:

min_length = 1

field dryrun: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=False, description='Determine if changes applied')] = False#: Determine if changes applied

field enconfig: Annotated[ConfigParams | None, Field(None, description='Parameters for Config instance')] = None#: Parameters for Config instance

field encrypts: Annotated[CryptsParams | None, Field(None, description='Parameters for Crypts instance')] = None#: Parameters for Crypts instance

field enlogger: Annotated[LoggerParams | None, Field(None, description='Parameters for Logger instance')] = None#: Parameters for Logger instance

Parameters for Orche groups

Constraints:

min_length = 1

Parameters for Orche persons

Constraints:

min_length = 1

Parameters for Orche subnets

Constraints:

min_length = 1

Parameters for Orche systems

Constraints:

min_length = 1

pydantic model orchestro.orche.params.OrcheParamsModel[source]#

Bases: BaseModel

Process and validate the Homie configuration parameters.

Show JSON schema

{
   "title": "OrcheParamsModel",
   "description": "Process and validate the Homie configuration parameters.",
   "type": "object",
   "properties": {},
   "additionalProperties": false
}

Config:

extra: str = forbid

pydantic model orchestro.orche.params.OrchePersonParams[source]#

Bases: OrcheChildParams

Process and validate the Orche configuration parameters.

Show JSON schema

{
   "title": "OrchePersonParams",
   "description": "Process and validate the Orche configuration parameters.",
   "type": "object",
   "properties": {
      "enable": {
         "default": false,
         "description": "Determine whether child enabled",
         "title": "Enable",
         "type": "boolean"
      },
      "inherits": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Other configuration to inherit",
         "title": "Inherits"
      },
      "display": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Friendly name value for child",
         "title": "Display"
      },
      "memberof": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Groups child is a member of",
         "title": "Memberof"
      },
      "realm": {
         "default": "psuedo",
         "description": "Logical realm for the object",
         "enum": [
            "domain",
            "local",
            "psuedo"
         ],
         "title": "Realm",
         "type": "string"
      },
      "domain": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Domain to which child belongs",
         "title": "Domain"
      },
      "first": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "First name for person account",
         "title": "First"
      },
      "last": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Last name for person account",
         "title": "Last"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid

Fields:

display (Annotated[Optional[str], Field(None, description='Friendly name value for child', min_length=1)])
domain (Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Domain to which child belongs', metadata=[MinLen(min_length=1)])])
enable (Annotated[bool, Field(False, description='Determine whether child enabled')])
first (Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='First name for person account', metadata=[MinLen(min_length=1)])])
inherits (Annotated[Optional[list[str]], Field(None, description='Other configuration to inherit', min_length=1)])
last (Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Last name for person account', metadata=[MinLen(min_length=1)])])
memberof (Annotated[Optional[list[str]], Field(None, description='Groups child is a member of', min_length=1)])
realm (Annotated[Literal['domain', 'local', 'psuedo'], FieldInfo(annotation=NoneType, required=False, default='psuedo', description='Logical realm for the object')])

field display: Annotated[str | None, Field(None, description='Friendly name value for child', min_length=1)] = None#

Friendly name value for child

Constraints:

min_length = 1

field domain: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Domain to which child belongs', metadata=[MinLen(min_length=1)])] = None#

Domain to which child belongs

Constraints:

min_length = 1

field enable: Annotated[bool, Field(False, description='Determine whether child enabled')] = False#: Determine whether child enabled

field first: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='First name for person account', metadata=[MinLen(min_length=1)])] = None#

First name for person account

Constraints:

min_length = 1

field inherits: Annotated[list[str] | None, Field(None, description='Other configuration to inherit', min_length=1)] = None#

Other configuration to inherit

Constraints:

min_length = 1

field last: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Last name for person account', metadata=[MinLen(min_length=1)])] = None#

Last name for person account

Constraints:

min_length = 1

field memberof: Annotated[list[str] | None, Field(None, description='Groups child is a member of', min_length=1)] = None#

Groups child is a member of

Constraints:

min_length = 1

field realm: Annotated[Literal['domain', 'local', 'psuedo'], FieldInfo(annotation=NoneType, required=False, default='psuedo', description='Logical realm for the object')] = 'psuedo'#: Logical realm for the object

pydantic model orchestro.orche.params.OrcheSubnetParams[source]#

Bases: OrcheChildParams

Process and validate the Orche configuration parameters.

Show JSON schema

{
   "title": "OrcheSubnetParams",
   "description": "Process and validate the Orche configuration parameters.",
   "type": "object",
   "properties": {
      "enable": {
         "default": false,
         "description": "Determine whether child enabled",
         "title": "Enable",
         "type": "boolean"
      },
      "inherits": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Other configuration to inherit",
         "title": "Inherits"
      },
      "display": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Friendly name value for child",
         "title": "Display"
      },
      "memberof": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Groups child is a member of",
         "title": "Memberof"
      },
      "subnet": {
         "description": "IPv4 or IPv6 network subnet",
         "minLength": 1,
         "title": "Subnet",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "subnet"
   ]
}

Config:

extra: str = forbid

Fields:

display (Annotated[Optional[str], Field(None, description='Friendly name value for child', min_length=1)])
enable (Annotated[bool, Field(False, description='Determine whether child enabled')])
inherits (Annotated[Optional[list[str]], Field(None, description='Other configuration to inherit', min_length=1)])
memberof (Annotated[Optional[list[str]], Field(None, description='Groups child is a member of', min_length=1)])
subnet (Annotated[str, FieldInfo(annotation=NoneType, required=True, description='IPv4 or IPv6 network subnet', metadata=[MinLen(min_length=1)])])

field display: Annotated[str | None, Field(None, description='Friendly name value for child', min_length=1)] = None#

Friendly name value for child

Constraints:

min_length = 1

field enable: Annotated[bool, Field(False, description='Determine whether child enabled')] = False#: Determine whether child enabled

field inherits: Annotated[list[str] | None, Field(None, description='Other configuration to inherit', min_length=1)] = None#

Other configuration to inherit

Constraints:

min_length = 1

field memberof: Annotated[list[str] | None, Field(None, description='Groups child is a member of', min_length=1)] = None#

Groups child is a member of

Constraints:

min_length = 1

field subnet: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='IPv4 or IPv6 network subnet', metadata=[MinLen(min_length=1)])] [Required]#

IPv4 or IPv6 network subnet

Constraints:

min_length = 1

pydantic model orchestro.orche.params.OrcheSystemParams[source]#

Bases: OrcheChildParams

Process and validate the Orche configuration parameters.

Show JSON schema

{
   "title": "OrcheSystemParams",
   "description": "Process and validate the Orche configuration parameters.",
   "type": "object",
   "properties": {
      "enable": {
         "default": false,
         "description": "Determine whether child enabled",
         "title": "Enable",
         "type": "boolean"
      },
      "inherits": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Other configuration to inherit",
         "title": "Inherits"
      },
      "display": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Friendly name value for child",
         "title": "Display"
      },
      "memberof": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Groups child is a member of",
         "title": "Memberof"
      },
      "realm": {
         "default": "ansible",
         "description": "Logical realm for the object",
         "enum": [
            "ansible",
            "psuedo"
         ],
         "title": "Realm",
         "type": "string"
      },
      "domain": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Domain to which child belongs",
         "title": "Domain"
      },
      "ansible": {
         "anyOf": [
            {
               "$ref": "#/$defs/OrcheSystemAnsibleParams"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Variables provided to Ansible"
      }
   },
   "$defs": {
      "OrcheSystemAnsibleParams": {
         "additionalProperties": true,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {},
         "title": "OrcheSystemAnsibleParams",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid

Fields:

ansible (Annotated[orchestro.orche.params.system.OrcheSystemAnsibleParams | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Variables provided to Ansible')])
display (Annotated[Optional[str], Field(None, description='Friendly name value for child', min_length=1)])
domain (Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Domain to which child belongs', metadata=[MinLen(min_length=1)])])
enable (Annotated[bool, Field(False, description='Determine whether child enabled')])
inherits (Annotated[Optional[list[str]], Field(None, description='Other configuration to inherit', min_length=1)])
memberof (Annotated[Optional[list[str]], Field(None, description='Groups child is a member of', min_length=1)])
realm (Annotated[Literal['ansible', 'psuedo'], FieldInfo(annotation=NoneType, required=False, default='ansible', description='Logical realm for the object')])

field ansible: Annotated[OrcheSystemAnsibleParams | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Variables provided to Ansible')] = None#: Variables provided to Ansible

field display: Annotated[str | None, Field(None, description='Friendly name value for child', min_length=1)] = None#

Friendly name value for child

Constraints:

min_length = 1

field domain: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Domain to which child belongs', metadata=[MinLen(min_length=1)])] = None#

Domain to which child belongs

Constraints:

min_length = 1

field enable: Annotated[bool, Field(False, description='Determine whether child enabled')] = False#: Determine whether child enabled

field inherits: Annotated[list[str] | None, Field(None, description='Other configuration to inherit', min_length=1)] = None#

Other configuration to inherit

Constraints:

min_length = 1

field memberof: Annotated[list[str] | None, Field(None, description='Groups child is a member of', min_length=1)] = None#

Groups child is a member of

Constraints:

min_length = 1

field realm: Annotated[Literal['ansible', 'psuedo'], FieldInfo(annotation=NoneType, required=False, default='ansible', description='Logical realm for the object')] = 'ansible'#: Logical realm for the object

orchestro.orche.params package#

Submodules#

orchestro.orche.params.child module#

orchestro.orche.params.common module#

orchestro.orche.params.group module#

orchestro.orche.params.orche module#

orchestro.orche.params.person module#

orchestro.orche.params.subnet module#

orchestro.orche.params.system module#

Module contents#

This Page