Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace docker

Index

Classes

Type Aliases

Type Aliases

DockerAuth

DockerAuth: { password: string; username: string }

Authentication for registries using standard docker login credentials

Type declaration

  • password: string

    Specify an environment variable (e.g. $DOCKER_PASSWORD)

  • username: string

DockerAuthAWS

DockerAuthAWS: { aws_access_key_id: string; aws_secret_access_key: string }

Authentication for AWS Elastic Container Registry (ECR)

Type declaration

  • aws_access_key_id: string
  • aws_secret_access_key: string

    Specify an environment variable (e.g. $ECR_AWS_SECRET_ACCESS_KEY)

DockerExecutorContentsShape

DockerExecutorContentsShape: DockerImageShape[]

A JSON representation of the Docker Executor Schema To be converted to YAML

DockerImageMap

DockerImageMap: { image: StringParameter }

Type declaration

DockerImageShape

DockerImageShape: { auth?: DockerAuth; aws_auth?: DockerAuthAWS; command?: string[]; entrypoint?: string[]; environment?: EnvironmentParameter; image: string; name?: string; user?: string }

Type interface for a single Docker image.

Type declaration

  • Optional auth?: DockerAuth
  • Optional aws_auth?: DockerAuthAWS
  • Optional command?: string[]
  • Optional entrypoint?: string[]
  • Optional environment?: EnvironmentParameter
  • image: string
  • Optional name?: string
  • Optional user?: string

DockerResourceClass

DockerResourceClass: AnyResourceClassBase

The available Docker Resource Classes.

see

https://circleci.com/docs/2.0/configuration-reference/#docker-executor for specifications of each class.

Generated using TypeDoc