Skip to content

Latest commit

 

History

History
113 lines (90 loc) · 4.75 KB

README.md

File metadata and controls

113 lines (90 loc) · 4.75 KB
Raw

galaxy.galaxy.user

Description

An Ansible Role to create users in Automation Hub.

Variables

Variable Name Default Value Required Description Example
ah_host "" yes URL to the Automation Hub or Galaxy Server. (alias: ah_hostname) 127.0.0.1
ah_username "" yes Admin User on the Automation Hub or Galaxy Server.
ah_password "" yes Automation Hub Admin User's password on the Automation Hub Server. This should be stored in an Ansible Vault at vars/tower-secrets.yml or elsewhere and called from a parent playbook.
ah_validate_certs true no Whether or not to validate the Ansible Automation Hub Server's SSL certificate.
ah_request_timeout 10 no Specify the timeout Ansible should use in requests to the Galaxy or Automation Hub host.
ah_path_prefix "" no API path used to access the api. Either galaxy, automation-hub, or custom
ah_configuration_async_dir null no Sets the directory to write the results file for async tasks. The default value is set to null which uses the Ansible Default of /root/.ansible_async/.
ah_users see below yes Data structure describing your execution environment images, described below.

Secure Logging Variables

The following Variables compliment each other. If Both variables are not set, secure logging defaults to false. The role defaults to False as normally the add user task does not include sensitive information. ah_configuration_user_secure_logging defaults to the value of ah_configuration_secure_logging if it is not explicitly called. This allows for secure logging to be toggled for the entire suite of automation hub configuration roles with a single variable, or for the user to selectively use it.

Variable Name Default Value Required Description
ah_configuration_user_secure_logging False no Whether or not to include the sensitive Namespace role tasks in the log. Set this value to True if you will be providing your sensitive values from elsewhere.
ah_configuration_secure_logging False no This variable enables secure logging as well, but is shared across multiple roles, see above.

Asynchronous Retry Variables

The following Variables set asynchronous retries for the role. If neither of the retries or delay or retries are set, they will default to their respective defaults. This allows for all items to be created, then checked that the task finishes successfully. This also speeds up the overall role.

Variable Name Default Value Required Description
ah_configuration_async_retries 50 no This variable sets the number of retries to attempt for the role globally.
ah_configuration_user_async_retries ah_configuration_async_retries no This variable sets the number of retries to attempt for the role.
ah_configuration_async_delay 1 no This sets the delay between retries for the role globally.
ah_configuration_user_async_delay ah_configuration_async_delay no This sets the delay between retries for the role.

Data Structure

User Variables

Variable Name Default Value Required Type Description
username "" yes str Username. Must be lower case containing only alphanumeric characters and underscores.
groups [] no list List of the groups to update.
append true no str Whether to append or replace the group list provided.
first_name "" no str User's first name.
last_name "" no str User's last name.
email "" no str User's email address.
is_superuser false no bool Whether the user is a superuser.
password "" no str User's password as a clear string. The password must contain at least 9 characters with numbers or special characters.
state present no str Desired state of the user.

Standard Project Data Structure

Yaml Example

---
ah_users:
  - username: user1
    groups:
      - group1
    append: true
    first_name: user
    last_name: one
    email: user1@example.com
    is_superuser: false
    password: p4ssword
    state: present

Playbook Examples

Standard Role Usage

---
- name: Add user to Automation Hub
  hosts: localhost
  connection: local
  gather_facts: false
  vars:
    ah_validate_certs: false
  # Define following vars here, or in ah_configs/ah_auth.yml
  # ah_host: ansible-ah-web-svc-test-project.example.com
  pre_tasks:
    - name: Include vars from ah_configs directory
      ansible.builtin.include_vars:
        dir: ./vars
        extensions: ["yml"]
      tags:
        - always
  roles:
    - ../../user

License

GPLv3+

Author

Tom Page