skupper.network.site_load (1.2.1) — module

Install collection

Install with ansible-galaxy collection install skupper.network:==1.2.1

Add to requirements.yml

  collections:
    - name: skupper.network
      version: 1.2.1

Description

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.

Requirements

• kubectl if using kubernetes platform
• podman v4+ if using podman as the site platform

Usage examples

Scanned by Steampunk Spotter

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

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

Inputs

    
context:
    description:
    - KUBECONFIG context to use
    required: false
    type: str

hostname:
    description:
    - Ansible's inventory_hostname used to represent the given Skupper site
    - This is automatically provided by the action plugin
    required: false
    type: str

platform:
    description:
    - Platform to be used (kubernetes or podman)
    required: false
    type: str

namespace:
    description:
    - Kubernetes namespace to run the Skupper site
    required: false
    type: str

kubeconfig:
    description:
    - KUBECONFIG file to be used (defaults to ${HOME}/.kube/config)
    required: false
    type: str

podman_endpoint:
    description:
    - Podman endpoint to use when managing a Skupper site
    required: false
    type: str

Outputs

site:
  description: Skupper site information
  returned: always
  sample:
    site:
      host: host-a
      id: 53899d80-1ae6-11ee-be28-1e9341abe0db
      name: site-a
  type: dict