rapyutarobotics.rr_io.builds – Module to interact with rapyuta_io builds.

Note

This plugin is part of the rapyutarobotics.rr_io collection (version 2.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install rapyutarobotics.rr_io.

To use it in a playbook, specify: rapyutarobotics.rr_io.builds.

New in version 1.0.0: of rapyutarobotics.rr_io

Synopsis

  • This is my longer description explaining my builds module.

Parameters

Parameter

Comments

architecture

string

added in 1.0.0 of rapyutarobotics.rr_io

Strategy type to make the build.

Choices are case insensitive.

Choices:

  • amd64 ← (default)

  • arm32v7

  • arm64v8

branch

string

added in 1.0.0 of rapyutarobotics.rr_io

Branch in the repository from which to create the build.

Default: “”

catkin_options

list / elements=dictionary

added in 1.0.0 of rapyutarobotics.rr_io

Catkin options for the build if is_ros is set to True.

Each Catkin option is a dictionary.

blacklist

string

blacklist for the catkin option.

catkin_make_args

string

catkin_make_args for the catkin option.

cmake_args

string

Cmake Args for the catkin option.

make_args

string

Make Args for the catkin option.

ros_packages

string

Ros package for the catkin option.

context_directory

string

added in 1.0.0 of rapyutarobotics.rr_io

Context dir to be used in the build.

Default: “”

docker_file_path

string

added in 1.0.0 of rapyutarobotics.rr_io

Path of Dockerfile.

This path is appended to the context_directory before searching for the Dockerfile.

Default: “”

docker_image_repository

string

added in 1.0.0 of rapyutarobotics.rr_io

An external docker repository where Build will push the image.

For example ‘docker.io/user/example’.

Default: “”

docker_pull_secret

string

added in 1.0.0 of rapyutarobotics.rr_io

Secret name created in rapyuta io to pull the docker image.

This is valid if the strategy_type is set to docker

Default: “”

docker_push_secret

string

added in 1.0.0 of rapyutarobotics.rr_io

Secret name created in rapyuta io to push the docker image.

This is valid if the strategy_type is set to docker.

Default: “”

enable_simulation

boolean

added in 1.0.0 of rapyutarobotics.rr_io

Whether to enable simulation in the build.

Can be set to true only when is_ros is true.

Choices:

  • no ← (default)

  • yes

is_ros

boolean

added in 1.0.0 of rapyutarobotics.rr_io

Whether the build has a ros component.

If this parameter is set to true then a ros_distro is required.

Choices:

  • no ← (default)

  • yes

name

string / required

added in 1.0.0 of rapyutarobotics.rr_io

Name of the build.

present

boolean / required

added in 1.0.0 of rapyutarobotics.rr_io

Whether build should be present or not.

Choices:

  • no

  • yes

repository

string / required

added in 1.0.0 of rapyutarobotics.rr_io

Repository to make the build from.

ros_distro

string

added in 1.0.0 of rapyutarobotics.rr_io

Ros distribution to use for the build.

This parameter is required only if the build has a ros component.

Choices are case insensitive.

Choices:

  • kinetic

  • melodic

  • noetic

Default: “”

source_secret

string

added in 1.0.0 of rapyutarobotics.rr_io

Represents secret for a private git repository.

Default: “”

strategy_type

string / required

added in 1.0.0 of rapyutarobotics.rr_io

Strategy type to make the build.

Choices are case insensitive.

Choices:

  • docker

  • source

tag_name

string

added in 1.0.0 of rapyutarobotics.rr_io

If the build is already present and the trigger option is enabled then this option sets the tag name of the docker image.

trigger

boolean

added in 1.0.0 of rapyutarobotics.rr_io

If the build is already present then this options lets you trigger the build.

It is automatically set to true if there is a build with same name which failed and present=true.

Choices:

  • no ← (default)

  • yes

trigger_name

string

added in 1.0.0 of rapyutarobotics.rr_io

If the build is already present and the trigger option is enabled then this option sets the trigger name of the docker image.

Examples

- name: rio_amr_pa build
  async: 100
  poll: 0
  rapyutarobotics.rr_io.builds:
  name: rio_amr_pa
  strategy_type: docker
  present: true
  repository: git@github.com:rapyuta-robotics/io_amr.git
  branch: release
  docker_file_path: docker/amrrobot/Dockerfile
  source_secret: github
  docker_pull_secret: dockerhub
  docker_push_secret: dockerhub
  docker_image_repository: docker.io/rrdockerhub/io_amr_pa
  trigger: false
  trigger_name: ansible_ci
  tag_name: ansible_ci

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

build_id

string

The build id of the build which was operated on during the execution.

Returned: always

Sample: “build-123”

changed

boolean

Whether the build was changed after executing the playbook.

Returned: always

Sample: true

exists

boolean

Whether the build exists after executing the playbook.

Returned: always

Sample: true

triggered

boolean

Whether the build was triggered during the execution of the playbook.

Returned: always

Sample: true

Authors

  • Dhananjay Sathe (@dsathe)

  • Abhinav Gupta (@abhinavg97)