skupper.network.site_load module – Loads site information as ansible facts into the respective host

Note

This module is part of the skupper.network collection (version 1.1.0).

To install it, use: ansible-galaxy collection install skupper.network. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: skupper.network.site_load.

New in skupper.network 1.1.0

Synopsis

  • Loads Skupper site information as a hostvar named ‘site’. It contains the site name, site id and inventory hostname related to it. This ‘site’ info can be used by modules to map runtime information of a skupper site to an ansible host defined through the inventory file. Kubernetes options can be set through host variables (kubeconfig, context, namespace). Podman endpoint can be customized through init.podmanEndpoint host variable.

Note

This module has a corresponding action plugin.

Requirements

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

  • kubectl if using kubernetes platform

  • podman v4+ if using podman as the site platform

Examples

- name: Loading site information
  skupper.network.site_load:

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

site

dictionary

Skupper site information

Returned: always

Sample: {"site": {"host": "host-a", "id": "53899d80-1ae6-11ee-be28-1e9341abe0db", "name": "site-a"}}