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

Note

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

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 Choices/Defaults Comments
architecture
string
added in 1.0.0 of rapyutarobotics.rr_io
    Choices:
  • amd64 ←
  • arm32v7
  • arm64v8
Strategy type to make the build.
Choices are case insensitive.
branch
string
added in 1.0.0 of rapyutarobotics.rr_io
Default:
""
Branch in the repository from which to create the build.
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
Default:
""
Context dir to be used in the build.
docker_file_path
string
added in 1.0.0 of rapyutarobotics.rr_io
Default:
""
Path of Dockerfile.
This path is appended to the context_directory before searching for the Dockerfile.
docker_image_repository
string
added in 1.0.0 of rapyutarobotics.rr_io
Default:
""
An external docker repository where Build will push the image.
For example ‘docker.io/user/example’.
docker_pull_secret
string
added in 1.0.0 of rapyutarobotics.rr_io
Default:
""
Secret name created in rapyuta io to pull the docker image.
This is valid if the strategy_type is set to docker
docker_push_secret
string
added in 1.0.0 of rapyutarobotics.rr_io
Default:
""
Secret name created in rapyuta io to push the docker image.
This is valid if the strategy_type is set to docker.
enable_simulation
boolean
added in 1.0.0 of rapyutarobotics.rr_io
    Choices:
  • no ←
  • yes
Whether to enable simulation in the build.
Can be set to true only when is_ros is true.
is_ros
boolean
added in 1.0.0 of rapyutarobotics.rr_io
    Choices:
  • no ←
  • yes
Whether the build has a ros component.
If this parameter is set to true then a ros_distro is required.
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
    Choices:
  • no
  • yes
Whether build should be present or not.
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
    Choices:
  • kinetic
  • melodic
  • noetic
Default:
""
Ros distribution to use for the build.
This parameter is required only if the build has a ros component.
Choices are case insensitive.
source_secret
string
added in 1.0.0 of rapyutarobotics.rr_io
Default:
""
Represents secret for a private git repository.
strategy_type
string / required
added in 1.0.0 of rapyutarobotics.rr_io
    Choices:
  • docker
  • source
Strategy type to make the build.
Choices are case insensitive.
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
    Choices:
  • no ←
  • yes
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.
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 Returned Description
build_id
string
always
The build id of the build which was operated on during the execution.

Sample:
build-123
changed
boolean
always
Whether the build was changed after executing the playbook.

Sample:
True
exists
boolean
always
Whether the build exists after executing the playbook.

Sample:
True
triggered
boolean
always
Whether the build was triggered during the execution of the playbook.

Sample:
True


Authors

  • Dhananjay Sathe (@dsathe)

  • Abhinav Gupta (@abhinavg97)