ResolvedSecrets

pydantic model phalanx.models.secrets.ResolvedSecrets

All resolved secrets for a given Phalanx environment.

Secret resolution means that the configuration has been translated into a secret value.

Parameters:

data (Any)

Show JSON schema

{
   "title": "ResolvedSecrets",
   "description": "All resolved secrets for a given Phalanx environment.\n\nSecret resolution means that the configuration has been translated into a\nsecret value.",
   "type": "object",
   "properties": {
      "applications": {
         "additionalProperties": {
            "additionalProperties": {
               "format": "password",
               "type": "string",
               "writeOnly": true
            },
            "type": "object"
         },
         "default": {},
         "description": "Mapping of application to secret key to that resolved secret",
         "title": "Secrets by application and key",
         "type": "object"
      },
      "pull_secret": {
         "anyOf": [
            {
               "$ref": "#/$defs/PullSecret"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Pull secret for the environment, if needed",
         "title": "Pull secret"
      }
   },
   "$defs": {
      "PullSecret": {
         "additionalProperties": false,
         "description": "Specification for a Docker pull secret.",
         "properties": {
            "description": {
               "default": "Pull secrets for Docker registries. Each key under registries is the name of a Docker registry that needs a pull secret. The value should have two keys, username and password, that provide the HTTP Basic Auth credentials for that registry.",
               "description": "Description of the pull secret for humans reading the YAML file",
               "title": "Description of pull secret",
               "type": "string"
            },
            "registries": {
               "additionalProperties": {
                  "$ref": "#/$defs/RegistryPullSecret"
               },
               "default": {},
               "description": "Pull secrets for each registry that needs one",
               "title": "Pull secret by registry",
               "type": "object"
            }
         },
         "title": "PullSecret",
         "type": "object"
      },
      "RegistryPullSecret": {
         "additionalProperties": false,
         "description": "Pull secret for a specific Docker Repository.",
         "properties": {
            "username": {
               "description": "HTTP Basic Auth username",
               "title": "Username",
               "type": "string"
            },
            "password": {
               "description": "HTTP Basic Auth password",
               "format": "password",
               "title": "Password",
               "type": "string",
               "writeOnly": true
            }
         },
         "required": [
            "username",
            "password"
         ],
         "title": "RegistryPullSecret",
         "type": "object"
      }
   }
}

Fields:

• applications (dict[str, dict[str, pydantic.types.SecretStr]])

• pull_secret (phalanx.models.secrets.PullSecret | None)

field applications: dict[str, dict[str, SecretStr]] = {}

Mapping of application to secret key to that resolved secret

field pull_secret: PullSecret | None = None

Pull secret for the environment, if needed