skupper.network.links (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

Updates the links defined by the respective site, based on the links list defined through the host variables.

Existing links that cannot be mapped to an inventory host will be deleted.

Links with a corresponding token (provided by skupper_token role) or manually through the token property will be created.

If a corresponding token cannot be found for a requested link, it will fail.

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

Inputs

    
create:
    description:
    - List of links to create for a given site
    - This list is automatically provided by the links plugin based on host variable named
      I(links)
    - More information on how to define a link can be found at the I(skupper_link) role
      documentation
    - For links to be created the I(skupper_token) role must have been invoked for the
      target host
    elements: dict
    required: false
    suboptions:
      cost:
        description:
        - Cost of the link
        required: false
        type: int
      host:
        description:
        - The ansible_inventory hostname that the respective link is intending to use
          as a target
        required: true
        type: str
      name:
        description:
        - Name of the link to be created
        required: false
        type: str
      token:
        description:
        - Token to use in case I(skupper_token) role hasn't been called (generated token
          is not available)
        required: false
        type: str
    type: list

delete:
    description:
    - List of link names to be deleted
    - Existing links must have been loaded earlier by calling M(skupper.network.links_load)
      module
    elements: dict
    required: false
    suboptions:
      name:
        description:
        - Name of the link to be deleted
        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