Fixed graphics, illustrations, tables, examples, sizing
@@ -13,7 +13,7 @@ Scaling your mesh is only available on Openshift and Kubernetes (K8S) deployment
|
|||||||
|
|
||||||
Instances serve as nodes in your mesh topology. Automation mesh allows you to extend the footprint of your automation. Where you launch a job and where the ``ansible-playbook`` runs can be in different locations.
|
Instances serve as nodes in your mesh topology. Automation mesh allows you to extend the footprint of your automation. Where you launch a job and where the ``ansible-playbook`` runs can be in different locations.
|
||||||
|
|
||||||
.. image:: ../common/images/instances_mesh_concept.png
|
.. image:: ../common/images/instances_mesh_concept.drawio.png
|
||||||
:alt: Site A pointing to Site B and dotted arrows to two hosts from Site B
|
:alt: Site A pointing to Site B and dotted arrows to two hosts from Site B
|
||||||
|
|
||||||
Automation mesh is useful for:
|
Automation mesh is useful for:
|
||||||
@@ -23,7 +23,7 @@ Automation mesh is useful for:
|
|||||||
|
|
||||||
The nodes (control, hop, and execution instances) are interconnected via receptor, forming a virtual mesh.
|
The nodes (control, hop, and execution instances) are interconnected via receptor, forming a virtual mesh.
|
||||||
|
|
||||||
.. image:: ../common/images/instances_mesh_concept_with_nodes.png
|
.. image:: ../common/images/instances_mesh_concept_with_nodes.drawio.png
|
||||||
:alt: Control node pointing to hop node, which is pointing to two execution nodes.
|
:alt: Control node pointing to hop node, which is pointing to two execution nodes.
|
||||||
|
|
||||||
|
|
||||||
@@ -78,11 +78,11 @@ Hop nodes can be added to sit between the control plane of AWX and standalone ex
|
|||||||
|
|
||||||
Below is an example of an AWX task pod with two execution nodes. Traffic to execution node 2 flows through a hop node that is setup between it and the control plane.
|
Below is an example of an AWX task pod with two execution nodes. Traffic to execution node 2 flows through a hop node that is setup between it and the control plane.
|
||||||
|
|
||||||
.. image:: ../common/images/instances_awx_task_pods_hopnode.png
|
.. image:: ../common/images/instances_awx_task_pods_hopnode.drawio.png
|
||||||
:alt: AWX task pod with a hop node between the control plane of AWX and standalone execution nodes.
|
:alt: AWX task pod with a hop node between the control plane of AWX and standalone execution nodes.
|
||||||
|
|
||||||
|
|
||||||
An example of a simple topology may look like the following:
|
Below are sample values used to configure each node in a simple topology:
|
||||||
|
|
||||||
.. list-table::
|
.. list-table::
|
||||||
:widths: 20 30 10 20 15
|
:widths: 20 30 10 20 15
|
||||||
@@ -95,9 +95,9 @@ An example of a simple topology may look like the following:
|
|||||||
- Peers
|
- Peers
|
||||||
* - Control plane
|
* - Control plane
|
||||||
- awx-task-65d6d96987-mgn9j
|
- awx-task-65d6d96987-mgn9j
|
||||||
- 27199
|
- n/a
|
||||||
- True
|
- n/a
|
||||||
- []
|
- [hop node]
|
||||||
* - Hop node
|
* - Hop node
|
||||||
- awx-hop-node
|
- awx-hop-node
|
||||||
- 27199
|
- 27199
|
||||||
@@ -107,7 +107,7 @@ An example of a simple topology may look like the following:
|
|||||||
- awx-example.com
|
- awx-example.com
|
||||||
- n/a
|
- n/a
|
||||||
- False
|
- False
|
||||||
- ["hop node"]
|
- [hop node]
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -117,11 +117,11 @@ Mesh topology
|
|||||||
Mesh ingress is a feature that allows remote nodes to connect inbound to the control plane. This is especially useful when creating remote nodes in restricted networking environments that disallow inbound traffic.
|
Mesh ingress is a feature that allows remote nodes to connect inbound to the control plane. This is especially useful when creating remote nodes in restricted networking environments that disallow inbound traffic.
|
||||||
|
|
||||||
|
|
||||||
.. image:: ../common/images/instances_mesh_ingress_topology.png
|
.. image:: ../common/images/instances_mesh_ingress_topology.drawio.png
|
||||||
:alt: Mesh ingress architecture showing the peering relationship between nodes.
|
:alt: Mesh ingress architecture showing the peering relationship between nodes.
|
||||||
|
|
||||||
|
|
||||||
An example of a topology that uses mesh ingress may look like the following:
|
Below are sample values used to configure each node in a mesh ingress topology:
|
||||||
|
|
||||||
.. list-table::
|
.. list-table::
|
||||||
:widths: 20 30 10 20 15
|
:widths: 20 30 10 20 15
|
||||||
@@ -133,12 +133,12 @@ An example of a topology that uses mesh ingress may look like the following:
|
|||||||
- Peers from control nodes
|
- Peers from control nodes
|
||||||
- Peers
|
- Peers
|
||||||
* - Control plane
|
* - Control plane
|
||||||
- awx-task-xyz
|
- awx-task-65d6d96987-mgn9j
|
||||||
- 27199
|
- n/a
|
||||||
- True
|
- n/a
|
||||||
- []
|
- [hop node]
|
||||||
* - Hop node
|
* - Hop node
|
||||||
- awx-hop-node
|
- awx-mesh-ingress-1
|
||||||
- 27199
|
- 27199
|
||||||
- True
|
- True
|
||||||
- []
|
- []
|
||||||
@@ -146,13 +146,14 @@ An example of a topology that uses mesh ingress may look like the following:
|
|||||||
- awx-example.com
|
- awx-example.com
|
||||||
- n/a
|
- n/a
|
||||||
- False
|
- False
|
||||||
- ["hop node"]
|
- [hop node]
|
||||||
|
|
||||||
|
|
||||||
In order to create a mesh ingress for AWX, see the `Mesh Ingress <https://ansible.readthedocs.io/projects/awx-operator/en/latest/user-guide/advanced-configuration/mesh-ingress.html>`_ chapter of the AWX Operator Documentation for information on setting up this type of topology. The last step is to create a remote execution node and add the execution node to an instance group in order for it to be used in your job execution. Whatever execution environment image used to run a playbook needs to be accessible for your remote execution node. Everything you are using in your playbook also needs to be accessible from this remote execution node.
|
In order to create a mesh ingress for AWX, see the `Mesh Ingress <https://ansible.readthedocs.io/projects/awx-operator/en/latest/user-guide/advanced-configuration/mesh-ingress.html>`_ chapter of the AWX Operator Documentation for information on setting up this type of topology. The last step is to create a remote execution node and add the execution node to an instance group in order for it to be used in your job execution. Whatever execution environment image used to run a playbook needs to be accessible for your remote execution node. Everything you are using in your playbook also needs to be accessible from this remote execution node.
|
||||||
|
|
||||||
.. image:: ../common/images/instances-job-template-using-remote-execution-ig.png
|
.. image:: ../common/images/instances-job-template-using-remote-execution-ig.png
|
||||||
:alt: Job template using the instance group with the execution node to run jobs.
|
:alt: Job template using the instance group with the execution node to run jobs.
|
||||||
|
:width: 1400px
|
||||||
|
|
||||||
|
|
||||||
.. _ag_instances_add:
|
.. _ag_instances_add:
|
||||||
@@ -168,6 +169,7 @@ To create an instance in AWX:
|
|||||||
|
|
||||||
.. image:: ../common/images/instances_create_new.png
|
.. image:: ../common/images/instances_create_new.png
|
||||||
:alt: Create a new instance form.
|
:alt: Create a new instance form.
|
||||||
|
:width: 1400px
|
||||||
|
|
||||||
An instance has several attributes that may be configured:
|
An instance has several attributes that may be configured:
|
||||||
|
|
||||||
@@ -190,6 +192,7 @@ Upon successful creation, the Details of the one of the created instances opens.
|
|||||||
|
|
||||||
.. image:: ../common/images/instances_create_details.png
|
.. image:: ../common/images/instances_create_details.png
|
||||||
:alt: Details of the newly created instance.
|
:alt: Details of the newly created instance.
|
||||||
|
:width: 1400px
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
@@ -199,6 +202,7 @@ Upon successful creation, the Details of the one of the created instances opens.
|
|||||||
|
|
||||||
.. image:: ../common/images/instances_install_bundle.png
|
.. image:: ../common/images/instances_install_bundle.png
|
||||||
:alt: Instance details showing the Download button in the Install Bundle field of the Details tab.
|
:alt: Instance details showing the Download button in the Install Bundle field of the Details tab.
|
||||||
|
:width: 1400px
|
||||||
|
|
||||||
5. Extract the downloaded ``tar.gz`` file from the location you downloaded it. The install bundle contains TLS certificates and keys, a certificate authority, and a proper Receptor configuration file. To facilitate that these files will be in the right location on the remote machine, the install bundle includes an ``install_receptor.yml`` playbook. The playbook requires the Receptor collection which can be obtained via:
|
5. Extract the downloaded ``tar.gz`` file from the location you downloaded it. The install bundle contains TLS certificates and keys, a certificate authority, and a proper Receptor configuration file. To facilitate that these files will be in the right location on the remote machine, the install bundle includes an ``install_receptor.yml`` playbook. The playbook requires the Receptor collection which can be obtained via:
|
||||||
|
|
||||||
@@ -237,11 +241,13 @@ Wait a few minutes for the periodic AWX task to do a health check against the ne
|
|||||||
|
|
||||||
.. image:: ../common/images/instances_peers_tab.png
|
.. image:: ../common/images/instances_peers_tab.png
|
||||||
:alt: "Peers" tab showing two peers.
|
:alt: "Peers" tab showing two peers.
|
||||||
|
:width: 1400px
|
||||||
|
|
||||||
To associate peers with your node, click the **Associate** button to open a dialog box of instances eligible for peering.
|
To associate peers with your node, click the **Associate** button to open a dialog box of instances eligible for peering.
|
||||||
|
|
||||||
.. image:: ../common/images/instances_associate_peer.png
|
.. image:: ../common/images/instances_associate_peer.png
|
||||||
:alt: Instances available to peer with the example hop node.
|
:alt: Instances available to peer with the example hop node.
|
||||||
|
:width: 1400px
|
||||||
|
|
||||||
Execution nodes can peer with either hop nodes or other execution nodes. Hop nodes can only peer with execution nodes unless you check the **Peers from control nodes** check box from the **Options** field.
|
Execution nodes can peer with either hop nodes or other execution nodes. Hop nodes can only peer with execution nodes unless you check the **Peers from control nodes** check box from the **Options** field.
|
||||||
|
|
||||||
@@ -265,6 +271,7 @@ Click **Instances** from the left side navigation menu to access the Instances l
|
|||||||
|
|
||||||
.. image:: ../common/images/instances_list_view.png
|
.. image:: ../common/images/instances_list_view.png
|
||||||
:alt: List view of instances in AWX
|
:alt: List view of instances in AWX
|
||||||
|
:width: 1400px
|
||||||
|
|
||||||
The Instances list displays all the current nodes in your topology, along with relevant details:
|
The Instances list displays all the current nodes in your topology, along with relevant details:
|
||||||
|
|
||||||
@@ -290,7 +297,9 @@ The Instances list displays all the current nodes in your topology, along with r
|
|||||||
From this page, you can add, remove or run health checks on your nodes. Use the check boxes next to an instance to select it to remove or run a health check against. When a button is grayed-out, you do not have permission for that particular action. Contact your Administrator to grant you the required level of access. If you are able to remove an instance, you will receive a prompt for confirmation, like the one below:
|
From this page, you can add, remove or run health checks on your nodes. Use the check boxes next to an instance to select it to remove or run a health check against. When a button is grayed-out, you do not have permission for that particular action. Contact your Administrator to grant you the required level of access. If you are able to remove an instance, you will receive a prompt for confirmation, like the one below:
|
||||||
|
|
||||||
.. image:: ../common/images/instances_delete_prompt.png
|
.. image:: ../common/images/instances_delete_prompt.png
|
||||||
:alt: Prompt for deleting instances in AWX.
|
:alt: Prompt for deleting instances in AWX
|
||||||
|
:width: 1400px
|
||||||
|
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
@@ -304,6 +313,7 @@ If running a health check on an instance, at the top of the Details page, a mess
|
|||||||
|
|
||||||
.. image:: ../common/images/instances_health_check.png
|
.. image:: ../common/images/instances_health_check.png
|
||||||
:alt: Health check for instances in AWX
|
:alt: Health check for instances in AWX
|
||||||
|
:width: 1400px
|
||||||
|
|
||||||
Click **Reload** to refresh the instance status.
|
Click **Reload** to refresh the instance status.
|
||||||
|
|
||||||
@@ -318,6 +328,7 @@ The example health check shows the status updates with an error on node 'one':
|
|||||||
|
|
||||||
.. image:: ../common/images/topology-viewer-instance-with-errors.png
|
.. image:: ../common/images/topology-viewer-instance-with-errors.png
|
||||||
:alt: Health check showing an error in one of the instances.
|
:alt: Health check showing an error in one of the instances.
|
||||||
|
:width: 1400px
|
||||||
|
|
||||||
|
|
||||||
Using a custom Receptor CA
|
Using a custom Receptor CA
|
||||||
|
|||||||
|
After Width: | Height: | Size: 21 KiB |
|
Before Width: | Height: | Size: 40 KiB After Width: | Height: | Size: 40 KiB |
|
After Width: | Height: | Size: 26 KiB |
|
Before Width: | Height: | Size: 41 KiB After Width: | Height: | Size: 38 KiB |
|
After Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 52 KiB |
|
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 172 KiB |
BIN
docs/docsite/rst/common/images/instances_mesh_concept.drawio.png
Normal file
|
After Width: | Height: | Size: 10 KiB |
|
After Width: | Height: | Size: 10 KiB |
|
After Width: | Height: | Size: 23 KiB |