abhinavg97.rr_io.deployments (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.

Inputs

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

depends:
    description:
    - 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.
    required: false
    suboptions:
      deployments:
        description:
        - Name of the dependent deployment.
        - Each element of the list is a dependent deployment.
        elements: str
        required: false
        type: list
    type: dict
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

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

runtime:
    description:
    - 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 I(device) parameter.
    required: false
    type: str
    version_added: 1.1.9
    version_added_collection: abhinavg97.rr_io

networks:
    description:
    - Can have 2 types of network options.
    - For native networks, use native_networks.
    - For static routes, use static_routes.
    required: false
    suboptions:
      native_networks:
        description:
        - 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.
        elements: str
        required: false
        type: list
      static_routes:
        description:
        - 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.
        elements: str
        required: false
        type: list
    type: dict
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

device_name:
    description:
    - The device name to which to deploy the deployment on.
    - Ensure the device is online for successfully deploying the deployments.
    - Required if I(type=device).
    required: false
    type: str
    version_added: 1.1.9
    version_added_collection: abhinavg97.rr_io

package_name:
    description:
    - 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.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

component_name:
    description:
    - 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.
    required: true
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

component_alias:
    description:
    - Alias of the component if required.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

package_version:
    default: max
    description:
    - 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.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

component_params:
    description:
    - Used to modify the component params in the component used in the deployment.
    required: false
    type: dict
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

ignore_device_config:
    default: []
    description:
    - List of device configurations to be ignored while deploying the deployment on the
      device.
    elements: str
    required: false
    type: list
    version_added: 1.1.9
    version_added_collection: abhinavg97.rr_io

Outputs

changed:
  description: Whether the deployment was changed during executing the playbook.
  returned: always
  sample: true
  type: bool
deployment_id:
  description: The deployment id of the deployment which was operated on during the
    execution.
  returned: always
  sample: dep-123
  type: str
deployment_phase:
  description: The deployment phase of the after the execution of the playbook.
  returned: always
  sample: RUNNING
  type: str
exists:
  description: Whether the deployment exists after executing the playbook.
  returned: always
  sample: true
  type: bool