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

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

New in version 1.0.0: of rapyutarobotics.rr_io

Synopsis

  • This is my longer description explaining my test module.

Parameters

Parameter

Comments

authentication_type

string

added in 1.0.0 of rapyutarobotics.rr_io

There are 2 types of authentication types for source secrets in rapyuta.io.

If authentication_type=ssh then ssh_key option is required.

If authentication_type=ssh=basic then executable_type option is required.

Choices:

  • ssh

  • basic

ca_cert

string

added in 1.0.0 of rapyutarobotics.rr_io

Used if type=source when authentication_type=basic.

email

string

added in 1.0.0 of rapyutarobotics.rr_io

Required if type=docker secrets.

executable_type

string

added in 1.0.0 of rapyutarobotics.rr_io

Required if type=source when authentication_type=basic.

Choices:

  • password ← (default)

  • source_token

name

string / required

Name of the secret.

password

string

added in 1.0.0 of rapyutarobotics.rr_io

Required if type=docker secrets or type=source when authentication_type=basic and executable_type=password.

present

boolean / required

added in 1.0.0 of rapyutarobotics.rr_io

Whether the secret should be present in rapyuta.io.

Choices:

  • no

  • yes

registry_url

string

added in 1.0.0 of rapyutarobotics.rr_io

Required if type=docker secrets.

Default: “https://index.docker.io/v1/”

source_token

string

added in 1.0.0 of rapyutarobotics.rr_io

Required if type=docker secrets or type=source when authentication_type=basic and executable_type=source_token.

ssh_key

string

added in 1.0.0 of rapyutarobotics.rr_io

Required if authentication_type=ssh for type=source secrets.

ssh_key can be given to authenticate to a private source control repository.

type

string / required

added in 1.0.0 of rapyutarobotics.rr_io

There are 2 types of secrets in rapyuta.io.

If type=docker then username, password, email option are required. registry is by default dockerhub, but a custom registry can be used.

If type=source then authentication_type option is required.

Source secrets allow the user to pull in code from private Source control repository.

Docker secrets allow the user to pull the docker image from private image registry.

Choices:

  • source

  • docker

username

string

added in 1.0.0 of rapyutarobotics.rr_io

Required if type=docker secrets or type=source when authentication_type=basic and executable_type=password.

Examples

-   name: Github secret
    async: 100
    poll: 0
    rapyutarobotics.rr_io.secrets:
    name: github
    present: false
    type: source
    authentication_type: ssh
    ssh_key: |
        -----BEGIN RSA PRIVATE KEY-----
            XXX
        -----END RSA PRIVATE KEY-----

-   name: Docker Secret
    async: 100
    poll: 0
    rapyutarobotics.rr_io.secrets:
    name: dockerhub
    present: false
    type: docker
    username: YYY
    password: XXX
    email: XYZ@robotics-company.com

Return Values

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

Key

Description

message

string

The output message that the test module generates.

Returned: always

Sample: “goodbye”

original_message

string

The original name param that was passed in.

Returned: always

Sample: “hello world”

Authors

  • Dhananjay Sathe (@dsathe)

  • Abhinav Gupta (@abhinavg97)