From b80238901f1e7356ed73a5f9b6c8748f0419bfeb Mon Sep 17 00:00:00 2001 From: Michele Baldessari Date: Thu, 12 Feb 2026 11:10:15 +0100 Subject: [PATCH] Some agof cleanups --- content/learn/vp_agof.adoc | 38 ++++++++++---------- content/learn/vp_agof_config_controller.adoc | 6 ++-- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/content/learn/vp_agof.adoc b/content/learn/vp_agof.adoc index ea3d7d339..ef4956150 100644 --- a/content/learn/vp_agof.adoc +++ b/content/learn/vp_agof.adoc @@ -18,11 +18,11 @@ The link:/patterns/ansible-gitops-framework/[Ansible GitOps Framework] provides When there is no access to OpenShift Container Platform, AGOF provides a standalone solution for deploying and managing validated patterns. This framework leverages GitOps principles without relying on OpenShift. -Administrators can use the Ansible Automation Platform, which includes automation controller, a web-based UI interface to define, operate, scale, and delegate automation across their enterprise. +Administrators can use the Ansible Automation Platform, which includes automation controller, a web-based interface to define, operate, scale, and delegate automation across their enterprise. The repository at https://github.com/validatedpatterns/agof/[Ansible GitOps Framework] provides code for installing VMs on AWS, if needed. It can also be used with existing VMs or a functional AAP Controller endpoint. -The link:https://github.com/validatedpatterns/agof/[Ansible GitOps Framework] repository contains code to set up the infrastructure for applying `controller_configuration` to an AAP instance. It includes some predefined configurations and practices to make the infrastructure as code repository more user-friendly and standardized. An AGOF pattern for example link:https://github.com/mhjacks/agof_demo_config[demo] is primarily an IaC infrastructure as code (IaC) artifact designed to be used with the `controller_configuration` collection. +The link:https://github.com/validatedpatterns/agof/[Ansible GitOps Framework] repository contains code to set up the infrastructure for applying `controller_configuration` to an AAP instance. It includes some predefined configurations and practices to make the infrastructure as code repository more user-friendly and standardized. An AGOF pattern, for example the link:https://github.com/mhjacks/agof_demo_config[demo], is primarily an infrastructure as code (IaC) artifact designed to be used with the `controller_configuration` collection. == Role of the Ansible Controller @@ -53,7 +53,7 @@ This is the easiest method if you already use AWS, as it automates the provision In this method, you provide an existing Ansible Automation Platform (AAP) Controller endpoint, either on bare metal or in a private cloud, without needing AWS or pre-configured VMs. You specify the manifest, endpoint hostname, admin credentials, and pass the installation process to a predefined `controller_config_dir`. This is suitable for complex or custom topologies where you want full control over the deployment. -This method provides maximum flexibility and is designed for advanced users who have their own AAP installations, either on-prem or in complex environments that do not fit into the default or AWS-centric model. You need an existing AAP controller, which might not be ideal for users new to AAP or those looking for more hands-off installation +This method provides maximum flexibility and is designed for advanced users who have their own AAP installations, either on-prem or in complex environments that do not fit into the default or AWS-centric model. You need an existing AAP controller, which might not be ideal for users new to AAP or those looking for a more hands-off installation. == Creating a validated pattern using the AGOF framework @@ -75,7 +75,7 @@ This is a minimal pattern that demonstrates how to use the Ansible GitOps Framew $ git clone git@github.com:validatedpatterns/agof.git ---- + -This serves as the provisioner for the pattern +This serves as the provisioner for the pattern. === Deploying using the AWS-based install method @@ -93,7 +93,7 @@ This method: You need to provide some key information to a file named `agof_vault.yml` created in your home directory. The key pieces of information needed are: -* The name of a hosted zone created under Route 53 in AWS. For example this could be `aws.validatedpatterns.io`. +* The name of a hosted zone created under Route 53 in AWS. For example, this could be `aws.validatedpatterns.io`. * Your AWS account `Account ID` @@ -183,8 +183,8 @@ Click the `Load token` link at https://console.redhat.com[console.redhat.com] > . Edit the file and add the following: -* `agof_controller_config_dir:` set it's value to `{{ '~/agof_minimal_demo' | expanduser }}`. -* `db_password:` sets an appropriate value for the postgres password for the DB instance for example `test`. +* `agof_controller_config_dir:` set its value to `{{ '~/agof_minimal_demo' | expanduser }}`. +* `db_password:` set an appropriate value for the postgres password for the DB instance, for example `test`. * `agof_statedir:` set its value to `"{{ '~/agof' | expanduser }}"` * `agof_iac_repo:` set its value to `"https://github.com/mhjacks/agof_demo_config.git"` @@ -232,12 +232,12 @@ activation_key_vault: "kevs-agof-key" automation_hub_token_vault: '' -# These variables can be set but are optional. The previous (before AAP 2.4) conncept of sync-list was private +# These variables can be set but are optional. The previous (before AAP 2.4) concept of sync-list was private # to an account. #automation_hub_url_certified_vault: 'The private automation hub URL for certified content' #automation_hub_url_validated_vault: 'The private automation hub URL for validated content' -controller_config_dir: "{{ '~/agof_minimal_demo' | expanduser }}" +agof_controller_config_dir: "{{ '~/agof_minimal_demo' | expanduser }}" db_password: 'test' @@ -258,23 +258,23 @@ This command invokes the `controller_configuration` `dispatch` role on the contr The default installation provides an AAP 2.4 installation deployed by using the containerized installer, with services deployed this way: -.agof_vault settings -[cols="30%,70%",options="header"] +.Default service URLs +[cols="40%,60%",options="header"] |=== -| URL | Service +| Service | URL -| `https:{{ ec2_name_prefix }}.{{ domain }}:8443` -a| Controller API. +| Controller API +a| `\https://{{ ec2_name_prefix }}.{{ domain }}:8443/` -| `https:{{ ec2_name_prefix }}.{{ domain }}:8444/` -a|Private Automation Hub +| Private Automation Hub +a| `\https://{{ ec2_name_prefix }}.{{ domain }}:8444/` -| `https:/{{ ec2_name_prefix }}.{{ domain }}:8445/`` -a| EDA Automation Controller +| EDA Automation Controller +a| `\https://{{ ec2_name_prefix }}.{{ domain }}:8445/` |=== -Once the install completes, you will have a project, an inventory (consisting of the AAP controller), a credential (the private key from ec2), a job template (which runs a fact gather on the AAP controller) and a schedule that will run the job template every 5 minutes. +Once the install completes, you will have a project, an inventory (consisting of the AAP controller), a credential (the private key from ec2), a job template (which runs a fact gather on the AAP controller) and a schedule that will run the job template every 120 minutes. . Log in to `https://aap.{{ ec2_name_prefix }}.{{ domain }}:8443` with the username `admin` and the password as configured in `admin_password` field of `agof_vault.yml`. diff --git a/content/learn/vp_agof_config_controller.adoc b/content/learn/vp_agof_config_controller.adoc index c2c45cc0b..64aa4f128 100644 --- a/content/learn/vp_agof_config_controller.adoc +++ b/content/learn/vp_agof_config_controller.adoc @@ -4,7 +4,7 @@ menu: parent: Validated patterns frameworks title: Using the Controller Configuration collection weight: 25 -aliases: /ocp-framework/agof/ +aliases: /ocp-framework/agof/config-controller/ --- :toc: @@ -14,7 +14,7 @@ include::modules/comm-attributes.adoc[] == Overview of the Ansible GitOps Framework (AGOF) Installation Process -The Ansible GitOps Framework (AGOF) is a powerful solution designed to automate the deployment and configuration of Ansible Automation Platform (AAP) environments using link:https://opengitops.dev/[GitOps principles]. It leverages Ansible to manage infrastructure and application provisioning in a declarative, version-controlled way. AGOF provides a structured approach to setting up cloud infrastructure, installing AAP components, and handing over control to the AAP Controller for ongoing automation and management. An overview of the steps involved in configuring a basic demo minimal demo application are listed here: +The Ansible GitOps Framework (AGOF) is a powerful solution designed to automate the deployment and configuration of Ansible Automation Platform (AAP) environments using link:https://opengitops.dev/[GitOps principles]. It leverages Ansible to manage infrastructure and application provisioning in a declarative, version-controlled way. AGOF provides a structured approach to setting up cloud infrastructure, installing AAP components, and handing over control to the AAP Controller for ongoing automation and management. An overview of the steps involved in configuring a basic minimal demo application are listed here: === 1. Pre-Init Environment (Bootstrap Ansible) @@ -29,7 +29,7 @@ The Ansible GitOps Framework (AGOF) is a powerful solution designed to automate === 3. Handover to Ansible Controller * *Controller Setup*: The Ansible Automation Platform (AAP) Controller and optionally the Automation Hub are installed and configured. Entitlements are managed through a manifest, and execution environments and collections are downloaded and prepared. -* *GitOps Mode*: After configuration, AGOF transitions to GitOps mode. GGit commits made by the controller to the repositories manage all environment changes, ensuring declarative and automated infrastructure management from this point onward. +* *GitOps Mode*: After configuration, AGOF transitions to GitOps mode. Git commits made by the controller to the repositories manage all environment changes, ensuring declarative and automated infrastructure management from this point onward. == Controller configuration collection