skupper.v2.controller module – Manages the lifecycle of the skupper-controller for system sites

Note

This module is part of the skupper.v2 collection (version 2.2.0).

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 skupper.v2. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: skupper.v2.controller.

New in skupper.v2 2.1.0

Synopsis

  • Manages the lifecycle of the skupper-controller.

  • Prepares the environment and runs the skupper-controller for system sites

  • Runs with podman (default) or docker engines

  • With podman-docker (Docker CLI using Podman), use the podman platform; the docker platform requires a real Docker daemon.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.9

  • PyYAML >= 3.11

Parameters

Parameter

Comments

action

string

install - Prepares the environment and runs the skupper-controller

uninstall - Adjusts the local environment and removes the skupper-controller

Choices:

  • "install" ← (default)

  • "uninstall"

image

string

The controller-image to use

Default: "quay.io/skupper/system-controller:2.2.0"

platform

string

The platform used to run the controller for system sites

Choices:

  • "podman" ← (default)

  • "docker"

Examples

# Installs the skupper-controller using podman
- name: Installs the skupper-controller using podman
  skupper.v2.controller:
    action: install
    platform: podman

# Uninstalls the skupper-controller
- name: Uninstalls the skupper-controller
  skupper.v2.controller:
    action: uninstall

Authors

  • Fernando Giorgetti (@fgiorgetti)