EnvironmentConfig#

pydantic model phalanx.models.environments.EnvironmentConfig#

Configuration for a Phalanx environment.

This is a partial model for the environment values.yaml file. It cannot currently be used as a real model because enabled applications are stored as a list rather than the data structure used in values.yaml.

Parameters:: data (Any) –

Show JSON schema

{
   "title": "EnvironmentConfig",
   "description": "Configuration for a Phalanx environment.\n\nThis is a partial model for the environment :file:`values.yaml` file.\nIt cannot currently be used as a real model because enabled applications\nare stored as a list rather than the data structure used in\n:file:`values.yaml`.",
   "type": "object",
   "properties": {
      "vaultUrl": {
         "title": "Vaulturl",
         "type": "string"
      },
      "vaultPathPrefix": {
         "title": "Vaultpathprefix",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "fqdn": {
         "title": "Fqdn",
         "type": "string"
      },
      "applications": {
         "title": "Applications",
         "description": "List of enabled applications",
         "default": [],
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   },
   "required": [
      "vaultUrl",
      "vaultPathPrefix",
      "name",
      "fqdn"
   ]
}

Config:

alias_generator: function = <function to_camel_case at 0x7f579e577d80>
allow_population_by_field_name: bool = True

Fields:

applications (list[str])
fqdn (str)
name (str)
vault_path_prefix (str)
vault_url (str)

field applications: list[str] = []#: List of enabled applications

field fqdn: str [Required]#: Fully-qualified domain name of the environment.

field name: str [Required]#: Name of the environment.

field vault_path_prefix: str [Required] (alias 'vaultPathPrefix')#: Prefix of Vault paths, including the Kv2 mount point.

field vault_url: str [Required] (alias 'vaultUrl')#: URL of Vault server for this environment.

dict(**kwargs)#

Export the model as a dictionary.

Overridden to change the default of by_alias from False to True, so that by default the exported dictionary uses camel-case.

Parameters:: kwargs (Any) –
Return type:: dict[str, Any]

json(**kwargs)#

Export the model as JSON.

Overridden to change the default of by_alias from False to True, so that by default the exported dictionary uses camel-case.

Parameters:: kwargs (Any) –
Return type:: str

property vault_path: str#: Vault path without the initial Kv2 mount point.

property vault_read_approle: str#: Name of the Vault read AppRole for this environment.

property vault_read_policy: str#: Name of the Vault read policy for this environment.

property vault_write_policy: str#: Name of the Vault write policy for this environment.

property vault_write_token: str#

Display name of the Vault write token for this environment.

Unlike AppRole names, this could include a slash, but use the same name as the AppRole for consistency and simplicity.