abhinavg97.rr_io.packages (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: rio_amr_pa package
    async: 1250
    poll: 0
    abhinavg97.rr_io.packages:
    name: rio_amr_pa
    present: false
    type: build
    build: rio_amr_pa
    manifest_path: /tmp/rio_amr_pa.json

Scanned by Steampunk Spotter

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

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

Inputs

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

type:
    choices:
    - build
    - docker
    description:
    - There are 2 methods to create packages.
    - If I(type=build) then C(build) option is required.
    - If I(type=docker) then C(secret) and C(docker_image) options are required.
    required: true
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

build:
    description:
    - Required when I('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.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

secret:
    description:
    - Required when I('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.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

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

version:
    choices:
    - max
    - auto
    - vx.y.z
    default: max
    description:
    - Use I('auto') to increment the package version upon the existing packages by updating
      the patch number of the highest versioned package.
    - Use I('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.
    required: true
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

docker_image:
    description:
    - Required when I('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.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

manifest_path:
    description:
    - Required when I('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.
    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