redhat_cop.ah_configuration.ah_repository (0.8.0) — module

Install collection

Install with ansible-galaxy collection install redhat_cop.ah_configuration:==0.8.0

Add to requirements.yml

  collections:
    - name: redhat_cop.ah_configuration
      version: 0.8.0

Description

Configure an Automation Hub remote Repository. See U(https://www.ansible.com/) for an overview.

Usage examples

Scanned by Steampunk Spotter

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

- name: Configure rh-certified repo
  ah_repository:
    name: rh-certified
    url: https://cloud.redhat.com/api/automation-hub/
    token: aabbcc
    auth_url: https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token

Scanned by Steampunk Spotter

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

- name: Configure community repo
  ah_repository:
    name: community
    url: https://galaxy.ansible.com/api/
    requirements:
      - redhat_cop.ah_configuration
      - redhat_cop.tower_configuration

Scanned by Steampunk Spotter

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

- name: Configure community repo from a file
  ah_repository:
    name: community
    url: https://galaxy.ansible.com/api/
    requirements_file: "/tmp/requirements.yml"

Inputs

    
url:
    description:
    - Remote URL for the repository.
    required: true
    type: str

name:
    description:
    - Repository name. Probably one of community ot rh-certified.
    required: true
    type: str

token:
    description:
    - Token to authenticate to the remote repository.
    type: str

ah_host:
    aliases:
    - ah_hostname
    description:
    - URL to Ansible Galaxy or Automation Hub instance.
    - If value not set, will try environment variable C(AH_HOST)
    - If value not specified by any means, the value of C(127.0.0.1) will be used
    type: str

ah_token:
    description:
    - The Ansible Galaxy or Automation Hub API token to use.
    - This value can be in one of two formats.
    - A string which is the token itself. (i.e. bqV5txm97wqJqtkxlMkhQz0pKhRMMX)
    - A dictionary structure as returned by the ah_token module.
    - If value not set, will try environment variable C(AH_API_TOKEN)
    type: raw

auth_url:
    description:
    - Remote URL for the repository authentication if seperate.
    type: str

password:
    description:
    - Password to authenticate to the remote repository.
    type: str

username:
    description:
    - Username to authenticate to the remote repository.
    type: str

proxy_url:
    description:
    - Proxy URL to use for the connection
    type: str

ah_password:
    description:
    - Password for your Ansible Galaxy or Automation Hub instance.
    - If value not set, will try environment variable C(AH_PASSWORD)
    type: str

ah_username:
    description:
    - Username for your Ansible Galaxy or Automation Hub instance.
    - If value not set, will try environment variable C(AH_USERNAME)
    type: str

requirements:
    description:
    - Requirements to download from remote.
    type: list

ah_path_prefix:
    description:
    - API path used to access the api.
    - For galaxy_ng this is either 'automation-hub' or the custom prefix used on install
      with GALAXY_API_PATH_PREFIX
    - For Automation Hub this is 'galaxy'
    type: str

proxy_password:
    description:
    - Proxy URL to use for the connection
    type: str

proxy_username:
    description:
    - Proxy URL to use for the connection
    type: str

validate_certs:
    aliases:
    - ah_verify_ssl
    description:
    - Whether to allow insecure connections to Galaxy or Automation Hub Server.
    - If C(no), SSL certificates will not be validated.
    - This should only be used on personally controlled sites using self-signed certificates.
    - If value not set, will try environment variable C(AH_VERIFY_SSL)
    type: bool

requirements_file:
    description:
    - A yaml requirements file to download from remote.
    type: str

download_concurrency:
    default: 10
    description:
    - Number of concurrent collections to download.
    type: str