ballerina/docker package

Annotations

Name Attachement Points Data Type Description
Config endpoint, service DockerConfiguration

@docker:Config annotation to configure docker artifact generation

CopyFiles endpoint, service FileConfigs

@docker:CopyFile annotation to copy external files to docker image

Expose endpoint ExposeConfig

@docker:Expose annotation to expose ballerina ports

Records Summary

Record Description
DockerConfiguration

Docker annotation configuration

ExposeConfig

Expose ports for docker

FileConfig

External file type for docker

FileConfigs

External File configurations for docker

public type DockerConfiguration

Docker annotation configuration

Field Name Data Type Default Value Description
name string
  • Name of the docker image
registry string
  • Docker registry url
tag string
  • Docker image tag
username string
  • Docker registry username
password string
  • Docker registry password
baseImage string
  • Base image for Dockerfile
push boolean
  • Enable pushing docker image to registry
buildImage boolean
  • Enable docker image build
enableDebug boolean
  • Enable ballerina debug
debugPort int
  • Ballerina debug port
dockerHost string
  • Docker host IP and docker PORT. ( e.g minikube IP and docker PORT)
dockerCertPath string
  • Docker certificate path

public type ExposeConfig

Expose ports for docker

public type FileConfig

External file type for docker

Field Name Data Type Default Value Description
source string
  • source path of the file (in your machine)
target string
  • target path (inside container)
isBallerinaConf boolean
  • Flag to specify ballerina config file

public type FileConfigs

External File configurations for docker

Field Name Data Type Default Value Description
files docker:FileConfig[]