-
Notifications
You must be signed in to change notification settings - Fork 144
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Readmes and fix a few things #944
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
9ea3df7
readme updates
sean-m-sullivan cac4ac2
gateway collection updates
sean-m-sullivan e3b81d1
udpate to global aap vars
sean-m-sullivan 369529c
more role conversions
sean-m-sullivan 82cd1bf
update roles loops
sean-m-sullivan 884b18b
update vars add start of guide
sean-m-sullivan 9da67ba
rebase
sean-m-sullivan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,128 @@ | ||
# AAP Configuration conversion guide | ||
|
||
## Background | ||
|
||
This is documentation on how to use convert from the older infra collections to the aap_configuration collection. | ||
|
||
Previously there were multiple collections | ||
infra.controller_configuration | ||
infra.ah_configuration | ||
infra.eda_configuration | ||
|
||
These have been combined along with new roles to configure the gateway aspect of AAP. | ||
|
||
It is recomended to use the old collections when interacting with the Ansible Automation Platforms with versions 2.4 or prior. While some aspects of the collection may work, it can have unintended changes or behaviors. | ||
The collections have been revamped to use a single set of connection variables and to standardize variables throughout the collections. | ||
|
||
This guide will go through some of the standard variables what they were before and what to change them to. | ||
|
||
## Basics | ||
|
||
This collection requires other collections to be used. These collections mainly house the roles to wrap around the official certified collections. While these validated collections are not certified or have a level of support, volunteers spend their free time to maintain them, and to try and address any issues that arise quickly. | ||
|
||
These collections are | ||
|
||
- [ansible.eda](https://console.redhat.com/ansible/automation-hub/repo/published/ansible/eda/) or [upstream](https://galaxy.ansible.com/ui/repo/published/ansible/eda/) | ||
- [ansible.hub](https://console.redhat.com/ansible/automation-hub/repo/published/ansible/hub/) or [upstream](https://galaxy.ansible.com/ui/repo/published/ansible/hub/) | ||
- [ansible.controller](https://console.redhat.com/ansible/automation-hub/repo/published/ansible/controller/) or [awx.awx](https://galaxy.ansible.com/ui/repo/published/awx/awx/) | ||
- [ansible.platform(Gateway collection)](https://console.redhat.com/ansible/automation-hub/repo/published/ansible/platform/) | ||
|
||
These collections are required for this collection to work, While ansible.controller and ansible.gateway are only available from [https://console.redhat.com/](https://console.redhat.com/). | ||
|
||
## Connection and Global Variables | ||
|
||
These are the variables that are used to connecto the platfrom and are the same accross all Roles. Various environment variables can be used as specfied by their module collections, but it is recomended to use ansible vars as they can be homogonized to be single variables. | ||
|
||
### Connection Variables | ||
|
||
These are the connection variables, These are used to connect to the platform. | ||
|
||
|Variable Name|Default Value|Required|Description| | ||
|:---|:---:|:---:|:---|:---| | ||
|`aap_hostname`|""|yes|URL to the Ansible Automation Platform Server.|127.0.0.1| | ||
|`aap_validate_certs`|`True`|no|Whether or not to validate the Ansible Automation Platform Server's SSL certificate.|| | ||
|`aap_username`|""|no|Admin User on the Ansible Automation Platform Server. Either username / password or oauthtoken need to be specified.|| | ||
|`aap_password`|""|no|Platform Admin User's password on the Server. This should be stored in an Ansible Vault at vars/platform-secrets.yml or elsewhere and called from a parent playbook.|| | ||
|`aap_token`|""|no|Controller Admin User's token on the Ansible Automation Platform Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| | ||
|`aap_request_timeout`|`10`|no|Specify the timeout in seconds Ansible should use in requests to the Ansible Automation Platform host.|| | ||
|
||
### Global Variables | ||
|
||
Other Variables that will apply to all roles when used globally. Each of these has a per role that can override the default value if you wish to selectivly use them. This is useful for things like retries and delay on projects, or secure logging for a role. | ||
|
||
|Variable Name|Default Value|Required|Description| | ||
|:---|:---:|:---:|:---|:---| | ||
|`aap_configuration_enforce_defaults`|`False`|no|Whether or not to enforce default option values. This is not universal and it is a best effort to enforce the default values of fields.| | ||
|`aap_configuration_secure_logging`|`False`|no|Whether or not to include the sensitive Registry role tasks in the log. Set this value to `True` if you will be providing your sensitive values from elsewhere.| | ||
|`aap_configuration_async_retries`|50|no|This variable sets the number of retries to attempt for each role globally.| | ||
|`aap_configuration_async_delay`|1|no|This sets the delay between retries for each role globally.| | ||
|`aap_configuration_loop_delay`|1000|no|This variable sets the loop_delay for each role globally.| | ||
|`aap_configuration_async_dir`|`null`|no|Sets the directory to write the results file for async tasks. The default value is set to `null` which uses the Ansible Default of `/root/.ansible_async/`.| | ||
|
||
## Role variables | ||
|
||
The order these variables and roles get applied by the dispatch role are | ||
Gateway -> Hub -> Controller -> EDA | ||
|
||
Below listed are the top level variables for each object in the order they are run by the dispatch role. Also included are the previous values if applicable | ||
|
||
gateway_configuration vars: | ||
|
||
- gateway_authenticators | ||
- gateway_authenticator_maps | ||
- gateway_settings | ||
- aap_applications | ||
- http_ports | ||
- aap_organizations | ||
- gateway_service_nodes | ||
- gateway_gateway_service_keys | ||
- gateway_service_clusters | ||
- gateway_services | ||
- gateway_role_user_assignments | ||
- gateway_routes | ||
- aap_teams | ||
|
||
ah_configuration vars: | ||
|
||
- aap_teams <- ah_groups | ||
- aap_user_accounts <- ah_users | ||
- ah_namespaces | ||
- ah_collections | ||
- ah_ee_registries | ||
- ah_ee_repositories | ||
- ah_ee_images | ||
- ah_collection_remotes | ||
- ah_collection_repositories | ||
|
||
controller_configuration vars: | ||
|
||
- controller_settings | ||
- aap_organizations < - controller_organizations | ||
- controller_instances | ||
- controller_instance_groups | ||
- controller_labels | ||
- controller_credential_types | ||
- controller_credentials | ||
- controller_credential_input_sources | ||
- controller_execution_environments | ||
- aap_applications < - controller_applications | ||
- controller_notifications | ||
- controller_projects | ||
- controller_inventories | ||
- controller_inventory_sources | ||
- controller_inventory_sources | ||
- controller_hosts | ||
- controller_bulk_hosts | ||
- controller_templates | ||
- controller_workflows | ||
- controller_schedules | ||
- controller_launch_jobs | ||
- controller_workflow_launch_jobs | ||
|
||
eda_configuration vars: | ||
|
||
- eda_credentials | ||
- eda_controller_tokens | ||
- eda_projects | ||
- eda_decision_environments | ||
- eda_rulebook_activations |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will this work for validated content?