abhinavg97.rr_io.secrets (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 test module.

Usage examples

Scanned by Steampunk Spotter

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

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

Scanned by Steampunk Spotter

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

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

Inputs

    
name:
    description: Name of the secret.
    required: true
    type: str

type:
    choices:
    - source
    - docker
    description:
    - There are 2 types of secrets in rapyuta.io.
    - If I(type=docker) then C(username), C(password), C(email) option are required. C(registry)
      is by default dockerhub, but a custom registry can be used.
    - If I(type=source) then C(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.
    required: true
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

email:
    description:
    - Required if I(type=docker) secrets.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

ca_cert:
    description:
    - Used if I(type=source) when I(authentication_type=basic).
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

present:
    choices:
    - true
    - false
    description:
    - Whether the secret should be present in rapyuta.io.
    required: true
    type: bool
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

ssh_key:
    description:
    - Required if I(authentication_type=ssh) for I(type=source) secrets.
    - ssh_key can be given to authenticate to a private source control repository.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

password:
    description:
    - Required if I(type=docker) secrets or I(type=source) when I(authentication_type=basic)
      and I(executable_type=password).
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

username:
    description:
    - Required if I(type=docker) secrets or I(type=source) when I(authentication_type=basic)
      and I(executable_type=password).
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

registry_url:
    default: https://index.docker.io/v1/
    description:
    - Required if I(type=docker) secrets.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

source_token:
    description:
    - Required if I(type=docker) secrets or I(type=source) when I(authentication_type=basic)
      and I(executable_type=source_token).
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

executable_type:
    choices:
    - password
    - source_token
    default: password
    description:
    - Required if I(type=source) when I(authentication_type=basic).
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

authentication_type:
    choices:
    - ssh
    - basic
    description:
    - There are 2 types of authentication types for source secrets in rapyuta.io.
    - If I(authentication_type=ssh) then C(ssh_key) option is required.
    - If I(authentication_type=ssh=basic) then C(executable_type) option is required.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

Outputs

message:
  description: The output message that the test module generates.
  returned: always
  sample: goodbye
  type: str
original_message:
  description: The original name param that was passed in.
  returned: always
  sample: hello world
  type: str