Build Application with YAML

List of YAML parameters and examples for the \"Build Application\" action

提示

Learn more about: Build actions.

YAML Parameters for building applications

信息

Buddy操作通用参数列表

名称	类型	描述
action 必填	String	The ID of the action.
type 必填	String	The type of the action. Should be set to BUILD.
docker_image_name 必填	String	The name of the Docker image.
docker_image_tag 必填	String	The tag of the Docker image.
execute_commands 必填	String[]	The commands that will be executed.
cached_dirs	String[]	The dependencies & directories to be cached and available to every execution in this pipeline.
working_directory	String	The directory in which the pipeline filesystem will be mounted.
setup_commands	String[]	The command that will be executed only on the first run.
shell	String	The name of the shell that will be used to execute commands. Can be one of SH (default) or BASH.
services	Service[]	The containers with the services that will be attached to this environment. Available types: MYSQL, MONGO_DB, MARIADB, POSTGRE_SQL, REDIS, MEMCACHED, ELASTICSEARCH.
main_service_name	String	The hostname of the container in which the action is run. The container will be available under this name in the docker network for services defined in the services field.
login	String	The username required to connect to a private registry.
password	String	The password required to connect to a private registry.
registry	String	The url to the Docker registry or GCR. Required for Google GCR.
integration_hash	String	The ID of the integration. Required for using the image from the Amazon ECR and Docker Hub.
region	String	The name of the Amazon S3 region. Required for using the image from the Amazon ECR. The full list of regions is available here.
use_image_from_action	Boolean	If set to true the Docker image will be taken from action defined by docker_build_action_id or docker_build_action_name.
docker_build_action_id	Integer	The ID of the action which built the desired Docker image. If set to 0, the image will be taken from previous pipeline action. Can be used instead of docker_build_action_name.
docker_build_action_name	String	The name of the action which built the desired Docker image. Can be used instead of docker_build_action_id.
execute_every_command	Boolean	If set to true, all commands will be executed regardless of the result of the previous command.
cache_base_image	Boolean	If set to true, the cached version of the image is used, instead of being pulled each time.

YAML example for building apps

actions:
- action: "Build application"
  type: "BUILD"
  docker_image_name: "library/ubuntu"
  docker_image_tag: "$tag"
  execute_commands:
  - "ls -al > ls.log"
  setup_commands:
  - "apt-get update -y"
  - "apt-get install -y wget"
  main_service_name: "my-app.svc"
  services:
  - type: "MYSQL"
    version: "5.7"
  - type: "MONGO_DB"
    version: "3.2.4"
  cached_dirs:
  - "/build/test"
  - "/bin/Debug"
  working_directory: "/buddy/my-repo-dir"
  shell: "SH"
  cache_base_image: true
  variables:
  - key: "tag"
    value: "latest"

Example – Using private image from Dockerhub

YAML

actions:
- action: "Build application"
  type: "BUILD"
  docker_image_name: "buddyworks/private_image"
  docker_image_tag: "latest"
  execute_commands:
  - "ls -al > ls.log"
  integration_hash: "5ddb7c180fb38be67bd78a88a"
  variables:
  - key: "top_secret_password"
    value: "secure!14ivLMxPgv7TX6c9+ITX/g=="
    encrypted: true
    description: "The password for docker registry."

Example – Using image from private registry

YAML

actions:
- action: "Build application"
  type: "BUILD"
  docker_image_name: "buddyworks/private_image"
  docker_image_tag: "latest"
  execute_commands:
  - "ls -al > ls.log"
  login: "buddyworks"
  registry: "my.registry.com"
  password: "${top_secret_password}"
  variables:
  - key: "top_secret_password"
    value: "secure!14ivLMxPgv7TX6c9+ITX/g=="
    encrypted: true
    description: "The password for docker registry."

Example – Using image from Google Container Registry

YAML

actions:
- action: "Build application"
  type: "BUILD"
  docker_image_name: "tokyo-house-147623/private_image"
  docker_image_tag: "latest"
  execute_commands:
  - "ls -al > ls.log"
  registry: "my.gcr.com"
  integration_hash: "5ddb7c180fb38be67bd78a88a"

Example – Using image from Amazon ECR

YAML

actions:
- action: "Build application"
  type: "BUILD"
  docker_image_name: "private_image"
  docker_image_tag: "latest"
  execute_commands:
  - "ls -al > ls.log"
  region: "us-east-1"
  integration_hash: "5ddb7c180fb38be67bd78a88a"

Example – Using image built in previous action

YAML

actions:
- action: "Build application"
  type: "BUILD"
  use_image_from_action: true
  docker_build_action_id: 0
  execute_commands:
  - "ls -al > ls.log"

Using the build action services

Parameters of the service

信息

Buddy操作通用参数列表

名称	类型	描述
type 必填	String	The type of the attached service. Can be one of MYSQL, MARIADB, REDIS, MONGO_DB, POSTGRE_SQL, CASSANDRA, MEMCACHED, ELASTICSEARCH, SELENIUM_CHROME, SELENIUM_FIREFOX, GANACHE, RABBITMQ, CUSTOM.
connection 必填	Connection	The service’s connection details.
persistent	Boolean	If set to true, the database content will be cached between executions. Available when type is set to MYSQL, MARIADB, REDIS, MONGO_DB, POSTGRE_SQL, CASSANDRA or GANACHE.
version	String	The version of the predefined service’s base image. Required for every type except for CUSTOM.
dump_path	String	The path to the SQL dump file that will be used to populate service’s database. Available when type is set to MARIADB, POSTGRE_SQL or MYSQL.
docker_image_name	String	The name of the Docker image. Available when type is set to CUSTOM.
docker_image_tag	String	The tag of the Docker image. Available when type is set to CUSTOM.
registry	String	The url to the Docker registry or GCR. Available when type is set to CUSTOM.
login	String	When type is set to custom, this is the username required to connect to a private registry or GCR.
password	String	When type is set to custom, this is the password required to connect to a private registry or GCR.
working_directory	String	The directory in which the commands are executed. Available when type is set to CUSTOM.
inline_commands	String	The command that will be executed upon running the container with the service. Available when type is set to CUSTOM.
volume_mappings	String[]	The path preceding the colon is the filesystem path (the folder from the filesystem to be mounted in the container). The path after the colon is the container path (the path in the container, where this filesystem will be located).
cached_dirs	String[]	The additional container’s directories that will be cached between executions. Available when typeis set to CUSTOM.
use_image_from_action	Boolean	If set to true the Docker image will be taken from action defined by docker_build_action_id or docker_build_action_name. Available when type is set to CUSTOM.
docker_build_action_id	Integer	The ID of the action which built the desired Docker image. If set to 0, the image will be taken from previous pipeline action. Can be used instead of docker_build_action_name.
docker_build_action_name	String	The name of the action which built the desired Docker image. Can be used instead of docker_build_action_id.
integration_hash	Integer	The ID of the integration. Required for using the image from the Amazon ECR and Docker Hub. Available when type is set to CUSTOM.
region	String	The name of the Amazon S3 region. Available when type is set to CUSTOM. Required for using the image from the Amazon ECR. The full list of regions is available here.
wait_for_port	Integer	Build commands in the main container will be executed only if the entered service port is responding. Available when type is set to CUSTOM.
execute_every_command	Boolean	If set to true all commands will be executed regardless of the result of the previous command.
pass_variables	Boolean	Allow passing variables to this service.
entrypoint	String	Default command to execute at runtime. Overwrites the default entrypoint set by the image.

Parameters of the connection item

信息

Buddy操作通用参数列表

名称	类型	描述
host 必填	String	The hostname that will be available within the docker network upon the execution.
db	String	The initial database name. Available when type is set to MARIADB, POSTGRE_SQL or MYSQL.
port	Integer	The service’s connection port.
user	String	Defines the username used in the desired service. Available and required when type is set to MYSQL, MARIADB, POSTGRE_SQL or RABBITMQ.
password	String	Defines the password used in the desired service. Available and required when type is set to MYSQL, MARIADB, POSTGRE_SQL or RABBITMQ.

Example

YAML

actions:
- action: "Build application"
    type: "BUILD"
    docker_image_name: "library/ubuntu"
    docker_image_tag: "latest"
    execute_commands:
    - "ls"
    services:
    - type: "CUSTOM"
      connection:
        host: "custom.service"
      use_image_from_action: true
      wait_for_port: 1234
      working_directory: "/buddy/git-repo"
      volume_mappings:
      - "/:/buddy/mount/directory"
      cached_dirs:
      - "/var/data/"
      pass_variables: true
      entrypoint: "/bin/sh"
    - type: "MYSQL"
      version: "5.7"
      persistent: true
      connection:
        host: "mysql"
        port: 3306
        user: "root"
        password: "root"
      pass_variables: true
    - type: "MARIADB"
      version: "10.1.16"
      persistent: true
      connection:
        host: "mariadb"
        port: 3306
        user: "root"
        password: "root"
      pass_variables: true
    - type: "REDIS"
      version: "3.2.1"
      persistent: true
      connection:
        host: "redis"
        port: 6379
      pass_variables: true
    - type: "MONGO_DB"
      version: "3.2.4"
      persistent: true
      connection:
        host: "mongo"
        port: 27017
      pass_variables: true
    - type: "POSTGRE_SQL"
      version: "9.5.3"
      persistent: true
      connection:
        host: "postgres"
        port: 5432
        user: "root"
        password: "root"
      pass_variables: true
    - type: "CASSANDRA"
      version: "3.11"
      persistent: true
      connection:
        host: "cassandra"
        port: 9042
      pass_variables: true
    - type: "MEMCACHED"
      version: "1.4.29"
      persistent: false
      connection:
        host: "memcached"
        port: 11211
      pass_variables: true
    - type: "ELASTICSEARCH"
      version: "2.3.4"
      persistent: false
      connection:
        host: "elasticsearch"
        port: 9200
      pass_variables: true
    - type: "SELENIUM_FIREFOX"
      version: "3.0.1"
      persistent: false
      connection:
        host: "selenium-ff"
        port: 4444
      pass_variables: true
    - type: "SELENIUM_CHROME"
      version: "3.0.1"
      persistent: false
      connection:
        host: "selenium-ch"
        port: 4444
      pass_variables: true
    - type: "GANACHE"
      version: "latest"
      persistent: true
      connection:
        host: "ganache"
        port: 8545
      gas_price: 20000000000
      gas_limit: 90000
      accounts:
      - "0xfd7ac8b32e8a2391cad323efd7b162d77dd9ca67806d09877552c38b618713a5:1000000000000000000"
      pass_variables: true
    - type: "RABBIT_MQ"
      version: "3.7.8"
      persistent: true
      connection:
        host: "rabbitmq"
        port: 5672
        user: "guest"
        password: "guest"
      pass_variables: true