rapyutarobotics.rr_io.deployments – Module to interact with rapyuta_io deployments
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.deployments.
New in version 1.0.0: of rapyutarobotics.rr_io
Synopsis
This is my longer description explaining my test module.
Parameters
Parameter |
Comments |
|---|---|
Alias of the component if required. |
|
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. |
|
Used to modify the component params in the component used in the deployment. |
|
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. |
|
Name of the dependent deployment. Each element of the list is a dependent deployment. |
|
The device name to which to deploy the deployment on. Ensure the device is online for successfully deploying the deployments. Required if type=device. |
|
List of device configurations to be ignored while deploying the deployment on the device. Default: [] |
|
Name of the deployment. |
|
Can have 2 types of network options. For native networks, use native_networks. For static routes, use static_routes. |
|
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. |
|
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. |
|
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. |
|
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. Default: “max” |
|
Whether the deployment should be present in rapyuta.io. Choices:
|
|
Can be device or cloud on which to deploy the deployment on. To run locally, register your local device on rapyuta.io and add the device parameter. |
Examples
# Pass in a message
- name: GBC deployment
async: 2200
poll: 0
rapyutarobotics.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 |
Description |
|---|---|
Whether the deployment was changed during executing the playbook. Returned: always Sample: true |
|
The deployment id of the deployment which was operated on during the execution. Returned: always Sample: “dep-123” |
|
The deployment phase of the after the execution of the playbook. Returned: always Sample: “RUNNING” |
|
Whether the deployment exists after executing the playbook. Returned: always Sample: true |