Skip to content

Commit 2306441

Browse files
Merge pull request #643 from mbaldessari/agof-cleanup
Some agof cleanups
2 parents 752a231 + b802389 commit 2306441

2 files changed

Lines changed: 22 additions & 22 deletions

File tree

content/learn/vp_agof.adoc

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ The link:/patterns/ansible-gitops-framework/[Ansible GitOps Framework] provides
1818

1919
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.
2020

21-
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.
21+
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.
2222

2323
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.
2424

25-
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.
25+
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.
2626

2727
== Role of the Ansible Controller
2828

@@ -53,7 +53,7 @@ This is the easiest method if you already use AWS, as it automates the provision
5353

5454
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.
5555

56-
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
56+
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.
5757

5858
== Creating a validated pattern using the AGOF framework
5959

@@ -75,7 +75,7 @@ This is a minimal pattern that demonstrates how to use the Ansible GitOps Framew
7575
$ git clone git@github.com:validatedpatterns/agof.git
7676
----
7777
+
78-
This serves as the provisioner for the pattern
78+
This serves as the provisioner for the pattern.
7979

8080
=== Deploying using the AWS-based install method
8181

@@ -93,7 +93,7 @@ This method:
9393

9494
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:
9595

96-
* The name of a hosted zone created under Route 53 in AWS. For example this could be `aws.validatedpatterns.io`.
96+
* The name of a hosted zone created under Route 53 in AWS. For example, this could be `aws.validatedpatterns.io`.
9797

9898
* Your AWS account `Account ID`
9999

@@ -183,8 +183,8 @@ Click the `Load token` link at https://console.redhat.com[console.redhat.com] >
183183

184184
. Edit the file and add the following:
185185

186-
* `agof_controller_config_dir:` set it's value to `{{ '~/agof_minimal_demo' | expanduser }}`.
187-
* `db_password:` sets an appropriate value for the postgres password for the DB instance for example `test`.
186+
* `agof_controller_config_dir:` set its value to `{{ '~/agof_minimal_demo' | expanduser }}`.
187+
* `db_password:` set an appropriate value for the postgres password for the DB instance, for example `test`.
188188
* `agof_statedir:` set its value to `"{{ '~/agof' | expanduser }}"`
189189
* `agof_iac_repo:` set its value to `"https://github.com/mhjacks/agof_demo_config.git"`
190190

@@ -232,12 +232,12 @@ activation_key_vault: "kevs-agof-key"
232232
233233
automation_hub_token_vault: '<insert-token-here>'
234234
235-
# These variables can be set but are optional. The previous (before AAP 2.4) conncept of sync-list was private
235+
# These variables can be set but are optional. The previous (before AAP 2.4) concept of sync-list was private
236236
# to an account.
237237
#automation_hub_url_certified_vault: 'The private automation hub URL for certified content'
238238
#automation_hub_url_validated_vault: 'The private automation hub URL for validated content'
239239
240-
controller_config_dir: "{{ '~/agof_minimal_demo' | expanduser }}"
240+
agof_controller_config_dir: "{{ '~/agof_minimal_demo' | expanduser }}"
241241
242242
db_password: 'test'
243243
@@ -258,23 +258,23 @@ This command invokes the `controller_configuration` `dispatch` role on the contr
258258

259259
The default installation provides an AAP 2.4 installation deployed by using the containerized installer, with services deployed this way:
260260

261-
.agof_vault settings
262-
[cols="30%,70%",options="header"]
261+
.Default service URLs
262+
[cols="40%,60%",options="header"]
263263
|===
264-
| URL | Service
264+
| Service | URL
265265

266-
| `https:{{ ec2_name_prefix }}.{{ domain }}:8443`
267-
a| Controller API.
266+
| Controller API
267+
a| `\https://{{ ec2_name_prefix }}.{{ domain }}:8443/`
268268

269-
| `https:{{ ec2_name_prefix }}.{{ domain }}:8444/`
270-
a|Private Automation Hub
269+
| Private Automation Hub
270+
a| `\https://{{ ec2_name_prefix }}.{{ domain }}:8444/`
271271

272-
| `https:/{{ ec2_name_prefix }}.{{ domain }}:8445/``
273-
a| EDA Automation Controller
272+
| EDA Automation Controller
273+
a| `\https://{{ ec2_name_prefix }}.{{ domain }}:8445/`
274274

275275
|===
276276

277-
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.
277+
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.
278278

279279
. 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`.
280280

content/learn/vp_agof_config_controller.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ menu:
44
parent: Validated patterns frameworks
55
title: Using the Controller Configuration collection
66
weight: 25
7-
aliases: /ocp-framework/agof/
7+
aliases: /ocp-framework/agof/config-controller/
88
---
99

1010
:toc:
@@ -14,7 +14,7 @@ include::modules/comm-attributes.adoc[]
1414

1515
== Overview of the Ansible GitOps Framework (AGOF) Installation Process
1616

17-
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:
17+
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:
1818

1919
=== 1. Pre-Init Environment (Bootstrap Ansible)
2020

@@ -29,7 +29,7 @@ The Ansible GitOps Framework (AGOF) is a powerful solution designed to automate
2929
=== 3. Handover to Ansible Controller
3030

3131
* *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.
32-
* *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.
32+
* *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.
3333

3434
== Controller configuration collection
3535

0 commit comments

Comments
 (0)