AWX Interface

This section describes how to use the AWX web-based interface.

To log into AWX, browse to AWX interface at http://<AWX-server-name>/ and log in with a valid AWX username and password.

welcome-to-awx.png

The default username set during installation has admin capabilities. The credentials can be accessed in the awx-cluster-bringup-admin-password secret. TBD verify

To retrieve the admin password, run the following command on your AWX host:

Copy
Copied!
            

$ kubectl get secret awx-cluster-bringup-admin-password -o jsonpath="{.data.password}" | base64 --decode

Warning

You can specify the controller_oauthtoken variable with OAuth token for your AWX controller instance instead of using controller_username and controller_password variables.

Refer to the official Ansible Tower Users documentation for information on users.

To view a list of the users currently configured, navigate to Access > Users:

awx-users-menu.png

Warning

When modifying your own password, log out and log back in for it to take effect.

The following example shows how to update admin user details:

  1. Navigate to Access > Users.

  2. Click the "Edit User" icon which opens the "Edit Details" dialog box.

    awx-edit-user.png

  3. Update the appropriate details for the following fields: First Name Last Name Email Password Confirmation Password images/networking/download/attachments/89146554/awx-edit-user-details.png
  4. Click the "Save" button when finished.

Credentials are utilized by AWX for authentication when launching jobs against machines, synchronizing with inventory sources and importing project content from a version control system. Refer to the official Ansible Tower Credentials documentation for further information.

To view a list of the credentials that are currently configured, navigate to Resources > Credentials.

awx-credentials-menu.png

"Default" is configured to use the SSH protocol with the root username.

The following example shows how to update credentials:

  1. Click the "Edit Credential" icon, which opens the "Edit Details" dialog.

    awx-edit-credential.png

  2. Update the appropriate details for the following fields to use for SSH authentication: Username Password images/networking/download/attachments/89146554/awx-edit-credential-details.png
  3. Clock "Save" when finished.

The inventory includes a collection of hosts against which jobs may be launched. Inventories are divided into groups containing the actual hosts. Refer to the official Ansible Tower Inventories documentation for further information.

To view a list of the inventories currently available, go to Resources > Inventories.

awx-inventories-menu.png

A job template is a definition and set of parameters for running an Ansible job. Job templates are useful to execute a single task many times. Refer to the official Ansible Tower Job Templates documentation for further information.

To view a list of the job templates currently available, go to Resources > Templates.

awx-templates-menu.png

You can view a short description of the job template by selecting one from the list.

awx-templates-description.png

In this example, the inventory to be used for this job template is defined as "IB Cluster Inventory" and the credentials for the hosts are defined as "Default".

To launch a job template, click the "Launch Template" icon.

awx-templates-launch.png

To edit settings for a job template, click the "Edit Template" icon:

awx-templates-edit.png

A workflow job template links together a sequence of disparate resources that accomplishes the task of tracking the full set of jobs that are part of the release process as a single unit. Refer to the official Ansible Tower Workflows and Ansible Tower Workflow Job Templates documentation for further information.

To view a list of the workflow job templates currently available, go to Resources > Templates.

awx-templates-workflow.png

Workflow templates have a visualizer action that displays a graphical way of linking together job templates, workflow templates, project syncs, and inventory syncs.

To view the graph-like structure, click the "Visualizer" icon on a particular workflow:

awx-templates-visualizer.png

Example visualization:

awx-templates-visualization.png

© Copyright 2023, NVIDIA. Last updated on Sep 8, 2023.