PullSecret

pydantic model phalanx.models.secrets.PullSecret

Specification for a Docker pull secret.

Parameters:

data (Any) –

Show JSON schema

{
   "title": "PullSecret",
   "description": "Specification for a Docker pull secret.",
   "type": "object",
   "properties": {
      "description": {
         "title": "Description of pull secret",
         "description": "Description of the pull secret for humans reading the YAML file",
         "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.",
         "type": "string"
      },
      "registries": {
         "title": "Pull secret by registry",
         "description": "Pull secrets for each registry that needs one",
         "default": {},
         "type": "object",
         "additionalProperties": {
            "$ref": "#/definitions/RegistryPullSecret"
         }
      }
   },
   "additionalProperties": false,
   "definitions": {
      "RegistryPullSecret": {
         "title": "RegistryPullSecret",
         "description": "Pull secret for a specific Docker Repository.",
         "type": "object",
         "properties": {
            "username": {
               "title": "Username",
               "description": "HTTP Basic Auth username",
               "type": "string"
            },
            "password": {
               "title": "Password",
               "description": "HTTP Basic Auth password",
               "type": "string",
               "writeOnly": true,
               "format": "password"
            }
         },
         "required": [
            "username",
            "password"
         ],
         "additionalProperties": false
      }
   }
}

Config:

• extra: Extra = Extra.forbid

Fields:

• description (phalanx.yaml.YAMLFoldedString)

• registries (dict[str, phalanx.models.secrets.RegistryPullSecret])

field description: YAMLFoldedString = '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 of the pull secret for humans reading the YAML file

field registries: dict[str, RegistryPullSecret] = {}

Pull secrets for each registry that needs one

to_dockerconfigjson()

Convert to the serialized format used by Docker.

Return type:

str