runway.cfngin.hooks.docker package¶

Docker hook.

pydantic model runway.cfngin.hooks.docker.LoginArgs[source]¶

Bases: BaseModel

Args passed to the docker.login hook.

Show JSON schema

{
   "title": "LoginArgs",
   "type": "object",
   "properties": {
      "ctx": {
         "default": null,
         "title": "Ctx"
      },
      "dockercfg_path": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Dockercfg Path"
      },
      "ecr": {
         "anyOf": [
            {
               "$ref": "#/$defs/ElasticContainerRegistry"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "email": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Email"
      },
      "password": {
         "title": "Password",
         "type": "string"
      },
      "registry": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Registry"
      },
      "username": {
         "default": "AWS",
         "title": "Username",
         "type": "string"
      }
   },
   "$defs": {
      "ElasticContainerRegistry": {
         "description": "AWS Elastic Container Registry.",
         "properties": {
            "account_id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Account Id"
            },
            "alias": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Alias"
            },
            "public": {
               "default": true,
               "title": "Public",
               "type": "boolean"
            },
            "aws_region": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Aws Region"
            }
         },
         "title": "ElasticContainerRegistry",
         "type": "object"
      }
   },
   "required": [
      "password"
   ]
}

field ctx: Annotated[CfnginContext | None, Field(alias='context', exclude=True)] = None (alias 'context')¶

field dockercfg_path: str | None = None¶: Path to a non-default Docker config file.

field ecr: ElasticContainerRegistry | None = None¶: Information describing an ECR registry.

field email: str | None = None¶: The email for the registry account.

field password: str = PydanticUndefined¶: The plaintext password for the registry account.

field registry: Annotated[str | None, Field(validate_default=True)] = None¶: URI of the registry to login to.

field username: str = 'AWS'¶: The registry username.

runway.cfngin.hooks.docker.login(*, context: runway.context.CfnginContext, **kwargs: Any) → DockerHookData[source]¶

Docker login hook.

Replicates the functionality of docker login cli command.

kwargs are parsed by LoginArgs.

Subpackages¶

runway.cfngin.hooks.docker.image package

runway.cfngin.hooks.docker package¶

Subpackages¶

Submodules¶