skupper.network.links_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 existing Skupper links to other sites, using the same format expected for links, referring other ansible hosts. The mapping of existing links to ansible hosts defined in the inventory file, depends on previous execution of site_load module, which loads site ids for each site defined in the inventory. Without it, links will be considered as unmapped and might be removed if links module is invoked.

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 existing links
  skupper.network.links_load:

Inputs

    
sites:
    description:
    - List of sites used to correlate existing links to Ansible's inventory_hostname entries
    - This module expects that site_load module has been invoked previously
    elements: dict
    required: false
    suboptions:
      host:
        description:
        - The Ansible's inventory_hostname value that represent a given site entry (provided
          by site_load module)
        required: true
        type: str
      id:
        description:
        - The Skupper site id (provided by site_load module)
        required: true
        type: str
      name:
        description:
        - The Skupper site name (provided by site_load module)
        required: true
        type: str
    type: list

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

existing_links:
  description: List of existing links mapped to the corresponding ansible inventory
    hostname
  returned: always
  sample:
    existing_links:
    - cost: 1
      host: host-a
      name: site-a
    - cost: 1
      host: host-b
      name: site-b
  type: dict