Ansible Tower User Guide Release Ansible Tower 3.4.1
Total Page:16
File Type:pdf, Size:1020Kb
Ansible Tower User Guide Release Ansible Tower 3.4.1 Red Hat, Inc. May 05, 2021 CONTENTS 1 Overview 2 1.1 Real-time Playbook Output and Exploration..............................2 1.2 “Push Button” Automation........................................2 1.3 Enhanced and Simplified Role-Based Access Control and Auditing..................2 1.4 Cloud & Autoscaling Flexibility.....................................3 1.5 The Ideal RESTful API.........................................3 1.6 Backup and Restore...........................................3 1.7 Ansible Galaxy Integration........................................3 1.8 Inventory Support for OpenStack....................................3 1.9 Remote Command Execution......................................4 1.10 System Tracking.............................................4 1.11 Integrated Notifications.........................................4 1.12 Satellite and CloudForms Integration..................................4 1.13 Run-time Job Customization.......................................4 1.14 Red Hat Insights Integration.......................................4 1.15 Enhanced Tower User Interface.....................................5 1.16 Custom Virtual Environments......................................5 1.17 Authentication Enhancements......................................5 1.18 Cluster Management...........................................5 1.19 Container Platform Support.......................................5 1.20 Workflow Enhancements.........................................5 1.21 Job Distribution.............................................6 1.22 Support for deployment in a FIPS-enabled environment........................6 2 Tower Licensing, Updates, and Support7 2.1 Support..................................................7 2.2 Trial / Evaluation.............................................7 2.3 Subscription Types............................................7 2.4 Node Counting in Licenses.......................................8 2.5 Tower Component Licenses.......................................8 3 Logging In 9 4 Import a License 10 4.1 Adding a Tower License Manually.................................... 11 5 The Tower User Interface 13 5.1 Activity Streams............................................. 13 5.2 Views................................................... 15 5.3 Resources and Access.......................................... 18 i 5.4 Tower Administration Menu....................................... 19 6 Search 21 6.1 Searching Tips.............................................. 21 6.2 Sort.................................................... 23 7 Organizations 25 7.1 Creating a New Organization...................................... 26 8 Users 36 8.1 Create a User............................................... 36 8.2 User Types - Quick View......................................... 38 8.3 Users - Organizations.......................................... 39 8.4 Users - Teams.............................................. 39 8.5 Users - Permissions........................................... 39 8.6 Users - Tokens.............................................. 42 9 Teams 44 9.1 Create a Team.............................................. 44 10 Credentials 50 10.1 Understanding How Credentials Work.................................. 50 10.2 Getting Started with Credentials..................................... 51 10.3 Add a New Credential.......................................... 52 10.4 Credential Types............................................. 54 11 Custom Credential Types 66 11.1 Backwards-Compatible API Considerations............................... 66 11.2 Getting Started with Credential Types.................................. 67 11.3 Create a New Credential Type...................................... 68 12 Applications 73 12.1 Getting Started with Applications.................................... 73 12.2 Create a new application......................................... 74 13 Projects 77 13.1 Add a new project............................................ 78 13.2 Work with Permissions.......................................... 82 13.3 Work with Notifications......................................... 86 13.4 Work with Job Templates........................................ 87 13.5 Work with Schedules........................................... 87 14 Inventories 90 14.1 Smart Inventories............................................. 92 14.2 Add a new inventory........................................... 93 14.3 Running Ad Hoc Commands....................................... 115 15 Job Templates 118 15.1 Create a Job Template.......................................... 119 15.2 Add Permissions............................................. 124 15.3 Work with Notifications......................................... 128 15.4 View Completed Jobs.......................................... 129 15.5 Scheduling................................................ 130 15.6 Surveys.................................................. 132 15.7 Launch a Job Template.......................................... 134 15.8 Copy a Job Template........................................... 137 ii 15.9 Scan Job Templates........................................... 138 15.10 Fact Caching............................................... 141 15.11 Utilizing Cloud Credentials....................................... 143 15.12 Provisioning Callbacks.......................................... 146 15.13 Extra Variables.............................................. 148 16 Job Slicing 151 16.1 Job slice considerations......................................... 151 16.2 Job slice execution behavior....................................... 152 16.3 Search job slices............................................. 153 17 Workflows 154 17.1 Workflow scenarios and considerations................................. 155 17.2 Extra Variables.............................................. 157 17.3 Workflow States............................................. 158 17.4 Role-Based Access Controls....................................... 159 18 Workflow Job Templates 160 18.1 Create a Workflow Template....................................... 161 18.2 Work with Permissions.......................................... 163 18.3 Work with Notifications......................................... 164 18.4 View Completed Jobs.......................................... 165 18.5 Work with Schedules........................................... 167 18.6 Surveys.................................................. 169 18.7 Workflow Visualizer........................................... 171 18.8 Launch a Workflow Template...................................... 180 18.9 Copy a Workflow Template....................................... 181 18.10 Extra Variables.............................................. 182 19 Instance Groups 183 19.1 Create an instance group......................................... 183 20 Jobs 187 20.1 Job Details - Inventory Sync....................................... 189 20.2 Job Details - SCM............................................ 190 20.3 Job Details - Playbook Run....................................... 192 20.4 Ansible Tower Capacity Determination and Job Impact......................... 196 21 Notifications 200 21.1 Notifier Hierarchy............................................ 200 21.2 Workflow................................................. 201 21.3 Create a Notification Template...................................... 201 21.4 Notification Types............................................ 202 21.5 Configuring the towerhost hostname................................. 208 22 Setting up an Insights Project 209 22.1 Create Insights Credential........................................ 209 22.2 Create an Insights Project........................................ 211 22.3 Create Insights Inventory......................................... 212 22.4 Create a Scan Project........................................... 213 22.5 Create a Scan Job Template....................................... 214 22.6 Remediate Insights Inventory...................................... 216 23 Best Practices 220 23.1 Use Source Control............................................ 220 iii 23.2 Ansible file and directory structure................................... 220 23.3 Use Dynamic Inventory Sources..................................... 220 23.4 Variable Management for Inventory................................... 221 23.5 Autoscaling................................................ 221 23.6 Larger Host Counts............................................ 221 23.7 Continuous integration / Continuous Deployment............................ 221 24 Security 222 24.1 Playbook Access and Information Sharing............................... 222 24.2 Role-Based Access Controls....................................... 224 24.3 Function of roles: editing and creating.................................. 232 25 Index 235 26 Copyright © 2019 Red Hat, Inc. 236 Index 237 iv Ansible Tower User Guide, Release Ansible Tower 3.4.1 Thank you for your interest in Red Hat Ansible Tower. Ansible Tower is a commercial offering that helps teams man- age complex multi-tier deployments by adding control, knowledge, and delegation to Ansible-powered environments. The Ansible Tower User Guide discusses all of the functionality available in Ansible Tower and assumes moderate familiarity with Ansible, including concepts such as Playbooks, Variables, and Tags. For more information on these and other Ansible concepts, please see the Ansible documentation at http://docs.ansible.com/.