diff options
author | TVo <thavo@redhat.com> | 2024-07-24 15:54:43 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-07-24 15:54:43 +0200 |
commit | 018f235a645163ee820ff33b47a70194fabeea66 (patch) | |
tree | 0450ef77ce9d0c0ecc3a3f2a67dfdc26ca710500 | |
parent | Add UI for RECEPTOR_KEEP_WORK_ON_ERROR (diff) | |
download | awx-018f235a645163ee820ff33b47a70194fabeea66.tar.xz awx-018f235a645163ee820ff33b47a70194fabeea66.zip |
Replaced all references of downstream docs to upstream docs (#15388)
* Replaced all references of downstream docs to upstream docs.
* Update README.md
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update README.md.j2
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update README.md.j2
Co-authored-by: Don Naro <dnaro@redhat.com>
* Incorpor'd review feedback from @oraNod and @samccann
* Updated with agreed link (for now) until further change is needed.
---------
Co-authored-by: Don Naro <dnaro@redhat.com>
-rw-r--r-- | .github/triage_replies.md | 2 | ||||
-rw-r--r-- | awx_collection/README.md | 5 | ||||
-rw-r--r-- | awx_collection/plugins/lookup/controller_api.py | 2 | ||||
-rw-r--r-- | awx_collection/plugins/modules/job_template.py | 8 | ||||
-rw-r--r-- | awx_collection/tools/roles/template_galaxy/templates/README.md.j2 | 5 | ||||
-rw-r--r-- | docs/auth/ldap.md | 2 | ||||
-rw-r--r-- | docs/auth/saml.md | 2 | ||||
-rw-r--r-- | docs/docsite/rst/userguide/inventories.rst | 2 | ||||
-rw-r--r-- | docs/docsite/rst/userguide/job_templates.rst | 2 | ||||
-rw-r--r-- | docs/tasks.md | 16 | ||||
-rwxr-xr-x | tools/scripts/post_webhook.py | 2 |
11 files changed, 23 insertions, 25 deletions
diff --git a/.github/triage_replies.md b/.github/triage_replies.md index 110cf260f9..7e315ebcff 100644 --- a/.github/triage_replies.md +++ b/.github/triage_replies.md @@ -1,7 +1,7 @@ ## General - For the roundup of all the different mailing lists available from AWX, Ansible, and beyond visit: https://docs.ansible.com/ansible/latest/community/communication.html - Hello, we think your question is answered in our FAQ. Does this: https://www.ansible.com/products/awx-project/faq cover your question? -- You can find the latest documentation here: https://docs.ansible.com/automation-controller/latest/html/userguide/index.html +- You can find the latest documentation here: https://ansible.readthedocs.io/projects/awx/en/latest/userguide/index.html diff --git a/awx_collection/README.md b/awx_collection/README.md index c3b6f9d529..b6dd3f3a8d 100644 --- a/awx_collection/README.md +++ b/awx_collection/README.md @@ -32,7 +32,7 @@ Installing the `tar.gz` involves no special instructions. ## Running Non-deprecated modules in this collection have no Python requirements, but -may require the official [AWX CLI](https://docs.ansible.com/ansible-tower/latest/html/towercli/index.html) +may require the official [AWX CLI](https://pypi.org/project/awxkit/) in the future. The `DOCUMENTATION` for each module will report this. You can specify authentication by a combination of either: @@ -41,8 +41,7 @@ You can specify authentication by a combination of either: - host, OAuth2 token The OAuth2 token is the preferred method. You can obtain a token via the -AWX CLI [login](https://docs.ansible.com/ansible-tower/latest/html/towercli/reference.html#awx-login) -command. +``login`` command with the AWX CLI. These can be specified via (from highest to lowest precedence): diff --git a/awx_collection/plugins/lookup/controller_api.py b/awx_collection/plugins/lookup/controller_api.py index 6f0d07a4d7..4d5d79cf91 100644 --- a/awx_collection/plugins/lookup/controller_api.py +++ b/awx_collection/plugins/lookup/controller_api.py @@ -12,7 +12,7 @@ requirements: - None description: - Returns GET requests from the Automation Platform Controller API. See - U(https://docs.ansible.com/ansible-tower/latest/html/towerapi/index.html) for API usage. + U(https://docs.ansible.com/automation-controller/latest/html/towerapi/) for API usage. - For use that is cross-compatible between the awx.awx and ansible.controller collection see the controller_meta module options: diff --git a/awx_collection/plugins/modules/job_template.py b/awx_collection/plugins/modules/job_template.py index 81fe495120..6f09e2a5aa 100644 --- a/awx_collection/plugins/modules/job_template.py +++ b/awx_collection/plugins/modules/job_template.py @@ -16,9 +16,9 @@ DOCUMENTATION = ''' --- module: job_template author: "Wayne Witzel III (@wwitzel3)" -short_description: create, update, or destroy Automation Platform Controller job templates. +short_description: create, update, or destroy job templates. description: - - Create, update, or destroy Automation Platform Controller job templates. See + - Create, update, or destroy job templates. See U(https://www.ansible.com/tower) for an overview. options: name: @@ -320,8 +320,8 @@ extends_documentation_fragment: awx.awx.auth notes: - JSON for survey_spec can be found in the API Documentation. See - U(https://docs.ansible.com/ansible-tower/latest/html/towerapi/api_ref.html#/Job_Templates/Job_Templates_job_templates_survey_spec_create) - for POST operation payload example. + U(https://docs.ansible.com/automation-controller/latest/html/towerapi) + for job template survey creation and POST operation payload example. ''' diff --git a/awx_collection/tools/roles/template_galaxy/templates/README.md.j2 b/awx_collection/tools/roles/template_galaxy/templates/README.md.j2 index 94c42b701a..c80b7fc397 100644 --- a/awx_collection/tools/roles/template_galaxy/templates/README.md.j2 +++ b/awx_collection/tools/roles/template_galaxy/templates/README.md.j2 @@ -37,7 +37,7 @@ This collection should be installed from [Content Hub](https://cloud.redhat.com/ ## Running Non-deprecated modules in this collection have no Python requirements, but -may require the official [AWX CLI](https://docs.ansible.com/ansible-tower/latest/html/towercli/index.html) +may require the AWX CLI in the future. The `DOCUMENTATION` for each module will report this. You can specify authentication by a combination of either: @@ -46,8 +46,7 @@ You can specify authentication by a combination of either: - host, OAuth2 token The OAuth2 token is the preferred method. You can obtain a token via the -AWX CLI [login](https://docs.ansible.com/ansible-tower/latest/html/towercli/reference.html#awx-login) -command. +``login`` command with the AWX CLI. These can be specified via (from highest to lowest precedence): diff --git a/docs/auth/ldap.md b/docs/auth/ldap.md index 6f154cfe74..d212fa7ca8 100644 --- a/docs/auth/ldap.md +++ b/docs/auth/ldap.md @@ -4,7 +4,7 @@ The Lightweight Directory Access Protocol (LDAP) is an open, vendor-neutral, ind # Configure LDAP Authentication -Please see the [Tower documentation](https://docs.ansible.com/ansible-tower/latest/html/administration/ldap_auth.html) as well as [Ansible blog post](https://www.ansible.com/blog/getting-started-ldap-authentication-in-ansible-tower) for basic LDAP configuration. +Please see the [AWX documentation](https://ansible.readthedocs.io/projects/awx/en/latest/administration/ldap_auth.html) for basic LDAP configuration. LDAP Authentication provides duplicate sets of configuration fields for authentication with up to six different LDAP servers. The default set of configuration fields take the form `AUTH_LDAP_<field name>`. Configuration fields for additional LDAP servers are numbered `AUTH_LDAP_<n>_<field name>`. diff --git a/docs/auth/saml.md b/docs/auth/saml.md index 56d07f6c96..8b9425027c 100644 --- a/docs/auth/saml.md +++ b/docs/auth/saml.md @@ -3,7 +3,7 @@ Security Assertion Markup Language, or SAML, is an open standard for exchanging # Configure SAML Authentication -Please see the [Tower documentation](https://docs.ansible.com/ansible-tower/latest/html/administration/ent_auth.html#saml-authentication-settings) as well as the [Ansible blog post](https://www.ansible.com/blog/using-saml-with-red-hat-ansible-tower) for basic SAML configuration. Note that AWX's SAML implementation relies on `python-social-auth` which uses `python-saml`. AWX exposes three fields which are directly passed to the lower libraries: +Please see the [AWX documentation](https://ansible.readthedocs.io/projects/awx/en/latest/administration/ent_auth.html#saml-settings) for basic SAML configuration. Note that AWX's SAML implementation relies on `python-social-auth` which uses `python-saml`. AWX exposes three fields which are directly passed to the lower libraries: * `SOCIAL_AUTH_SAML_SP_EXTRA` is passed to the `python-saml` library configuration's `sp` setting. * `SOCIAL_AUTH_SAML_SECURITY_CONFIG` is passed to the `python-saml` library configuration's `security` setting. * `SOCIAL_AUTH_SAML_EXTRA_DATA` diff --git a/docs/docsite/rst/userguide/inventories.rst b/docs/docsite/rst/userguide/inventories.rst index db78bcb08e..6127dc0d51 100644 --- a/docs/docsite/rst/userguide/inventories.rst +++ b/docs/docsite/rst/userguide/inventories.rst @@ -734,7 +734,7 @@ This opens the Details tab of the selected host. .. note:: - You may create hosts in bulk using the newly added endpoint in the API, ``/api/v2/bulk/host_create``. This endpoint accepts JSON and you can specify the target inventory and a list of hosts to add to the inventory. These hosts must be unique within the inventory. Either all hosts are added, or an error is returned indicating why the operation was not able to complete. Use the **OPTIONS** request to return relevant schema. For more information, see the `Bulk endpoint <https://docs.ansible.com/automation-controller/latest/html/controllerapi/api_ref.html#/Bulk>`_ of the *Reference* section of the |atapi|. + You may create hosts in bulk using the newly added endpoint in the API, ``/api/v2/bulk/host_create``. This endpoint accepts JSON and you can specify the target inventory and a list of hosts to add to the inventory. These hosts must be unique within the inventory. Either all hosts are added, or an error is returned indicating why the operation was not able to complete. Use the **OPTIONS** request to return relevant schema. For more information, see the `Bulk endpoint <https://ansible.readthedocs.io/projects/awx/en/latest/rest_api/api_ref.html#/Bulk>`_ of the *Reference* section of the |atapi|. .. _ug_inventories_add_source: diff --git a/docs/docsite/rst/userguide/job_templates.rst b/docs/docsite/rst/userguide/job_templates.rst index 3980e10b26..348ae8c84d 100644 --- a/docs/docsite/rst/userguide/job_templates.rst +++ b/docs/docsite/rst/userguide/job_templates.rst @@ -473,7 +473,7 @@ When slice jobs are running, job lists display the workflow and job slices, as w .. note:: - You may launch jobs in bulk using the newly added endpoint in the API, ``/api/v2/bulk/job_launch``. This endpoint accepts JSON and you can specify a list of unified job templates (such as job templates, project updates, etc) to launch. The user must have the appropriate permission to launch all the jobs. Either all jobs are launched, or an error is returned indicating why the operation was not able to complete. Use the **OPTIONS** request to return relevant schema. For more information, see the `Bulk endpoint <https://docs.ansible.com/automation-controller/latest/html/controllerapi/api_ref.html#/Bulk>`_ of the *Reference* section of the |atapi|. + You may launch jobs in bulk using the newly added endpoint in the API, ``/api/v2/bulk/job_launch``. This endpoint accepts JSON and you can specify a list of unified job templates (such as job templates, project updates, etc) to launch. The user must have the appropriate permission to launch all the jobs. Either all jobs are launched, or an error is returned indicating why the operation was not able to complete. Use the **OPTIONS** request to return relevant schema. For more information, see the `Bulk endpoint <https://ansible.readthedocs.io/projects/awx/en/latest/rest_api/api_ref.html#/Bulk>`_ of the *Reference* section of the |atapi|. Copy a Job Template diff --git a/docs/tasks.md b/docs/tasks.md index b627915784..65dce39ba4 100644 --- a/docs/tasks.md +++ b/docs/tasks.md @@ -187,14 +187,14 @@ This task spawns an `ansible` process, which then runs a command using Ansible. - Build a command line argument list for running Ansible, optionally using `ssh-agent` for public/private key authentication. - Return whether the task should use process isolation. -For more information on ad hoc commands, read the [Running Ad Hoc Commands section](https://docs.ansible.com/ansible-tower/latest/html/userguide/inventories.html#running-ad-hoc-commands) of the Inventories page of the Ansible Tower User Guide. +For more information on ad hoc commands, read the [Running Ad Hoc Commands section](https://ansible.readthedocs.io/projects/awx/en/latest/userguide/inventories.html#running-ad-hoc-commands) of the Inventories chapter of _Automating with AWX_ guide. #### Run Job This task is a definition and set of parameters for running `ansible-playbook` via a Job Template. It defines metadata about a given playbook run, such as a named identifier, an associated inventory to run against, the project and `.yml` playbook file to run, etc. -For more information, visit the [Jobs page](https://docs.ansible.com/ansible-tower/latest/html/userguide/jobs.html) of the Ansible Tower User Guide. +For more information, visit the [Jobs chapter](https://ansible.readthedocs.io/projects/awx/en/latest/userguide/jobs.html) of the _Automating with AWX_ guide. #### Run Project Update @@ -203,7 +203,7 @@ When a Project Update is run in AWX, an `ansible-playbook` command is composed a This task also includes a helper method to build SCM url and extra vars with parameters needed for authentication, as well as a method for returning search/replace strings to prevent output URLs from showing sensitive passwords. -To read more about this topic, visit the [Projects page](https://docs.ansible.com/ansible-tower/latest/html/userguide/projects.html) of the Ansible Tower User Guide. +To read more about this topic, visit the [Projects chapter](https://ansible.readthedocs.io/projects/awx/en/latest/userguide/projects.html) of the _Automating with AWX_ guide. #### Run Inventory Update @@ -214,14 +214,14 @@ In older versions of AWX, the `INI` files were not exclusive for either specific Additionally, inventory imports are run through a management command. Inventory in `args` get passed to that command, which results in it not being considered to be an Ansible inventory by Runner even though it is. -To read more about inventories, visit the [Inventories page](https://docs.ansible.com/ansible-tower/latest/html/userguide/inventories.html) of the Ansible Tower User Guide. For more detail about Runner, visit the [Ansible Runner Integration Overview](https://github.com/ansible/awx/blob/devel/docs/ansible_runner_integration.md) AWX documentation page. +To read more about inventories, visit the [Inventories chapter](https://ansible.readthedocs.io/projects/awx/en/latest/userguide/inventories.html) of the _Automating with AWX_ guide. For more detail about Runner, visit the [Ansible Runner Integration Overview](https://github.com/ansible/awx/blob/devel/docs/ansible_runner_integration.md) AWX documentation page. #### System Jobs The main distinctive feature of a System Job (as compared to all other Unified Jobs) is that a system job runs management commands, which are given the highest priority for execution hierarchy purposes. They also implement a database lock while running, _i.e._, no other jobs can be run during that time on the same node. Additionally, they have a fixed fork impact of 5 vs 1. -You can read more about [Ansible Tower Capacity Determination and Job Impact](https://docs.ansible.com/ansible-tower/latest/html/userguide/jobs.html#at-capacity-determination-and-job-impact) in the Jobs section of the Ansible Tower User Guide. +You can read more about [Ansible Tower Capacity Determination and Job Impact](https://ansible.readthedocs.io/projects/awx/en/latest/userguide/jobs.html#awx-capacity-determination-and-job-impact) in the Jobs chapter of the _Automating with AWX_ guide. ### Periodic Background Tasks @@ -247,7 +247,7 @@ The `smart_inventories` field in AWX uses a membership lookup table that identif An important thing to note is that this task is only run if the `AWX_REBUILD_SMART_MEMBERSHIP` is set to `True` (default is `False`). -For more information, visit the [Smart Inventories section](https://docs.ansible.com/ansible-tower/latest/html/userguide/inventories.html#smart-inventories) of the Tower User Guide's "Inventory" page or the AWX documentation page [Inventory Refresh Overview page](https://github.com/ansible/awx/blob/devel/docs/inventory_refresh.md#inventory-changes) in this repo. +For more information, visit the [Smart Inventories section](https://ansible.readthedocs.io/projects/awx/en/latest/userguide/inventories.html#smart-inventories) of the Inventories chapter of the _Automating with AWX_ guide. #### Deep Copy Model Object @@ -277,7 +277,7 @@ This task allows the user to turn on a global profiler in their system, so that The analytics collection `gather()` and `ship()` functions are called by an `awx-manage gather_analytics --ship` command, which runs on whichever instance it is invoked on. When these functions are called by Celery beat (currently at midnight local time), it is run on one `execution_node` by the Python in the AWX virtualenv. -For more details about analytics, please visit the [Usability Analytics and Data Collection](https://docs.ansible.com/ansible-tower/latest/html/administration/usability_data_collection.html) page. +For more details about analytics, please visit the [Analytics gathering](https://ansible.readthedocs.io/projects/awx/en/latest/administration/awx-manage.html#analytics-gathering) section of the _Administering AWX Deployments_ guide. #### Run Administrative Checks @@ -308,4 +308,4 @@ When a user creates a notification template in `/api/v2/notification_templates`, Notifications assigned at certain levels will inherit traits defined on parent objects in different ways. For example, ad hoc commands will use notifications defined on the Organization that the inventory is associated with. -For more details on notifications, visit the [Notifications page](https://docs.ansible.com/ansible-tower/3.4.3/html/userguide/notifications.html) of the Tower user guide, or the AWX documentation on [Notification System Overview](https://github.com/ansible/awx/blob/devel/docs/notification_system.md) in this repository. +For more details on notifications, visit the [Notifications chapter](hhttps://ansible.readthedocs.io/projects/awx/en/latest/userguide/notifications.html) of the _Automating with AWX_ guide. diff --git a/tools/scripts/post_webhook.py b/tools/scripts/post_webhook.py index 766a033bd1..62f7f85e3b 100755 --- a/tools/scripts/post_webhook.py +++ b/tools/scripts/post_webhook.py @@ -37,7 +37,7 @@ def post_webhook(file, webhook_key, url, verbose, event_type, insecure): \b For setting up webhooks in AWX see: - https://docs.ansible.com/ansible-tower/latest/html/userguide/webhooks.html + https://ansible.readthedocs.io/projects/awx/en/latest/userguide/webhooks.html \b Example usage for GitHub: |