Objective
This SOP outlines the practical steps to prepare for and execute an Ansible Automation Platform installation workflow, including downloading required bundles, modifying inventory and variables, and understanding related lab/exam tasks such as credentials, workflow setup, and backup/restore considerations. It is designed to help a team member follow the process in a structured, repeatable way.
Key Steps
1. Confirm the installation baseline and required components
- Identify the controller node where Ansible Automation Controller will be installed.
- Confirm the installation pattern being used for the environment.
- Verify that the setup includes the required components for the first installation phase.
- Make sure the team understands that the initial focus is on the controller and hub installation.
2. Use the workstation as the starting point for downloads and preparation
- Log in to the workstation server.
- Switch to the root user before starting installation preparation.
- Download the required bundles from the workstation: Ansible bundle and Certificates bundle.
- Begin preparing the files needed for the installation process.
3. Wait for the required setup window before continuing
- Allow the required waiting period to complete before proceeding.
- Do not attempt to rush the process during this time.
- Use this time to review the remaining installation steps and confirm prerequisites.
- Treat the first question or baseline setup as the most important part of the overall process.
4. Unzip the installation archive and locate the inventory file
- Unzip the provided installation archive.
- Locate the single inventory file included in the extracted contents.
- Confirm that this is the file that will be modified for the installation.
- Use the standard inventory structure provided in the bundle.
5. Update inventory and controller variables
- Modify the inventory file with the required values for the controller.
- Send or define the variables needed for the controller setup.
- Ensure the registration-related values are included where required.
- Verify that the inventory changes match the expected installation pattern.
6. Enter the required admin and database details
- Provide the admin password when prompted.
- Move to the database configuration section.
- Confirm the PostgreSQL database settings for both configuration and storage.
- Ensure the database values are entered correctly before continuing.
7. Complete the controller and hub installation
- Execute the installation commands for the first version of the setup.
- Install the controller and hub as the initial deployment scope.
- Confirm that the installation is being run using the prepared inventory and variables.
- Validate that the installation completes successfully before moving to later tasks.
8. Understand the role of the workstation and root access
- Use the workstation server as the primary access point.
- Switch to root to simplify bundle download and setup tasks.
- Download both the Ansible bundle and the certificates bundle from the workstation.
- Continue preparation from the root session to avoid permission issues.
9. Plan the installation timeline and use buffer time wisely
- Aim to complete the baseline installation quickly, ideally within the first 30 minutes.
- Use the remaining exam or lab time for follow-up tasks.
- Treat the provided duration as including buffer time.
- Prioritize the baseline so the rest of the work becomes easier.
10. Download the manifest after installation is complete
- After the installation finishes, download the manifest.
- Do not attempt to download the manifest before the installation is done.
- Keep the manifest available for subscription and access-related configuration.
- Store it with the rest of the installation artifacts for reference.
11. Use the manifest for subscription and access setup
- Confirm that the manifest contains the required subscription access information.
- Use it to enable access to Ansible Automation Platform resources.
- Verify that the manifest is tied to the correct environment or subscription.
- Keep the manifest ready for any later licensing or access validation.
12. Download files from the workstation using terminal commands
- From the workstation machine, open a terminal session.
- Use wget or a similar command to download the required files.
- Prefer downloading directly from the workstation rather than from another host when possible.
- Confirm the files are saved in the expected location before proceeding.
13. Access the workstation directly with root credentials
- Log in to the workstation using the provided root username and password.
- Do not assume the access flow is the same as OpenShift or other platforms.
- Use direct root access to simplify the setup process.
- Verify that the login is successful before starting downloads or edits.
14. Review inventory host grouping and nested group structure
- Identify the primary host for the load balancer group.
- Confirm that the load balancer group contains the correct host mapping.
- Understand that some hosts may be nested under a parent group.
- Ensure the inventory reflects the backend host relationships correctly.
15. Copy and paste inventory values carefully into the spreadsheet or template
- Transfer the required inventory values into the provided template or spreadsheet.
- Copy the host and group details exactly as specified.
- Double-check for formatting or naming errors before saving.
- Keep the inventory aligned with the expected exam or lab structure.
16. Create required credentials and project access entries
- Create any mandatory credentials requested by the task.
- Add project URLs or other required project details.
- Confirm whether the project requires authentication or can be accessed directly.
- Save the credential entries so they can be reused in workflows and templates.
17. Configure project synchronization and access permissions
- Ensure the correct credentials are used for Git or project authentication.
- Grant access where required for the development or automation team.
- Verify that the project can sync successfully.
- Confirm the correct authentication method if the task specifies one.
18. Build the workflow using the correct project order
- Create the workflow using the required project sequence.
- Place MyWebServiceDev and MyWebServiceProd in the correct row/order.
- Confirm the workflow references the intended project names exactly.
- Validate that the workflow structure matches the requested design.
19. Enable notifications and workflow-level settings
- Add notification settings if they are required for the workflow.
- Review whether notifications should apply to all templates and workflows.
- Enable the correct notification option for the selected workflow or template.
- Confirm the workflow is configured with the intended default behavior.
20. Configure webhook-triggered automation
- Update the YAML or related configuration to call the webhook.
- Use the appropriate user or trigger mechanism to invoke the automation controller webhook.
- Run the webhook from the CLI if required.
- Test the webhook configuration to confirm it triggers the automation correctly.
21. Plan backup and restore scope for the inventory
- Determine whether the task requires backup only or both backup and restore.
- Include all hosts in the inventory when taking backups.
- Confirm that the database is also covered in the backup scope.
- Use the consolidated inventory as the source of truth for the backup process.
22. Verify lab version and environment duration
- Confirm the platform version being used in the lab or exam.
- Understand that the base installation process is similar across versions.
- Adjust GUI navigation based on the version in use.
- Be aware of version-specific features such as Event-Driven Automation in newer releases.
23. Check lab availability and extension status
- Review the lab expiration or auto-stop status.
- Confirm whether the lab can be extended automatically or requires a request.
- Check the portal for the current remaining time.
- Plan work accordingly so the lab does not expire before completion.
Cautionary Notes
- Do not skip the baseline installation steps; the rest of the workflow depends on them.
- Make sure you are using the correct host, inventory, and group names exactly as provided.
- Do not download or apply the manifest before the installation is complete.
- Be careful when editing inventory files; a small typo can break the deployment.
- Confirm whether credentials are required for each project or whether direct access is allowed.
- Version-specific features may change the GUI path or available options.
- If the lab is close to expiring, prioritize critical setup tasks first.
Tips for Efficiency
- Start from the workstation and use root access to reduce permission issues.
- Download all required bundles at the beginning so you do not interrupt the installation later.
- Complete the baseline installation early to leave time for workflow, credential, and webhook tasks.
- Keep a checklist of inventory, credentials, manifest, and workflow items to avoid missing steps.
- Copy host and project names carefully from the source to prevent rework.
- Test webhook and workflow settings immediately after configuration to catch errors early.
💬 Discussion (0)
No comments yet. Be the first to start the discussion!
Leave a Comment