cybus.connectware.instance (2.2.2) — module

Install collection

Install with ansible-galaxy collection install cybus.connectware:==2.2.2

Add to requirements.yml

  collections:
    - name: cybus.connectware
      version: 2.2.2

Description

Deploy, or manage a Connectware Installation

Requirements

• python >= 3.9
• Docker Compose >= 2.0

Usage examples

Scanned by Steampunk Spotter

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

- name: Connectware present
  cybus.connectware.instance:
    state: "{{ state }}"
    license: "{{ license }}"

Inputs

    
state:
    choices:
    - present
    - absent
    - started
    - stopped
    - restarted
    default: started
    description:
    - Target state for the Connectware Installation
    type: str

license:
    description:
    - A valid Connectware License
    required: true
    type: str

offline:
    default: false
    description:
    - Flag for offline installation
    type: bool

version:
    description:
    - The Connectware Version to install
    type: str

registry:
    default: registry.cybus.io
    description:
    - Registry used for pulling images
    type: str

admin_user:
    default: admin
    description:
    - Admin username
    type: str

api_timeout:
    default: 30
    description:
    - Timeout for API calls
    type: int

environment:
    default: {}
    description:
    - A list of environment variables to be written
    type: dict

install_path:
    default: /opt/connectware
    description:
    - Target installation path
    type: str

env_file_name:
    default: .env
    description:
    - The name of the generated env file
    type: str

registry_user:
    default: license
    description:
    - Registry username
    type: str

remove_images:
    default: false
    description:
    - Flag for disabling removal of images
    type: bool

admin_password:
    default: admin
    description:
    - Admin password
    type: str

remove_volumes:
    default: false
    description:
    - Flag for enabeling removal of volumes
    type: bool

target_hostname:
    default: localhost
    description:
    - Used to connect to the Connectware API
    type: str

compose_file_name:
    default: docker-compose.yml
    description:
    - The name of the used docker compose file
    type: str

compose_file_path:
    description:
    - The local directory path, which holds the compose file
    type: str

registry_password:
    description:
    - Registry password
    type: str

offline_image_pull:
    default: false
    description:
    - Flag to enable pulling of docker images even so we are offline
    type: bool

validate_web_certs:
    default: false
    description:
    - Flag to enable web certificate checking
    type: bool

remove_all_cybus_images:
    default: false
    description:
    - Flag for disabling removal of all cybus images
    type: bool

remove_all_cybus_volumes:
    default: false
    description:
    - Flag for enabeling removal of all cybus volumes
    type: bool

remove_all_cybus_networks:
    default: true
    description:
    - Flag for disabling removal of all cybus networks
    type: bool

validate_connectware_certs:
    default: false
    description:
    - Flag to enable Connectware certificate checking
    type: bool

stop_all_service_containers:
    default: false
    description:
    - Flag for enabling removal of all service containers
    type: bool

stop_all_service_container_networks:
    default: false
    description:
    - Flag for enabling removal of all service containers networks
    type: bool