abhinavg97.rr_io.builds (1.1.19) — module

Install collection

Install with ansible-galaxy collection install abhinavg97.rr_io:==1.1.19

Add to requirements.yml

  collections:
    - name: abhinavg97.rr_io
      version: 1.1.19

Description

This is my longer description explaining my builds module.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: rio_amr_pa build
  async: 100
  poll: 0
  abhinavg97.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

Inputs

    
name:
    description:
    - Name of the build.
    required: true
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

branch:
    default: ''
    description:
    - Branch in the repository from which to create the build.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

is_ros:
    choices:
    - true
    - false
    default: false
    description:
    - Whether the build has a ros component.
    - If this parameter is set to true then a ros_distro is required.
    required: false
    type: bool
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

present:
    choices:
    - true
    - false
    description:
    - Whether build should be present or not.
    required: true
    type: bool
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

trigger:
    choices:
    - true
    - false
    default: false
    description:
    - 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 I(present=true).
    required: false
    type: bool
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

tag_name:
    description:
    - If the build is already present and the trigger option is enabled then this option
      sets the tag name of the docker image.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

repository:
    description:
    - Repository to make the build from.
    required: true
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

ros_distro:
    choices:
    - kinetic
    - melodic
    default: ''
    description:
    - Ros distribution to use for the build.
    - This parameter is required only if the build has a ros component.
    - Choices are case insensitive.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

architecture:
    choices:
    - amd64
    - arm32v7
    - arm64v8
    default: amd64
    description:
    - Strategy type to make the build.
    - Choices are case insensitive.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

trigger_name:
    description:
    - If the build is already present and the trigger option is enabled then this option
      sets the trigger name of the docker image.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

source_secret:
    default: ''
    description:
    - Represents secret for a private git repository.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

strategy_type:
    choices:
    - docker
    - source
    description:
    - Strategy type to make the build.
    - Choices are case insensitive.
    required: true
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

catkin_options:
    description:
    - Catkin options for the build if is_ros is set to True.
    - Each Catkin option is a dictionary.
    elements: dict
    required: false
    suboptions:
      blacklist:
        description:
        - blacklist for the catkin option.
        required: false
        type: str
      catkin_make_args:
        description:
        - catkin_make_args for the catkin option.
        required: false
        type: str
      cmake_args:
        description:
        - Cmake Args for the catkin option.
        required: false
        type: str
      make_args:
        description:
        - Make Args for the catkin option.
        required: false
        type: str
      ros_packages:
        description:
        - Ros package for the catkin option.
        required: false
        type: str
    type: list
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

docker_file_path:
    default: ''
    description:
    - Path of Dockerfile.
    - This path is appended to the context_directory before searching for the Dockerfile.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

context_directory:
    default: ''
    description:
    - Context dir to be used in the build.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

enable_simulation:
    choices:
    - true
    - false
    default: false
    description:
    - Whether to enable simulation in the build.
    - Can be set to true only when is_ros is true.
    required: false
    type: bool
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

docker_pull_secret:
    default: ''
    description:
    - Secret name created in rapyuta io to pull the docker image.
    - This is valid if the strategy_type is set to docker
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

docker_push_secret:
    default: ''
    description:
    - Secret name created in rapyuta io to push the docker image.
    - This is valid if the strategy_type is set to docker.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

docker_image_repository:
    default: ''
    description:
    - An external docker repository where Build will push the image.
    - "For example \u2018docker.io/user/example\u2019."
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

Outputs

build_id:
  description: The build id of the build which was operated on during the execution.
  returned: always
  sample: build-123
  type: str
changed:
  description: Whether the build was changed after executing the playbook.
  returned: always
  sample: true
  type: bool
exists:
  description: Whether the build exists after executing the playbook.
  returned: always
  sample: true
  type: bool
triggered:
  description: Whether the build was triggered during the execution of the playbook.
  returned: always
  sample: true
  type: bool