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

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.packages.

New in version 1.0.0: of rapyutarobotics.rr_io

Synopsis

  • This is my longer description explaining my test module.

Parameters

Parameter Choices/Defaults Comments
build
string
added in 1.0.0 of rapyutarobotics.rr_io
Required when 'type=build'.
The name of the build already existing in rapyuta.io from which to create the package.
The package waits for the build to become available if run in synchronous playbook otherwise waits until the async timeout expires.
docker_image
string
added in 1.0.0 of rapyutarobotics.rr_io
Required when 'type=docker'.
The docker image path to be used to create the package from docker.
By default, the repository is docker.io, but a custom repository can be used by specifying the FQDN of the docker image.
manifest_path
string
added in 1.0.0 of rapyutarobotics.rr_io
Required when 'present=true'.
The path of the package manifest relative to the playbook.
Absolute path of the package manifest can also be given, useful when executing on remote servers.
Use the copy module to transfer your manifest files to remote servers when executing on remote servers.
name
string / required
Name of the package.
present
boolean / required
added in 1.0.0 of rapyutarobotics.rr_io
    Choices:
  • no
  • yes
Whether the package should be present in rapyuta.io.
secret
string
added in 1.0.0 of rapyutarobotics.rr_io
Required when 'type=docker'.
The name of the secret already existing in rapyuta.io which can be used to pull the docker image from the private docker repository.
The package waits for the secret to become available if run in synchronous playbook otherwise waits until the async timeout expires.
type
string / required
added in 1.0.0 of rapyutarobotics.rr_io
    Choices:
  • build
  • docker
There are 2 methods to create packages.
If type=build then build option is required.
If type=docker then secret and docker_image options are required.
version
string / required
added in 1.0.0 of rapyutarobotics.rr_io
    Choices:
  • max ←
  • auto
  • vx.y.z
Use 'auto' to increment the package version upon the existing packages by updating the patch number of the highest versioned package.
Use 'max' to check the existence of a package.
Use semantical version number to create a package with the specified version.
The package number specified in the package manifest json is discarded, so specify the version only in the playbook yaml.
When present is set to false, all the packages get deleted when version is set to auto and only the highest versioned package when version is set to max and the specified package version otherwise.

Examples

-   name: rio_amr_pa package
    async: 1250
    poll: 0
    rapyutarobotics.rr_io.packages:
    name: rio_amr_pa
    present: false
    type: build
    build: rio_amr_pa
    manifest_path: /tmp/rio_amr_pa.json

-   name: rio_amr_pa package
    async: 1250
    poll: 0
    rapyutarobotics.rr_io.packages:
    name: rio_amr_pa
    present: false
    type: docker
    docker_image: rrdockerhub/io_amr_pa:release_04_27
    secret: dockerhub
    manifest_path: /tmp/rio_amr_pa.json

Return Values

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

Key Returned Description
message
string
always
The output message that the test module generates.

Sample:
goodbye
original_message
string
always
The original name param that was passed in.

Sample:
hello world


Authors

  • Dhananjay Sathe (@dsathe)

  • Abhinav Gupta (@abhinavg97)