abhinavg97.rr_io.deployments – Module to interact with rapyuta_io deployments

Note

This plugin is part of the abhinavg97.rr_io collection (version 1.1.1).

To install it use: ansible-galaxy collection install abhinavg97.rr_io.

To use it in a playbook, specify: abhinavg97.rr_io.deployments.

New in version 1.0.0: of abhinavg97.rr_io

Synopsis

  • This is my longer description explaining my test module.

Parameters

Parameter Choices/Defaults Comments
component_alias
string
added in 1.0.0 of abhinavg97.rr_io
Alias of the component if required.
component_name
string / required
added in 1.0.0 of abhinavg97.rr_io
Name of the component used in the deployment.
As of now, single component deployments are automated by Ansible.
Going forward, we plan to extend deployments to multi component deployments.
component_params
dictionary
added in 1.0.0 of abhinavg97.rr_io
Used to modify the component params in the component used in the deployment.
depends
dictionary
added in 1.0.0 of abhinavg97.rr_io
Dependent deployments for this deployment.
The deployment waits for the dependent deployment to become available if run in synchronous playbook otherwise waits until the async timeout expires.
deployments
list / elements=string
Name of the dependent deployment.
Each element of the list is a dependent deployment.
name
string / required
Name of the deployment.
networks
dictionary
added in 1.0.0 of abhinavg97.rr_io
Can have 2 types of network options.
For native networks, use native_networks.
For static routes, use static_routes.
native_networks
list / elements=string
List of the Native networks used by the deployment.
Each element of the list is the name of the native network present on rapyuta.io.
static_routes
list / elements=string
List of the static routes used by the deployment.
Each element of the list is the name of the static route present on rapyuta.io.
package_name
string
added in 1.0.0 of abhinavg97.rr_io
Name of the package used in the deployment.
The deployment waits for the package to become available if run in synchronous playbook otherwise waits until the async timeout expires.
package_version
string
added in 1.0.0 of abhinavg97.rr_io
Default:
"max"
Version of the package desired to be used in the deployment.
Version should of the form 'vx.y.z' if the corresponding versioned package already exists on rapyuta.io.
By default ansible uses the highest versioned package available on rapyuta.io.
present
boolean / required
added in 1.0.0 of abhinavg97.rr_io
    Choices:
  • no
  • yes
Whether the deployment should be present in rapyuta.io.

Examples

# Pass in a message
-   name: GBC deployment
    async: 2200
    poll: 0
    abhinavg97.rr_io.deployments:
    name: rr_gbc
    component_name: gbc
    present: false
    package_name: rio_gbc
    depends:
        deployments:
        - postgres
        - rr_gwm
    networks:
        static_routes:
        - name: rr-gbc
            endpoint_name: GWM_INTERFACE_ENDPOINT
        native_networks:
        - name: native_network
    component_params:
        GWM_INTERFACE_SITE: tatsumi
        AUTOBOOTSTRAP: true
        GWM_INTERFACE_ORG_ID: 1
        GWM_AUTH_TOKEN: autobootstrap
        IO_AMR_GWM_INTERFACE_NODE_NAME: rr_gwm_interface
        ROSCONSOLE_FORMAT: "[$${severity}] [$${time}] [$${node} $${logger} $${function} $${line}]: $${message}"

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)