redhat_cop.ah_configuration.ah_ee_namespace (0.9.2) — module

Manage private automation hub execution environment namespaces

| "added in version" 0.4.3 of redhat_cop.ah_configuration"

Authors: Herve Quatremain (@herve4m)

Install collection

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


Add to requirements.yml

  collections:
    - name: redhat_cop.ah_configuration
      version: 0.9.2

Description

Create, rename, and delete execution environment namespaces.

Grant group access to namespaces.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Ensure the namespace exists
  redhat_cop.ah_configuration.ah_ee_namespace:
    name: ansible-automation-platform-20-early-access
    state: present
    ah_host: hub.example.com
    ah_username: admin
    ah_password: Sup3r53cr3t
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Ensure the namespace has a new name
  redhat_cop.ah_configuration.ah_ee_namespace:
    name: ansible-automation-platform-20-early-access
    new_name: custom-ee-01
    state: present
    ah_host: hub.example.com
    ah_username: admin
    ah_password: Sup3r53cr3t
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Ensure the namespace is removed
  redhat_cop.ah_configuration.ah_ee_namespace:
    name: custom-ee-01
    state: absent
    ah_host: hub.example.com
    ah_username: admin
    ah_password: Sup3r53cr3t
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Ensure only the operators group can manage the namespace
  redhat_cop.ah_configuration.ah_ee_namespace:
    name: ansible-automation-platform-20-early-access
    state: present
    groups:
      - operators
    append: false
    ah_host: hub.example.com
    ah_username: admin
    ah_password: Sup3r53cr3t
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Ensure the managers group can also manage the namespace
  redhat_cop.ah_configuration.ah_ee_namespace:
    name: ansible-automation-platform-20-early-access
    state: present
    groups:
      - managers
    append: true
    ah_host: hub.example.com
    ah_username: admin
    ah_password: Sup3r53cr3t

Inputs

    
name:
    description:
    - Name of the namespace to create, remove, or modify.
    required: true
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - If C(absent), then the module deletes the namespace.
    - The module does not fail if the namespace does not exist because the state is already
      as expected.
    - If C(present), then the module creates the namespace if it does not already exist.
      If the namespace already exists, then the module updates its state.
    type: str

append:
    default: true
    description:
    - If C(yes), then grant access to the additionnal groups specified in C(groups).
    - If C(no), then the module only grants access to the groups specified in C(groups),
      revoking the access for all other groups.
    type: bool

groups:
    description:
    - List of the groups to grant or remove access to the namespace. When set to an empty
      list (C([])), the module revokes access for all groups.
    elements: str
    type: list

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

new_name:
    description:
    - New name for the namespace. Setting this option changes the name of the namespace
      which current name is provided in C(name).
    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

ah_path_prefix:
    default: galaxy
    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

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