EnvironmentConfig#
- pydantic model phalanx.models.environments.EnvironmentConfig#
Configuration for a Phalanx environment.
This is a model for the
values-environment.yaml
files for each environment and is also used to validate those files. For the complete configuration for an environment, initialize this model with the merger ofvalues.yaml
andvalues-environment.yaml
.- Parameters:
data (
Any
) –
Show JSON schema
{ "title": "EnvironmentConfig", "description": "Configuration for a Phalanx environment.\n\nThis is a model for the :file:`values-{environment}.yaml` files for each\nenvironment and is also used to validate those files. For the complete\nconfiguration for an environment, initialize this model with the merger of\n:file:`values.yaml` and :file:`values-{environment}.yaml`.", "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "fqdn": { "title": "Fqdn", "type": "string" }, "vaultUrl": { "title": "Vaulturl", "type": "string" }, "vaultPathPrefix": { "title": "Vaultpathprefix", "type": "string" }, "applications": { "title": "Applications", "type": "object", "additionalProperties": { "type": "boolean" } }, "butlerRepositoryIndex": { "title": "Butlerrepositoryindex", "type": "string" }, "onepasswordUuid": { "title": "Onepassworduuid", "type": "string" }, "repoUrl": { "title": "Repourl", "type": "string" }, "targetRevision": { "title": "Targetrevision", "type": "string" } }, "required": [ "name", "fqdn", "vaultUrl", "vaultPathPrefix", "applications" ], "additionalProperties": false, "$id": "https://phalanx.lsst.io/schemas/environment.json" }
- Config:
extra: Extra = Extra.forbid
schema_extra: dict = {‘$id’: ‘https://phalanx.lsst.io/schemas/environment.json’}
- Fields:
-
field butler_repository_index:
Optional
[str
] = None (alias 'butlerRepositoryIndex')# URL to Butler repository index.
-
field onepassword_uuid:
Optional
[str
] = None (alias 'onepasswordUuid')# UUID of 1Password item in which to find Vault tokens.
This is used only by the old installer and will be removed once the new secrets management and 1Password integration is deployed everywhere.
-
field repo_url:
Optional
[str
] = None (alias 'repoUrl')# URL of the Git repository holding Argo CD configuration.
This is required in the merged values file that includes environment overrides, but the environment override file doesn’t need to set it, so it’s marked as optional for schema checking purposes to allow the override file to be schema-checked independently.
-
field target_revision:
Optional
[str
] = None (alias 'targetRevision')# Branch of the Git repository holding Argo CD configuration.
This is required in the merged values file that includes environment overrides, but the environment override file doesn’t need to set it, so it’s marked as optional for schema checking purposes to allow the override file to be schema-checked independently.
-
field vault_path_prefix:
str
[Required] (alias 'vaultPathPrefix')# Prefix of Vault paths, including the Kv2 mount point.
- 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.
- 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.