Skip to content

Commit

Permalink
fixes and clarifications
Browse files Browse the repository at this point in the history
  • Loading branch information
ivarmu committed Jul 16, 2024
1 parent b56b57a commit 6bdeccd
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 12 deletions.
14 changes: 6 additions & 8 deletions docs/documentation/modules/ROOT/pages/020-export.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
= Export process
include::_attributes.adoc[]

== Pre-requisites
== Pre-Requisits

=== ansible-navigator

To proceed with this guide, ensure you have `ansible-navigator` version `>=3.4.2` installed. If not already installed, you can do so using the following command:

It must be `ansible-navigator>=3.4.2`, and can be installed with the following command:
[.console-input]
[source,console]
----
Expand All @@ -32,9 +31,8 @@ python3 -m pip install --user --upgrade ansible-navigator>=3.4.2

=== ansible-builder (optional)

ansible-builder is optional and required only if you are interested in the bonus steps.

Ensure you have `ansible-builder` version `>=3.0.0` installed. If not already installed, you can do so using the following command:
It is optional if interested in the bonus steps.
It must be `ansible-builder>=3.0.0`, and can be installed with the following command:

[.console-input]
[source,console]
Expand Down Expand Up @@ -77,12 +75,12 @@ The shell that is expected to be used to run the snippet below is `bash`.
----
read -e -p ">>> GitHub Username: " GITHUB_USERNAME
read -e -p ">>> AWX Admin User Name: " AWX_USERNAME
read -e -p ">>> AWX Admin Password: " -s AWX_PASSWORD
read -e -p ">>> AWX Admin Password: " -s AWX_PASSWORD && echo ""
read -e -p ">>> AWX Hostname: " AWX_HOSTNAME
read -e -p ">>> Validate Certs (yes/no): " -i no AWX_VALIDATE_CERTS
read -e -p ">>> Is AAP (yes/no): " -i no IS_AAP
read -e -p ">>> Have Constructed Inventories (yes/no): " -i no HAVE_CONSTRUCTED
read -e -p ">>> Vault Password: " -s VAULT_PASSWORD
read -e -p ">>> Vault Password: " -s VAULT_PASSWORD && echo ""
----

== Fork and clone the GitHub repository
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,9 @@ vaulted_machine_password: verysecretpassword
EOF
ansible-vault encrypt --vault-password-file .vault-password my_vars/vaulted-credentials.yaml
----
----

[NOTE]
====
The password provided in the the file above is not important as it won't be used to run any Job Template against any server. It's just to show the process of filling the sensitive information.
====
6 changes: 4 additions & 2 deletions docs/documentation/modules/ROOT/pages/023-import.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
= Import the configuration into the Ansible Controller
include::_attributes.adoc[]

== Review the initial status of the {ans} Controller

== Import the configuration

Once all the configuration files has been organized and the credentials have been filled in, it can be imported into the Ansible Controller, as shown below.
Expand All @@ -22,12 +24,12 @@ NOTE: The `Vault Password` variable used here should be the same as the one used
[source,console]
----
read -e -p ">>> Ansible Controller Admin User Name: " CONTROLLER_USERNAME
read -e -p ">>> Ansible Controller Admin Password: " -s CONTROLLER_PASSWORD
read -e -p ">>> Ansible Controller Admin Password: " -s CONTROLLER_PASSWORD && echo ""
read -e -p ">>> Ansible Controller Hostname: " CONTROLLER_HOSTNAME
read -e -p ">>> Validate Certs (yes/no): " -i no CONTROLLER_VALIDATE_CERTS
read -e -p ">>> Is AAP (yes/no): " -i yes IS_AAP
read -e -p ">>> Have Constructed Inventories (yes/no): " -i yes HAVE_CONSTRUCTED
read -e -p ">>> Vault Password: " -s VAULT_PASSWORD
read -e -p ">>> Vault Password: " -s VAULT_PASSWORD && echo ""
----

== Customize the Ansible Controller connection
Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/modules/ROOT/pages/_attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ ifndef::imagesdir[:imagesdir: ../assets/images/]

// Variables
:neworg: $\{SUPERADMIN_ORG}
:controller_url: <CHANGE_ME>
:controller_url: $\{CONTROLLER_HOSTNAME}

0 comments on commit 6bdeccd

Please sign in to comment.