diff --git a/downstream/archive/archived-modules/platform/con-gw-managing-access.adoc b/downstream/archive/archived-modules/platform/con-gw-managing-access.adoc index 91c2473867..e2d0f75078 100644 --- a/downstream/archive/archived-modules/platform/con-gw-managing-access.adoc +++ b/downstream/archive/archived-modules/platform/con-gw-managing-access.adoc @@ -2,7 +2,7 @@ [id="gw-managing-access"] -= Managing access with role based access control += Configure and administer role based access control (RBAC) Role-based access control (RBAC) restricts user access based on their role within an organization. The roles in RBAC refer to the levels of access that users have to the network. diff --git a/downstream/archive/archived-modules/platform/proc-controller-edit-credential.adoc b/downstream/archive/archived-modules/platform/proc-controller-edit-credential.adoc index cb2bf0b6eb..b71eebf648 100644 --- a/downstream/archive/archived-modules/platform/proc-controller-edit-credential.adoc +++ b/downstream/archive/archived-modules/platform/proc-controller-edit-credential.adoc @@ -2,7 +2,7 @@ [id="controller-getting-started-edit-credential"] -= Editing a credential += Edit a credential As part of the initial setup, you can leave the default *Demo Credential* as it is, and you can edit it later. diff --git a/downstream/assemblies/aap-hardening/assembly-hardening-aap.adoc b/downstream/assemblies/aap-hardening/assembly-hardening-aap.adoc index 9ae7535833..540c5db4dc 100644 --- a/downstream/assemblies/aap-hardening/assembly-hardening-aap.adoc +++ b/downstream/assemblies/aap-hardening/assembly-hardening-aap.adoc @@ -3,7 +3,7 @@ ifdef::context[:parent-context: {context}] [id="hardening-aap"] -= Hardening {PlatformNameShort} += Harden the platform security posture :context: hardening-aap diff --git a/downstream/assemblies/aap-hardening/assembly-managed-node-configuration.adoc b/downstream/assemblies/aap-hardening/assembly-managed-node-configuration.adoc index 418155d97e..08e62db44b 100644 --- a/downstream/assemblies/aap-hardening/assembly-managed-node-configuration.adoc +++ b/downstream/assemblies/aap-hardening/assembly-managed-node-configuration.adoc @@ -2,7 +2,7 @@ [id="assembly-managed-node-configuration"] -= Managed Node Configuration += Improve the security of nodes managed by {PlatformNameShort} [role="_abstract"] {PlatformNameShort} is an agentless technology that relies on making a remote connection to the devices it manages, called managed nodes, to run automation tasks. diff --git a/downstream/assemblies/aap-migration/assembly-migration-artifact.adoc b/downstream/assemblies/aap-migration/assembly-migration-artifact.adoc index 0c0d2f972c..bb67821306 100644 --- a/downstream/assemblies/aap-migration/assembly-migration-artifact.adoc +++ b/downstream/assemblies/aap-migration/assembly-migration-artifact.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="migration-artifact"] -= Migration artifact structure and verification += Contents of the migration artifact [role="_abstract"] The migration artifact packages all necessary data and configurations from your source environment. Verify its structure and contents to ensure a successful migration. diff --git a/downstream/assemblies/aap-migration/assembly-source-containerized.adoc b/downstream/assemblies/aap-migration/assembly-source-containerized.adoc index b44774e549..767165a798 100644 --- a/downstream/assemblies/aap-migration/assembly-source-containerized.adoc +++ b/downstream/assemblies/aap-migration/assembly-source-containerized.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="source-containerized"] -= Container-based {PlatformNameShort} += Prepare and export data from a container-based environment [role="_abstract"] Prepare and export data from your container-based {PlatformNameShort} deployment. diff --git a/downstream/assemblies/aap-migration/assembly-source-environment.adoc b/downstream/assemblies/aap-migration/assembly-source-environment.adoc index 868ae56ffc..b695cd70a4 100644 --- a/downstream/assemblies/aap-migration/assembly-source-environment.adoc +++ b/downstream/assemblies/aap-migration/assembly-source-environment.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="source-environment"] -= Source environment += Prepare and export data from the source environment [role="_abstract"] Prepare and export data from your existing {PlatformNameShort} deployment. The exported data forms a critical migration artifact, which you use to configure your new environment. diff --git a/downstream/assemblies/aap-migration/assembly-source-rpm.adoc b/downstream/assemblies/aap-migration/assembly-source-rpm.adoc index fa51f17ef4..dd0d7d095d 100644 --- a/downstream/assemblies/aap-migration/assembly-source-rpm.adoc +++ b/downstream/assemblies/aap-migration/assembly-source-rpm.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="source-rpm"] -= RPM-based {PlatformNameShort} += Prepare and export data from an RPM-based environment [role="_abstract"] Prepare and export data from your RPM-based {PlatformNameShort} deployment. diff --git a/downstream/assemblies/aap-migration/assembly-target-containerized.adoc b/downstream/assemblies/aap-migration/assembly-target-containerized.adoc index 216b25bab3..f94d155cb5 100644 --- a/downstream/assemblies/aap-migration/assembly-target-containerized.adoc +++ b/downstream/assemblies/aap-migration/assembly-target-containerized.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="target-containerized"] -= Container-based {PlatformNameShort} += Prepare the container-based target environment and import migration content [role="_abstract"] Prepare and assess your target container-based {PlatformNameShort} environment, and import and reconcile your migrated content. diff --git a/downstream/assemblies/aap-migration/assembly-target-environment.adoc b/downstream/assemblies/aap-migration/assembly-target-environment.adoc index a33609b82b..ccd0c75167 100644 --- a/downstream/assemblies/aap-migration/assembly-target-environment.adoc +++ b/downstream/assemblies/aap-migration/assembly-target-environment.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="target-environment"] -= Target environment += Prepare, configure, and validate the target environment [role="_abstract"] Prepare, configure, and validate your target {PlatformNameShort} environment. diff --git a/downstream/assemblies/aap-migration/assembly-target-managed-aap.adoc b/downstream/assemblies/aap-migration/assembly-target-managed-aap.adoc index 0baf95c287..2a98ce9898 100644 --- a/downstream/assemblies/aap-migration/assembly-target-managed-aap.adoc +++ b/downstream/assemblies/aap-migration/assembly-target-managed-aap.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="target-managed-aap"] -= Managed {PlatformNameShort} += Prepare to migrate to Managed {PlatformNameShort} [role="_abstract"] Prepare and migrate your source environment to a Managed {PlatformNameShort} deployment, and reconcile the target environment post-migration. diff --git a/downstream/assemblies/aap-migration/assembly-target-ocp.adoc b/downstream/assemblies/aap-migration/assembly-target-ocp.adoc index b18e32454c..c6b7b7c572 100644 --- a/downstream/assemblies/aap-migration/assembly-target-ocp.adoc +++ b/downstream/assemblies/aap-migration/assembly-target-ocp.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="target-ocp"] -= {OCPShort} += Prepare the {OCPShort} target environment and import migration content [role="_abstract"] Prepare and assess your target {OCPShort} environment, and import and reconcile your migrated content. diff --git a/downstream/assemblies/analytics/assembly-automation-savings-planner.adoc b/downstream/assemblies/analytics/assembly-automation-savings-planner.adoc index e35823327e..fe8cf71dcf 100644 --- a/downstream/assemblies/analytics/assembly-automation-savings-planner.adoc +++ b/downstream/assemblies/analytics/assembly-automation-savings-planner.adoc @@ -6,7 +6,7 @@ ifdef::context[:parent-context: {context}] :context: assembly-automation-savings-planner-ctxt -= About the {planner} += Plan, track, and analyze returns with {planner} [role="_abstract"] An automation savings plan gives you the ability to plan, track, and analyze the potential efficiency and cost savings of your automation initiatives. Use automation analytics to create an automation savings plan by defining a list of tasks needed to complete an automation job. diff --git a/downstream/assemblies/analytics/assembly-evaluating-automation-return.adoc b/downstream/assemblies/analytics/assembly-evaluating-automation-return.adoc index d532ed143a..af6197e0e9 100644 --- a/downstream/assemblies/analytics/assembly-evaluating-automation-return.adoc +++ b/downstream/assemblies/analytics/assembly-evaluating-automation-return.adoc @@ -7,7 +7,7 @@ ifdef::context[:parent-context: {context}] :context: assembly-evaluating-automation-return-ctxt -= About Automation Calculator += Use automation calculator to determine automation savings [role="_abstract"] The automation calculator provides graphs, metrics and calculations that help you determine the total savings on your investment in automated processes. diff --git a/downstream/assemblies/analytics/assembly-insights-reports.adoc b/downstream/assemblies/analytics/assembly-insights-reports.adoc index 1aee646213..2348169d47 100644 --- a/downstream/assemblies/analytics/assembly-insights-reports.adoc +++ b/downstream/assemblies/analytics/assembly-insights-reports.adoc @@ -6,7 +6,7 @@ ifdef::context[:parent-context: {context}] :context: assembly-insights-reports-ctxt -= Viewing your reports on {PlatformName} += Get a comprehensive visual overview of automation with reports [role="_abstract"] The reports feature on the {PlatformName} provides users with a visual overview of their automation efforts across different teams by using Ansible. diff --git a/downstream/assemblies/analytics/assembly-using-job-explorer.adoc b/downstream/assemblies/analytics/assembly-using-job-explorer.adoc index 6ba9467d67..08bb6e7066 100644 --- a/downstream/assemblies/analytics/assembly-using-job-explorer.adoc +++ b/downstream/assemblies/analytics/assembly-using-job-explorer.adoc @@ -6,7 +6,7 @@ ifdef::context[:parent-context: {context}] :context: assembly-using-job-explorer-ctxt -= About the Job Explorer += View data about automation jobs across your organization [role="_abstract"] The *Job Explorer* provides a detailed view of jobs run on {ControllerName} clusters across your organizations. You can access the *Job Explorer* by selecting {MenuAAJobExplorer} from the navigation panel or using the drill-down view available across each of the application's charts. diff --git a/downstream/assemblies/automation-dashboard/assembly-appendix-inventory-file-automation-dashboard.adoc b/downstream/assemblies/automation-dashboard/assembly-appendix-inventory-file-automation-dashboard.adoc index 7638de9074..7e11f8ea73 100644 --- a/downstream/assemblies/automation-dashboard/assembly-appendix-inventory-file-automation-dashboard.adoc +++ b/downstream/assemblies/automation-dashboard/assembly-appendix-inventory-file-automation-dashboard.adoc @@ -1,9 +1,9 @@ :_mod-docs-content-type: ASSEMBLY [id="assembly-appendix-inventory-file-automation-dashboard"] -= Appendix += Inventory file variables for {AutomationDashboardName} [role="_abstract"] -The inventory variables required by the {AutomationDashboardName} installer are described in the following table: +The inventory variables required by the {AutomationDashboardName} installation program are described in the following table: include::automation-dashboard/ref-automation-dashboard-inventory-variables.adoc[leveloffset=+1] diff --git a/downstream/assemblies/automation-dashboard/assembly-view-key-metrics.adoc b/downstream/assemblies/automation-dashboard/assembly-view-key-metrics.adoc index 68f3b65720..d8b08f7417 100644 --- a/downstream/assemblies/automation-dashboard/assembly-view-key-metrics.adoc +++ b/downstream/assemblies/automation-dashboard/assembly-view-key-metrics.adoc @@ -6,7 +6,7 @@ ifdef::context[:parent-context: {context}] :context: assembly-view-key-metrics-ctxt -= View key usage metrics with {AutomationDashboardName} += Install {AutomationDashboardName} to calculate savings (RHEL only) [role="_abstract"] diff --git a/downstream/assemblies/builder/assembly-MCP-servers-and-EE.adoc b/downstream/assemblies/builder/assembly-MCP-servers-and-EE.adoc index 98e9bb3487..5bd257b303 100644 --- a/downstream/assemblies/builder/assembly-MCP-servers-and-EE.adoc +++ b/downstream/assemblies/builder/assembly-MCP-servers-and-EE.adoc @@ -10,7 +10,7 @@ An MCP eliminates the need for custom integrations by providing a universal "lan The MCP operates using a client-server architecture: -[cols="a,a", options="header"] +[cols="a,a,a", options="header"] |=== | Component | Role | Description | MCP Host | The application environment | This is where the user interacts with the AI, such as an AI-powered IDE like VS Code or a chatbot interface. diff --git a/downstream/assemblies/builder/assembly-populate-container-registry.adoc b/downstream/assemblies/builder/assembly-populate-container-registry.adoc index 73c3fa164c..d9462c7371 100644 --- a/downstream/assemblies/builder/assembly-populate-container-registry.adoc +++ b/downstream/assemblies/builder/assembly-populate-container-registry.adoc @@ -2,7 +2,7 @@ [id="assembly-populate-container-registry"] -= Populating your {PrivateHubName} container registry += Manage {ExecEnvShort}s in {PrivateHubName} [role="_abstract"] By default, {PrivateHubName} does not include {ExecEnvName}. diff --git a/downstream/assemblies/builder/assembly-using-builder.adoc b/downstream/assemblies/builder/assembly-using-builder.adoc index 0115c03288..17610ccaaf 100644 --- a/downstream/assemblies/builder/assembly-using-builder.adoc +++ b/downstream/assemblies/builder/assembly-using-builder.adoc @@ -2,7 +2,7 @@ [id="assembly-using-builder"] -= Using {Builder} += Build customized runtime environments with Ansible builder [role="_abstract"] {Builder} is a command line tool that automates the process of building {ExecEnvName} by using metadata defined in various Ansible Collections or created by the user. diff --git a/downstream/assemblies/devtools/assembly-backstage-software-templates.adoc b/downstream/assemblies/devtools/assembly-backstage-software-templates.adoc index b57a35ba7c..52736a3411 100644 --- a/downstream/assemblies/devtools/assembly-backstage-software-templates.adoc +++ b/downstream/assemblies/devtools/assembly-backstage-software-templates.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context: {context}] :_mod-docs-content-type: ASSEMBLY [id="backstage-software-templates_{context}"] -= Using custom actions and UI components in Backstage Software Templates += Use custom actions and UI components in Backstage Software Templates :context: self-service-rbac diff --git a/downstream/assemblies/devtools/assembly-creating-playbook-project.adoc b/downstream/assemblies/devtools/assembly-creating-playbook-project.adoc index 8f480f4b3c..ddb39460d6 100644 --- a/downstream/assemblies/devtools/assembly-creating-playbook-project.adoc +++ b/downstream/assemblies/devtools/assembly-creating-playbook-project.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context: {context}] :_mod-docs-content-type: ASSEMBLY [id="creating-playbook-project"] -= Creating a playbook project += Auto-generate the structure and files for your automation project :context: creating-playbook-project [role="_abstract"] diff --git a/downstream/assemblies/devtools/assembly-developer-workflow.adoc b/downstream/assemblies/devtools/assembly-developer-workflow.adoc index 24dc3f0220..8f791b8c33 100644 --- a/downstream/assemblies/devtools/assembly-developer-workflow.adoc +++ b/downstream/assemblies/devtools/assembly-developer-workflow.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context: {context}] :_mod-docs-content-type: ASSEMBLY [id="developer-workflow"] -= Workflow for developing automation content += Development workflow :context: developer-workflow diff --git a/downstream/assemblies/devtools/assembly-devtools-create-roles-collection.adoc b/downstream/assemblies/devtools/assembly-devtools-create-roles-collection.adoc index 707675f61d..93612f062c 100644 --- a/downstream/assemblies/devtools/assembly-devtools-create-roles-collection.adoc +++ b/downstream/assemblies/devtools/assembly-devtools-create-roles-collection.adoc @@ -9,7 +9,7 @@ ifdef::context[] [id="devtools-create-roles-collection_{context}"] endif::[] -= Creating a collection for distributing roles += Understand collections for distributing roles :context: devtools-create-roles-collection diff --git a/downstream/assemblies/devtools/assembly-devtools-develop-collections.adoc b/downstream/assemblies/devtools/assembly-devtools-develop-collections.adoc index ccae6bc7e8..51c7e913c4 100644 --- a/downstream/assemblies/devtools/assembly-devtools-develop-collections.adoc +++ b/downstream/assemblies/devtools/assembly-devtools-develop-collections.adoc @@ -8,7 +8,7 @@ endif::[] ifdef::context[] [id="devtools-develop-collections_{context}"] endif::[] -= Developing collections += Package and distribute automation content with collections :context: devtools-develop-collections diff --git a/downstream/assemblies/devtools/assembly-devtools-extension-set-language.adoc b/downstream/assemblies/devtools/assembly-devtools-extension-set-language.adoc index 9ea41281bc..7054c45c08 100644 --- a/downstream/assemblies/devtools/assembly-devtools-extension-set-language.adoc +++ b/downstream/assemblies/devtools/assembly-devtools-extension-set-language.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context-of-assembly-devtools-install: {context}] :_mod-docs-content-type: ASSEMBLY [id="extension-set-language"] -= Manually adding the Ansible language to YAML files += Set the lanaguge for the {VSCode} extension [role="_abstract"] diff --git a/downstream/assemblies/devtools/assembly-devtools-install.adoc b/downstream/assemblies/devtools/assembly-devtools-install.adoc index b493ce4cb4..c610f78503 100644 --- a/downstream/assemblies/devtools/assembly-devtools-install.adoc +++ b/downstream/assemblies/devtools/assembly-devtools-install.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context-of-assembly-devtools-install: {context}] :_mod-docs-content-type: ASSEMBLY [id="installing-devtools"] -= Installing {ToolsName} += Install {ToolsName} :context: installing-devtools [role="_abstract"] diff --git a/downstream/assemblies/devtools/assembly-devtools-intro.adoc b/downstream/assemblies/devtools/assembly-devtools-intro.adoc index 0629791b93..429a95a076 100644 --- a/downstream/assemblies/devtools/assembly-devtools-intro.adoc +++ b/downstream/assemblies/devtools/assembly-devtools-intro.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context: {context}] :_mod-docs-content-type: ASSEMBLY [id="devtools-intro"] -= {ToolsName} += Create, test, and deploy automation content with ansible-dev-tools :context: devtools-intro [role="_abstract"] diff --git a/downstream/assemblies/devtools/assembly-mcp-vscode-ext-configure.adoc b/downstream/assemblies/devtools/assembly-mcp-vscode-ext-configure.adoc new file mode 100644 index 0000000000..c8d65c1908 --- /dev/null +++ b/downstream/assemblies/devtools/assembly-mcp-vscode-ext-configure.adoc @@ -0,0 +1,32 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-19 +:_mod-docs-content-type: ASSEMBLY + +ifdef::context[:parent-context-of-mcp-vscode-ext-enable: {context}] + +ifndef::context[] +[id="mcp-vscode-ext-enable"] +endif::[] +ifdef::context[] +[id="mcp-vscode-ext-enable_{context}"] +endif::[] += Configuring the Ansible {VSCode} extension MCP server + +:context: mcp-vscode-ext-enable + +[role="_abstract"] +As an automation developer, you can enable the Ansible MCP (Model context protocol) server to work with the Ansible {VSCode} extension. Doing so empowers {ToolsName} to give customized suggestions tuned specifically to your working environment. + +You can enable the MCP server through the {VSCode} command palette, or the *Settings* menu. + +== Prerequisites +* {VSCode} is installed and running. +* The GitHub Copilot extension is installed, running, and enabled in Agent Mode. +* The Ansible {VSCode} extension is installed. + +include::devtools/proc-enable-mcp-command-palette.adoc[leveloffset=+1] + +include::devtools/proc-enable-mcp-settings.adoc[leveloffset=+1] + +include::devtools/proc-disable-mcp-server.adoc[leveloffset=+1] + diff --git a/downstream/assemblies/devtools/assembly-mcp-vscode-ext-create-ee.adoc b/downstream/assemblies/devtools/assembly-mcp-vscode-ext-create-ee.adoc new file mode 100644 index 0000000000..78991f94b3 --- /dev/null +++ b/downstream/assemblies/devtools/assembly-mcp-vscode-ext-create-ee.adoc @@ -0,0 +1,33 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-19 +:_mod-docs-content-type: ASSEMBLY + +ifdef::context[:parent-context-of-mcp-vscode-ext-create-ee: {context}] + +ifndef::context[] +[id="mcp-vscode-ext-create-ee"] +endif::[] +ifdef::context[] +[id="mcp-vscode-ext-create-ee_{context}"] +endif::[] += Create and validate an {ExecEnvShort} with the AI assistant + +:context: mcp-vscode-ext-create-ee + +[role="_abstract"] +Use the AI assistant to generate and validate a definition file, and then build an {ExecEnvShort} with `ansible-builder`. + +== Prerequisites + +* The GitHub Copilot Extension installed and active. +* Ansible {VSCode} extension is installed. +* The Ansible MCP server is enabled. Ensure the setting `ansible.mcpServer.enabled` is set to `true`. +* {ToolsName} is installed either through the AI assistant (`adt_check_env`) or manually. + +include::devtools/proc-create-ee-def-with-assistant.adoc[leveloffset=+1] + +include::devtools/proc-generate-ee-from-playbook.adoc[leveloffset=+1] + +include::devtools/proc-validate-ee-with-assistant.adoc[leveloffset=+1] + +include::devtools/proc-build-ee-with-assistant.adoc[leveloffset=+1] \ No newline at end of file diff --git a/downstream/assemblies/devtools/assembly-mcp-vscode-ext-manage.adoc b/downstream/assemblies/devtools/assembly-mcp-vscode-ext-manage.adoc new file mode 100644 index 0000000000..0fe11fc79d --- /dev/null +++ b/downstream/assemblies/devtools/assembly-mcp-vscode-ext-manage.adoc @@ -0,0 +1,30 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-19 +:_mod-docs-content-type: ASSEMBLY + +ifdef::context[:parent-context-of-mcp-vscode-ext-manage: {context}] + +ifndef::context[] +[id="mcp-vscode-ext-manage"] +endif::[] +ifdef::context[] +[id="mcp-vscode-ext-manage_{context}"] +endif::[] += Manage your {ToolsName} environment with the AI assistant + +:context: mcp-vscode-ext-manage + +[role="_abstract"] +Use the AI assistant to help you understand what is happening in your own environment without having to leave the {VSCode} editor. + +== Prerequisites + +* {VSCode} is open with the Ansible {VSCode} extension active. +* The Ansible MCP server is enabled. +* GitHub Copilot is active. + +include::devtools/proc-understand-env-with-assistant.adoc[leveloffset=+1] + +include::devtools/proc-understand-automation-with-assistant.adoc[leveloffset=+1] + +include::devtools/proc-list-available-mcp-tools.adoc[leveloffset=+1] diff --git a/downstream/assemblies/devtools/assembly-mcp-vscode-ext-run.adoc b/downstream/assemblies/devtools/assembly-mcp-vscode-ext-run.adoc new file mode 100644 index 0000000000..63fb0e2e0f --- /dev/null +++ b/downstream/assemblies/devtools/assembly-mcp-vscode-ext-run.adoc @@ -0,0 +1,30 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-19 +:_mod-docs-content-type: ASSEMBLY + +ifdef::context[:parent-context-of-mcp-vscode-ext-run: {context}] + +ifndef::context[] +[id="mcp-vscode-ext-run"] +endif::[] +ifdef::context[] +[id="mcp-vscode-ext-run_{context}"] +endif::[] += Running playbooks with `ansible-navigator` using the AI assistant + +:context: mcp-vscode-ext-run + +[role="_abstract"] +Once you have built a suitable {ExecEnvShort}, prompt the AI assistant to generate the correct `ansible-navigator` command to execute your playbook in that particular environment. + +== Prerequisites + +* The GitHub Copilot Extension is installed and active. +* Ansible {VSCode} extension is installed. +* The Ansible MCP server is enabled. +* {ToolsName} is installed through the AI assistant (`adt_check_env`) or manually. +* An {ExecEnvShort} definition file is prepared and ready to use. + +include::devtools/proc-run-playbook-with-assistant.adoc[leveloffset=+1] + + diff --git a/downstream/assemblies/devtools/assembly-mcp-vscode-ext-scaffold.adoc b/downstream/assemblies/devtools/assembly-mcp-vscode-ext-scaffold.adoc new file mode 100644 index 0000000000..5361437e44 --- /dev/null +++ b/downstream/assemblies/devtools/assembly-mcp-vscode-ext-scaffold.adoc @@ -0,0 +1,31 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-19 +:_mod-docs-content-type: ASSEMBLY + +ifdef::context[:parent-context-of-mcp-vscode-ext-scaffold: {context}] + +ifndef::context[] +[id="mcp-vscode-ext-scaffold"] +endif::[] +ifdef::context[] +[id="mcp-vscode-ext-scaffold_{context}"] +endif::[] += Scaffolding an Ansible project with the AI assistant + +:context: mcp-vscode-ext-scaffold + +[role="_abstract"] +Use the Ansible {VSCode} extension's embedded MCP server to generate a new project structure, and to create and scaffold new content such as playbooks or collections. +With the AI assistant, you can ensure the project aligns with best practices and organizational standards without manually creating boilerplate code. + +== Prerequisites + +* The Ansible {VSCode} extension is installed, running, and enabled in Agent Mode. +* The Ansible MCP server is enabled in the Ansible {VSCode} extension. +* {ToolsName} is installed. + +include::devtools/proc-view-best-practices-for-content.adoc[leveloffset=+1] + +include::devtools/proc-create-project-structure-assistant.adoc[leveloffset=+1] + +include::devtools/proc-scaffold-content-assistant.adoc[leveloffset=+1] \ No newline at end of file diff --git a/downstream/assemblies/devtools/assembly-mcp-vscode-ext-setup.adoc b/downstream/assemblies/devtools/assembly-mcp-vscode-ext-setup.adoc new file mode 100644 index 0000000000..9518e9db86 --- /dev/null +++ b/downstream/assemblies/devtools/assembly-mcp-vscode-ext-setup.adoc @@ -0,0 +1,36 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-17 +:_mod-docs-content-type: ASSEMBLY + +ifdef::context[:parent-context-of-mcp-server-aap-vscode-extension: {context}] + +ifndef::context[] +[id="mcp-server-aap-vscode-extension"] +endif::[] +ifdef::context[] +[id="mcp-server-aap-vscode-extension_{context}"] +endif::[] += Set up your development environment with the MCP server-enabled Ansible {VSCode} extension + +:context: mcp-server-aap-vscode-extension + +[role="_abstract"] +Use the MCP server-enabled Ansible AI assistant within the Ansible {VSCode} extension to: + +* Query your environment to understand which tools are already installed. +* Install `ansible-dev-tools`. +* Set up and configure your development environment. + +== Prerequisites + +* The latest version of Python is installed. + +include::devtools/proc-run-environment-diagnostics.adoc[leveloffset=+1] + +include::devtools/proc-install-mcp-devtools.adoc[leveloffset=+1] + +include::devtools/proc-configure-adt-with-assistant.adoc[leveloffset=+1] + + + + diff --git a/downstream/assemblies/devtools/assembly-mcp-vscode-ext-validate.adoc b/downstream/assemblies/devtools/assembly-mcp-vscode-ext-validate.adoc new file mode 100644 index 0000000000..40c28333e5 --- /dev/null +++ b/downstream/assemblies/devtools/assembly-mcp-vscode-ext-validate.adoc @@ -0,0 +1,32 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-19 +:_mod-docs-content-type: ASSEMBLY + +ifdef::context[:parent-context-of-mcp-vscode-ext-validate: {context}] + +ifndef::context[] +[id="mcp-vscode-ext-validate"] +endif::[] +ifdef::context[] +[id="mcp-vscode-ext-validate_{context}"] +endif::[] += Validate and debug content with the AI assistant + +:context: mcp-vscode-ext-validate + +[role="_abstract"] +Use the AI assistant to validate playbooks in real time, identify issues before execution, and automatically apply fixes. + +== Prerequisites + +* {VSCode} is open with the Ansible {VSCode} extension active. +* The Ansible MCP Server is enabled. +* An Ansible playbook open in the {VSCode} editor. + +include::devtools/proc-validate-content-with-assistant.adoc[leveloffset=+1] + +include::devtools/proc-auto-fix-with-the-assistant.adoc[leveloffset=+1] + +include::devtools/proc-debug-with-assistant.adoc[leveloffset=+1] + +include::devtools/proc-implement-fixes-with-the-assistant.adoc[leveloffset=+1] \ No newline at end of file diff --git a/downstream/assemblies/devtools/assembly-publishing-playbook-collection-aap.adoc b/downstream/assemblies/devtools/assembly-publishing-playbook-collection-aap.adoc index a2b7da26ff..4deb360357 100644 --- a/downstream/assemblies/devtools/assembly-publishing-playbook-collection-aap.adoc +++ b/downstream/assemblies/devtools/assembly-publishing-playbook-collection-aap.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context: {context}] :_mod-docs-content-type: ASSEMBLY [id="publishing-playbook-collection-aap"] -= Publishing and running your playbooks in {PlatformNameShort} += Publish and run your playbook automation :context: publishing-playbook-collection-aap-intro [role="_abstract"] diff --git a/downstream/assemblies/devtools/assembly-rhdh-example.adoc b/downstream/assemblies/devtools/assembly-rhdh-example.adoc index 306a7781ca..1a6971831d 100644 --- a/downstream/assemblies/devtools/assembly-rhdh-example.adoc +++ b/downstream/assemblies/devtools/assembly-rhdh-example.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context: {context}] :_mod-docs-content-type: ASSEMBLY [id="rhdh-example_{context}"] -= Example: Automate Red Hat Enterprise Linux firewall configuration += Example: Automate a Red Hat Linux firewall configuration :context: rhdh-example [role="_abstract"] diff --git a/downstream/assemblies/devtools/assembly-rhdh-install-ocp-helm.adoc b/downstream/assemblies/devtools/assembly-rhdh-install-ocp-helm.adoc index 62808c59ff..66f3b31d46 100644 --- a/downstream/assemblies/devtools/assembly-rhdh-install-ocp-helm.adoc +++ b/downstream/assemblies/devtools/assembly-rhdh-install-ocp-helm.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context-of-rhdh-install-ocp-helm: {context}] :_mod-docs-content-type: ASSEMBLY [id="rhdh-install-ocp-helm_{context}"] -= Installing the Ansible plug-ins with a Helm chart on {OCPShort} += Install with a Helm chart :context: rhdh-install-ocp [role="_abstract"] diff --git a/downstream/assemblies/devtools/assembly-rhdh-install-ocp-operator.adoc b/downstream/assemblies/devtools/assembly-rhdh-install-ocp-operator.adoc index 16c63ea868..f4b87a00f2 100644 --- a/downstream/assemblies/devtools/assembly-rhdh-install-ocp-operator.adoc +++ b/downstream/assemblies/devtools/assembly-rhdh-install-ocp-operator.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context-of-rhdh-install-ocp-operator: {context}] :_mod-docs-content-type: ASSEMBLY [id="rhdh-install-ocp-operator_{context}"] -= Installing the {AAPRHDHShort} with the Operator on {OCPShort} += Install with the {OperatorPlatformNameShort} on {OCPShort} :context: rhdh-install-ocp-operator [role="_abstract"] diff --git a/downstream/assemblies/devtools/assembly-rhdh-intro.adoc b/downstream/assemblies/devtools/assembly-rhdh-intro.adoc index 83d73db6fe..1c6749b7c1 100644 --- a/downstream/assemblies/devtools/assembly-rhdh-intro.adoc +++ b/downstream/assemblies/devtools/assembly-rhdh-intro.adoc @@ -2,11 +2,11 @@ ifdef::context[:parent-context: {context}] :_mod-docs-content-type: ASSEMBLY [id="rhdh-intro_{context}"] -= {AAPRHDH} += Install {RHDH} ({OCP} only) :context: rhdh-intro [role="_abstract"] -{AAPRHDH} (RHDH) offer a tailored RHDH interface, curated learning paths, and software templates for creating projects, all while linking to supported development environments like OpenShift Dev Spaces and Ansible Automation Platform. +{AAPRHDH} (RHDH) offer a tailored {RHDH} interface, curated learning paths, and software templates for creating projects, all while linking to supported development environments like OpenShift Dev Spaces and Ansible Automation Platform. include::devtools/ref-rhdh-about-rhdh.adoc[leveloffset=+1] diff --git a/downstream/assemblies/devtools/assembly-rhdh-ocp-configure-optional.adoc b/downstream/assemblies/devtools/assembly-rhdh-ocp-configure-optional.adoc index 408cac7584..d8c0a36ef6 100644 --- a/downstream/assemblies/devtools/assembly-rhdh-ocp-configure-optional.adoc +++ b/downstream/assemblies/devtools/assembly-rhdh-ocp-configure-optional.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context-of-rhdh-ocp-configure-optional: {context}] :_mod-docs-content-type: ASSEMBLY [id="rhdh-ocp-configure-optional_{context}"] -= Optional configuration for Ansible plug-ins += Optional configurations :context: rhdh-ocp-configure-optional_{parent-context-of-rhdh-ocp-configure-optional} [role="_abstract"] diff --git a/downstream/assemblies/devtools/assembly-rhdh-ocp-full-examples.adoc b/downstream/assemblies/devtools/assembly-rhdh-ocp-full-examples.adoc index a4e8bb38cd..f919c48d14 100644 --- a/downstream/assemblies/devtools/assembly-rhdh-ocp-full-examples.adoc +++ b/downstream/assemblies/devtools/assembly-rhdh-ocp-full-examples.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context-of-rhdh-ocp-full-examples: {context}] :_mod-docs-content-type: ASSEMBLY [id="rhdh-ocp-full-examples_{context}"] -= Full examples += Example ConfigMaps :context: rhdh-ocp-full-examples [role="_abstract"] diff --git a/downstream/assemblies/devtools/assembly-rhdh-telemetry-capturing.adoc b/downstream/assemblies/devtools/assembly-rhdh-telemetry-capturing.adoc index 2a3b233a0d..6faf05dfa0 100644 --- a/downstream/assemblies/devtools/assembly-rhdh-telemetry-capturing.adoc +++ b/downstream/assemblies/devtools/assembly-rhdh-telemetry-capturing.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context-of-rhdh-telemetry-capturing: {context}] :_mod-docs-content-type: ASSEMBLY [id="rhdh-configure-telemetry_{context}"] -= {RHDH} data telemetry capturing += Capture telemetry data for {RHDH} [role="_abstract"] {RHDH} (RHDH) sends telemetry data to Red Hat using the `backstage-plugin-analytics-provider-segment` plug-in, which is enabled by default. diff --git a/downstream/assemblies/devtools/assembly-rhdh-uninstall-ocp-helm.adoc b/downstream/assemblies/devtools/assembly-rhdh-uninstall-ocp-helm.adoc index 8e9f4c959b..797aec2f0c 100644 --- a/downstream/assemblies/devtools/assembly-rhdh-uninstall-ocp-helm.adoc +++ b/downstream/assemblies/devtools/assembly-rhdh-uninstall-ocp-helm.adoc @@ -2,8 +2,7 @@ ifdef::context[:parent-context-of-assembly-rhdh-uninstall-ocp-helm: {context}] :_mod-docs-content-type: ASSEMBLY [id="rhdh-uninstall-ocp-helm_{context}"] -= Uninstalling the Ansible plug-ins from a Helm installation on {OCPShort} - += Uninstall from a Helm installation on {OCPShort} :context: rhdh-uninstall-ocp-helm [role="_abstract"] diff --git a/downstream/assemblies/devtools/assembly-rhdh-uninstall-ocp-operator.adoc b/downstream/assemblies/devtools/assembly-rhdh-uninstall-ocp-operator.adoc index 0fb4ccd5b1..540b1835c7 100644 --- a/downstream/assemblies/devtools/assembly-rhdh-uninstall-ocp-operator.adoc +++ b/downstream/assemblies/devtools/assembly-rhdh-uninstall-ocp-operator.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context-of-assembly-rhdh-uninstall-ocp-operator: {context :_mod-docs-content-type: ASSEMBLY [id="rhdh-uninstall-ocp-operator{context}"] -= Uninstalling an Operator installation on {OCPShort} += Uninstall an Operator installation on {OCPShort} :context: rhdh-uninstall-ocp-operator diff --git a/downstream/assemblies/devtools/assembly-rhdh-upgrade-ocp-helm.adoc b/downstream/assemblies/devtools/assembly-rhdh-upgrade-ocp-helm.adoc index b8cbf17419..df09ee0893 100644 --- a/downstream/assemblies/devtools/assembly-rhdh-upgrade-ocp-helm.adoc +++ b/downstream/assemblies/devtools/assembly-rhdh-upgrade-ocp-helm.adoc @@ -2,8 +2,7 @@ ifdef::context[:parent-context-of-assembly-rhdh-upgrade-ocp-helm: {context}] :_mod-docs-content-type: ASSEMBLY [id="rhdh-upgrade-ocp-helm_{context}"] -= Upgrading the Ansible plug-ins on a Helm installation on {OCPShort} - += Upgrade the Ansible plug-ins with Helm :context: rhdh-upgrade-ocp-helm [role="_abstract"] diff --git a/downstream/assemblies/devtools/assembly-rhdh-upgrade-ocp-operator.adoc b/downstream/assemblies/devtools/assembly-rhdh-upgrade-ocp-operator.adoc index 9ef1c4c28d..abdcd879c0 100644 --- a/downstream/assemblies/devtools/assembly-rhdh-upgrade-ocp-operator.adoc +++ b/downstream/assemblies/devtools/assembly-rhdh-upgrade-ocp-operator.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context-of-assembly-rhdh-upgrade-ocp-operator: {context}] :_mod-docs-content-type: ASSEMBLY [id="rhdh-upgrade-ocp-operator_{context}"] -= Upgrading the Ansible plug-ins on an Operator installation on {OCPShort} += Upgrade the Ansible plug-ins for an Operator environment :context: rhdh-upgrade-ocp-operator diff --git a/downstream/assemblies/devtools/assembly-rhdh-using.adoc b/downstream/assemblies/devtools/assembly-rhdh-using.adoc index d148199a32..1c67be6ac4 100644 --- a/downstream/assemblies/devtools/assembly-rhdh-using.adoc +++ b/downstream/assemblies/devtools/assembly-rhdh-using.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context: {context}] :_mod-docs-content-type: ASSEMBLY [id="rhdh-using_{context}"] -= Using the Ansible plug-ins += Streamline development by integrating {RHDH} plug-ins :context: rhdh-using [role="_abstract"] diff --git a/downstream/assemblies/devtools/assembly-self-service-about.adoc b/downstream/assemblies/devtools/assembly-self-service-about.adoc index c250236201..c27547ffb0 100644 --- a/downstream/assemblies/devtools/assembly-self-service-about.adoc +++ b/downstream/assemblies/devtools/assembly-self-service-about.adoc @@ -12,7 +12,7 @@ ifdef::context[] [id="self-service-about_{context}"] endif::[] -= About {SelfService} += Install {SelfService} ({OCPShort} only) :context: self-service-about diff --git a/downstream/assemblies/devtools/assembly-self-service-accessing-deployment.adoc b/downstream/assemblies/devtools/assembly-self-service-accessing-deployment.adoc index 0f3f37b6ed..b913ba7435 100644 --- a/downstream/assemblies/devtools/assembly-self-service-accessing-deployment.adoc +++ b/downstream/assemblies/devtools/assembly-self-service-accessing-deployment.adoc @@ -12,7 +12,7 @@ ifdef::context[] [id="self-service-accessing-deployment_{context}"] endif::[] -= Accessing the {SelfServiceShort} deployment += Update the deployment URL :context: self-service-accessing-deployment diff --git a/downstream/assemblies/devtools/assembly-self-service-disconnected-install-helm-chart.adoc b/downstream/assemblies/devtools/assembly-self-service-disconnected-install-helm-chart.adoc index 92218f12ef..e20ee8499e 100644 --- a/downstream/assemblies/devtools/assembly-self-service-disconnected-install-helm-chart.adoc +++ b/downstream/assemblies/devtools/assembly-self-service-disconnected-install-helm-chart.adoc @@ -12,7 +12,7 @@ ifdef::context[] [id="self-service-disconnected-install-helm-chart_{context}"] endif::[] -= Installing the Helm chart in the disconnected OpenShift environment += Install the Helm chart in the disconnected OpenShift environment [role="_abstract"] You can install the modified Helm chart using the `helm install` command in your disconnected OpenShift environment. This deploys the self-service automation portal using the locally available assets. diff --git a/downstream/assemblies/devtools/assembly-self-service-disconnected-install-prepare.adoc b/downstream/assemblies/devtools/assembly-self-service-disconnected-install-prepare.adoc index 1f62c4577f..ad64e448b3 100644 --- a/downstream/assemblies/devtools/assembly-self-service-disconnected-install-prepare.adoc +++ b/downstream/assemblies/devtools/assembly-self-service-disconnected-install-prepare.adoc @@ -12,7 +12,7 @@ ifdef::context[] [id="self-service-disconnected-install-prepare_{context}"] endif::[] -= Preparing for air-gapped installation += Prepare for air-gapped installation :context: self-service-disconnected-install-prepare diff --git a/downstream/assemblies/devtools/assembly-self-service-disconnected-install.adoc b/downstream/assemblies/devtools/assembly-self-service-disconnected-install.adoc index 89068388b1..3575f1ea49 100644 --- a/downstream/assemblies/devtools/assembly-self-service-disconnected-install.adoc +++ b/downstream/assemblies/devtools/assembly-self-service-disconnected-install.adoc @@ -12,7 +12,7 @@ ifdef::context[] [id="self-service-disconnected-install_{context}"] endif::[] -= Installing {SelfServiceShort} in air-gapped {OCPShort} environments += Install in an air-gapped environment :context: self-service-disconnected-install diff --git a/downstream/assemblies/devtools/assembly-self-service-installation-overview.adoc b/downstream/assemblies/devtools/assembly-self-service-installation-overview.adoc index 9e6fe8e5b9..497b31dc5b 100644 --- a/downstream/assemblies/devtools/assembly-self-service-installation-overview.adoc +++ b/downstream/assemblies/devtools/assembly-self-service-installation-overview.adoc @@ -12,7 +12,7 @@ ifdef::context[] [id="self-service-installation-overview_{context}"] endif::[] -= Installation overview += Overview and prerequisites :context: self-service-installation-overview diff --git a/downstream/assemblies/devtools/assembly-self-service-login.adoc b/downstream/assemblies/devtools/assembly-self-service-login.adoc index fe1f9334b3..d5ea82c586 100644 --- a/downstream/assemblies/devtools/assembly-self-service-login.adoc +++ b/downstream/assemblies/devtools/assembly-self-service-login.adoc @@ -12,7 +12,7 @@ ifdef::context[] [id="self-service-login_{context}"] endif::[] -= Logging in to {SelfServiceShort} += Launch automation templates from self-service automation portal :context: self-service-login diff --git a/downstream/assemblies/devtools/assembly-self-service-rbac.adoc b/downstream/assemblies/devtools/assembly-self-service-rbac.adoc index b3ea9b5e4e..e8dbd560bd 100644 --- a/downstream/assemblies/devtools/assembly-self-service-rbac.adoc +++ b/downstream/assemblies/devtools/assembly-self-service-rbac.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context: {context}] :_mod-docs-content-type: ASSEMBLY [id="self-service-rbac_{context}"] -= Working with custom self-service template permissions += Set up permissions for custom self-service templates :context: self-service-rbac diff --git a/downstream/assemblies/devtools/assembly-self-service-telemetry-capture.adoc b/downstream/assemblies/devtools/assembly-self-service-telemetry-capture.adoc index e60a3de1c0..4f735aef30 100644 --- a/downstream/assemblies/devtools/assembly-self-service-telemetry-capture.adoc +++ b/downstream/assemblies/devtools/assembly-self-service-telemetry-capture.adoc @@ -12,7 +12,7 @@ ifdef::context[] [id="self-service-telemetry_{context}"] endif::[] -= Telemetry capturing += Capture telemetry data for the Ansible self-service portal :context: self-service-telemetry diff --git a/downstream/assemblies/devtools/assembly-self-service-upgrading.adoc b/downstream/assemblies/devtools/assembly-self-service-upgrading.adoc index d3ba519fa3..b088b54d79 100644 --- a/downstream/assemblies/devtools/assembly-self-service-upgrading.adoc +++ b/downstream/assemblies/devtools/assembly-self-service-upgrading.adoc @@ -12,7 +12,7 @@ ifdef::context[] [id="self-service-upgrading_{context}"] endif::[] -= Upgrading {SelfServiceShort} += Upgrade {SelfServiceShort} :context: self-service-upgrading diff --git a/downstream/assemblies/devtools/assembly-self-service-view-deployment.adoc b/downstream/assemblies/devtools/assembly-self-service-view-deployment.adoc index bb9aaff758..5170402614 100644 --- a/downstream/assemblies/devtools/assembly-self-service-view-deployment.adoc +++ b/downstream/assemblies/devtools/assembly-self-service-view-deployment.adoc @@ -12,7 +12,7 @@ ifdef::context[] [id="self-service-view-deployment_{context}"] endif::[] -= Inspecting the deployment on OpenShift += Verify the configuration :context: self-service-view-deployment diff --git a/downstream/assemblies/devtools/assembly-workspaces-create-launch.adoc b/downstream/assemblies/devtools/assembly-workspaces-create-launch.adoc index 7dcbd43b5b..7cfc43d958 100644 --- a/downstream/assemblies/devtools/assembly-workspaces-create-launch.adoc +++ b/downstream/assemblies/devtools/assembly-workspaces-create-launch.adoc @@ -12,7 +12,7 @@ ifdef::context[] [id="assembly-workspaces-create-launch_{context}"] endif::[] -= Creating and launching an {AnsibleWorkspaceSing} += Create and launch an Ansible development workspace :context: assembly-workspaces-create-launch diff --git a/downstream/assemblies/devtools/assembly-workspaces-develop.adoc b/downstream/assemblies/devtools/assembly-workspaces-develop.adoc index 543070992a..7b48046b69 100644 --- a/downstream/assemblies/devtools/assembly-workspaces-develop.adoc +++ b/downstream/assemblies/devtools/assembly-workspaces-develop.adoc @@ -12,7 +12,7 @@ ifdef::context[] [id="assembly-workspaces-develop_{context}"] endif::[] -= Developing automation content in your workspace += Develop automation content in your workspace :context: assembly-workspaces-develop diff --git a/downstream/assemblies/devtools/assembly-workspaces-intro.adoc b/downstream/assemblies/devtools/assembly-workspaces-intro.adoc index c7b77f47b5..5904bc81be 100644 --- a/downstream/assemblies/devtools/assembly-workspaces-intro.adoc +++ b/downstream/assemblies/devtools/assembly-workspaces-intro.adoc @@ -12,7 +12,7 @@ ifdef::context[] [id="assembly-workspaces-intro_{context}"] endif::[] -= {AnsibleWorkspaces} += Access preconfigured development tools with Ansible development workspaces :context: assembly-workspaces-intro diff --git a/downstream/assemblies/devtools/assembly-workspaces-management.adoc b/downstream/assemblies/devtools/assembly-workspaces-management.adoc index 993ffc746c..647fab902e 100644 --- a/downstream/assemblies/devtools/assembly-workspaces-management.adoc +++ b/downstream/assemblies/devtools/assembly-workspaces-management.adoc @@ -12,7 +12,7 @@ ifdef::context[] [id="assembly-workspaces-management{context}"] endif::[] -= {AnsibleWorkspaces} management and teardown += Delete an Ansible development workspace :context: assembly-workspaces-management diff --git a/downstream/assemblies/devtools/assembly-workspaces-set-up-devspaces.adoc b/downstream/assemblies/devtools/assembly-workspaces-set-up-devspaces.adoc index 055a6adc1c..3ce2fffc58 100644 --- a/downstream/assemblies/devtools/assembly-workspaces-set-up-devspaces.adoc +++ b/downstream/assemblies/devtools/assembly-workspaces-set-up-devspaces.adoc @@ -12,7 +12,7 @@ ifdef::context[] [id="assembly-workspaces_{context}"] endif::[] -= Setting up {AnsibleDevSpaces} += Set up and install Red Hat OpenShift dev spaces to run your Ansible container :context: assembly-workspaces-set-up-devspaces diff --git a/downstream/assemblies/devtools/assembly-writing-running-playbook.adoc b/downstream/assemblies/devtools/assembly-writing-running-playbook.adoc index fed50af92b..45481282d5 100644 --- a/downstream/assemblies/devtools/assembly-writing-running-playbook.adoc +++ b/downstream/assemblies/devtools/assembly-writing-running-playbook.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context_of_writing-running-playbook: {context}] :_mod-docs-content-type: ASSEMBLY [id="writing-running-playbook_{context}"] -= Writing and running a playbook with {ToolsName} += Write your first automation task using the {VSCode} extension :context: writing-running-playbook [role="_abstract"] diff --git a/downstream/assemblies/eda/assembly-eda-credential-types.adoc b/downstream/assemblies/eda/assembly-eda-credential-types.adoc index a1f44283b6..4131d78477 100644 --- a/downstream/assemblies/eda/assembly-eda-credential-types.adoc +++ b/downstream/assemblies/eda/assembly-eda-credential-types.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: [id="eda-credential-types"] -= Credential types += Connect to external secret management systems with built-in credentials [role="_abstract"] {EDAcontroller} comes with several built-in credential types that you can use for syncing projects, running rulebook activations, executing job templates through {MenuTopAE} ({ControllerName}), fetching images from container registries, and processing data through event streams. diff --git a/downstream/assemblies/eda/assembly-eda-credentials.adoc b/downstream/assemblies/eda/assembly-eda-credentials.adoc index 2cb8615e61..530fb8a671 100644 --- a/downstream/assemblies/eda/assembly-eda-credentials.adoc +++ b/downstream/assemblies/eda/assembly-eda-credentials.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="eda-credentials"] -= Credentials += Configure credentials for {EDAName} [role="_abstract"] You can use credentials to store secrets that can be used for authentication purposes with resources, such as decision environments, rulebook activations and projects for {EDAcontroller}, and projects for {ControllerName}. diff --git a/downstream/assemblies/eda/assembly-eda-decision-environments.adoc b/downstream/assemblies/eda/assembly-eda-decision-environments.adoc index 8958e64d3b..02b17c0b3e 100644 --- a/downstream/assemblies/eda/assembly-eda-decision-environments.adoc +++ b/downstream/assemblies/eda/assembly-eda-decision-environments.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="eda-decision-environments"] -= Decision environments += Create runtime environments for event-driven automation [role="_abstract"] Decision environments are container images that run Ansible rulebooks. They create a common language for communicating automation dependencies, and give a standard way to build and distribute the automation environment. @@ -10,7 +10,7 @@ You can find the default decision environment in the link:https://quay.io/reposi To create your own decision environment, see link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/using_automation_decisions/eda-decision-environments#eda-controller-install-builder[Installing ansible-builder] and link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/using_automation_decisions/eda-decision-environments#eda-build-a-custom-decision-environment[Building a custom decision environment for {EDAName} within {PlatformNameShort}]. -include::eda/ref-eda-controller-install-builder.adoc[leveloffset=+1] +//include::eda/ref-eda-controller-install-builder.adoc[leveloffset=+1] include::eda/proc-eda-build-a-custom-decision-environment.adoc[leveloffset=+1] diff --git a/downstream/assemblies/eda/assembly-eda-event-filter-plugins.adoc b/downstream/assemblies/eda/assembly-eda-event-filter-plugins.adoc index 8a12b02d2c..f96b74c32d 100644 --- a/downstream/assemblies/eda/assembly-eda-event-filter-plugins.adoc +++ b/downstream/assemblies/eda/assembly-eda-event-filter-plugins.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="eda-event-filter-plugins"] -= Event filter plugins += Filter events before triggering automation [role="_abstract"] Events sometimes have extra data that is unnecessary and might overwhelm the rule engine. diff --git a/downstream/assemblies/eda/assembly-eda-logging-strategy.adoc b/downstream/assemblies/eda/assembly-eda-logging-strategy.adoc index 3d31877d8e..b668502a71 100644 --- a/downstream/assemblies/eda/assembly-eda-logging-strategy.adoc +++ b/downstream/assemblies/eda/assembly-eda-logging-strategy.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="eda-logging-strategy"] -= {EDAName} logging strategy += Configure logging for Event-Driven Ansible [role="_abstract"] {EDAName} offers an audit logging solution over its resources. Each supported create, read, update and delete (CRUD) operation is logged against rulebook activations, event streams, decision environments, projects, and activations. diff --git a/downstream/assemblies/eda/assembly-eda-manage-active-rulebook-activations.adoc b/downstream/assemblies/eda/assembly-eda-manage-active-rulebook-activations.adoc new file mode 100644 index 0000000000..71d48ba05a --- /dev/null +++ b/downstream/assemblies/eda/assembly-eda-manage-active-rulebook-activations.adoc @@ -0,0 +1,16 @@ +:_mod-docs-content-type: ASSEMBLY +[id="eda-manage-active-rulebook-activations"] + += Manage active event-driven automation integrations + +[role="_abstract"] + +To maintain efficient event-driven workflows, you must manage the lifecycle of your rulebook activations. Managing these activations effectively ensures that your automation remains responsive, reduces resource duplication, and minimizes downtime during configuration updates. + +include::eda/proc-eda-enable-rulebook-activations.adoc[leveloffset=+1] + +include::eda/proc-eda-restart-rulebook-activations.adoc[leveloffset=+1] + +include::eda/proc-eda-edit-rulebook-activation.adoc[leveloffset=+1] + +include::eda/proc-eda-delete-rulebook-activations.adoc[leveloffset=+1] diff --git a/downstream/assemblies/eda/assembly-eda-performance-tuning.adoc b/downstream/assemblies/eda/assembly-eda-performance-tuning.adoc index 59b0528dc5..3cd3fd3b43 100644 --- a/downstream/assemblies/eda/assembly-eda-performance-tuning.adoc +++ b/downstream/assemblies/eda/assembly-eda-performance-tuning.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="eda-performance-tuning"] -= Performance tuning for {EDAcontroller} += Tune performance for {EDAName} [role="_abstract"] {EDAcontroller} provides the interface in which {EDAName} automation performs. diff --git a/downstream/assemblies/eda/assembly-eda-projects.adoc b/downstream/assemblies/eda/assembly-eda-projects.adoc index f68cdba25b..b6a1e2e5c4 100644 --- a/downstream/assemblies/eda/assembly-eda-projects.adoc +++ b/downstream/assemblies/eda/assembly-eda-projects.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="eda-projects"] -= Projects += Organize rulebooks for event-driven automation [role="_abstract"] Projects are a logical collection of rulebooks. They must be a git repository and located in the path defined for {EDAName} content in Ansible collections: `/extensions/eda/rulebooks` at the root of the project. diff --git a/downstream/assemblies/eda/assembly-eda-reuse-rulebook-activation-configurations.adoc b/downstream/assemblies/eda/assembly-eda-reuse-rulebook-activation-configurations.adoc new file mode 100644 index 0000000000..21cb54bfad --- /dev/null +++ b/downstream/assemblies/eda/assembly-eda-reuse-rulebook-activation-configurations.adoc @@ -0,0 +1,10 @@ +:_mod-docs-content-type: ASSEMBLY +[id="eda-reuse-rulebook-activation-configurations"] + += Reuse event-driven automation configurations + +[role="_abstract"] + +Streamline your workflow by duplicating existing rulebook activations to reuse proven configurations. This section covers how to create copies, manage unique naming requirements, and navigate bulk-enablement safety warnings to avoid duplicate job failures. + +include::eda/proc-eda-copy-rulebook-activation.adoc[leveloffset=+1] diff --git a/downstream/assemblies/eda/assembly-eda-rule-audit.adoc b/downstream/assemblies/eda/assembly-eda-rule-audit.adoc index 110b23af98..3ed4249290 100644 --- a/downstream/assemblies/eda/assembly-eda-rule-audit.adoc +++ b/downstream/assemblies/eda/assembly-eda-rule-audit.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="eda-rule-audit"] -= Rule Audit += Audit pipeline-triggered automation activity [role="_abstract"] Rule audit allows the auditing of rules which have been triggered by all the rules that were activated at some point. diff --git a/downstream/assemblies/eda/assembly-eda-rulebook-activations.adoc b/downstream/assemblies/eda/assembly-eda-rulebook-activations.adoc index 631d5ccbeb..a854246976 100644 --- a/downstream/assemblies/eda/assembly-eda-rulebook-activations.adoc +++ b/downstream/assemblies/eda/assembly-eda-rulebook-activations.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="eda-rulebook-activations"] -= Rulebook activations += Define rules that trigger automation from events [role="_abstract"] @@ -53,16 +53,6 @@ include::eda/con-eda-rulebook-activation-list-view.adoc[leveloffset=+1] include::eda/proc-eda-view-activation-output.adoc[leveloffset=+2] -include::eda/proc-eda-enable-rulebook-activations.adoc[leveloffset=+1] +//include::eda/proc-eda-activate-webhook.adoc[leveloffset=+1] -include::eda/proc-eda-restart-rulebook-activations.adoc[leveloffset=+1] - -include::eda/proc-eda-edit-rulebook-activation.adoc[leveloffset=+1] - -include::eda/proc-eda-copy-rulebook-activation.adoc[leveloffset=+1] - -include::eda/proc-eda-delete-rulebook-activations.adoc[leveloffset=+1] - -include::eda/proc-eda-activate-webhook.adoc[leveloffset=+1] - -include::eda/proc-eda-test-with-K8s.adoc[leveloffset=+1] +//include::eda/proc-eda-test-with-K8s.adoc[leveloffset=+1] diff --git a/downstream/assemblies/eda/assembly-eda-rulebook-troubleshooting.adoc b/downstream/assemblies/eda/assembly-eda-rulebook-troubleshooting.adoc index 9cf3fc3d7c..3ac13787a6 100644 --- a/downstream/assemblies/eda/assembly-eda-rulebook-troubleshooting.adoc +++ b/downstream/assemblies/eda/assembly-eda-rulebook-troubleshooting.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="eda-rulebook-troubleshooting"] -= Rulebook activations troubleshooting += Troubleshoot failed event-driven automation triggers [role="_abstract"] Rulebook activations might occasionally fail due to various reasons. While many issues can be resolved through basic checks, diagnosing failures across a distributed system requires robust logging. diff --git a/downstream/assemblies/eda/assembly-eda-set-up-rhaap-credential.adoc b/downstream/assemblies/eda/assembly-eda-set-up-rhaap-credential.adoc index 5a67891c7d..b9755e3182 100644 --- a/downstream/assemblies/eda/assembly-eda-set-up-rhaap-credential.adoc +++ b/downstream/assemblies/eda/assembly-eda-set-up-rhaap-credential.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="eda-set-up-rhaap-credential-type"] -= {PlatformName} credential += Replace legacy {ControllerName} tokens [role="_abstract"] When {EDAcontroller} is deployed on {PlatformNameShort} {PlatformVers}, you can create a {PlatformName} credential to connect to {ControllerName} through the use of an {ControllerName} URL and a username and password. diff --git a/downstream/assemblies/eda/assembly-eda-user-guide-overview.adoc b/downstream/assemblies/eda/assembly-eda-user-guide-overview.adoc index 9e9317701c..1f42b2970a 100644 --- a/downstream/assemblies/eda/assembly-eda-user-guide-overview.adoc +++ b/downstream/assemblies/eda/assembly-eda-user-guide-overview.adoc @@ -1,25 +1,18 @@ :_mod-docs-content-type: ASSEMBLY [id="eda-user-guide-overview"] -= {EDAcontroller} overview += Trigger automation from events with {EDAName} [role="_abstract"] {EDAName} is a highly scalable, flexible automation capability. It works with external event sources (like software vendors' monitoring tools) to identify IT events and automatically implement the defined changes or responses within a rulebook. -The following procedures form the user configuration: +Learn how to configure and manage the end-to-end lifecycle of event-driven automation within the {PlatformName}. {EDAName} provides you the ability to perform the following actions: -* link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/using_automation_decisions/eda-credentials[Credentials] -* link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/using_automation_decisions/eda-credential-types[Credential types] -* link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/using_automation_decisions/eda-projects[Projects] -* link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/using_automation_decisions/eda-decision-environments[Decision environments] -* link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/using_automation_decisions/eda-set-up-rhaap-credential-type[Red Hat Ansible Automation Platform credential] -* link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/using_automation_decisions/eda-rulebook-activations[Rulebook activations] -* link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/using_automation_decisions/eda-rulebook-troubleshooting[Rulebook activations troubleshooting] -* link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/using_automation_decisions/eda-rule-audit[Rule audit] -* link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/using_automation_decisions/simplified-event-routing[Simplified event routing] -* link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/using_automation_decisions/eda-performance-tuning[Performance tuning for {EDAcontroller}] -* link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/using_automation_decisions/eda-event-filter-plugins[Event filter plugins] -* link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/using_automation_decisions/eda-logging-strategy[Event-Driven Ansible logging strategy] +* Manage projects for rulebook storage +* Build and restore decision environments for execution +* Define credentials for secure authentication +* Create event streams for centralized routing +* Manage rulebook activations to main persistent, scalable listeners that monitor infrastructure and trigger automated workflows in real time [NOTE] @@ -41,3 +34,4 @@ In new installations of {PlatformNameShort} {PlatformVers}, using {EDAcontroller * link:{URLCentralAuth}/gw-managing-access#ref-controller-user-roles[Adding roles for a user] * link:{URLCentralAuth}/assembly-gw-roles[Roles] * link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/using_event-driven_ansible_2.5_with_ansible_automation_platform_2.4/index[Using Event-Driven Ansible 2.5 with Ansible Automation Platform 2.4] +//Verify whether the link "Using Event-Driven Ansible 2.5 with Ansible Automation Platform 2.4" is useful anymore \ No newline at end of file diff --git a/downstream/assemblies/eda/assembly-simplified-event-routing.adoc b/downstream/assemblies/eda/assembly-simplified-event-routing.adoc index 814473e05a..60b8a3fc1e 100644 --- a/downstream/assemblies/eda/assembly-simplified-event-routing.adoc +++ b/downstream/assemblies/eda/assembly-simplified-event-routing.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="simplified-event-routing"] -= Simplified event routing += Respond to events from external systems [role="_abstract"] Simplified event routing provides {EDAcontroller} the capability to capture and analyze data from various remote systems (like GitHub or GitLab) using event streams. You can attach one or more event streams to an activation by swapping out sources in a rulebook. diff --git a/downstream/assemblies/hub/assembly-pull-image.adoc b/downstream/assemblies/hub/assembly-pull-image.adoc index 183ed3b480..572293dc81 100644 --- a/downstream/assemblies/hub/assembly-pull-image.adoc +++ b/downstream/assemblies/hub/assembly-pull-image.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context: {context}] [id="pulling-images-container-repository"] -= Pulling images from a container repository += Pull and sync images from {HubName} to your local system :context: pulling-images-container-repository diff --git a/downstream/assemblies/hub/assembly-setup-container-repository.adoc b/downstream/assemblies/hub/assembly-setup-container-repository.adoc index 6a20220097..c98343c22d 100644 --- a/downstream/assemblies/hub/assembly-setup-container-repository.adoc +++ b/downstream/assemblies/hub/assembly-setup-container-repository.adoc @@ -5,7 +5,7 @@ ifdef::context[:parent-context: {context}] [id="setting-up-container-repository"] -= Setting up your container repository += Set up your container repository :context: assembly-keyword diff --git a/downstream/assemblies/hub/assembly-working-with-signed-containers.adoc b/downstream/assemblies/hub/assembly-working-with-signed-containers.adoc index db62bcf4f6..9cc4d6fc3b 100644 --- a/downstream/assemblies/hub/assembly-working-with-signed-containers.adoc +++ b/downstream/assemblies/hub/assembly-working-with-signed-containers.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context: {context}] [id="working-with-signed-containers"] -= Working with signed containers += Secure your automation with container signing :context: working-with-signed-containers diff --git a/downstream/assemblies/navigator/assembly-browse-collections-navigator.adoc b/downstream/assemblies/navigator/assembly-browse-collections-navigator.adoc index 27fe3a92e9..8de780e6f5 100644 --- a/downstream/assemblies/navigator/assembly-browse-collections-navigator.adoc +++ b/downstream/assemblies/navigator/assembly-browse-collections-navigator.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] :imagesdir: images [id="assembly-review-collections-navigator_{context}"] -= Browsing collections with {Navigator} += Browse collections in a text-based format :context: browse-collections-navigator diff --git a/downstream/assemblies/navigator/assembly-execute-playbook-navigator.adoc b/downstream/assemblies/navigator/assembly-execute-playbook-navigator.adoc index 0b15d510d7..3498322e6e 100644 --- a/downstream/assemblies/navigator/assembly-execute-playbook-navigator.adoc +++ b/downstream/assemblies/navigator/assembly-execute-playbook-navigator.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] :imagesdir: images [id="assembly-execute-playbooks-navigator_{context}"] -= Running Ansible playbooks with {Navigator} += Run playbooks locally with {Navigator} :context: execute-playbooks-navigator diff --git a/downstream/assemblies/navigator/assembly-intro-navigator.adoc b/downstream/assemblies/navigator/assembly-intro-navigator.adoc index cd3d450545..21dde873a4 100644 --- a/downstream/assemblies/navigator/assembly-intro-navigator.adoc +++ b/downstream/assemblies/navigator/assembly-intro-navigator.adoc @@ -5,7 +5,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-intro-navigator_{context}"] -= Introduction to {Navigator} += Emulate a platform environment locally with {Navigator} :context: intro-ansible-navigator diff --git a/downstream/assemblies/navigator/assembly-review-ansible-config-navigator.adoc b/downstream/assemblies/navigator/assembly-review-ansible-config-navigator.adoc index 2d264e0540..895919eeb5 100644 --- a/downstream/assemblies/navigator/assembly-review-ansible-config-navigator.adoc +++ b/downstream/assemblies/navigator/assembly-review-ansible-config-navigator.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] :imagesdir: images [id="assembly-review-config-navigator_{context}"] -= Reviewing your Ansible configuration with {Navigator} += View Ansible configuration file contents in text-based format :context: review-config-navigator diff --git a/downstream/assemblies/navigator/assembly-review-ee-navigator.adoc b/downstream/assemblies/navigator/assembly-review-ee-navigator.adoc index cf9e77f4f5..8b8f2086b8 100644 --- a/downstream/assemblies/navigator/assembly-review-ee-navigator.adoc +++ b/downstream/assemblies/navigator/assembly-review-ee-navigator.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] :imagesdir: images [id="assembly-review-ee-navigator_{context}"] -= Reviewing {ExecEnvName} with {Navigator} += Run a playbook to display {ExecEnvShort} contents :context: review-ee-navigator diff --git a/downstream/assemblies/navigator/assembly-review-inventory-navigator.adoc b/downstream/assemblies/navigator/assembly-review-inventory-navigator.adoc index f01fd8398d..4e916ed4e1 100644 --- a/downstream/assemblies/navigator/assembly-review-inventory-navigator.adoc +++ b/downstream/assemblies/navigator/assembly-review-inventory-navigator.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] :imagesdir: images [id="assembly-review-inventory-navigator_{context}"] -= Reviewing inventories with {Navigator} += View groups and hosts in your inventory :context: review-inventory-navigator diff --git a/downstream/assemblies/navigator/assembly-settings-navigator.adoc b/downstream/assemblies/navigator/assembly-settings-navigator.adoc index 102289bdde..3624251579 100644 --- a/downstream/assemblies/navigator/assembly-settings-navigator.adoc +++ b/downstream/assemblies/navigator/assembly-settings-navigator.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] :imagesdir: images [id="assembly-settings-navigator_{context}"] -= {NavigatorStart} configuration settings += {NavigatorStart} command reference :context: settings-navigator diff --git a/downstream/assemblies/navigator/assembly-troubleshooting-navigator.adoc b/downstream/assemblies/navigator/assembly-troubleshooting-navigator.adoc index b56419068b..e3529d89de 100644 --- a/downstream/assemblies/navigator/assembly-troubleshooting-navigator.adoc +++ b/downstream/assemblies/navigator/assembly-troubleshooting-navigator.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] :imagesdir: images [id="assembly-troubleshooting-navigator_{context}"] -= Troubleshooting Ansible content with {Navigator} += Troubleshoot collections, execution environments, and playbooks :context: troubleshooting-navigator diff --git a/downstream/assemblies/performance-tuning/assembly-primary-workloads.adoc b/downstream/assemblies/performance-tuning/assembly-primary-workloads.adoc index 48d901f32b..ed61d8eaf7 100644 --- a/downstream/assemblies/performance-tuning/assembly-primary-workloads.adoc +++ b/downstream/assemblies/performance-tuning/assembly-primary-workloads.adoc @@ -5,7 +5,7 @@ :context: aap-primary-workloads [id="primary-workloads"] -= Primary workloads for {ControllerName} += Understand primary workloads for {ControllerName} ifdef::context[:parent-context: {context}] diff --git a/downstream/assemblies/performance-tuning/assembly-types-of-workloads.adoc b/downstream/assemblies/performance-tuning/assembly-types-of-workloads.adoc index 0bd86d69ff..aaba755d19 100644 --- a/downstream/assemblies/performance-tuning/assembly-types-of-workloads.adoc +++ b/downstream/assemblies/performance-tuning/assembly-types-of-workloads.adoc @@ -5,7 +5,7 @@ :context: aap-workload-types [id="types-of-workloads"] -= Types of workloads += Workload types and access methods ifdef::context[:parent-context: {context}] diff --git a/downstream/assemblies/platform/assembly-aap-activate.adoc b/downstream/assemblies/platform/assembly-aap-activate.adoc index 8470e4d75d..d3bdf38778 100644 --- a/downstream/assemblies/platform/assembly-aap-activate.adoc +++ b/downstream/assemblies/platform/assembly-aap-activate.adoc @@ -3,7 +3,8 @@ ifdef::context[:parent-context: {context}] [id="assembly-aap-activate"] -= Activating {PlatformName} + += Activate your subscription :context: activate-aap diff --git a/downstream/assemblies/platform/assembly-aap-backup-recovery.adoc b/downstream/assemblies/platform/assembly-aap-backup-recovery.adoc index 020a86e512..1850bb12e6 100644 --- a/downstream/assemblies/platform/assembly-aap-backup-recovery.adoc +++ b/downstream/assemblies/platform/assembly-aap-backup-recovery.adoc @@ -6,7 +6,7 @@ ifdef::context[:parent-context: {context}] :context: aap-backup -= Backup and recovery of {PlatformName} += Backup and restore in an OpenShift environment [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-aap-backup.adoc b/downstream/assemblies/platform/assembly-aap-backup.adoc index 763e9603ec..e1a8ac7240 100644 --- a/downstream/assemblies/platform/assembly-aap-backup.adoc +++ b/downstream/assemblies/platform/assembly-aap-backup.adoc @@ -6,7 +6,7 @@ ifdef::context[:parent-context: {context}] :context: aap-backup -= Creating {PlatformName} backup resources += Back up {PlatformNameShort} [role="_abstract"] @@ -19,5 +19,9 @@ Take a backup regularly in case you want to restore the platform to a previous s include::platform/proc-aap-platform-gateway-backup.adoc[leveloffset=+1] +include::platform/proc-aap-define-backup-pvc.adoc[leveloffset=+1] + +include::platform/con-aap-override-backup-configs.adoc[leveloffset=+1] + ifdef::parent-context[:context: {parent-context}] ifndef::parent-context[:!context:] diff --git a/downstream/assemblies/platform/assembly-aap-containerized-disconnected-installation.adoc b/downstream/assemblies/platform/assembly-aap-containerized-disconnected-installation.adoc index b3011501d6..78362f7d46 100644 --- a/downstream/assemblies/platform/assembly-aap-containerized-disconnected-installation.adoc +++ b/downstream/assemblies/platform/assembly-aap-containerized-disconnected-installation.adoc @@ -2,7 +2,7 @@ [id="aap-containerized-disconnected-installation"] -= Disconnected installation += Install in a disconnected environment [role="_abstract"] You can install containerized {PlatformNameShort} in an environment that does not have an active internet connection. To do this you need to obtain and configure the RPM source dependencies before performing the disconnected installation. diff --git a/downstream/assemblies/platform/assembly-aap-recovery.adoc b/downstream/assemblies/platform/assembly-aap-recovery.adoc index 93cc915f34..8c1e32e8e1 100644 --- a/downstream/assemblies/platform/assembly-aap-recovery.adoc +++ b/downstream/assemblies/platform/assembly-aap-recovery.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-aap-recovery"] -= Recovering a {PlatformName} deployment += Recover {PlatformNameShort} :context: aap-recovery diff --git a/downstream/assemblies/platform/assembly-aap-upgrades.adoc b/downstream/assemblies/platform/assembly-aap-upgrades.adoc index 64c94baa2c..f20b02138e 100644 --- a/downstream/assemblies/platform/assembly-aap-upgrades.adoc +++ b/downstream/assemblies/platform/assembly-aap-upgrades.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] [id="aap-upgrades"] -= {PlatformName} {PlatformVers} upgrades += Upgrade your RPM deployment of {PlatformNameShort} :context: aap-upgrades diff --git a/downstream/assemblies/platform/assembly-aap-upgrading-platform.adoc b/downstream/assemblies/platform/assembly-aap-upgrading-platform.adoc index d4c6a2bbb1..3394f75e0f 100644 --- a/downstream/assemblies/platform/assembly-aap-upgrading-platform.adoc +++ b/downstream/assemblies/platform/assembly-aap-upgrading-platform.adoc @@ -3,7 +3,7 @@ ifdef::context[:parent-context: {context}] [id="aap-upgrading-platform"] -= Upgrading to {PlatformName} {PlatformVers} += Upgrade to {PlatformName} {PlatformVers} :context: aap-upgrading-platform diff --git a/downstream/assemblies/platform/assembly-advanced-configuration-containerized.adoc b/downstream/assemblies/platform/assembly-advanced-configuration-containerized.adoc index fc12004fbe..73479dbe7f 100644 --- a/downstream/assemblies/platform/assembly-advanced-configuration-containerized.adoc +++ b/downstream/assemblies/platform/assembly-advanced-configuration-containerized.adoc @@ -2,7 +2,7 @@ [id="advanced-configuration-containerized"] -= Advanced containerized deployment += Advanced configuration options [role="_abstract"] Configure external databases, custom TLS certificates, execution nodes, HAProxy load balancers, and hub storage for complex containerized {PlatformNameShort} deployments. diff --git a/downstream/assemblies/platform/assembly-ag-controller-backup-and-restore.adoc b/downstream/assemblies/platform/assembly-ag-controller-backup-and-restore.adoc index 3f6d0738fa..fba2f84c96 100644 --- a/downstream/assemblies/platform/assembly-ag-controller-backup-and-restore.adoc +++ b/downstream/assemblies/platform/assembly-ag-controller-backup-and-restore.adoc @@ -2,7 +2,7 @@ [id="controller-backup-and-restore"] -= Backup and restore += Backup and restore overview [role="_abstract"] You can backup and restore your system by using the {PlatformNameShort} setup playbook. diff --git a/downstream/assemblies/platform/assembly-ag-controller-clustering.adoc b/downstream/assemblies/platform/assembly-ag-controller-clustering.adoc index 11283441c3..2cbf019d52 100644 --- a/downstream/assemblies/platform/assembly-ag-controller-clustering.adoc +++ b/downstream/assemblies/platform/assembly-ag-controller-clustering.adoc @@ -2,7 +2,7 @@ [id="controller-clustering"] -= Clustering += Configure clusters and load balancing [role="_abstract"] Clustering is sharing load between hosts. diff --git a/downstream/assemblies/platform/assembly-ag-controller-secret-handling.adoc b/downstream/assemblies/platform/assembly-ag-controller-secret-handling.adoc index ecb09dcb77..76b6773b88 100644 --- a/downstream/assemblies/platform/assembly-ag-controller-secret-handling.adoc +++ b/downstream/assemblies/platform/assembly-ag-controller-secret-handling.adoc @@ -15,8 +15,8 @@ include::platform/ref-controller-secret-handling-automation-use.adoc[leveloffset include::platform/ref-controller-connection-security.adoc[leveloffset=+2] -include::platform/ref-controller-internal-services.adoc[leveloffset=+2] +//include::platform/ref-controller-internal-services.adoc[leveloffset=+2] -include::platform/ref-controller-external-access.adoc[leveloffset=+2] +//include::platform/ref-controller-external-access.adoc[leveloffset=+2] -include::platform/ref-controller-managed-nodes.adoc[leveloffset=+2] +//include::platform/ref-controller-managed-nodes.adoc[leveloffset=+2] diff --git a/downstream/assemblies/platform/assembly-ag-controller-troubleshooting.adoc b/downstream/assemblies/platform/assembly-ag-controller-troubleshooting.adoc index 4eb9582ebf..a6fc676248 100644 --- a/downstream/assemblies/platform/assembly-ag-controller-troubleshooting.adoc +++ b/downstream/assemblies/platform/assembly-ag-controller-troubleshooting.adoc @@ -2,7 +2,7 @@ [id="controller-troubleshooting"] -= Troubleshooting {ControllerName} += Troubleshoot {ControllerName} [role="_abstract"] Useful troubleshooting information for {ControllerName}. diff --git a/downstream/assemblies/platform/assembly-appendix-operator-crs.adoc b/downstream/assemblies/platform/assembly-appendix-operator-crs.adoc index 93b687ee85..7fbf50a486 100644 --- a/downstream/assemblies/platform/assembly-appendix-operator-crs.adoc +++ b/downstream/assemblies/platform/assembly-appendix-operator-crs.adoc @@ -7,7 +7,7 @@ ifdef::context[:parent-context: {context}] [id="appendix-operator-crs_{context}"] -= Appendix: {PlatformName} custom resources += {PlatformName} custom resources [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-appendix-troubleshoot-containerized-aap.adoc b/downstream/assemblies/platform/assembly-appendix-troubleshoot-containerized-aap.adoc index e23ef29bf4..689d0f1f04 100644 --- a/downstream/assemblies/platform/assembly-appendix-troubleshoot-containerized-aap.adoc +++ b/downstream/assemblies/platform/assembly-appendix-troubleshoot-containerized-aap.adoc @@ -2,7 +2,7 @@ [id="troubleshooting-containerized-ansible-automation-platform"] -= Troubleshooting containerized {PlatformNameShort} += Troubleshoot your containerized deployment [role="_abstract"] Use this information to troubleshoot your containerized {PlatformNameShort} installation. diff --git a/downstream/assemblies/platform/assembly-appendix-troubleshoot-rpm-aap.adoc b/downstream/assemblies/platform/assembly-appendix-troubleshoot-rpm-aap.adoc index a3d521c532..5a570da19b 100644 --- a/downstream/assemblies/platform/assembly-appendix-troubleshoot-rpm-aap.adoc +++ b/downstream/assemblies/platform/assembly-appendix-troubleshoot-rpm-aap.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="appendix-troubleshoot-rpm-aap"] -= Troubleshooting RPM installation of {PlatformNameShort} += Troubleshoot your RPM-based deployment of {PlatformNameShort} [role="_abstract"] Resolve common installation issues and errors that can occur when installing RPM-based {PlatformNameShort}. Learn how to generate diagnostic logs to identify problems. diff --git a/downstream/assemblies/platform/assembly-automation-mesh-operator-aap.adoc b/downstream/assemblies/platform/assembly-automation-mesh-operator-aap.adoc index b828ee281f..00d89114ae 100644 --- a/downstream/assemblies/platform/assembly-automation-mesh-operator-aap.adoc +++ b/downstream/assemblies/platform/assembly-automation-mesh-operator-aap.adoc @@ -2,7 +2,7 @@ [id="assembly-automation-mesh-operator-aap"] -= {AutomationMeshStart} for operator-based {PlatformName} += Scale automation in an operator environment [role="_abstract"] Scaling your automation mesh is available on OpenShift deployments of {PlatformName} and is possible through adding or removing nodes from your cluster dynamically, using the *Instances* resource of the {PlatformNameShort} UI, without running the installation script. @@ -15,7 +15,27 @@ To manage instances from the {PlatformNameShort} UI, you must have System Admini In general, the more processor cores (CPU) and memory (RAM) a node has, the more jobs that can be scheduled to run on that node at once. -For more information, see link:{URLControllerUserGuide}/controller-jobs#controller-capacity-determination[{ControllerNameStart} capacity determination and job impact]. +For more information, see link:{URLControllerUserGuide}/controller-jobs#controller-capacity-determination[{ControllerNameStart} capacity determination and job impact]. + +.Prerequisites + +[role="_abstract"] +The automation mesh is dependent on hop and execution nodes running on _{RHEL}_ (RHEL). +Your {PlatformName} subscription grants you ten {RHEL} licenses that can be used for running components of {PlatformNameShort}. + +For more information about {RHEL} subscriptions, see link:{BaseURL}/red_hat_enterprise_linux/9/html/configuring_basic_system_settings/assembly_registering-the-system-and-managing-subscriptions_configuring-basic-system-settings[Registering the system and managing subscriptions] in the {RHEL} documentation. + +The following steps prepare the RHEL instances for deployment of the automation mesh. + +. You require a {RHEL} operating system. +Each node in the mesh requires a static IP address, or a resolvable DNS hostname that {PlatformNameShort} can access. +. Ensure that you have the minimum requirements for the RHEL virtual machine before proceeding. +For more information, see the link:{URLPlanningGuide}/platform-system-requirements[System requirements]. +. Deploy the RHEL instances within the remote networks where communication is required. +For information about creating virtual machines, see link:{BaseURL}/red_hat_enterprise_linux/9/html/configuring_and_managing_virtualization/assembly_creating-virtual-machines_configuring-and-managing-virtualization[Creating Virtual Machines] in the _{RHEL}_ documentation. Remember to scale the capacity of your virtual machines sufficiently so that your proposed tasks can run on them. + +** RHEL ISOs can be obtained from access.redhat.com. +** RHEL cloud images can be built using Image Builder from {Console}. include::platform/ref-operator-mesh-prerequisites.adoc[leveloffset=+1] diff --git a/downstream/assemblies/platform/assembly-changing-ssl-certs-keys.adoc b/downstream/assemblies/platform/assembly-changing-ssl-certs-keys.adoc index f29afa9cb3..508097fe8e 100644 --- a/downstream/assemblies/platform/assembly-changing-ssl-certs-keys.adoc +++ b/downstream/assemblies/platform/assembly-changing-ssl-certs-keys.adoc @@ -3,7 +3,8 @@ ifdef::context[:parent-context: {context}] [id="changing-ssl-certs-keys"] -= Renewing and changing the SSL/TLS certificates + += Renew and change SSL/TLS certificates :context: renewing-changing-ssl-certs-keys diff --git a/downstream/assemblies/platform/assembly-configure-egress-proxy.adoc b/downstream/assemblies/platform/assembly-configure-egress-proxy.adoc index d822ad2c24..6557858501 100644 --- a/downstream/assemblies/platform/assembly-configure-egress-proxy.adoc +++ b/downstream/assemblies/platform/assembly-configure-egress-proxy.adoc @@ -2,7 +2,7 @@ [id="assembly-configure-egress-proxy"] -= Configuring Ansible Automation Platform to use egress proxy += Configure proxy servers for egress traffic [role="_abstract"] You can deploy {PlatformNameShort} so that egress from the platform for various purposes functions properly through proxy servers. diff --git a/downstream/assemblies/platform/assembly-configure-hub-storage.adoc b/downstream/assemblies/platform/assembly-configure-hub-storage.adoc index 797deb44bc..fdb7c4ebad 100644 --- a/downstream/assemblies/platform/assembly-configure-hub-storage.adoc +++ b/downstream/assemblies/platform/assembly-configure-hub-storage.adoc @@ -2,7 +2,7 @@ [id="configuring-storage-for-automation-hub"] -= Configuring storage for {HubName} += Configure storage for {HubName} [role="_abstract"] Configure storage backends for {HubName} to store automation content by using Amazon S3, Azure Blob Storage, or Network File System (NFS). diff --git a/downstream/assemblies/platform/assembly-configuring-proxy-support.adoc b/downstream/assemblies/platform/assembly-configuring-proxy-support.adoc index d67d32f7f7..ce1eafe2d1 100644 --- a/downstream/assemblies/platform/assembly-configuring-proxy-support.adoc +++ b/downstream/assemblies/platform/assembly-configuring-proxy-support.adoc @@ -3,7 +3,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-configuring-proxy-support"] -= Configuring proxy support for {PlatformName} += Configure proxy support to manage network configuration :context: configuring-proxy-support diff --git a/downstream/assemblies/platform/assembly-control-plane-adjustments.adoc b/downstream/assemblies/platform/assembly-control-plane-adjustments.adoc index 2ffd9fa22d..9cca9942f2 100644 --- a/downstream/assemblies/platform/assembly-control-plane-adjustments.adoc +++ b/downstream/assemblies/platform/assembly-control-plane-adjustments.adoc @@ -5,7 +5,7 @@ ifdef::context[:parent-context: {context}] :context: performance-considerations [id="assembly-control-plane-adjustments_{context}"] -= Control plane adjustments += Adjust the control plane to tune performance [role="_abstract"] The control plane refers to the {ControllerName} pods which contain the web and task containers that, among other things, provide the user interface and handle the scheduling and launching of jobs. diff --git a/downstream/assemblies/platform/assembly-controller-activity-stream.adoc b/downstream/assemblies/platform/assembly-controller-activity-stream.adoc index 83c5fcffb8..ecd684cf25 100644 --- a/downstream/assemblies/platform/assembly-controller-activity-stream.adoc +++ b/downstream/assemblies/platform/assembly-controller-activity-stream.adoc @@ -2,7 +2,7 @@ [id="assembly-controller-activity-stream"] -= Activity stream += View activity streams for all resources [role="_abstract"] Track all changes made to any object in {ControllerName} by reviewing the *Activity Stream*. diff --git a/downstream/assemblies/platform/assembly-controller-api-access-resources.adoc b/downstream/assemblies/platform/assembly-controller-api-access-resources.adoc index fb7b457d9c..2c7f88421e 100644 --- a/downstream/assemblies/platform/assembly-controller-api-access-resources.adoc +++ b/downstream/assemblies/platform/assembly-controller-api-access-resources.adoc @@ -2,7 +2,7 @@ [id="controller-api-access-resources"] -= Access resources += Access resource objects through API identifiers [role="_abstract"] {ControllerNameStart} uses a primary key to access individual resource objects. diff --git a/downstream/assemblies/platform/assembly-controller-api-auth-methods.adoc b/downstream/assemblies/platform/assembly-controller-api-auth-methods.adoc index d365f2b922..c1d8a99be3 100644 --- a/downstream/assemblies/platform/assembly-controller-api-auth-methods.adoc +++ b/downstream/assemblies/platform/assembly-controller-api-auth-methods.adoc @@ -2,7 +2,7 @@ [id="controller-api-auth-methods"] -= Authenticating in the API += Authenticate through the API [role="_abstract"] {ControllerNameStart} is designed for organizations to control their automation with a visual dashboard for out-of-the box control while providing a REST API to integrate with your other tools on a deeper level. diff --git a/downstream/assemblies/platform/assembly-controller-api-browsing-api.adoc b/downstream/assemblies/platform/assembly-controller-api-browsing-api.adoc index ee2fe039f7..7002fcae72 100644 --- a/downstream/assemblies/platform/assembly-controller-api-browsing-api.adoc +++ b/downstream/assemblies/platform/assembly-controller-api-browsing-api.adoc @@ -2,7 +2,7 @@ [id="controller-api-browsing-api"] -= Browsing with the API += Browse resources with the API [role="_abstract"] REST APIs give access to resources (data entities) through URI paths. diff --git a/downstream/assemblies/platform/assembly-controller-api-conventions.adoc b/downstream/assemblies/platform/assembly-controller-api-conventions.adoc index 410b1d8fab..88ca0a5325 100644 --- a/downstream/assemblies/platform/assembly-controller-api-conventions.adoc +++ b/downstream/assemblies/platform/assembly-controller-api-conventions.adoc @@ -2,7 +2,7 @@ [id="controller-api-conventions"] -= Use conventions in the API += Find resources with the search query string parameter [role="_abstract"] The API is versioned for compatibility reasons. diff --git a/downstream/assemblies/platform/assembly-controller-api-filter.adoc b/downstream/assemblies/platform/assembly-controller-api-filter.adoc index 19748d232d..5262b297fc 100644 --- a/downstream/assemblies/platform/assembly-controller-api-filter.adoc +++ b/downstream/assemblies/platform/assembly-controller-api-filter.adoc @@ -2,7 +2,7 @@ [id="controller-api-filter"] -= Filtering in the API += Filter resources through the API [role="_abstract"] The system recognizes a collection as a "queryset". diff --git a/downstream/assemblies/platform/assembly-controller-api-pagination.adoc b/downstream/assemblies/platform/assembly-controller-api-pagination.adoc index d82b2a4c92..7d5393aa4b 100644 --- a/downstream/assemblies/platform/assembly-controller-api-pagination.adoc +++ b/downstream/assemblies/platform/assembly-controller-api-pagination.adoc @@ -2,7 +2,7 @@ [id="controller-api-pagination"] -= Using pagination in the API += View collection responses that are not shown by default [role="_abstract"] The API paginates responses for collections. diff --git a/downstream/assemblies/platform/assembly-controller-api-search.adoc b/downstream/assemblies/platform/assembly-controller-api-search.adoc index 3307a5e656..c0b4449a03 100644 --- a/downstream/assemblies/platform/assembly-controller-api-search.adoc +++ b/downstream/assemblies/platform/assembly-controller-api-search.adoc @@ -2,7 +2,7 @@ [id="controller-api-search"] -= Using the search query string parameter += Find resources with the search query string parameter [role="_abstract"] The search query string parameter provides a simple yet powerful way to filter and find specific resources within your {PlatformNameShort} API. diff --git a/downstream/assemblies/platform/assembly-controller-api-sorting.adoc b/downstream/assemblies/platform/assembly-controller-api-sorting.adoc index 5632bf1abc..e506838003 100644 --- a/downstream/assemblies/platform/assembly-controller-api-sorting.adoc +++ b/downstream/assemblies/platform/assembly-controller-api-sorting.adoc @@ -2,7 +2,7 @@ [id="controller-api-sorting"] -= Sorting in the API += Sort the API [role="_abstract"] To give you examples that are easy to follow, we use the following URL throughout this guide: diff --git a/downstream/assemblies/platform/assembly-controller-api-tools.adoc b/downstream/assemblies/platform/assembly-controller-api-tools.adoc index 5de1e6d14c..2b2ffed14f 100644 --- a/downstream/assemblies/platform/assembly-controller-api-tools.adoc +++ b/downstream/assemblies/platform/assembly-controller-api-tools.adoc @@ -2,7 +2,7 @@ [id="controller-api-tools"] -= Available tools with the API += Use the REST API to browse, query, filter, and authenticate [id="ref-controller-api-tools"] diff --git a/downstream/assemblies/platform/assembly-controller-awx-manage-utility.adoc b/downstream/assemblies/platform/assembly-controller-awx-manage-utility.adoc index f12b556952..56b7f71da8 100644 --- a/downstream/assemblies/platform/assembly-controller-awx-manage-utility.adoc +++ b/downstream/assemblies/platform/assembly-controller-awx-manage-utility.adoc @@ -2,7 +2,7 @@ [id="assembly-controller-awx-manage-utility"] -= The _awx-manage_ utility += Use awx-manage to access {ControllerName} information [role="_abstract"] Use the `awx-manage` utility to access detailed internal information of {ControllerName}. diff --git a/downstream/assemblies/platform/assembly-controller-best-practices.adoc b/downstream/assemblies/platform/assembly-controller-best-practices.adoc index 863924ed75..bc5b3975b8 100644 --- a/downstream/assemblies/platform/assembly-controller-best-practices.adoc +++ b/downstream/assemblies/platform/assembly-controller-best-practices.adoc @@ -2,7 +2,7 @@ [id="assembly-controller-best-practices"] -= Best practices for {ControllerName} += Best practices for automation execution [role="_abstract"] Adopt these best practices to help ensure scalable, maintainable, and highly efficient automation. diff --git a/downstream/assemblies/platform/assembly-controller-credentials.adoc b/downstream/assemblies/platform/assembly-controller-credentials.adoc index a4cb14370d..fbedbbd570 100644 --- a/downstream/assemblies/platform/assembly-controller-credentials.adoc +++ b/downstream/assemblies/platform/assembly-controller-credentials.adoc @@ -2,7 +2,7 @@ [id="controller-credentials"] -= Managing user credentials += Configure credentials to authenticate remote systems and services [role="_abstract"] Credentials authenticate the {ControllerName} user when launching jobs against machines, synchronizing with inventory sources, and importing project content from a version control system. diff --git a/downstream/assemblies/platform/assembly-controller-ee-setup-reference.adoc b/downstream/assemblies/platform/assembly-controller-ee-setup-reference.adoc index 63aa765fbd..1d45207238 100644 --- a/downstream/assemblies/platform/assembly-controller-ee-setup-reference.adoc +++ b/downstream/assemblies/platform/assembly-controller-ee-setup-reference.adoc @@ -2,7 +2,7 @@ [id="assembly-controller-ee-setup-reference"] -= Execution Environment Setup Reference += Execution environment setup reference [role="_abstract"] Review this reference information to better understand the definition of an {ExecEnvShort}. diff --git a/downstream/assemblies/platform/assembly-controller-hosts.adoc b/downstream/assemblies/platform/assembly-controller-hosts.adoc index 3d7940bc82..5c0a002372 100644 --- a/downstream/assemblies/platform/assembly-controller-hosts.adoc +++ b/downstream/assemblies/platform/assembly-controller-hosts.adoc @@ -2,7 +2,7 @@ [id="assembly-controller-hosts"] -= Hosts += Add new hosts as automation targets [role="_abstract"] A host is a system managed by {PlatformNameShort}, which might include a physical, virtual, cloud-based server, or other device. diff --git a/downstream/assemblies/platform/assembly-controller-improving-performance.adoc b/downstream/assemblies/platform/assembly-controller-improving-performance.adoc index 7963facd1d..8666383d98 100644 --- a/downstream/assemblies/platform/assembly-controller-improving-performance.adoc +++ b/downstream/assemblies/platform/assembly-controller-improving-performance.adoc @@ -2,7 +2,7 @@ [id="assembly-controller-improving-performance"] -= Performance tuning for {ControllerName} += Tune {ControllerName} to improve performance [role="_abstract"] Tune your {ControllerName} to optimize performance and scalability. When planning your workload, ensure that you identify your performance and scaling needs, adjust for any limitations, and monitor your deployment. diff --git a/downstream/assemblies/platform/assembly-controller-inventories.adoc b/downstream/assemblies/platform/assembly-controller-inventories.adoc index 88e22a809a..a064385f1a 100644 --- a/downstream/assemblies/platform/assembly-controller-inventories.adoc +++ b/downstream/assemblies/platform/assembly-controller-inventories.adoc @@ -7,7 +7,7 @@ ifdef::context[:parent-context: {context}] :context: controller-inventory :inventories: -= Inventories += Define automation target hosts in your inventory files //ifdef::controller-GS[] //An inventory is a collection of hosts managed by {ControllerName}. @@ -128,7 +128,7 @@ include::platform/proc-controller-inv-source-vm-esxi.adoc[leveloffset=+3] include::platform/proc-controller-inv-source-satellite.adoc[leveloffset=+3] -include::platform/proc-controller-inv-source-insights.adoc[leveloffset=+3] +include::platform/proc-controller-inv-source-rhlightspeed.adoc[leveloffset=+3] include::platform/proc-controller-inv-source-openstack.adoc[leveloffset=+3] diff --git a/downstream/assemblies/platform/assembly-controller-inventory-templates.adoc b/downstream/assemblies/platform/assembly-controller-inventory-templates.adoc index fb43c05ec2..46f2f6f175 100644 --- a/downstream/assemblies/platform/assembly-controller-inventory-templates.adoc +++ b/downstream/assemblies/platform/assembly-controller-inventory-templates.adoc @@ -2,7 +2,7 @@ [id="controller-inventory-templates"] -= Supported Inventory plugin templates += Configure supported inventory plugin templates [role="_abstract"] After upgrade to 4.x, existing configurations are migrated to the new format that produces an inventory output compatible with earlier versions. diff --git a/downstream/assemblies/platform/assembly-controller-log-files.adoc b/downstream/assemblies/platform/assembly-controller-log-files.adoc index 290c725546..5cfa7fbc3c 100644 --- a/downstream/assemblies/platform/assembly-controller-log-files.adoc +++ b/downstream/assemblies/platform/assembly-controller-log-files.adoc @@ -2,7 +2,7 @@ [id="assembly-controller-log-files"] -= {ControllerNameStart} logs += Access log information [role="_abstract"] {ControllerNameStart} logs are accessed in different ways depending on whether you have an RPM-based or containerized installation of {PlatformNameShort}. diff --git a/downstream/assemblies/platform/assembly-controller-logging-aggregation.adoc b/downstream/assemblies/platform/assembly-controller-logging-aggregation.adoc index 38481a004f..0c24a44369 100644 --- a/downstream/assemblies/platform/assembly-controller-logging-aggregation.adoc +++ b/downstream/assemblies/platform/assembly-controller-logging-aggregation.adoc @@ -2,7 +2,7 @@ [id="assembly-controller-logging-aggregation"] -= Logging and Aggregation += Send log files to third-party aggregation services [role="_abstract"] Logging provides the capability to send detailed logs to third-party external log aggregation services. diff --git a/downstream/assemblies/platform/assembly-controller-login.adoc b/downstream/assemblies/platform/assembly-controller-login.adoc index 311786dbf3..42e70e64fe 100644 --- a/downstream/assemblies/platform/assembly-controller-login.adoc +++ b/downstream/assemblies/platform/assembly-controller-login.adoc @@ -2,7 +2,7 @@ [id="assembly-controller-login"] -= Logging into {PlatformNameShort} after installation += Log in after installation [role="_abstract"] After you install {PlatformNameShort}, you must log in. diff --git a/downstream/assemblies/platform/assembly-controller-metrics.adoc b/downstream/assemblies/platform/assembly-controller-metrics.adoc index ef44c9bd62..c6f047b2aa 100644 --- a/downstream/assemblies/platform/assembly-controller-metrics.adoc +++ b/downstream/assemblies/platform/assembly-controller-metrics.adoc @@ -2,7 +2,7 @@ [id="assembly-controller-metrics"] -= Metrics += Send metrics to system monitoring software [role="_abstract"] {ControllerNameStart} provides metrics that can be used to monitor the health and performance of the system. diff --git a/downstream/assemblies/platform/assembly-controller-organizations.adoc b/downstream/assemblies/platform/assembly-controller-organizations.adoc index 9388cd8e95..55f56a60c4 100644 --- a/downstream/assemblies/platform/assembly-controller-organizations.adoc +++ b/downstream/assemblies/platform/assembly-controller-organizations.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-controller-organizations_{context}"] -= Organizations += Structure groups and resources with organizations :context: access-mgmt-orgs diff --git a/downstream/assemblies/platform/assembly-controller-pac.adoc b/downstream/assemblies/platform/assembly-controller-pac.adoc index 9f430e05fb..bac012e7c9 100644 --- a/downstream/assemblies/platform/assembly-controller-pac.adoc +++ b/downstream/assemblies/platform/assembly-controller-pac.adoc @@ -10,7 +10,7 @@ endif::[] ifdef::context[] [id="controller-pac_{context}"] endif::[] -= Implementing policy enforcement += Implement policy enforcement :context: controller-pac diff --git a/downstream/assemblies/platform/assembly-controller-project-signing.adoc b/downstream/assemblies/platform/assembly-controller-project-signing.adoc index fa9e7411e3..b8eed4b2b1 100644 --- a/downstream/assemblies/platform/assembly-controller-project-signing.adoc +++ b/downstream/assemblies/platform/assembly-controller-project-signing.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-controller-project-signing"] -= Project Signing and Verification += Enforce project integrity with signing and verification [role="_abstract"] Use project signing and verification in your project directory to sign files. You can then verify whether or not that content has changed in any way, or files have been added to, or removed from the project unexpectedly. diff --git a/downstream/assemblies/platform/assembly-controller-projects.adoc b/downstream/assemblies/platform/assembly-controller-projects.adoc index 7ee60b48a8..987754d839 100644 --- a/downstream/assemblies/platform/assembly-controller-projects.adoc +++ b/downstream/assemblies/platform/assembly-controller-projects.adoc @@ -8,7 +8,7 @@ ifdef::controller-GS[] endif::controller-GS[] ifdef::controller-UG[] -= Projects += Logically group playbooks with projects endif::controller-UG[] diff --git a/downstream/assemblies/platform/assembly-controller-secret-management.adoc b/downstream/assemblies/platform/assembly-controller-secret-management.adoc index 97dd4c0141..c3c4be7e68 100644 --- a/downstream/assemblies/platform/assembly-controller-secret-management.adoc +++ b/downstream/assemblies/platform/assembly-controller-secret-management.adoc @@ -2,7 +2,7 @@ [id="assembly-controller-secret-management"] -= Secret management system += Configure an external secret management system for automation [role="_abstract"] Users and system administrators upload machine and cloud credentials so that automation can access machines and external services on their behalf. diff --git a/downstream/assemblies/platform/assembly-controller-teams.adoc b/downstream/assemblies/platform/assembly-controller-teams.adoc index 5a953f1c52..76a4000cd4 100644 --- a/downstream/assemblies/platform/assembly-controller-teams.adoc +++ b/downstream/assemblies/platform/assembly-controller-teams.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-controller-teams_{context}"] -= Teams += Bulk-assign roles to users with teams :context: controller-teams diff --git a/downstream/assemblies/platform/assembly-controller-topology-viewer.adoc b/downstream/assemblies/platform/assembly-controller-topology-viewer.adoc index 07935a4d11..96670cbe9d 100644 --- a/downstream/assemblies/platform/assembly-controller-topology-viewer.adoc +++ b/downstream/assemblies/platform/assembly-controller-topology-viewer.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-controller-topology-viewer"] -= Topology View += View details about mesh nodes with topology viewer [role="_abstract"] Use the *Topology View* to view node type, node health, and specific details about each node if you already have a mesh topology deployed. diff --git a/downstream/assemblies/platform/assembly-controller-users.adoc b/downstream/assemblies/platform/assembly-controller-users.adoc index 8f69ee2e87..54ac9830e7 100644 --- a/downstream/assemblies/platform/assembly-controller-users.adoc +++ b/downstream/assemblies/platform/assembly-controller-users.adoc @@ -3,7 +3,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-controller-users_{context}"] -= Users += View, create, or assign roles to users :context: access-mgmt-users diff --git a/downstream/assemblies/platform/assembly-controlling-data-collection.adoc b/downstream/assemblies/platform/assembly-controlling-data-collection.adoc index c75af43eee..0a7bdcd39d 100644 --- a/downstream/assemblies/platform/assembly-controlling-data-collection.adoc +++ b/downstream/assemblies/platform/assembly-controlling-data-collection.adoc @@ -3,7 +3,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-controlling-data-collection"] -= Managing usability analytics and data collection from {ControllerName} += Manage analytics and data collection in {PlatformNameShort} :context: data-collection diff --git a/downstream/assemblies/platform/assembly-deploy-ansible-mcp-server-operator-install.adoc b/downstream/assemblies/platform/assembly-deploy-ansible-mcp-server-operator-install.adoc index c351d8bdfd..af3fd2e196 100644 --- a/downstream/assemblies/platform/assembly-deploy-ansible-mcp-server-operator-install.adoc +++ b/downstream/assemblies/platform/assembly-deploy-ansible-mcp-server-operator-install.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context: {context}] [id="deploy-ansible-mcp-server-operator-install"] -= Deploying Ansible MCP server on {PlatformNameShort} += Deploy the Ansible MCP server on {PlatformNameShort} :context: deploying-ansible-mcp-server diff --git a/downstream/assemblies/platform/assembly-deploying-alia.adoc b/downstream/assemblies/platform/assembly-deploying-alia.adoc index dd6aacf3e3..1cea81acae 100644 --- a/downstream/assemblies/platform/assembly-deploying-alia.adoc +++ b/downstream/assemblies/platform/assembly-deploying-alia.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] [id="deploying-alia"] -= Deploying the {AAPchatbot} += Deploy the Ansible Lightspeed intelligent assistant [role="_abstract"] This section provides information about the procedures involved in deploying the {AAPchatbot} on {OCPShort}. diff --git a/downstream/assemblies/platform/assembly-deploying-chatbot-operator.adoc b/downstream/assemblies/platform/assembly-deploying-chatbot-operator.adoc index 9f3e490fc0..7b02a6520b 100644 --- a/downstream/assemblies/platform/assembly-deploying-chatbot-operator.adoc +++ b/downstream/assemblies/platform/assembly-deploying-chatbot-operator.adoc @@ -5,7 +5,7 @@ ifdef::context[:parent-context: {context}] [id="deploying-chatbot-operator"] -= Deploying the {AAPchatbot} on {OCPShort} += Deploy the Ansible Lightspeed intelligent assistant on OpenShift Container Platform :context: deploying-chatbot-operator diff --git a/downstream/assemblies/platform/assembly-deploying-lightspeed-containerized-install.adoc b/downstream/assemblies/platform/assembly-deploying-lightspeed-containerized-install.adoc index 739e79653a..bf727116d3 100644 --- a/downstream/assemblies/platform/assembly-deploying-lightspeed-containerized-install.adoc +++ b/downstream/assemblies/platform/assembly-deploying-lightspeed-containerized-install.adoc @@ -2,7 +2,7 @@ ifdef::context[:parent-context: {context}] [id="deploying-lightspeed-containerized-install"] -= Deploying {LightspeedShortName} on containerized {PlatformNameShort} += Deploy Red Hat Ansible Lightspeed on containerized Ansible Automation Platform :context: deploying-lightspeed-containerized-install diff --git a/downstream/assemblies/platform/assembly-disconnected-installation.adoc b/downstream/assemblies/platform/assembly-disconnected-installation.adoc index f8bf3b5f7d..0fc0af2196 100644 --- a/downstream/assemblies/platform/assembly-disconnected-installation.adoc +++ b/downstream/assemblies/platform/assembly-disconnected-installation.adoc @@ -6,7 +6,7 @@ ifdef::context[:parent-context: {context}] :context: disconnected-installation [id="disconnected-installation"] -= Disconnected installation += Install in a disconnected environment [role="_abstract"] If you are not connected to the internet or do not have access to online repositories, you can install {PlatformName} without an active internet connection. diff --git a/downstream/assemblies/platform/assembly-edge-manager-device-fleets.adoc b/downstream/assemblies/platform/assembly-edge-manager-device-fleets.adoc index 5e36be28ef..5215b4562f 100644 --- a/downstream/assemblies/platform/assembly-edge-manager-device-fleets.adoc +++ b/downstream/assemblies/platform/assembly-edge-manager-device-fleets.adoc @@ -2,7 +2,7 @@ [id="assembly-edge-manager-device-fleets"] -= Device fleets += Manage a large number of devices with device fleets [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-edge-manager-images.adoc b/downstream/assemblies/platform/assembly-edge-manager-images.adoc index 609bec4a28..7644a18c02 100644 --- a/downstream/assemblies/platform/assembly-edge-manager-images.adoc +++ b/downstream/assemblies/platform/assembly-edge-manager-images.adoc @@ -2,7 +2,7 @@ [id="assembly-edge-manager-images"] -= Operating system images for using with the {RedHatEdge} += Understand bootable container images [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-edge-manager-install.adoc b/downstream/assemblies/platform/assembly-edge-manager-install.adoc index 6071e8a656..89eef7b9af 100644 --- a/downstream/assemblies/platform/assembly-edge-manager-install.adoc +++ b/downstream/assemblies/platform/assembly-edge-manager-install.adoc @@ -2,7 +2,7 @@ [id="assembly-edge-manager-install"] -= Installing the {RedHatEdge} on {PlatformNameShort} += Install {RedHatEdge} [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-edge-manager-intro.adoc b/downstream/assemblies/platform/assembly-edge-manager-intro.adoc index b9d32fa46a..d79bd6da9c 100644 --- a/downstream/assemblies/platform/assembly-edge-manager-intro.adoc +++ b/downstream/assemblies/platform/assembly-edge-manager-intro.adoc @@ -2,7 +2,7 @@ [id="assembly-edge-manager-intro"] -= {RedHatEdge} overview += Manage edge devices by integrating with {RedHatEdge} [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-edge-manager-manage-apps.adoc b/downstream/assemblies/platform/assembly-edge-manager-manage-apps.adoc index 488dcada68..c89e816ba3 100644 --- a/downstream/assemblies/platform/assembly-edge-manager-manage-apps.adoc +++ b/downstream/assemblies/platform/assembly-edge-manager-manage-apps.adoc @@ -2,7 +2,7 @@ [id="edge-manager-manage-apps"] -= Managing applications on an edge device += Manage applications on an edge device [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-edge-manager-manage-devices.adoc b/downstream/assemblies/platform/assembly-edge-manager-manage-devices.adoc index cce1a52027..034dcddc50 100644 --- a/downstream/assemblies/platform/assembly-edge-manager-manage-devices.adoc +++ b/downstream/assemblies/platform/assembly-edge-manager-manage-devices.adoc @@ -2,7 +2,7 @@ [id="assembly-edge-manager-manage-devices"] -= Manage devices += Enroll and view devices [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-edge-manager-provisioning-devices.adoc b/downstream/assemblies/platform/assembly-edge-manager-provisioning-devices.adoc index f78d471d2b..2c5ad26de5 100644 --- a/downstream/assemblies/platform/assembly-edge-manager-provisioning-devices.adoc +++ b/downstream/assemblies/platform/assembly-edge-manager-provisioning-devices.adoc @@ -2,7 +2,7 @@ [id="edge-manager-provisioning-devices"] -= Provision devices += Provision edge devices [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-edge-manager-troubleshooting.adoc b/downstream/assemblies/platform/assembly-edge-manager-troubleshooting.adoc index 7aefffa4e0..ac193420ec 100644 --- a/downstream/assemblies/platform/assembly-edge-manager-troubleshooting.adoc +++ b/downstream/assemblies/platform/assembly-edge-manager-troubleshooting.adoc @@ -2,7 +2,7 @@ [id="assembly-edge-manager-troubleshooting"] -= Troubleshooting {RedHatEdge} += Troubleshoot {RedHatEdge} [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-gateway-licensing-operator-copy.adoc b/downstream/assemblies/platform/assembly-gateway-licensing-operator-copy.adoc index 01d6553e4d..a57162fe48 100644 --- a/downstream/assemblies/platform/assembly-gateway-licensing-operator-copy.adoc +++ b/downstream/assemblies/platform/assembly-gateway-licensing-operator-copy.adoc @@ -6,7 +6,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-gateway-licensing-operator-copy"] -= Managing {PlatformNameShort} subscriptions, updates, and support += Manage {PlatformNameShort} subscriptions, updates, and support :context: licensing-gw diff --git a/downstream/assemblies/platform/assembly-gs-auto-dev.adoc b/downstream/assemblies/platform/assembly-gs-auto-dev.adoc index 52d081b777..cd19be300c 100644 --- a/downstream/assemblies/platform/assembly-gs-auto-dev.adoc +++ b/downstream/assemblies/platform/assembly-gs-auto-dev.adoc @@ -11,7 +11,7 @@ endif::[] :context: assembly-gs-auto-dev -= Getting started as an automation developer += Get started as an automation developer [role="_abstract"] As an automation developer, you can use {PlatformNameShort} to implement your organization's automation strategy. diff --git a/downstream/assemblies/platform/assembly-gs-auto-op.adoc b/downstream/assemblies/platform/assembly-gs-auto-op.adoc index 27095e5163..43dbfc90a7 100644 --- a/downstream/assemblies/platform/assembly-gs-auto-op.adoc +++ b/downstream/assemblies/platform/assembly-gs-auto-op.adoc @@ -11,7 +11,7 @@ endif::[] :context: assembly-gs-auto-op -= Getting started as an automation operator += Get started as an automation operator [role="_abstract"] As an automation operator, {PlatformNameShort} helps you monitor and execute automation projects with Red Hat certified collections or custom content for your organization. diff --git a/downstream/assemblies/platform/assembly-gs-key-functionality.adoc b/downstream/assemblies/platform/assembly-gs-key-functionality.adoc index 87f77421fd..02e48de224 100644 --- a/downstream/assemblies/platform/assembly-gs-key-functionality.adoc +++ b/downstream/assemblies/platform/assembly-gs-key-functionality.adoc @@ -11,7 +11,7 @@ endif::[] :context: assembly-gs-key-functionality -= Key functionality and concepts += {PlatformNameShort} overview [role="_abstract"] With {PlatformNameShort}, you can create, manage, and scale automation for your organization across users, teams, and regions. diff --git a/downstream/assemblies/platform/assembly-gw-config-authentication-type.adoc b/downstream/assemblies/platform/assembly-gw-config-authentication-type.adoc index 7463b79bd3..2f9cea2f81 100644 --- a/downstream/assemblies/platform/assembly-gw-config-authentication-type.adoc +++ b/downstream/assemblies/platform/assembly-gw-config-authentication-type.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] [id="gw-config-authentication-type"] -= Configuring an authentication type += Configure an authentication type to simplify user logins [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-gw-configure-authentication.adoc b/downstream/assemblies/platform/assembly-gw-configure-authentication.adoc index 397b8b2ef0..e7e6f8106b 100644 --- a/downstream/assemblies/platform/assembly-gw-configure-authentication.adoc +++ b/downstream/assemblies/platform/assembly-gw-configure-authentication.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] [id="gw-configure-authentication"] -= Configuring authentication in the {PlatformNameShort} += Configure central authentication for {PlatformNameShort} [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-gw-managing-authentication.adoc b/downstream/assemblies/platform/assembly-gw-managing-authentication.adoc index 7bcfa6f0ea..f19a5db9d5 100644 --- a/downstream/assemblies/platform/assembly-gw-managing-authentication.adoc +++ b/downstream/assemblies/platform/assembly-gw-managing-authentication.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] [id="gw-managing-authentication"] -= Managing authentication in {PlatformNameShort} += Locate and manage authentication configurations [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-gw-mapping.adoc b/downstream/assemblies/platform/assembly-gw-mapping.adoc index afdf17752d..bc03ae7b42 100644 --- a/downstream/assemblies/platform/assembly-gw-mapping.adoc +++ b/downstream/assemblies/platform/assembly-gw-mapping.adoc @@ -2,7 +2,7 @@ [id="gw-mapping"] -= Mapping += Map external authenticators to {PlatformNameShort} [role="_abstract"] To control which users are allowed into the {PlatformNameShort} server, and placed into {PlatformNameShort} organizations or teams based on their attributes (such as username and email address) or what groups they belong to, you can configure authenticator maps. diff --git a/downstream/assemblies/platform/assembly-gw-resources.adoc b/downstream/assemblies/platform/assembly-gw-resources.adoc index c8fe9de2ea..b9fdc7d12e 100644 --- a/downstream/assemblies/platform/assembly-gw-resources.adoc +++ b/downstream/assemblies/platform/assembly-gw-resources.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-gw-resources"] -= Resources += Manage user access to resources [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-gw-roles.adoc b/downstream/assemblies/platform/assembly-gw-roles.adoc index 7f0682d71e..c934932d67 100644 --- a/downstream/assemblies/platform/assembly-gw-roles.adoc +++ b/downstream/assemblies/platform/assembly-gw-roles.adoc @@ -2,7 +2,7 @@ [id="assembly-gw-roles"] -= Roles += View, create, and assign roles to grant user access to resources [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-gw-token-based-authentication.adoc b/downstream/assemblies/platform/assembly-gw-token-based-authentication.adoc index c7961562a2..9927acdcf1 100644 --- a/downstream/assemblies/platform/assembly-gw-token-based-authentication.adoc +++ b/downstream/assemblies/platform/assembly-gw-token-based-authentication.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] [id="gw-token-based-authentication"] -= Configuring access to external applications with token-based authentication += Configure access to external applications with tokens [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-horizontal-scaling.adoc b/downstream/assemblies/platform/assembly-horizontal-scaling.adoc index 20ff7c27b8..2cbffe2412 100644 --- a/downstream/assemblies/platform/assembly-horizontal-scaling.adoc +++ b/downstream/assemblies/platform/assembly-horizontal-scaling.adoc @@ -3,7 +3,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-horizontal-scaling"] -= Horizontal scaling in {PlatformName} += Horizontally scale in {EDAName} [role="_abstract"] You can set up multi-node deployments for components across {PlatformNameShort}. Whether you require horizontal scaling for {MenuTopAE}, {MenuAD}, or {AutomationMesh}, you can scale your deployments based on your organization's needs. diff --git a/downstream/assemblies/platform/assembly-install-aap-gateway.adoc b/downstream/assemblies/platform/assembly-install-aap-gateway.adoc index 3330b44eb9..7622739ca9 100644 --- a/downstream/assemblies/platform/assembly-install-aap-gateway.adoc +++ b/downstream/assemblies/platform/assembly-install-aap-gateway.adoc @@ -6,7 +6,7 @@ ifdef::context[:parent-context: {context}] :context: install-aap-gateway -= Installing {PlatformName} gateway on {OCP} += Deploy {PlatformNameShort} [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-install-aap-operator.adoc b/downstream/assemblies/platform/assembly-install-aap-operator.adoc index 3b3b7f4f11..6d4668b69a 100644 --- a/downstream/assemblies/platform/assembly-install-aap-operator.adoc +++ b/downstream/assemblies/platform/assembly-install-aap-operator.adoc @@ -6,7 +6,7 @@ ifdef::context[:parent-context: {context}] :context: install-aap-operator -= Deploying the {OperatorPlatformName} on {OCP} += Install the {OperatorPlatformNameShort} through OperatorHub [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-installing-aap-operator-cli.adoc b/downstream/assemblies/platform/assembly-installing-aap-operator-cli.adoc index dc54422a5f..c5f6ebd385 100644 --- a/downstream/assemblies/platform/assembly-installing-aap-operator-cli.adoc +++ b/downstream/assemblies/platform/assembly-installing-aap-operator-cli.adoc @@ -3,7 +3,7 @@ ifdef::context[:parent-context: {context}] [id="installing-aap-operator-cli_{context}"] -= Installing {OperatorPlatformName} from the {OCP} CLI += Install {OperatorPlatformNameShort} from the CLI :context: installing-aap-operator-cli diff --git a/downstream/assemblies/platform/assembly-installing-aap-operator-fetch-details.adoc b/downstream/assemblies/platform/assembly-installing-aap-operator-fetch-details.adoc index f366f1f830..648104b9fb 100644 --- a/downstream/assemblies/platform/assembly-installing-aap-operator-fetch-details.adoc +++ b/downstream/assemblies/platform/assembly-installing-aap-operator-fetch-details.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] [id="installing-aap-operator-fetch-details_{context}"] -= Accessing {Gateway} through the {OCPShort} CLI += Access {PlatformNameShort} through the CLI :context: installing-aap-operator-fetch-details diff --git a/downstream/assemblies/platform/assembly-installing-controller-operator.adoc b/downstream/assemblies/platform/assembly-installing-controller-operator.adoc index 9c20eb7447..7455fd3e66 100644 --- a/downstream/assemblies/platform/assembly-installing-controller-operator.adoc +++ b/downstream/assemblies/platform/assembly-installing-controller-operator.adoc @@ -9,7 +9,7 @@ See also the complementary step on the last line of this file. ifdef::context[:parent-context: {context}] [id="installing-controller-operator"] -= Configuring {ControllerName} on {OCP} web console += Configure {ControllerName} :context: installing-controller-operator diff --git a/downstream/assemblies/platform/assembly-installing-hub-operator.adoc b/downstream/assemblies/platform/assembly-installing-hub-operator.adoc index 4a8b060120..fb292811c8 100644 --- a/downstream/assemblies/platform/assembly-installing-hub-operator.adoc +++ b/downstream/assemblies/platform/assembly-installing-hub-operator.adoc @@ -10,7 +10,7 @@ ifdef::context[:parent-context: {context}] [id="installing-hub-operator"] -= Configuring {HubName} on {OCP} web console += Configure {HubName} :context: installing-hub-operator diff --git a/downstream/assemblies/platform/assembly-inventory-file-importing.adoc b/downstream/assemblies/platform/assembly-inventory-file-importing.adoc index 31c985196a..419e42b794 100644 --- a/downstream/assemblies/platform/assembly-inventory-file-importing.adoc +++ b/downstream/assemblies/platform/assembly-inventory-file-importing.adoc @@ -2,7 +2,7 @@ [id="assembly-inventory-file-importing"] -= Inventory File Importing += Import your inventory file from source control [role="_abstract"] With {ControllerName} you can select an inventory file from source control, rather than creating one from scratch. diff --git a/downstream/assemblies/platform/assembly-maintaining-containerized-aap.adoc b/downstream/assemblies/platform/assembly-maintaining-containerized-aap.adoc index d91d8bcf56..f257d30a38 100644 --- a/downstream/assemblies/platform/assembly-maintaining-containerized-aap.adoc +++ b/downstream/assemblies/platform/assembly-maintaining-containerized-aap.adoc @@ -2,7 +2,7 @@ [id="maintaining-containerized-aap"] -= Maintaining containerized {PlatformNameShort} += Maintain containerized {PlatformNameShort} [role="_abstract"] Update, backup, restore, uninstall, or reinstall containerized {PlatformNameShort} deployments to support your automation infrastructure. diff --git a/downstream/assemblies/platform/assembly-mesh-design-patterns.adoc b/downstream/assemblies/platform/assembly-mesh-design-patterns.adoc index ca9742065d..1851bc6b7b 100644 --- a/downstream/assemblies/platform/assembly-mesh-design-patterns.adoc +++ b/downstream/assemblies/platform/assembly-mesh-design-patterns.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] [id="design-patterns"] -= {AutomationMeshStart} design patterns += Design patterns for mesh :context: design-patterns diff --git a/downstream/assemblies/platform/assembly-metrics-utility.adoc b/downstream/assemblies/platform/assembly-metrics-utility.adoc index c611006558..3ba51d1cc2 100644 --- a/downstream/assemblies/platform/assembly-metrics-utility.adoc +++ b/downstream/assemblies/platform/assembly-metrics-utility.adoc @@ -6,7 +6,7 @@ ifdef::context[:parent-context-of-metrics-utility: {context}] :context: metrics-utility -= Usage reporting with `metrics-utility` += Generate consumption-based billing reports with the `metrics-utility` [role="_abstract"] The {PlatformNameShort} metrics utility tool (`metrics-utility`) is a command-line utility that is installed on a system containing an instance of {ControllerName}. diff --git a/downstream/assemblies/platform/assembly-operator-customize-aap.adoc b/downstream/assemblies/platform/assembly-operator-customize-aap.adoc index ddb37ed707..c54874506c 100644 --- a/downstream/assemblies/platform/assembly-operator-customize-aap.adoc +++ b/downstream/assemblies/platform/assembly-operator-customize-aap.adoc @@ -6,7 +6,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-operator-customize-aap"] -= Customizing your {OperatorPlatformName} on {OCPShort} += Customize your {OperatorPlatformName} [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-operator-install-operator.adoc b/downstream/assemblies/platform/assembly-operator-install-operator.adoc index 5a2b78c654..5383d87619 100644 --- a/downstream/assemblies/platform/assembly-operator-install-operator.adoc +++ b/downstream/assemblies/platform/assembly-operator-install-operator.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] [id="operator-install-operator_{context}"] -= Installing {OperatorPlatformName} on {OCP} += Install on {OCPShort} :context: operator-install-operator diff --git a/downstream/assemblies/platform/assembly-operator-install-planning.adoc b/downstream/assemblies/platform/assembly-operator-install-planning.adoc index d31752d6f6..44c7f60b29 100644 --- a/downstream/assemblies/platform/assembly-operator-install-planning.adoc +++ b/downstream/assemblies/platform/assembly-operator-install-planning.adoc @@ -3,7 +3,7 @@ ifdef::context[:parent-context: {context}] [id="operator-install-planning_{context}"] -= Planning your {OperatorPlatformName} on {OCP} += Plan your installation of {PlatformNameShort} on {OCP} :context: operator-install-planning diff --git a/downstream/assemblies/platform/assembly-operator-troubleshoot.adoc b/downstream/assemblies/platform/assembly-operator-troubleshoot.adoc index 634710b652..976cc2cfb8 100644 --- a/downstream/assemblies/platform/assembly-operator-troubleshoot.adoc +++ b/downstream/assemblies/platform/assembly-operator-troubleshoot.adoc @@ -6,7 +6,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-operator-troubleshoot"] -= Troubleshooting the {OperatorPlatformName} on {OCPShort} += Troubleshoot your Operator-based deployment of {PlatformNameShort} [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-operator-upgrade.adoc b/downstream/assemblies/platform/assembly-operator-upgrade.adoc index 732d45126a..c33ec57a6a 100644 --- a/downstream/assemblies/platform/assembly-operator-upgrade.adoc +++ b/downstream/assemblies/platform/assembly-operator-upgrade.adoc @@ -5,7 +5,7 @@ ifdef::context[:parent-context: {context}] [id="operator-upgrade_{context}"] -= Upgrading {OperatorPlatformName} on {OCP} += Upgrade your Operator-based deployment of {PlatformNameShort} :context: operator-upgrade diff --git a/downstream/assemblies/platform/assembly-planning-mesh.adoc b/downstream/assemblies/platform/assembly-planning-mesh.adoc index e5edb1b519..f3baf88e07 100644 --- a/downstream/assemblies/platform/assembly-planning-mesh.adoc +++ b/downstream/assemblies/platform/assembly-planning-mesh.adoc @@ -4,11 +4,11 @@ ifdef::context[:parent-context: {context}] [id="assembly-planning-mesh"] ifdef::mesh-VM[] -= Planning for {AutomationMesh} in your VM-based {PlatformName} environment += Scale automation across your infrastructure with automation mesh endif::mesh-VM[] ifdef::operator-mesh[] -= Planning for {AutomationMesh} in your operator-based {PlatformName} environment += Scale automation across your infrastructure with automation mesh endif::operator-mesh[] :context: planning-mesh diff --git a/downstream/assemblies/platform/assembly-platform-install-overview.adoc b/downstream/assemblies/platform/assembly-platform-install-overview.adoc index 0161609d74..7425c32e1c 100644 --- a/downstream/assemblies/platform/assembly-platform-install-overview.adoc +++ b/downstream/assemblies/platform/assembly-platform-install-overview.adoc @@ -5,7 +5,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-platform-install-overview"] -= {PlatformName} installation overview += Install RPM-based {PlatformNameShort} :context: platform-install-scenario diff --git a/downstream/assemblies/platform/assembly-platform-install-scenario.adoc b/downstream/assemblies/platform/assembly-platform-install-scenario.adoc index 31dcb45209..48ed91573e 100644 --- a/downstream/assemblies/platform/assembly-platform-install-scenario.adoc +++ b/downstream/assemblies/platform/assembly-platform-install-scenario.adoc @@ -6,7 +6,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-platform-install-scenario"] -= Installing {PlatformName} += Install {PlatformNameShort} :context: platform-install-scenario diff --git a/downstream/assemblies/platform/assembly-pod-spec-modifications.adoc b/downstream/assemblies/platform/assembly-pod-spec-modifications.adoc index f3da2a4f4c..7c64c41038 100644 --- a/downstream/assemblies/platform/assembly-pod-spec-modifications.adoc +++ b/downstream/assemblies/platform/assembly-pod-spec-modifications.adoc @@ -6,7 +6,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-pod-spec-modifications_{context}"] -= Pod specification modifications += Performance tuning for operator environments [role="_abstract"] A pod in Kubernetes is the smallest deployable compute unit, consisting of one or more containers sharing networking and storage on a single host. diff --git a/downstream/assemblies/platform/assembly-preparing-containerized-installation.adoc b/downstream/assemblies/platform/assembly-preparing-containerized-installation.adoc index e11b979a22..3732c667f5 100644 --- a/downstream/assemblies/platform/assembly-preparing-containerized-installation.adoc +++ b/downstream/assemblies/platform/assembly-preparing-containerized-installation.adoc @@ -2,7 +2,7 @@ [id="preparing-containerized-installation"] -= Preparing the containerized {PlatformNameShort} installation += Prepare the containerized {PlatformNameShort} installation [role="_abstract"] Prepare your environment for containerized {PlatformNameShort} by understanding deployment topologies, verifying system requirements, configuring {RHEL} hosts, and setting up inventory files. diff --git a/downstream/assemblies/platform/assembly-setting-up-automation-mesh.adoc b/downstream/assemblies/platform/assembly-setting-up-automation-mesh.adoc index 22d759c7f3..6715aecca3 100644 --- a/downstream/assemblies/platform/assembly-setting-up-automation-mesh.adoc +++ b/downstream/assemblies/platform/assembly-setting-up-automation-mesh.adoc @@ -5,7 +5,7 @@ ifdef::context[:parent-context: {context}] [id="setting-up"] -= Setting up {AutomationMesh} += Scale with automation mesh in a VM environment :context: setting-up diff --git a/downstream/assemblies/platform/assembly-setup-postgresql-ext-database.adoc b/downstream/assemblies/platform/assembly-setup-postgresql-ext-database.adoc index 0325830978..bdc2827382 100644 --- a/downstream/assemblies/platform/assembly-setup-postgresql-ext-database.adoc +++ b/downstream/assemblies/platform/assembly-setup-postgresql-ext-database.adoc @@ -2,7 +2,7 @@ [id="setting-up-a-customer-provided-external-database"] -= Configuring an external (customer provided) PostgreSQL database += Configure an external (customer provided) PostgreSQL database [role="_abstract"] Set up an external (customer provided) PostgreSQL database for containerized {PlatformNameShort} to use your own database infrastructure. diff --git a/downstream/assemblies/platform/assembly-specify-dedicated-nodes.adoc b/downstream/assemblies/platform/assembly-specify-dedicated-nodes.adoc index fab3f901c1..2468cdfa44 100644 --- a/downstream/assemblies/platform/assembly-specify-dedicated-nodes.adoc +++ b/downstream/assemblies/platform/assembly-specify-dedicated-nodes.adoc @@ -6,7 +6,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-specify-dedicted-nodes_{context}"] -= Specifying dedicated nodes += Specify dedicated nodes for pods and job execution [role="_abstract"] A Kubernetes cluster runs on top of many Virtual Machines or nodes (generally anywhere between 2 and 20 nodes). diff --git a/downstream/assemblies/platform/assembly-ug-controller-attributes-custom-notifications.adoc b/downstream/assemblies/platform/assembly-ug-controller-attributes-custom-notifications.adoc index 9f2813a91f..9100d34b52 100644 --- a/downstream/assemblies/platform/assembly-ug-controller-attributes-custom-notifications.adoc +++ b/downstream/assemblies/platform/assembly-ug-controller-attributes-custom-notifications.adoc @@ -2,7 +2,7 @@ [id="controller-attributes-custom-notifications"] -= Supported attributes for custom notifications += Custom notification attributes [role="_abstract"] Learn about the list of supported job attributes and the proper syntax for constructing the message text for notifications. diff --git a/downstream/assemblies/platform/assembly-ug-controller-instance-groups.adoc b/downstream/assemblies/platform/assembly-ug-controller-instance-groups.adoc index ac64fe2b6d..23e9362dd2 100644 --- a/downstream/assemblies/platform/assembly-ug-controller-instance-groups.adoc +++ b/downstream/assemblies/platform/assembly-ug-controller-instance-groups.adoc @@ -2,7 +2,7 @@ [id="controller-instance-groups"] -= Managing Instance Groups += Determine where automation runs with instance groups [role="_abstract"] An Instance Group enables you to group instances in a clustered environment. diff --git a/downstream/assemblies/platform/assembly-ug-controller-job-slicing.adoc b/downstream/assemblies/platform/assembly-ug-controller-job-slicing.adoc index e278d30e05..bef161083c 100644 --- a/downstream/assemblies/platform/assembly-ug-controller-job-slicing.adoc +++ b/downstream/assemblies/platform/assembly-ug-controller-job-slicing.adoc @@ -5,7 +5,7 @@ ifdef::context[:parent-context: {context}] [id="controller-job-slicing"] -= Job slicing += Distribute automation across a large number of hosts with job slicing [role="_abstract"] A sliced job refers to the concept of a distributed job. diff --git a/downstream/assemblies/platform/assembly-ug-controller-job-templates.adoc b/downstream/assemblies/platform/assembly-ug-controller-job-templates.adoc index 321ac5e5e0..44831bb277 100644 --- a/downstream/assemblies/platform/assembly-ug-controller-job-templates.adoc +++ b/downstream/assemblies/platform/assembly-ug-controller-job-templates.adoc @@ -2,7 +2,7 @@ [id="controller-job-templates"] -= Job templates += Standardize and streamline automation with automation job templates [role="_abstract"] You can create both Job templates and Workflow job templates from {MenuAETemplates}. diff --git a/downstream/assemblies/platform/assembly-ug-controller-jobs.adoc b/downstream/assemblies/platform/assembly-ug-controller-jobs.adoc index 151c5347c4..3ec9439f6c 100644 --- a/downstream/assemblies/platform/assembly-ug-controller-jobs.adoc +++ b/downstream/assemblies/platform/assembly-ug-controller-jobs.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] [id="controller-jobs"] -= Jobs in {ControllerName} += Use jobs to run playbooks against an inventory of hosts :context: jobs-in-controller diff --git a/downstream/assemblies/platform/assembly-ug-controller-notifications.adoc b/downstream/assemblies/platform/assembly-ug-controller-notifications.adoc index 9b3bf52494..27fb15133c 100644 --- a/downstream/assemblies/platform/assembly-ug-controller-notifications.adoc +++ b/downstream/assemblies/platform/assembly-ug-controller-notifications.adoc @@ -2,7 +2,7 @@ [id="controller-notifications"] -= Notifiers += Understand and configure notifications [role="_abstract"] A xref:controller-notification-types[Notification type] such as Email, Slack or a Webhook, is an instance of a Notification Template, and has a name, description and configuration defined in the Notification template. diff --git a/downstream/assemblies/platform/assembly-ug-controller-schedules.adoc b/downstream/assemblies/platform/assembly-ug-controller-schedules.adoc index 8db51bd08d..defd5c9f55 100644 --- a/downstream/assemblies/platform/assembly-ug-controller-schedules.adoc +++ b/downstream/assemblies/platform/assembly-ug-controller-schedules.adoc @@ -2,7 +2,7 @@ [id="controller-schedules"] -= Schedules += Schedule recurring automation :context: schedules-controller diff --git a/downstream/assemblies/platform/assembly-ug-controller-setting-up-insights.adoc b/downstream/assemblies/platform/assembly-ug-controller-setting-up-insights.adoc index 4043981c80..59a0a24176 100644 --- a/downstream/assemblies/platform/assembly-ug-controller-setting-up-insights.adoc +++ b/downstream/assemblies/platform/assembly-ug-controller-setting-up-insights.adoc @@ -2,7 +2,7 @@ [id="controller-setting-up-insights"] -= Setting up {RHLightspeed} Remediations += Integrate with {RHLightspeed} (formerly Insights) [role="_abstract"] {ControllerNameStart} supports integration with {RHLightspeed}. diff --git a/downstream/assemblies/platform/assembly-ug-controller-work-with-webhooks.adoc b/downstream/assemblies/platform/assembly-ug-controller-work-with-webhooks.adoc index 48e25aee92..be96386032 100644 --- a/downstream/assemblies/platform/assembly-ug-controller-work-with-webhooks.adoc +++ b/downstream/assemblies/platform/assembly-ug-controller-work-with-webhooks.adoc @@ -2,7 +2,7 @@ [id="controller-work-with-webhooks"] -= Working with Webhooks += Trigger automation using webhooks [role="_abstract"] Use webhooks to run specified commands between applications over the web. diff --git a/downstream/assemblies/platform/assembly-ug-controller-workflow-job-templates.adoc b/downstream/assemblies/platform/assembly-ug-controller-workflow-job-templates.adoc index 227b2b24a5..dc6b0f2188 100644 --- a/downstream/assemblies/platform/assembly-ug-controller-workflow-job-templates.adoc +++ b/downstream/assemblies/platform/assembly-ug-controller-workflow-job-templates.adoc @@ -2,7 +2,7 @@ [id="controller-workflow-job-templates"] -= Workflow job templates += Orchestrate complex automation with workflow job templates :context: worklow-job-templates diff --git a/downstream/assemblies/platform/assembly-ug-controller-workflows.adoc b/downstream/assemblies/platform/assembly-ug-controller-workflows.adoc index 63c67b53bd..f09dfa6103 100644 --- a/downstream/assemblies/platform/assembly-ug-controller-workflows.adoc +++ b/downstream/assemblies/platform/assembly-ug-controller-workflows.adoc @@ -2,7 +2,7 @@ [id="controller-workflows"] -= Workflows in {ControllerName} += Understand how to configure workflows :context: workflows-controller diff --git a/downstream/assemblies/platform/assembly-update-ocp.adoc b/downstream/assemblies/platform/assembly-update-ocp.adoc index e870444e5b..3134fb7912 100644 --- a/downstream/assemblies/platform/assembly-update-ocp.adoc +++ b/downstream/assemblies/platform/assembly-update-ocp.adoc @@ -2,7 +2,7 @@ [id="update-ocp"] -= Updating {PlatformName} on {OCP} += Patch update for Operator-based {PlatformNameShort} [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-upgrade-api-changes.adoc b/downstream/assemblies/platform/assembly-upgrade-api-changes.adoc index da3c03d3e3..df3fe62716 100644 --- a/downstream/assemblies/platform/assembly-upgrade-api-changes.adoc +++ b/downstream/assemblies/platform/assembly-upgrade-api-changes.adoc @@ -2,7 +2,7 @@ [id="upgrade-api-changes"] -= API changes in {PlatformNameShort} {PlatformVers} += API changes in {PlatformVers} [role="_abstract"] {PlatformNameShort} 2.5 and {PlatformVers} include changes to API endpoints with the addition of {Gateway}. Versions 2.5 and {PlatformVers} expose API access to individual services ({ControllerName}, {PrivateHubName}, {EDAName}) to maintain compatibility with existing REST API integrations. This access will be removed in a future release. diff --git a/downstream/assemblies/platform/assembly-upgrade-authentication-movement-2.4-to-2.6.adoc b/downstream/assemblies/platform/assembly-upgrade-authentication-movement-2.4-to-2.6.adoc index e88cacfa07..7b65328b01 100644 --- a/downstream/assemblies/platform/assembly-upgrade-authentication-movement-2.4-to-2.6.adoc +++ b/downstream/assemblies/platform/assembly-upgrade-authentication-movement-2.4-to-2.6.adoc @@ -2,7 +2,7 @@ [id="upgrade-authentication-movement-2.4-to-2.6"] -= Authentication movement += Authentication provider migration behavior [role="_abstract"] During an upgrade from {PlatformNameShort} 2.4 to {PlatformVers}, only complete authentication provider configurations are migrated to the new {Gateway}. diff --git a/downstream/assemblies/platform/assembly-upgrade-data-movement.adoc b/downstream/assemblies/platform/assembly-upgrade-data-movement.adoc index 289ae748f8..80e2e2f4bd 100644 --- a/downstream/assemblies/platform/assembly-upgrade-data-movement.adoc +++ b/downstream/assemblies/platform/assembly-upgrade-data-movement.adoc @@ -2,7 +2,7 @@ [id="upgrade-data-movement"] -= Identity access management data movement += Identity access management changes when upgrading to {PlatformVers} [role="_abstract"] During the upgrade process to {PlatformNameShort} {PlatformVers}, Identity Access Management (IAM) data, including users, teams, organizations, their memberships, and associated roles, is migrated from {ControllerName} and {HubName} to {Gateway}. diff --git a/downstream/assemblies/platform/assembly-upgrade-faqs.adoc b/downstream/assemblies/platform/assembly-upgrade-faqs.adoc index 8bbe775c16..f8342f3f71 100644 --- a/downstream/assemblies/platform/assembly-upgrade-faqs.adoc +++ b/downstream/assemblies/platform/assembly-upgrade-faqs.adoc @@ -2,7 +2,7 @@ [id="upgrade-faqs"] -= FAQs related to upgrading += FAQs on upgrading to {PlatformVers} [role="_abstract"] diff --git a/downstream/assemblies/platform/assembly-upgrade-support-matrix.adoc b/downstream/assemblies/platform/assembly-upgrade-support-matrix.adoc index 2495262b3a..f309b1681d 100644 --- a/downstream/assemblies/platform/assembly-upgrade-support-matrix.adoc +++ b/downstream/assemblies/platform/assembly-upgrade-support-matrix.adoc @@ -2,7 +2,7 @@ [id="upgrade-support-matrix"] -= Support matrix for upgrade scenarios += Supported upgrade and migration scenarios [role="_abstract"] diff --git a/downstream/assemblies/playbooks/assembly-intro-to-playbooks.adoc b/downstream/assemblies/playbooks/assembly-intro-to-playbooks.adoc index 68cdb31cac..c69cca7ff3 100644 --- a/downstream/assemblies/playbooks/assembly-intro-to-playbooks.adoc +++ b/downstream/assemblies/playbooks/assembly-intro-to-playbooks.adoc @@ -2,7 +2,7 @@ [id="assembly-intro-to-playbooks"] -= Introduction += Introduction to {PlatformNameShort} playbooks [role="_abstract"] An Ansible Playbook is a blueprint for automation tasks, which are actions executed with limited manual effort across an inventory of solutions. diff --git a/downstream/assemblies/playbooks/assembly-networking-playbook.adoc b/downstream/assemblies/playbooks/assembly-networking-playbook.adoc index 8ef2e94728..e0059f706c 100644 --- a/downstream/assemblies/playbooks/assembly-networking-playbook.adoc +++ b/downstream/assemblies/playbooks/assembly-networking-playbook.adoc @@ -2,7 +2,7 @@ [id="assembly-networking-playbook"] -= Use a playbook to establish a connection to a managed node += Gather and display network device info with a playbook [role="_abstract"] Learn how to create and run a simple Ansible Playbook that connects to a network device, gathers facts, and displays them. diff --git a/downstream/assemblies/playbooks/assembly-playbook-practical-example.adoc b/downstream/assemblies/playbooks/assembly-playbook-practical-example.adoc index cdaead3c40..406ffb5e10 100644 --- a/downstream/assemblies/playbooks/assembly-playbook-practical-example.adoc +++ b/downstream/assemblies/playbooks/assembly-playbook-practical-example.adoc @@ -2,7 +2,7 @@ [id="assembly-playbook-practical-example"] -= A practical example of an Ansible Playbook += Example: automate software updates [role="_abstract"] Ansible can communicate with many different device classifications, from cloud-based REST APIs, to Linux and Windows systems, networking hardware, and much more. diff --git a/downstream/assemblies/security/assembly-aap-security-use-cases.adoc b/downstream/assemblies/security/assembly-aap-security-use-cases.adoc index f8f89c9ad2..ed7ac69a57 100644 --- a/downstream/assemblies/security/assembly-aap-security-use-cases.adoc +++ b/downstream/assemblies/security/assembly-aap-security-use-cases.adoc @@ -3,7 +3,7 @@ ifdef::context[:parent-context: {context}] [id="aap-security-use-cases"] -= {PlatformNameShort} security automation use cases += Security automation use cases :context: aap-security-enabling diff --git a/downstream/assemblies/security/assembly-eda-react-to-security-events.adoc b/downstream/assemblies/security/assembly-eda-react-to-security-events.adoc index acba28ebbc..39120d7c3e 100644 --- a/downstream/assemblies/security/assembly-eda-react-to-security-events.adoc +++ b/downstream/assemblies/security/assembly-eda-react-to-security-events.adoc @@ -2,7 +2,7 @@ [id="assembly-eda-react-to-security-events"] -= {EDAName} for reacting to security-related events += Configure automatic security reactions with {EDAName} [role="_abstract"] diff --git a/downstream/assemblies/security/assembly-firewall-policy-manage.adoc b/downstream/assemblies/security/assembly-firewall-policy-manage.adoc index 0f10cc403b..9f7d8da3d0 100644 --- a/downstream/assemblies/security/assembly-firewall-policy-manage.adoc +++ b/downstream/assemblies/security/assembly-firewall-policy-manage.adoc @@ -6,7 +6,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-firewall-policy-management_{context}"] -= Firewall policy management with Ansible security automation += Manage firewall policies and rules with security automation :context: firewall-policy-management diff --git a/downstream/assemblies/security/assembly-idps.adoc b/downstream/assemblies/security/assembly-idps.adoc index 54d1b2c3cd..e49a617277 100644 --- a/downstream/assemblies/security/assembly-idps.adoc +++ b/downstream/assemblies/security/assembly-idps.adoc @@ -5,7 +5,7 @@ ifdef::context[:parent-context: {context}] [id="assembly-idps_{context}"] -= Automating Network Intrusion Detection and Prevention Systems (IDPS) with {PlatformNameShort} += Automate network intrusion detection and prevention systems :context: idps diff --git a/downstream/assemblies/terraform-aap/assembly-cloud-terraform-integrating.adoc b/downstream/assemblies/terraform-aap/assembly-cloud-terraform-integrating.adoc index 9c31f241b1..053cf27dd8 100644 --- a/downstream/assemblies/terraform-aap/assembly-cloud-terraform-integrating.adoc +++ b/downstream/assemblies/terraform-aap/assembly-cloud-terraform-integrating.adoc @@ -2,7 +2,7 @@ [id="cloud-terraform-integrating"] -= Integrating with cloud.terraform += Integrate with the cloud.terraform collection [role="_abstract"] diff --git a/downstream/assemblies/terraform-aap/assembly-terraform-hashicorp-authenticating.adoc b/downstream/assemblies/terraform-aap/assembly-terraform-hashicorp-authenticating.adoc index f33a7dba6c..2b9087c983 100644 --- a/downstream/assemblies/terraform-aap/assembly-terraform-hashicorp-authenticating.adoc +++ b/downstream/assemblies/terraform-aap/assembly-terraform-hashicorp-authenticating.adoc @@ -2,7 +2,7 @@ [id="terraform-hashicorp-authenticating"] -= Authenticating to hashicorp.terraform += Authenticate to hashicorp.terraform [role="_abstract"] diff --git a/downstream/assemblies/terraform-aap/assembly-terraform-integrating-from-terraform.adoc b/downstream/assemblies/terraform-aap/assembly-terraform-integrating-from-terraform.adoc index 5a1c6f3a53..0cc6dff6af 100644 --- a/downstream/assemblies/terraform-aap/assembly-terraform-integrating-from-terraform.adoc +++ b/downstream/assemblies/terraform-aap/assembly-terraform-integrating-from-terraform.adoc @@ -2,7 +2,7 @@ [id="terraform-integrating-from-terraform"] -= Integrating from {Terraform} += Integrate from {Terraform} [role="_abstract"] diff --git a/downstream/assemblies/terraform-aap/assembly-terraform-introduction.adoc b/downstream/assemblies/terraform-aap/assembly-terraform-introduction.adoc index febc99f793..6e99631c88 100644 --- a/downstream/assemblies/terraform-aap/assembly-terraform-introduction.adoc +++ b/downstream/assemblies/terraform-aap/assembly-terraform-introduction.adoc @@ -2,7 +2,7 @@ [id="terraform-introduction"] -= About the {Terraform} integration += Integrate with {TerraformEnterpriseFullName} [role="_abstract"] diff --git a/downstream/assemblies/terraform-aap/assembly-terraform-migrating-from-cloud-terraform.adoc b/downstream/assemblies/terraform-aap/assembly-terraform-migrating-from-cloud-terraform.adoc index bf5d62aa30..44a6d3e443 100644 --- a/downstream/assemblies/terraform-aap/assembly-terraform-migrating-from-cloud-terraform.adoc +++ b/downstream/assemblies/terraform-aap/assembly-terraform-migrating-from-cloud-terraform.adoc @@ -2,7 +2,7 @@ [id="migrating-from-cloud-terraform"] -= Migrating from `cloud.terraform` to `hashicorp.terraform` += Migrate from `cloud.terraform` to `hashicorp.terraform` [role="_abstract"] diff --git a/downstream/assemblies/terraform-aap/assembly-terraform-migrating-from-community.adoc b/downstream/assemblies/terraform-aap/assembly-terraform-migrating-from-community.adoc index c7064dc361..173d066940 100644 --- a/downstream/assemblies/terraform-aap/assembly-terraform-migrating-from-community.adoc +++ b/downstream/assemblies/terraform-aap/assembly-terraform-migrating-from-community.adoc @@ -2,10 +2,8 @@ [id="terraform-migrating-from-community-terraform"] -= Migrating from {TerraformCommunityName} += Migrate from {TerraformCommunityName} [role="_abstract"] -If you want to use {PlatformNameShort} with {TerraformEnterpriseShortName} (TFE) or {TerraformCloudShortName} and you are currently using {TerraformCommunityName} (TCE), you must migrate to TFE or {TerraformCloudShortName} and then update {PlatformNameShort} configurations to work with TFE or {TerraformCloudShortName}. - include::terraform-aap/proc-terraform-migrating-from-community.adoc[leveloffset=+1] \ No newline at end of file diff --git a/downstream/assemblies/terraform-aap/assembly-terraform-provider-using-tf-actions-eda.adoc b/downstream/assemblies/terraform-aap/assembly-terraform-provider-using-tf-actions-eda.adoc index 95d69b18bf..0d3475c5f5 100644 --- a/downstream/assemblies/terraform-aap/assembly-terraform-provider-using-tf-actions-eda.adoc +++ b/downstream/assemblies/terraform-aap/assembly-terraform-provider-using-tf-actions-eda.adoc @@ -2,7 +2,7 @@ [id="terraform-using-tf-actions-eda"] -= Using TF Actions with {EDAName} += Use TF Actions with {EDAName} [role="_abstract"] diff --git a/downstream/assemblies/terraform-aap/assembly-terraform-using-tf-actions.adoc b/downstream/assemblies/terraform-aap/assembly-terraform-using-tf-actions.adoc index c0195f8010..d07bcb2e8c 100644 --- a/downstream/assemblies/terraform-aap/assembly-terraform-using-tf-actions.adoc +++ b/downstream/assemblies/terraform-aap/assembly-terraform-using-tf-actions.adoc @@ -2,7 +2,7 @@ [id="terraform-using-tf-actions"] -= Using TF Actions and {PlatformNameShort} += Use TF Actions and {PlatformNameShort} [role="_abstract"] diff --git a/downstream/assemblies/topologies/assembly-overview-tested-deployment-models.adoc b/downstream/assemblies/topologies/assembly-overview-tested-deployment-models.adoc index be7e0dee6d..2d96f71f3c 100644 --- a/downstream/assemblies/topologies/assembly-overview-tested-deployment-models.adoc +++ b/downstream/assemblies/topologies/assembly-overview-tested-deployment-models.adoc @@ -2,7 +2,7 @@ [id="overview-tested-deployment-models"] -= Tested deployment model types += Choose a deployment method and topology [role="_abstract"] Red Hat tests {PlatformNameShort} {PlatformVers} with a defined set of topologies to give you opinionated deployment options. diff --git a/downstream/assemblies/troubleshooting-aap/assembly-diagnosing-the-problem.adoc b/downstream/assemblies/troubleshooting-aap/assembly-diagnosing-the-problem.adoc index a0459d2936..6a13535513 100644 --- a/downstream/assemblies/troubleshooting-aap/assembly-diagnosing-the-problem.adoc +++ b/downstream/assemblies/troubleshooting-aap/assembly-diagnosing-the-problem.adoc @@ -2,7 +2,7 @@ [id="diagnosing-the-problem"] -= Diagnosing the problem += Collect configuration and diagnostic information [role="_abstract"] To start troubleshooting {PlatformNameShort}, use the `must-gather` command on {OCPShort} or the `sos` utility on a {VMBase} to collect configuration and diagnostic information. diff --git a/downstream/assemblies/vault-aap/assembly-vault-authenticating.adoc b/downstream/assemblies/vault-aap/assembly-vault-authenticating.adoc index 5e35a1e183..cc95e552da 100644 --- a/downstream/assemblies/vault-aap/assembly-vault-authenticating.adoc +++ b/downstream/assemblies/vault-aap/assembly-vault-authenticating.adoc @@ -2,7 +2,7 @@ [id="vault-authenticating"] -= Authenticating to `hashicorp.vault` += Authenticate to `hashicorp.vault` [role="_abstract"] diff --git a/downstream/assemblies/vault-aap/assembly-vault-introduction.adoc b/downstream/assemblies/vault-aap/assembly-vault-introduction.adoc index d92f8f215b..839ecf8df3 100644 --- a/downstream/assemblies/vault-aap/assembly-vault-introduction.adoc +++ b/downstream/assemblies/vault-aap/assembly-vault-introduction.adoc @@ -2,7 +2,7 @@ [id="vault-introduction"] -= About the {Vault} integration += Integrate with {VaultFullName} [role="_abstract"] diff --git a/downstream/assemblies/vault-aap/assembly-vault-kv1-modules.adoc b/downstream/assemblies/vault-aap/assembly-vault-kv1-modules.adoc index 78d28e5ca2..d01441c918 100644 --- a/downstream/assemblies/vault-aap/assembly-vault-kv1-modules.adoc +++ b/downstream/assemblies/vault-aap/assembly-vault-kv1-modules.adoc @@ -2,7 +2,7 @@ [id="vault-kv1-modules"] -= Configuring KV1 modules += Configure KV1 modules [role="_abstract"] diff --git a/downstream/assemblies/vault-aap/assembly-vault-kv2-modules.adoc b/downstream/assemblies/vault-aap/assembly-vault-kv2-modules.adoc index 999c2f5e4d..9e437700bd 100644 --- a/downstream/assemblies/vault-aap/assembly-vault-kv2-modules.adoc +++ b/downstream/assemblies/vault-aap/assembly-vault-kv2-modules.adoc @@ -2,7 +2,7 @@ [id="vault-kv2-modules"] -= Configuring KV2 modules += Configure KV2 modules [role="_abstract"] diff --git a/downstream/assemblies/vault-aap/assembly-vault-migrating-from-community.adoc b/downstream/assemblies/vault-aap/assembly-vault-migrating-from-community.adoc index ed1d80b42d..7f1b2a0d07 100644 --- a/downstream/assemblies/vault-aap/assembly-vault-migrating-from-community.adoc +++ b/downstream/assemblies/vault-aap/assembly-vault-migrating-from-community.adoc @@ -2,7 +2,7 @@ [id="vault-migrating-from-community-hashi-vault"] -= Migrating from `community.hashi_vault` += Migrate from `community.hashi_vault` [role="_abstract"] diff --git a/downstream/modules/aap-hardening/con-compliance-profile-considerations.adoc b/downstream/modules/aap-hardening/con-compliance-profile-considerations.adoc index f7e16a1969..4cda7cbb1d 100644 --- a/downstream/modules/aap-hardening/con-compliance-profile-considerations.adoc +++ b/downstream/modules/aap-hardening/con-compliance-profile-considerations.adoc @@ -2,7 +2,7 @@ [id="con-compliance-profile-considerations"] -= Compliance profile considerations += Ensure compliance with host-level security controls [role="_abstract"] In many environments, {PlatformNameShort} might need to be installed on {RHEL} systems where security controls have been applied to meet the requirements of a compliance profile such as CIS Critical Security Controls, _Payment Card Industry/Data Security Standard_ (PCI/DSS), the DISA STIG, or a similar profile. diff --git a/downstream/modules/aap-hardening/con-credential-management-planning.adoc b/downstream/modules/aap-hardening/con-credential-management-planning.adoc index d078edaa88..cb77bd4169 100644 --- a/downstream/modules/aap-hardening/con-credential-management-planning.adoc +++ b/downstream/modules/aap-hardening/con-credential-management-planning.adoc @@ -5,7 +5,7 @@ [id="con-credential-management-planning_{context}"] -= Credential management planning for {PlatformNameShort} += Manage platform credentials [role="_abstract"] diff --git a/downstream/modules/aap-hardening/con-day-two-operations.adoc b/downstream/modules/aap-hardening/con-day-two-operations.adoc index e1139a1abc..c577f2dab8 100644 --- a/downstream/modules/aap-hardening/con-day-two-operations.adoc +++ b/downstream/modules/aap-hardening/con-day-two-operations.adoc @@ -5,7 +5,7 @@ [id="con-day-two-operations_{context}"] -= Day two operations += RBAC security considerations for day two operations [role="_abstract"] diff --git a/downstream/modules/aap-hardening/con-hashicorp-vault-external-secrets.adoc b/downstream/modules/aap-hardening/con-hashicorp-vault-external-secrets.adoc index 3c0b1b959c..931f5a94e1 100644 --- a/downstream/modules/aap-hardening/con-hashicorp-vault-external-secrets.adoc +++ b/downstream/modules/aap-hardening/con-hashicorp-vault-external-secrets.adoc @@ -2,7 +2,7 @@ [id="con-hashicorp-vault-external-secrets"] -= Using HashiCorp vault for external secrets management += Integrate with HashiCorp to secure sensitive data [role="_abstract"] You can integrate HashiCorp Vault with {PlatformNameShort} to manage and retrieve sensitive data. diff --git a/downstream/modules/aap-hardening/con-installation.adoc b/downstream/modules/aap-hardening/con-installation.adoc index 115ee197f3..783e2ea327 100644 --- a/downstream/modules/aap-hardening/con-installation.adoc +++ b/downstream/modules/aap-hardening/con-installation.adoc @@ -5,7 +5,7 @@ [id="con-installation_{context}"] -= Installation += Installation settings to secure your platform [role="_abstract"] diff --git a/downstream/modules/aap-hardening/con-logging-log-capture.adoc b/downstream/modules/aap-hardening/con-logging-log-capture.adoc index 2356cc2df1..2d2f7d4bb8 100644 --- a/downstream/modules/aap-hardening/con-logging-log-capture.adoc +++ b/downstream/modules/aap-hardening/con-logging-log-capture.adoc @@ -5,7 +5,7 @@ [id="con-logging-log-capture_{context}"] -= Logging and log capture += Best practices for setting up secure logging [role="_abstract"] diff --git a/downstream/modules/aap-hardening/con-more_compliance-profile-considerations.adoc b/downstream/modules/aap-hardening/con-more_compliance-profile-considerations.adoc index 927d736d99..eb8eceb098 100644 --- a/downstream/modules/aap-hardening/con-more_compliance-profile-considerations.adoc +++ b/downstream/modules/aap-hardening/con-more_compliance-profile-considerations.adoc @@ -2,7 +2,7 @@ [id="con-more_compliance-profile-considerations"] -= Compliance profile considerations += Automate nodes that comply with security profiles [role="_abstract"] In many environments, you can use {PlatformNameShort} to manage systems where security controls have been applied to managed RHEL nodes to meet the requirements of a compliance profile such as CIS, PCI/DSS, the DISA STIG, or similar. diff --git a/downstream/modules/aap-hardening/con-protect-sensitive-data-no-log.adoc b/downstream/modules/aap-hardening/con-protect-sensitive-data-no-log.adoc index a8eac9becf..2c335bcd1d 100644 --- a/downstream/modules/aap-hardening/con-protect-sensitive-data-no-log.adoc +++ b/downstream/modules/aap-hardening/con-protect-sensitive-data-no-log.adoc @@ -2,7 +2,7 @@ [id="con-protect-sensitive-data-no-log"] -= Protecting sensitive data with no_log += Protect sensitive data with no_log [role="_abstract"] If you save Ansible output to a log, you expose any secret data in your Ansible output, such as passwords and usernames. diff --git a/downstream/modules/aap-hardening/con-rhel-host-planning.adoc b/downstream/modules/aap-hardening/con-rhel-host-planning.adoc index de539c3ce4..c5bc5598fc 100644 --- a/downstream/modules/aap-hardening/con-rhel-host-planning.adoc +++ b/downstream/modules/aap-hardening/con-rhel-host-planning.adoc @@ -5,7 +5,7 @@ [id="con-rhel-host-planning_{context}"] -= {RHEL} host planning += Secure your {RHEL} hosts [role="_abstract"] diff --git a/downstream/modules/aap-hardening/con-user-authentication-planning.adoc b/downstream/modules/aap-hardening/con-user-authentication-planning.adoc index f7decb3c9b..b5dc15ab4a 100644 --- a/downstream/modules/aap-hardening/con-user-authentication-planning.adoc +++ b/downstream/modules/aap-hardening/con-user-authentication-planning.adoc @@ -5,7 +5,7 @@ [id="con-user-authentication-planning_{context}"] -= User authentication planning += Best practices for securing user accounts [role="_abstract"] diff --git a/downstream/modules/aap-hardening/proc-configure-hashicorp-credentials.adoc b/downstream/modules/aap-hardening/proc-configure-hashicorp-credentials.adoc index 1a24c6cfca..b5cf6220c6 100644 --- a/downstream/modules/aap-hardening/proc-configure-hashicorp-credentials.adoc +++ b/downstream/modules/aap-hardening/proc-configure-hashicorp-credentials.adoc @@ -2,7 +2,7 @@ [id="proc-configure-hashicorp-credentials"] -= Using HashiCorp Vault credentials within {PlatformNameShort} += Use HashiCorp Vault credentials within {PlatformNameShort} [role="_abstract"] To use HashiCorp vault credentials within {PlatformNameShort}, create a new credential with the type *Machine Credential*. diff --git a/downstream/modules/aap-hardening/proc-configure-hashicorp-vault.adoc b/downstream/modules/aap-hardening/proc-configure-hashicorp-vault.adoc index bf90952d82..2456959c3f 100644 --- a/downstream/modules/aap-hardening/proc-configure-hashicorp-vault.adoc +++ b/downstream/modules/aap-hardening/proc-configure-hashicorp-vault.adoc @@ -2,7 +2,7 @@ [id="proc-configure-hashicorp-vault"] -= Configuring {PlatformNameShort} to communicate with HashiCorp vault += Configure {PlatformNameShort} to communicate with HashiCorp vault [role="_abstract"] In an enterprise environment, having externally managed secrets is a convenient way to manage sensitive data across multiple services. diff --git a/downstream/modules/aap-hardening/proc-configure-ldap-logging.adoc b/downstream/modules/aap-hardening/proc-configure-ldap-logging.adoc index 403ee47d89..04d288e919 100644 --- a/downstream/modules/aap-hardening/proc-configure-ldap-logging.adoc +++ b/downstream/modules/aap-hardening/proc-configure-ldap-logging.adoc @@ -2,7 +2,7 @@ [id="proc-configure-ldap-logging"] -= Configuring LDAP logging += Configure LDAP logging [role="_abstract"] Enable logging for LDAP. diff --git a/downstream/modules/aap-hardening/proc-configure-ssh-private-key.adoc b/downstream/modules/aap-hardening/proc-configure-ssh-private-key.adoc index 1c829bfd29..962c9c05a8 100644 --- a/downstream/modules/aap-hardening/proc-configure-ssh-private-key.adoc +++ b/downstream/modules/aap-hardening/proc-configure-ssh-private-key.adoc @@ -2,7 +2,7 @@ [id="proc-configure-ssh-private-key"] -= Configuring the machine credential’s SSH private key += Configure the machine credential’s SSH private key [role="_abstract"] Use the following procedure: diff --git a/downstream/modules/aap-hardening/proc-disaster-recovery-operations.adoc b/downstream/modules/aap-hardening/proc-disaster-recovery-operations.adoc index 890af56de3..7561f70ab0 100644 --- a/downstream/modules/aap-hardening/proc-disaster-recovery-operations.adoc +++ b/downstream/modules/aap-hardening/proc-disaster-recovery-operations.adoc @@ -5,7 +5,7 @@ [id="proc-disaster-recovery-operations_{context}"] -= Disaster recovery and continuity of operations += Disaster recovery and operational continuity [role="_abstract"] diff --git a/downstream/modules/aap-hardening/proc-implement-security-control.adoc b/downstream/modules/aap-hardening/proc-implement-security-control.adoc index 83a52852a0..8327228047 100644 --- a/downstream/modules/aap-hardening/proc-implement-security-control.adoc +++ b/downstream/modules/aap-hardening/proc-implement-security-control.adoc @@ -2,7 +2,7 @@ [id="proc-implement-security-control"] -= Implementing security control += Implement security control [role="_abstract"] Some of the following examples of meeting compliance requirements come from the US DoD _Security Technical Implementation Guide_, but go back to integrity and security best practices. diff --git a/downstream/modules/aap-hardening/proc-implement-security-controller.adoc b/downstream/modules/aap-hardening/proc-implement-security-controller.adoc index 410da7f0b4..72abc96d65 100644 --- a/downstream/modules/aap-hardening/proc-implement-security-controller.adoc +++ b/downstream/modules/aap-hardening/proc-implement-security-controller.adoc @@ -2,7 +2,7 @@ [id="proc-implement-security-controller"] -= Implementing security control for each host += Implement security control for each host [role="_abstract"] {ControllerNameStart}'s log files must be accessible by explicitly defined privilege. @@ -26,7 +26,7 @@ To implement the security control, use the following procedure: * `chmod 770 /var/log/supervisor/` * `chown root:root /var/log/supervisor/` + -{ControllerNameStart} must be configured to fail over to another system in the event of log subsystem failure. +{ControllerNameStart} must be configured to fail over to another system in case of log subsystem failure. {ControllerNameStart} hosts must be capable of failing over to another {ControllerName} host which can handle application and logging functions upon detection of an application log processing failure. This enables continual operation of the application and logging functions while minimizing the loss of operation for the users and loss of log data. diff --git a/downstream/modules/aap-hardening/proc-implement-security-for-admin.adoc b/downstream/modules/aap-hardening/proc-implement-security-for-admin.adoc index 96a3b41b5d..077bf33a77 100644 --- a/downstream/modules/aap-hardening/proc-implement-security-for-admin.adoc +++ b/downstream/modules/aap-hardening/proc-implement-security-for-admin.adoc @@ -5,7 +5,7 @@ [id="proc-implement-security-for-admin"] -= Implementing security control for system administrators += Implement security control for system administrators [role="_abstract"] {ControllerNameStart} must generate the appropriate log records. diff --git a/downstream/modules/aap-hardening/proc-install-containerized-deployment.adoc b/downstream/modules/aap-hardening/proc-install-containerized-deployment.adoc index 9d66e4a34d..b1c2989fcc 100644 --- a/downstream/modules/aap-hardening/proc-install-containerized-deployment.adoc +++ b/downstream/modules/aap-hardening/proc-install-containerized-deployment.adoc @@ -2,7 +2,7 @@ [id="proc-install-containerized-deployment"] -= Using an external vault file with a containerized installation += Use an external vault file with a containerized installation [role="_abstract"] For containerized installations of {PlatformNameShort}, use the provided automation execution playbook with the external vault file. diff --git a/downstream/modules/aap-hardening/proc-install-rpm-deployment.adoc b/downstream/modules/aap-hardening/proc-install-rpm-deployment.adoc index 7a50ad0fd0..7787a70460 100644 --- a/downstream/modules/aap-hardening/proc-install-rpm-deployment.adoc +++ b/downstream/modules/aap-hardening/proc-install-rpm-deployment.adoc @@ -2,7 +2,7 @@ [id="proc-install-rpm-deployment"] -= Using an external vault file with an RPM-based {PlatformNameShort} deployment += Use an external vault file with an RPM-based {PlatformNameShort} deployment [role="_abstract"] diff --git a/downstream/modules/aap-hardening/proc-install-user-pki.adoc b/downstream/modules/aap-hardening/proc-install-user-pki.adoc index e75b5cf595..6f5ec4a923 100644 --- a/downstream/modules/aap-hardening/proc-install-user-pki.adoc +++ b/downstream/modules/aap-hardening/proc-install-user-pki.adoc @@ -5,7 +5,7 @@ [id="proc-install-user-pki_{context}"] -= Installing with user-provided PKI certificates += Install with user-provided PKI certificates [role="_abstract"] diff --git a/downstream/modules/aap-hardening/proc-sensitive-variables-install-inventory.adoc b/downstream/modules/aap-hardening/proc-sensitive-variables-install-inventory.adoc index 9d76f844d6..6152989783 100644 --- a/downstream/modules/aap-hardening/proc-sensitive-variables-install-inventory.adoc +++ b/downstream/modules/aap-hardening/proc-sensitive-variables-install-inventory.adoc @@ -5,7 +5,7 @@ [id="proc-sensitive-variables-install-inventory_{context}"] -= Securing sensitive variables with ansible vault += Secure sensitive variables with ansible vault [role="_abstract"] By securing sensitive values in the installation inventory file with Ansible Vault, both RPM-based and containerized {PlatformNameShort} installations benefit from improved security, password hygiene, and maintainability. diff --git a/downstream/modules/aap-hardening/ref-aap-operational-secrets.adoc b/downstream/modules/aap-hardening/ref-aap-operational-secrets.adoc index d9cf42d9c4..1d3f75724a 100644 --- a/downstream/modules/aap-hardening/ref-aap-operational-secrets.adoc +++ b/downstream/modules/aap-hardening/ref-aap-operational-secrets.adoc @@ -5,7 +5,7 @@ [id="ref-aap-operational-secrets_{context}"] -= {PlatformNameShort} operational secrets += Understand how {PlatformNameShort} manages secrets [role="_abstract"] {PlatformNameShort} uses several secrets (passwords, keys, and so on) operationally. diff --git a/downstream/modules/aap-hardening/ref-architecture.adoc b/downstream/modules/aap-hardening/ref-architecture.adoc index 693d8f5fa8..f73acc7ffe 100644 --- a/downstream/modules/aap-hardening/ref-architecture.adoc +++ b/downstream/modules/aap-hardening/ref-architecture.adoc @@ -5,7 +5,7 @@ [id="ref-architecture_{context}"] -= {PlatformNameShort} deployment topologies += Plan your topology and networking configuration [role="_abstract"] diff --git a/downstream/modules/aap-hardening/ref-auditing-incident-detection.adoc b/downstream/modules/aap-hardening/ref-auditing-incident-detection.adoc index ced9d73097..ae4821d125 100644 --- a/downstream/modules/aap-hardening/ref-auditing-incident-detection.adoc +++ b/downstream/modules/aap-hardening/ref-auditing-incident-detection.adoc @@ -5,7 +5,7 @@ [id="ref-auditing-incident-detection_{context}"] -= Auditing and incident detection += Apply the NIST Cybersecurity Framework [role="_abstract"] diff --git a/downstream/modules/aap-hardening/ref-initial-configuration.adoc b/downstream/modules/aap-hardening/ref-initial-configuration.adoc index 100a9a9c31..0da8f05cf8 100644 --- a/downstream/modules/aap-hardening/ref-initial-configuration.adoc +++ b/downstream/modules/aap-hardening/ref-initial-configuration.adoc @@ -5,7 +5,7 @@ [id="ref-initial-configuration_{context}"] -= Initial configuration += Recommended security practices for access controls [role="_abstract"] diff --git a/downstream/modules/aap-migration/con-introduction-and-objectives.adoc b/downstream/modules/aap-migration/con-introduction-and-objectives.adoc index 6c1bf117cc..b71069568d 100644 --- a/downstream/modules/aap-migration/con-introduction-and-objectives.adoc +++ b/downstream/modules/aap-migration/con-introduction-and-objectives.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="introduction-and-objectives"] -= Introduction and objectives += Migrate from existing deployment topologies [role="_abstract"] Learn about supported migration paths between RPM-based, container-based, {OCPShort}, and Managed {PlatformNameShort} deployments, including step-by-step workflows and migration requirements. diff --git a/downstream/modules/aap-migration/proc-containerized-post-import.adoc b/downstream/modules/aap-migration/proc-containerized-post-import.adoc index df6e6f9f00..511e608d54 100644 --- a/downstream/modules/aap-migration/proc-containerized-post-import.adoc +++ b/downstream/modules/aap-migration/proc-containerized-post-import.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="containerized-post-import"] -= Reconciling the target environment post-import += Reconcile the target environment post-import [role="_abstract"] Perform the following post-import reconciliation steps to verify your target environment functions correctly. diff --git a/downstream/modules/aap-migration/proc-containerized-source-environment-export.adoc b/downstream/modules/aap-migration/proc-containerized-source-environment-export.adoc index f222b059fe..5efb4792b1 100644 --- a/downstream/modules/aap-migration/proc-containerized-source-environment-export.adoc +++ b/downstream/modules/aap-migration/proc-containerized-source-environment-export.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="containerized-source-environment-export"] -= Exporting the source environment += Export the source environment [role="_abstract"] Export databases, secrets, and custom configurations from your source containerized {PlatformNameShort} deployment to create the migration artifact. diff --git a/downstream/modules/aap-migration/proc-containerized-source-environment-preparation-assessment.adoc b/downstream/modules/aap-migration/proc-containerized-source-environment-preparation-assessment.adoc index a0736f5905..8d64e752ae 100644 --- a/downstream/modules/aap-migration/proc-containerized-source-environment-preparation-assessment.adoc +++ b/downstream/modules/aap-migration/proc-containerized-source-environment-preparation-assessment.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="containerized-environment-source-prep"] -= Preparing and assessing the source environment += Prepare and assess the source environment [role="_abstract"] Document your current containerized deployment configuration, topology, and components to create a comprehensive reference for migration. diff --git a/downstream/modules/aap-migration/proc-containerized-target-import.adoc b/downstream/modules/aap-migration/proc-containerized-target-import.adoc index c614762909..77346a49c3 100644 --- a/downstream/modules/aap-migration/proc-containerized-target-import.adoc +++ b/downstream/modules/aap-migration/proc-containerized-target-import.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="containerized-target-import"] -= Importing the migration content to the target environment += Import the migration content to the target environment [role="_abstract"] To import your migration content into the target environment, stop the containerized services, import the database dumps, and then restart the services. diff --git a/downstream/modules/aap-migration/proc-containerized-target-prep.adoc b/downstream/modules/aap-migration/proc-containerized-target-prep.adoc index a54c033e82..fb44de8f60 100644 --- a/downstream/modules/aap-migration/proc-containerized-target-prep.adoc +++ b/downstream/modules/aap-migration/proc-containerized-target-prep.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="containerized-target-prep"] -= Preparing and assessing the target environment += Prepare and assess the target environment [role="_abstract"] Transfer the migration artifact, install containerized {PlatformNameShort}, and configure the inventory file to match your source environment topology and database settings. diff --git a/downstream/modules/aap-migration/proc-containerized-validation.adoc b/downstream/modules/aap-migration/proc-containerized-validation.adoc index 163d36086a..dbda4b263e 100644 --- a/downstream/modules/aap-migration/proc-containerized-validation.adoc +++ b/downstream/modules/aap-migration/proc-containerized-validation.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="containerized-validation"] -= Validating the target environment += Validate the target environment [role="_abstract"] After completing the migration, validate that all components in your target environment function correctly. diff --git a/downstream/modules/aap-migration/proc-managed-post-import.adoc b/downstream/modules/aap-migration/proc-managed-post-import.adoc index 615ea55422..938c0a0ed8 100644 --- a/downstream/modules/aap-migration/proc-managed-post-import.adoc +++ b/downstream/modules/aap-migration/proc-managed-post-import.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="managed-post-import"] -= Reconciling the target environment post-migration += Reconcile the target environment post-migration [role="_abstract"] Update necessary configurations after migrating to Managed {PlatformNameShort}. diff --git a/downstream/modules/aap-migration/proc-managed-target-migration.adoc b/downstream/modules/aap-migration/proc-managed-target-migration.adoc index 939597ab9a..23859543ee 100644 --- a/downstream/modules/aap-migration/proc-managed-target-migration.adoc +++ b/downstream/modules/aap-migration/proc-managed-target-migration.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="managed-target-migration"] -= Migrating to Managed {PlatformNameShort} += Migrate to Managed {PlatformNameShort} [role="_abstract"] Submit a support ticket on the Red Hat Customer Portal to request a migration to Managed {PlatformNameShort}. diff --git a/downstream/modules/aap-migration/proc-ocp-post-import.adoc b/downstream/modules/aap-migration/proc-ocp-post-import.adoc index 91db99d7ad..2ceec1590f 100644 --- a/downstream/modules/aap-migration/proc-ocp-post-import.adoc +++ b/downstream/modules/aap-migration/proc-ocp-post-import.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="ocp-post-import"] -= Reconciling the target environment post-import += Reconcile the target environment post-import [role="_abstract"] After importing your migration artifact, perform the following steps to reconcile your target environment. diff --git a/downstream/modules/aap-migration/proc-ocp-target-import.adoc b/downstream/modules/aap-migration/proc-ocp-target-import.adoc index 6c4b039e6e..182d8dc6e6 100644 --- a/downstream/modules/aap-migration/proc-ocp-target-import.adoc +++ b/downstream/modules/aap-migration/proc-ocp-target-import.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="ocp-target-import"] -= Importing the migration content to the target environment += Import the migration content to the target environment [role="_abstract"] To import your environment, scale down {PlatformNameShort} components, restore databases, replace encryption secrets, and scale services back up. diff --git a/downstream/modules/aap-migration/proc-ocp-target-prep.adoc b/downstream/modules/aap-migration/proc-ocp-target-prep.adoc index d19d2dbf63..6f3027eb6a 100644 --- a/downstream/modules/aap-migration/proc-ocp-target-prep.adoc +++ b/downstream/modules/aap-migration/proc-ocp-target-prep.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="ocp-target-prep"] -= Preparing and assessing the target environment += Prepare and assess the target environment [role="_abstract"] Transfer the migration artifact, create an {OCPShort} project, and deploy {PlatformNameShort} using the Operator with configurations matching your source environment. diff --git a/downstream/modules/aap-migration/proc-ocp-validation.adoc b/downstream/modules/aap-migration/proc-ocp-validation.adoc index 9e545a0955..c202749778 100644 --- a/downstream/modules/aap-migration/proc-ocp-validation.adoc +++ b/downstream/modules/aap-migration/proc-ocp-validation.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="ocp-validation"] -= Validating the target environment += Validate the target environment [role="_abstract"] Verify that all {PlatformNameShort} services are running, credentials work correctly, and migrated content like projects, inventories, and job templates are accessible on {OCPShort}. diff --git a/downstream/modules/aap-migration/proc-rpm-environment-source-prep.adoc b/downstream/modules/aap-migration/proc-rpm-environment-source-prep.adoc index c73df9cc09..6a6ddc4971 100644 --- a/downstream/modules/aap-migration/proc-rpm-environment-source-prep.adoc +++ b/downstream/modules/aap-migration/proc-rpm-environment-source-prep.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rpm-environment-source-prep"] -= Preparing and assessing the source environment += Prepare and assess the source environment [role="_abstract"] Before beginning your migration, document your current RPM deployment to use as a reference throughout the migration process and when configuring your target environment. diff --git a/downstream/modules/aap-migration/proc-rpm-source-environment-export.adoc b/downstream/modules/aap-migration/proc-rpm-source-environment-export.adoc index d632d79010..37f8371eb0 100644 --- a/downstream/modules/aap-migration/proc-rpm-source-environment-export.adoc +++ b/downstream/modules/aap-migration/proc-rpm-source-environment-export.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rpm-source-environment-export"] -= Exporting the source environment += Export the source environment [role="_abstract"] From your source environment, export the data and configurations needed for migration. diff --git a/downstream/modules/analytics/con-drill-down.adoc b/downstream/modules/analytics/con-drill-down.adoc index b4d7529c3c..43aa679694 100644 --- a/downstream/modules/analytics/con-drill-down.adoc +++ b/downstream/modules/analytics/con-drill-down.adoc @@ -6,7 +6,7 @@ [id="con-drill-down"] -= Drilling down into cluster data += Change your {Analytics} settings [role="_abstract"] You can drill down into cluster data to review more detailed information about successful or failed jobs. diff --git a/downstream/modules/analytics/proc-calculating-automation.adoc b/downstream/modules/analytics/proc-calculating-automation.adoc index 52f734ced8..e223f9ed7b 100644 --- a/downstream/modules/analytics/proc-calculating-automation.adoc +++ b/downstream/modules/analytics/proc-calculating-automation.adoc @@ -6,7 +6,7 @@ [id="proc-calculating_automation"] -= Calculating your automation savings += Calculate your automation savings [role="_abstract"] The *Automation Calculator* produces its default total savings figure based on estimates for each variable. diff --git a/downstream/modules/analytics/proc-create-savings-plan.adoc b/downstream/modules/analytics/proc-create-savings-plan.adoc index b9bb3312a7..c34afbbd2a 100644 --- a/downstream/modules/analytics/proc-create-savings-plan.adoc +++ b/downstream/modules/analytics/proc-create-savings-plan.adoc @@ -6,7 +6,7 @@ [id="proc-create-savings-plan_{context}"] -= Creating a new automation savings plan += Create a new automation savings plan [role="_abstract"] Create an automation savings plan by defining the tasks needed to complete an automation job by using the {planner}. diff --git a/downstream/modules/analytics/proc-curate-templates.adoc b/downstream/modules/analytics/proc-curate-templates.adoc index 38206f1878..a6beb3df7b 100644 --- a/downstream/modules/analytics/proc-curate-templates.adoc +++ b/downstream/modules/analytics/proc-curate-templates.adoc @@ -6,7 +6,7 @@ [id="proc-curating-templates"] -= Curating top templates += Curate top templates [role="_abstract"] You can use the toggle switch for each template to show or hide it in the bar graph to compare performance and savings based on specific templates. diff --git a/downstream/modules/analytics/proc-ignoring-nested-workflows-jobs.adoc b/downstream/modules/analytics/proc-ignoring-nested-workflows-jobs.adoc index 434939ccb1..e2237fa8eb 100644 --- a/downstream/modules/analytics/proc-ignoring-nested-workflows-jobs.adoc +++ b/downstream/modules/analytics/proc-ignoring-nested-workflows-jobs.adoc @@ -4,7 +4,7 @@ // assembly-using-job-explorer.adoc [id="ignoring-nested-workflows"] -= Ignoring nested workflows and jobs += Ignore nested workflows and jobs [role="_abstract"] Ignoring nested workflows and jobs filters out duplicate workflow and job template entries and excludes those items from overall totals. diff --git a/downstream/modules/analytics/proc-jobs-explorer.adoc b/downstream/modules/analytics/proc-jobs-explorer.adoc index 007c076b50..39cd8063a5 100644 --- a/downstream/modules/analytics/proc-jobs-explorer.adoc +++ b/downstream/modules/analytics/proc-jobs-explorer.adoc @@ -7,7 +7,7 @@ [id="proc-jobs-explorer"] -= Creating a filtered and sorted view of jobs += Create a filtered and sorted view of jobs [role="_abstract"] You can view a list of jobs, filtered by attributes you choose, using the *Job Explorer*. diff --git a/downstream/modules/analytics/proc-review-job-details.adoc b/downstream/modules/analytics/proc-review-job-details.adoc index 526d8e5784..e91655fdf0 100644 --- a/downstream/modules/analytics/proc-review-job-details.adoc +++ b/downstream/modules/analytics/proc-review-job-details.adoc @@ -7,7 +7,7 @@ [id="proc-review-job-details"] -= Reviewing job details on {ControllerName} += Review job details on {ControllerName} [role="_abstract"] You review job details on {ControllerName}. diff --git a/downstream/modules/analytics/proc-review-reports.adoc b/downstream/modules/analytics/proc-review-reports.adoc index edc07636c1..02e10b29c8 100644 --- a/downstream/modules/analytics/proc-review-reports.adoc +++ b/downstream/modules/analytics/proc-review-reports.adoc @@ -6,7 +6,7 @@ [id="proc-review-reports"] -= Reviewing your reports += Review your reports [role="_abstract"] To view reports about your Ansible automation environment, proceed with the following steps: diff --git a/downstream/modules/analytics/proc-top-template-job-explorer.adoc b/downstream/modules/analytics/proc-top-template-job-explorer.adoc index 398de9b1e7..b3dcf5bf0e 100644 --- a/downstream/modules/analytics/proc-top-template-job-explorer.adoc +++ b/downstream/modules/analytics/proc-top-template-job-explorer.adoc @@ -5,7 +5,7 @@ [id="proc-top-template-job-explorer"] -= Viewing top templates job details for a specific cluster += View top templates job details for a specific cluster [role="_abstract"] You can view job instances for top templates in a cluster to learn more about individual job runs associated with that template or to apply filters to further drill down into the data. diff --git a/downstream/modules/analytics/proc-view-failed-jobs-detail.adoc b/downstream/modules/analytics/proc-view-failed-jobs-detail.adoc index 19f27caae2..60248d8eeb 100644 --- a/downstream/modules/analytics/proc-view-failed-jobs-detail.adoc +++ b/downstream/modules/analytics/proc-view-failed-jobs-detail.adoc @@ -7,7 +7,7 @@ [id="proc-view-failed-jobs"] -= Example: Reviewing failed jobs += Example: Review failed jobs [role="_abstract"] You can view detailed information about failed jobs across your organization by drilling down on a graph in the *Clusters* view and using the *Job Explorer* to refine results. diff --git a/downstream/modules/analytics/proc-view-more-job-info.adoc b/downstream/modules/analytics/proc-view-more-job-info.adoc index 3e50b4e097..b0790261f1 100644 --- a/downstream/modules/analytics/proc-view-more-job-info.adoc +++ b/downstream/modules/analytics/proc-view-more-job-info.adoc @@ -7,7 +7,7 @@ [id="proc-view-more-job-info"] -= Viewing more information about an individual job += View more information about an individual job [role="_abstract"] You can view additional information about each individual job. diff --git a/downstream/modules/analytics/proc-view-template-details.adoc b/downstream/modules/analytics/proc-view-template-details.adoc index e6b1459a27..c2269740cb 100644 --- a/downstream/modules/analytics/proc-view-template-details.adoc +++ b/downstream/modules/analytics/proc-view-template-details.adoc @@ -6,7 +6,7 @@ [id="proc-view-template-details"] -= Viewing template details += View template details [role="_abstract"] View detailed information for each template in *Top templates* to learn more about the template's context in the calculation of automation savings. diff --git a/downstream/modules/automation-dashboard/con-filter-automation-data.adoc b/downstream/modules/automation-dashboard/con-filter-automation-data.adoc index 95d05117b7..4db85a32c3 100644 --- a/downstream/modules/automation-dashboard/con-filter-automation-data.adoc +++ b/downstream/modules/automation-dashboard/con-filter-automation-data.adoc @@ -32,6 +32,6 @@ After selecting your filters, select a time period for analysis, and select a cu * A longer time period is useful when considering overall platform usage and automation growth. * Changing from one currency to another does not convert the value of that currency. You must manually change the manual and automation cost figures to reflect whichever currency you select. -== Saving a report +== Save a report Use *Save as Report* to save this report to your {AutomationDashboardName}. You can retrieve it at any time by using *Select a Report*. \ No newline at end of file diff --git a/downstream/modules/automation-dashboard/con-top-overview-usage.adoc b/downstream/modules/automation-dashboard/con-top-overview-usage.adoc index 0fd563eb1c..50a122c9f2 100644 --- a/downstream/modules/automation-dashboard/con-top-overview-usage.adoc +++ b/downstream/modules/automation-dashboard/con-top-overview-usage.adoc @@ -3,7 +3,7 @@ [id="con-top-overview-usage"] -= Summary of top and overview usage += Summary of key automation data metrics [role="_abstract"] {AutomationDashboardNameStart} displays a summary of the top and overview usage for your selected report. This includes the following data: diff --git a/downstream/modules/automation-dashboard/proc-analyzing-costs-savings.adoc b/downstream/modules/automation-dashboard/proc-analyzing-costs-savings.adoc index 8d0f7c55ab..630461937c 100644 --- a/downstream/modules/automation-dashboard/proc-analyzing-costs-savings.adoc +++ b/downstream/modules/automation-dashboard/proc-analyzing-costs-savings.adoc @@ -3,7 +3,7 @@ [id="proc-analyzing-costs-savings"] -= Analyzing costs and savings += Calculate savings from automation [role="_abstract"] The costs and savings analysis compares the cost of manual automation compared to the cost of automation execution by using {PlatformNameShort} to calculate the total savings derived from automation execution. diff --git a/downstream/modules/automation-dashboard/proc-installing-automation-dashboard.adoc b/downstream/modules/automation-dashboard/proc-installing-automation-dashboard.adoc index 5a5d488abe..d5b1bbc701 100644 --- a/downstream/modules/automation-dashboard/proc-installing-automation-dashboard.adoc +++ b/downstream/modules/automation-dashboard/proc-installing-automation-dashboard.adoc @@ -6,7 +6,7 @@ [id="proc-installing-automation-dashboard"] -= Installing {AutomationDashboardName} += Install {AutomationDashboardName} [role="_abstract"] Install {AutomationDashboardName} to collect and analyze key metrics related to job execution, efficiency, and automation savings across your {PlatformNameShort} deployments. diff --git a/downstream/modules/automation-dashboard/proc-integrating-automation-dashboard.adoc b/downstream/modules/automation-dashboard/proc-integrating-automation-dashboard.adoc index 5803ed7626..f590d99b64 100644 --- a/downstream/modules/automation-dashboard/proc-integrating-automation-dashboard.adoc +++ b/downstream/modules/automation-dashboard/proc-integrating-automation-dashboard.adoc @@ -4,7 +4,7 @@ [id="proc-integrating-automation-dashboard"] -= Integrating {AutomationDashboardName} with your {PlatformNameShort} += Configure {AutomationDashboardName} [role="_abstract"] Integrate your {PlatformNameShort} instances into the {AutomationDashboardName} configuration to collect and visualise data and gain insights into your automation. diff --git a/downstream/modules/automation-dashboard/proc-synchronizing-data-to-automation-dashboard.adoc b/downstream/modules/automation-dashboard/proc-synchronizing-data-to-automation-dashboard.adoc index 459c8c6827..6f9a204cd4 100644 --- a/downstream/modules/automation-dashboard/proc-synchronizing-data-to-automation-dashboard.adoc +++ b/downstream/modules/automation-dashboard/proc-synchronizing-data-to-automation-dashboard.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: PROCEDURE [id="synchronizing-data-to-automation-dashboard_{context}"] -= Synchronizing data to {AutomationDashboardName} += Synchronize data to {AutomationDashboardName} [role="_abstract"] Synchronize data from your connected {PlatformNameShort} clusters to the {AutomationDashboardName} to view the latest automation metrics. diff --git a/downstream/modules/automation-dashboard/proc-troubleshooting-sync-failures.adoc b/downstream/modules/automation-dashboard/proc-troubleshooting-sync-failures.adoc index 1467ae8c6b..c1f7f191d7 100644 --- a/downstream/modules/automation-dashboard/proc-troubleshooting-sync-failures.adoc +++ b/downstream/modules/automation-dashboard/proc-troubleshooting-sync-failures.adoc @@ -4,7 +4,7 @@ [id="proc-troubleshooting-sync-failures"] -= Troubleshooting synchronization failures += Troubleshoot synchronization failures [role="_abstract"] If new jobs from {PlatformNameShort} do not synchronize to the {AutomationDashboardName} after an upgrade, an interrupted synchronization job might be blocking the process. diff --git a/downstream/modules/automation-dashboard/proc-uninstalling-automation-dashboard.adoc b/downstream/modules/automation-dashboard/proc-uninstalling-automation-dashboard.adoc index c238e2e6cc..c602f29b3c 100644 --- a/downstream/modules/automation-dashboard/proc-uninstalling-automation-dashboard.adoc +++ b/downstream/modules/automation-dashboard/proc-uninstalling-automation-dashboard.adoc @@ -6,7 +6,7 @@ [id="proc-uninstalling-automation-dashboard"] -= Uninstalling {AutomationDashboardName} += Uninstall {AutomationDashboardName} [role="_abstract"] Uninstall {AutomationDashboardName} and its dependencies by using a single command, ensuring a clean removal from your host. diff --git a/downstream/modules/automation-dashboard/proc-upgrading-automation-dashboard.adoc b/downstream/modules/automation-dashboard/proc-upgrading-automation-dashboard.adoc index 18c790d539..b558030535 100644 --- a/downstream/modules/automation-dashboard/proc-upgrading-automation-dashboard.adoc +++ b/downstream/modules/automation-dashboard/proc-upgrading-automation-dashboard.adoc @@ -4,7 +4,7 @@ [id="proc-upgrading-automation-dashboard"] -= Upgrading {AutomationDashboardName} += Upgrade {AutomationDashboardName} [role="_abstract"] Upgrade your {AutomationDashboardName} installation to the latest version. This process involves running the installation program and updating your cluster configuration with new authentication requirements. diff --git a/downstream/modules/automation-dashboard/proc-verifying-cluster-access-tokens.adoc b/downstream/modules/automation-dashboard/proc-verifying-cluster-access-tokens.adoc index 0abb746145..9b7e659d6d 100644 --- a/downstream/modules/automation-dashboard/proc-verifying-cluster-access-tokens.adoc +++ b/downstream/modules/automation-dashboard/proc-verifying-cluster-access-tokens.adoc @@ -6,7 +6,7 @@ :mod-docs-content-type: PROCEDURE [id="verifying-cluster-access-tokens_{context}"] -= Verifying cluster access tokens += Verify cluster access tokens [role="_abstract"] After you configure and load your cluster data, verify the stored access tokens for debugging purposes. diff --git a/downstream/modules/builder/con-building-definition-file.adoc b/downstream/modules/builder/con-building-definition-file.adoc index 1227323db0..9f5fa4efed 100644 --- a/downstream/modules/builder/con-building-definition-file.adoc +++ b/downstream/modules/builder/con-building-definition-file.adoc @@ -2,7 +2,7 @@ [id="con-building-definition-file"] -= Building a definition file += Build a definition file [role="_abstract"] You can use {Builder} to create an {ExecEnvShort}. diff --git a/downstream/modules/builder/con-definition-file-breakdown.adoc b/downstream/modules/builder/con-definition-file-breakdown.adoc index 33b39a73de..bf6769f942 100644 --- a/downstream/modules/builder/con-definition-file-breakdown.adoc +++ b/downstream/modules/builder/con-definition-file-breakdown.adoc @@ -2,7 +2,7 @@ [id="con-definition-file-breakdown"] -= Breakdown of definition file content += Definition file reference [role="_abstract"] You must provide a definition file to build {ExecEnvName} with {Builder}, because it specifies the content that is included in the {ExecEnvNameSing} container image. diff --git a/downstream/modules/builder/con-why-builder.adoc b/downstream/modules/builder/con-why-builder.adoc index a19d457d97..8cccf4dfc8 100644 --- a/downstream/modules/builder/con-why-builder.adoc +++ b/downstream/modules/builder/con-why-builder.adoc @@ -2,7 +2,7 @@ [id="con-why-builder"] -= Why use {Builder} += Why Ansible Builder? [role="_abstract"] With {Builder}, you can easily create a customizable {ExecEnvName} definition file that specifies the content you want included in your {ExecEnvName} such as Ansible Core, Python, Collections, third-party Python requirements, and system level packages. diff --git a/downstream/modules/builder/proc-executing-build.adoc b/downstream/modules/builder/proc-executing-build.adoc index 4e4db4067d..5d92befa2f 100644 --- a/downstream/modules/builder/proc-executing-build.adoc +++ b/downstream/modules/builder/proc-executing-build.adoc @@ -2,7 +2,7 @@ [id="proc-executing-build"] -= Building the {ExecEnvNameSing} image += Build the {ExecEnvNameSing} image [role="_abstract"] When you have created a definition file, you can proceed to build an {ExecEnvNameSing} image. diff --git a/downstream/modules/builder/proc-installing-builder.adoc b/downstream/modules/builder/proc-installing-builder.adoc index a560a91df3..64f8ac18df 100644 --- a/downstream/modules/builder/proc-installing-builder.adoc +++ b/downstream/modules/builder/proc-installing-builder.adoc @@ -2,7 +2,7 @@ [id="proc-installing-builder"] -= Installing {Builder} += Define, create, and build execution environments [role="_abstract"] Install {Builder} to create custom execution environments that contain the dependencies and collections required for your automation content. diff --git a/downstream/modules/builder/proc-installing-the-collection.adoc b/downstream/modules/builder/proc-installing-the-collection.adoc index 88919b6cb2..ced73ee3d5 100644 --- a/downstream/modules/builder/proc-installing-the-collection.adoc +++ b/downstream/modules/builder/proc-installing-the-collection.adoc @@ -8,14 +8,14 @@ Install or upgrade the `ansible.mcp_builder` collection through the {Galaxy} command-line tool or a requirements file. Use the collection to deploy and manage MCP servers within an {ExecEnvShort}. -.Prequisites +.Prerequisites * ansible-core: 2.18.0+ * Python: 3.11+ *Collections* -*ansible.mcp for execution of MCP servers. +* `ansible.mcp` for execution of MCP servers. *External dependencies* diff --git a/downstream/modules/builder/ref-github-mcp-server.adoc b/downstream/modules/builder/ref-github-mcp-server.adoc index dd01aa75c4..5c714d6a0a 100644 --- a/downstream/modules/builder/ref-github-mcp-server.adoc +++ b/downstream/modules/builder/ref-github-mcp-server.adoc @@ -17,6 +17,6 @@ This collection has been tested in the following environments: * *Ansible Core versions*: 2.16+ - 2.20+ * *Python versions*: 3.10-3.13 -.Prerequisites +== Prerequisites * A compatible MCP host with remote server support such as, VS Code 1.101+, Claude Desktop, Cursor, or Windsurf. * Any applicable policies enabled \ No newline at end of file diff --git a/downstream/modules/builder/ref-mcp-builder-collection.adoc b/downstream/modules/builder/ref-mcp-builder-collection.adoc index a2ba4031b5..bbcb094e14 100644 --- a/downstream/modules/builder/ref-mcp-builder-collection.adoc +++ b/downstream/modules/builder/ref-mcp-builder-collection.adoc @@ -24,7 +24,7 @@ Roles Installs the link:https://github.com/github/github-mcp-server[GitHub MCP server] with support for local (build from source) and remote modes |=== -== Playbooks +*Playbooks* [cols="a,a", options="header"] |=== diff --git a/downstream/modules/builder/ref-scenario-update-hub-ca-cert.adoc b/downstream/modules/builder/ref-scenario-update-hub-ca-cert.adoc index e264be7927..c278c64357 100644 --- a/downstream/modules/builder/ref-scenario-update-hub-ca-cert.adoc +++ b/downstream/modules/builder/ref-scenario-update-hub-ca-cert.adoc @@ -2,7 +2,7 @@ [id="ref-scenario-update-hub-ca-cert"] -= Updating the {HubName} CA certificate += Configure the CA file [role="_abstract"] Use this example to customize the default definition file to include a CA certificate to the `additional-build-files` section, move the file to the appropriate directory and, finally, run the command to update the dynamic configuration of CA certificates to allow the system to trust this CA certificate. diff --git a/downstream/modules/devtools/con-devtools-plan-roles-collection.adoc b/downstream/modules/devtools/con-devtools-plan-roles-collection.adoc index b25702905a..ebf3247e98 100644 --- a/downstream/modules/devtools/con-devtools-plan-roles-collection.adoc +++ b/downstream/modules/devtools/con-devtools-plan-roles-collection.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="plan-roles-collection_{context}"] -= Planning your collection += Plan your collection [role="_abstract"] Organize smaller bundles of curated automation into separate collections for specific functions, rather than creating one big general collection for all of your roles. diff --git a/downstream/modules/devtools/con-self-service-customize-template.adoc b/downstream/modules/devtools/con-self-service-customize-template.adoc index a53981be8d..29ee1c6eff 100644 --- a/downstream/modules/devtools/con-self-service-customize-template.adoc +++ b/downstream/modules/devtools/con-self-service-customize-template.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: CONCEPT [id="self-service-customize-template_{context}"] -= Customized self-service templates += Add and launch custom self-service templates [role="_abstract"] Custom self-service templates are stored as YAML files in repositories in GitHub or Gitlab. diff --git a/downstream/modules/devtools/con-self-service-initial-rbac-setup.adoc b/downstream/modules/devtools/con-self-service-initial-rbac-setup.adoc index e530b1544a..e1870dd172 100644 --- a/downstream/modules/devtools/con-self-service-initial-rbac-setup.adoc +++ b/downstream/modules/devtools/con-self-service-initial-rbac-setup.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="self-service-initial-rbac-setup_{context}"] -= Setting up initial RBAC rules in {SelfServiceShort} += Set up initial RBAC rules in {SelfServiceShort} [role="_abstract"] After you install {SelfServiceShort} and synchronize it with {PlatformNameShort}, diff --git a/downstream/modules/devtools/con-understand-portal-rbac-permissions.adoc b/downstream/modules/devtools/con-understand-portal-rbac-permissions.adoc index 68b8a4738b..c5ea56e6a2 100644 --- a/downstream/modules/devtools/con-understand-portal-rbac-permissions.adoc +++ b/downstream/modules/devtools/con-understand-portal-rbac-permissions.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="understand-portal-rbac-permissions_{context}"] -= Understanding the permission model += Understand the permission model [role="_abstract"] {SelfServiceShortStart} and {PlatformNameShort} use separate but related permission systems. diff --git a/downstream/modules/devtools/proc-auto-fix-with-the-assistant.adoc b/downstream/modules/devtools/proc-auto-fix-with-the-assistant.adoc new file mode 100644 index 0000000000..013e9dfd80 --- /dev/null +++ b/downstream/modules/devtools/proc-auto-fix-with-the-assistant.adoc @@ -0,0 +1,27 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-21 +:_mod-docs-content-type: PROCEDURE + +[id="auto-fix-with-the-assistant_{context}"] += Auto-fixing errors with the AI assistant + +[role="_abstract"] +You can also prompt the AI assistant to automatically fix errors that `ansible_lint` finds. + +.Procedure +. In the GitHub Copilot chat window, enter the following prompt: +* _Run `ansible-lint` on my webserver playbook and apply automatic fixes_. ++ +The automated workflow triggers the `ansible_lint` tool with the `fix: true` parameter. ++ +. The `ansible_lint` tool then processes the file and applies corrections for issues such as: + +* Converting short module names to fully qualified ones. +* Correcting YAML indentation and Jinja2 expression spacing. +* Fixing key ordering within tasks. + +.Verification +When the AI assistant completes the auto fixes, confirm the updates by taking the following steps. + +* Either verify in the chat window that the AI assistant has displayed the fixed content, or confirm that the file has been updated. +* Review your open file in the editor. Changes (such as updated module names) should be reflected immediately in the code. diff --git a/downstream/modules/devtools/proc-build-ee-with-assistant.adoc b/downstream/modules/devtools/proc-build-ee-with-assistant.adoc new file mode 100644 index 0000000000..da81816f4e --- /dev/null +++ b/downstream/modules/devtools/proc-build-ee-with-assistant.adoc @@ -0,0 +1,26 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-21 +:_mod-docs-content-type: PROCEDURE + +[id="build-ee-with-assistant_{context}"] += Build the {ExecEnvShort} with the AI assistant + +[role="_abstract"] +After you have created and validated the definition file, prompt the assistant for the specific commands to build the {ExecEnvShort} image. + +.Prerequisites +* A container runtime like Podman is installed. +* The GitHub Copilot chat is active and your {ExecEnvShort} file is open. + +.Procedure +. Prompt the assistant for build instructions. For example: +* _How do I build this execution environment? What are the next steps?_ ++ +This prompts the AI assistant to generate an `ansible-builder` command tailored to fit your file and tag. ++ +. Copy the build command that was generated and run it in your {VSCode} terminal. An example command might look like this: ++ +[source,python] +---- +ansible-builder build --file execution-environment.yml --context ./context --tag webserver-ee:1.0 -vvv. +---- \ No newline at end of file diff --git a/downstream/modules/devtools/proc-configure-adt-with-assistant.adoc b/downstream/modules/devtools/proc-configure-adt-with-assistant.adoc new file mode 100644 index 0000000000..ff24cc43a8 --- /dev/null +++ b/downstream/modules/devtools/proc-configure-adt-with-assistant.adoc @@ -0,0 +1,38 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-19 +:_mod-docs-content-type: PROCEDURE + +[id="configure-adt-with-assistant_{context}"] += Configure {ToolsName} with the AI assistant + +[role="_abstract"] +After installing {ToolsName}, you can use the MCP server-enabled AI assistant in the Ansible {VSCode} extension to configure your workspace, including: + +* Setting up a virtual environment. +* Installing specific Python versions. +* Adding Ansible collections. + + +.Procedure +. Open GitHub Copilot chat. +. In the chat window, enter a natural language prompt instructing the AI assistant to set up the configuration you want. For example: ++ +_Set up a complete Ansible development environment with Python 3.11, and install the collections amazon.aws and ansible.posix_. ++ +The assistant triggers the `ade_setup_environment` tool, and the system automatically performs the following configuration steps: + +* Create a virtual environment: The assistant creates a virtual environment (`venv/`) in your workspace. +* Install core tools: The assistant installs `ansible-core` and `ansible-lint` in the new virtual environment. +* Install collections: The assistant installs the requested collections (`amazon.aws`, `ansible.posix`) and their dependencies. +* Check for conflicts: The assistant checks for conflicting packages and verifies `ansible-lint` status. ++ +. Review the output in the Copilot chat. When setup is complete, the assistant confirms that the environment is set up, and gives instructions on activating the environment. For example: +.. To activate, run `source /venv/bin/activate` +.. To deactivate, run `deactivate`. + +.Verification +Verify that configuration was successful by asking the AI assistant to check the environment status again. For example: + +_Check my environment again to confirm that everything is set up correctly_. + +The `ade_environment_info` tool runs and confirms the Python version, virtual environment path, and installed collections in its output. diff --git a/downstream/modules/devtools/proc-create-ee-def-with-assistant.adoc b/downstream/modules/devtools/proc-create-ee-def-with-assistant.adoc new file mode 100644 index 0000000000..3eca475b2f --- /dev/null +++ b/downstream/modules/devtools/proc-create-ee-def-with-assistant.adoc @@ -0,0 +1,29 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-21 +:_mod-docs-content-type: PROCEDURE + +[id="create-ee-with-assistant_{context}"] += Create an {ExecEnvShort} definition file with the AI assistant + +[role="_abstract"] +To create an {ExecEnvShort}, first prompt the AI assistant to generate a definition file that defines the environment. + +.Procedure +. Enter a prompt describing your {ExecEnvShort} requirements in the Copilot chat window. For example: +* _Create an {ExecEnvShort} definition file. Use `ee-minimal` as the base, include `ansible.builtin` and the `community.general` collection, add git as a system package, and tag it as `webserver-ee:1.0`_ ++ +In response, the assistant triggers the `define_and_build_execution_env tool` to formulate a prompt using your requirements and the internal `ee-rules.md` resource. ++ +[NOTE] + +==== +No file is created in this step. The assistant prepares the context for accurate YAML generation. +==== ++ +. Instruct the assistant to create the {ExecEnvShort} file. For example: +* _Generate the execution-environment.yml content based on the prompt you received_. ++ +The assistant then calls the tool again, this time with the `generatedYaml` parameter. The tool validates the generated YAML against the {ExecEnvShort}schema. + +.Verification +If successful, the assistant confirms the creation of `execution-environment.yml` and displays the validation status. \ No newline at end of file diff --git a/downstream/modules/devtools/proc-create-project-structure-assistant.adoc b/downstream/modules/devtools/proc-create-project-structure-assistant.adoc new file mode 100644 index 0000000000..5fc9f9c965 --- /dev/null +++ b/downstream/modules/devtools/proc-create-project-structure-assistant.adoc @@ -0,0 +1,24 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-21 +:_mod-docs-content-type: PROCEDURE + +[id="create-project-structure-assistant_{context}"] += Create the project structure with the AI assistant + +[role="_abstract"] +Enter a prompt in natural language to trigger the project creation tool. When prompted, `ansible-creator` works in the background to generate the directory structure. + +.Procedure +. In the Copilot chat window, enter a prompt specifying the project name and type. For example: +* _Create a new Ansible playbook project called `webserver-deployment.`_ ++ +This triggers the `create_ansible_projects` tool. The extension then executes `ansible-creator init playbook` to generate the content. + +.Verification +After the assistant confirms that the task is complete, verify that the project structure is consistent with the standard layout. + +. Navigate to the {VSCode} Explorer view. +. Locate the new directory (per the example above, `webserver-deployment/`). +. Confirm the presence of standard artifacts such as: +.. Initial playbook files. +.. Recommended configuration files (such as `ansible.cfg`, `inventory`). \ No newline at end of file diff --git a/downstream/modules/devtools/proc-debug-with-assistant.adoc b/downstream/modules/devtools/proc-debug-with-assistant.adoc new file mode 100644 index 0000000000..95669e1a00 --- /dev/null +++ b/downstream/modules/devtools/proc-debug-with-assistant.adoc @@ -0,0 +1,19 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-21 +:_mod-docs-content-type: PROCEDURE + +[id="debug-with-assistant_{context}"] += Debug with the AI assistant + +[role="_abstract"] +You can ask the AI assistant to analyze a playbook to identify why it is failing, or to find potential bugs. + +.Procedure +. Open the playbook that you want to debug. +. In the GitHub Copilot chat window, enter a natural language prompt describing the situation. For example: +* _Analyze this playbook and explain why it might be failing_. +* _Run debugging analysis on this file_. ++ +The AI assistant uses its embedded tools (such as static code analysis) to scan the playbook for common errors, logic gaps, or configuration mismatches. ++ +The assistant then provides an explanation of the issue in natural language, translating technical error codes or anti-patterns into understandable and actionable information. diff --git a/downstream/modules/devtools/proc-debugging-playbook.adoc b/downstream/modules/devtools/proc-debugging-playbook.adoc index f8d00c1907..b7ee44e433 100644 --- a/downstream/modules/devtools/proc-debugging-playbook.adoc +++ b/downstream/modules/devtools/proc-debugging-playbook.adoc @@ -1,7 +1,7 @@ [id="debugging-playbook_{context}"] :_mod-docs-content-type: PROCEDURE -= Debugging your playbook += Debug your playbook [role="_abstract"] Learn how to use {VSCode} to identify and understand error messages in playbooks. diff --git a/downstream/modules/devtools/proc-devspaces-create-code-workspace-file.adoc b/downstream/modules/devtools/proc-devspaces-create-code-workspace-file.adoc index 33ed15ecf5..49fd2025dd 100644 --- a/downstream/modules/devtools/proc-devspaces-create-code-workspace-file.adoc +++ b/downstream/modules/devtools/proc-devspaces-create-code-workspace-file.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="devspaces-create-code-workspace-file_{context}"] -= Creating a `.code-workspace` file for an {AnsibleWorkspaceSing} += Create a code-workspace file for an {AnsibleWorkspaceSing} [role="_abstract"] To configure {VSCode} extensions that are included in your {AnsibleWorkspaceSing}, diff --git a/downstream/modules/devtools/proc-devspaces-create-content.adoc b/downstream/modules/devtools/proc-devspaces-create-content.adoc index 1820623b22..ea229b9c7a 100644 --- a/downstream/modules/devtools/proc-devspaces-create-content.adoc +++ b/downstream/modules/devtools/proc-devspaces-create-content.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="devspaces-create-content_{context}"] -= Creating collections and playbooks in your {AnsibleWorkspaceSing} += Create collections and playbooks in your {AnsibleWorkspaceSing} [role="_abstract"] Use the Ansible extension in {VSCode} to use {ToolsName} to scaffold directories and files for your automation content. diff --git a/downstream/modules/devtools/proc-devspaces-create-devfile.adoc b/downstream/modules/devtools/proc-devspaces-create-devfile.adoc index ef812083d3..f6a0067df1 100644 --- a/downstream/modules/devtools/proc-devspaces-create-devfile.adoc +++ b/downstream/modules/devtools/proc-devspaces-create-devfile.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="devspaces-create-devfile_{context}"] -= Creating a devfile for an {AnsibleWorkspaceSing} += Create a devfile for an {AnsibleWorkspaceSing} [role="_abstract"] To ensure your {AnsibleWorkspaceSing} launches with the correct {AnsibleDevSpaces} image, diff --git a/downstream/modules/devtools/proc-devspaces-create-repo.adoc b/downstream/modules/devtools/proc-devspaces-create-repo.adoc index 7bda6c9180..95b96ec4ba 100644 --- a/downstream/modules/devtools/proc-devspaces-create-repo.adoc +++ b/downstream/modules/devtools/proc-devspaces-create-repo.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="devspaces-create-repo_{context}"] -= Creating a Git repository for an {AnsibleWorkspaceSing} += Create a Git repository for an {AnsibleWorkspaceSing} [role="_abstract"] To launch an {AnsibleWorkspaceSing}, you must provide a link to a Git repository that defines the development environment. diff --git a/downstream/modules/devtools/proc-devspaces-delete.adoc b/downstream/modules/devtools/proc-devspaces-delete.adoc index 621731e9fd..a750e13a61 100644 --- a/downstream/modules/devtools/proc-devspaces-delete.adoc +++ b/downstream/modules/devtools/proc-devspaces-delete.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="devspaces-uninstall_{context}"] -= Uninstalling {DevSpacesShort} += Uninstall {DevSpacesShort} [role="_abstract"] Uninstall {DevSpacesShort} completely when it is no longer required. Remember that this action removes all related {AnsibleDevSpaces} user data. diff --git a/downstream/modules/devtools/proc-devspaces-edit-content.adoc b/downstream/modules/devtools/proc-devspaces-edit-content.adoc index 4583613e7c..ea0621da4b 100644 --- a/downstream/modules/devtools/proc-devspaces-edit-content.adoc +++ b/downstream/modules/devtools/proc-devspaces-edit-content.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="devspaces-edit-content_{context}"] -= Editing and debugging automation content in your {AnsibleWorkspaceSing} += Edit and debug automation content in your {AnsibleWorkspaceSing} [role="_abstract"] You can continue your work in a previously created workspace. Workspaces that have been inactive for a set period might be paused to free up resources. The duration of inactivity before timeout is configured in {DevSpacesShort} by your administrator. A paused workspace automatically relaunches when you select it from the {DevSpacesShort} dashboard. Ansible lint indicates errors in your playbooks. diff --git a/downstream/modules/devtools/proc-devspaces-execute-playbooks.adoc b/downstream/modules/devtools/proc-devspaces-execute-playbooks.adoc index b176bd9f91..c80afa25dd 100644 --- a/downstream/modules/devtools/proc-devspaces-execute-playbooks.adoc +++ b/downstream/modules/devtools/proc-devspaces-execute-playbooks.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="devspaces-execute-playbooks_{context}"] -= Executing playbooks in your {AnsibleWorkspaceSing} += Execute playbooks in your {AnsibleWorkspaceSing} [role="_abstract"] Execute your playbooks efficiently using the integrated Ansible extension within the {VSCode} environment of your workspace. diff --git a/downstream/modules/devtools/proc-devspaces-git-auth.adoc b/downstream/modules/devtools/proc-devspaces-git-auth.adoc index 82ef157f6d..82094bd323 100644 --- a/downstream/modules/devtools/proc-devspaces-git-auth.adoc +++ b/downstream/modules/devtools/proc-devspaces-git-auth.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="devspaces-git-auth.adoc_{context}"] -= Configuring Git personal access token authentication += Configure Git personal access token authentication [role="_abstract"] You must create a personal access token (PAT) in your Git source control manager (SCM), and add it to {DevSpacesShort} to enable access to your repositories from your {AnsibleWorkspaceSing}. diff --git a/downstream/modules/devtools/proc-devspaces-install.adoc b/downstream/modules/devtools/proc-devspaces-install.adoc index 1ab6631005..2f987f6ee7 100644 --- a/downstream/modules/devtools/proc-devspaces-install.adoc +++ b/downstream/modules/devtools/proc-devspaces-install.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="devspaces-install_{context}"] -= Installing {DevSpacesFull} += Install Red Hat OpenShift dev spaces [role="_abstract"] An administrator must install {DevSpacesFull} to generate an {DevSpacesShort} dashboard. diff --git a/downstream/modules/devtools/proc-devspaces-launch.adoc b/downstream/modules/devtools/proc-devspaces-launch.adoc index 4918a8f197..54d30466a2 100644 --- a/downstream/modules/devtools/proc-devspaces-launch.adoc +++ b/downstream/modules/devtools/proc-devspaces-launch.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="devspaces-launch_{context}"] -= Launching an {AnsibleDevSpaces} workspace += Launch an {AnsibleDevSpaces} workspace [role="_abstract"] Launch your Ansible development workspace by providing the URL for your prepared Git repository in the {DevSpacesShort} dashboard. This opens your VS Code environment in a browser. diff --git a/downstream/modules/devtools/proc-devspaces-share-work.adoc b/downstream/modules/devtools/proc-devspaces-share-work.adoc index 73bafef712..21729b3caa 100644 --- a/downstream/modules/devtools/proc-devspaces-share-work.adoc +++ b/downstream/modules/devtools/proc-devspaces-share-work.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="devspaces-share-work_{context}"] -= Sharing your work += Share your work [role="_abstract"] Share your automation content and collaborate with colleagues by working together from a single shared Git repository and submitting pull requests. diff --git a/downstream/modules/devtools/proc-devtools-create-aap-job.adoc b/downstream/modules/devtools/proc-devtools-create-aap-job.adoc index c89775a388..299f3a99e2 100644 --- a/downstream/modules/devtools/proc-devtools-create-aap-job.adoc +++ b/downstream/modules/devtools/proc-devtools-create-aap-job.adoc @@ -1,7 +1,7 @@ [id="create-aap-job_{context}"] :_mod-docs-content-type: PROCEDURE -= Running your playbook in {PlatformNameShort} += Run your playbook in {PlatformNameShort} [role="_abstract"] To run your playbook in {PlatformNameShort}, you must create a project in {ControllerName} for the repository where you stored your playbook project. diff --git a/downstream/modules/devtools/proc-devtools-create-new-role-in-collection.adoc b/downstream/modules/devtools/proc-devtools-create-new-role-in-collection.adoc index 79cad1a225..baaba5ddf8 100644 --- a/downstream/modules/devtools/proc-devtools-create-new-role-in-collection.adoc +++ b/downstream/modules/devtools/proc-devtools-create-new-role-in-collection.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="devtools-create-new-role-in-collection_{context}"] -= Creating a new role in your collection += Create a new role in your collection [role="_abstract"] Create a new Ansible role within your collection by copying the default role directory. diff --git a/downstream/modules/devtools/proc-devtools-docs-roles-collection.adoc b/downstream/modules/devtools/proc-devtools-docs-roles-collection.adoc index 9b506c5054..8e46325702 100644 --- a/downstream/modules/devtools/proc-devtools-docs-roles-collection.adoc +++ b/downstream/modules/devtools/proc-devtools-docs-roles-collection.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="devtools-docs-roles-collection_{context}"] -= Adding documentation for your roles collection += Add documentation for your roles collection [role="_abstract"] It is important to provide documentation for your roles and roles collection, so that other users understand what your roles do and how to use them. diff --git a/downstream/modules/devtools/proc-devtools-extension-run-ansible-navigator.adoc b/downstream/modules/devtools/proc-devtools-extension-run-ansible-navigator.adoc index 6046a67fba..001f2ef40c 100644 --- a/downstream/modules/devtools/proc-devtools-extension-run-ansible-navigator.adoc +++ b/downstream/modules/devtools/proc-devtools-extension-run-ansible-navigator.adoc @@ -1,7 +1,7 @@ [id="extension-run-ansible-navigator_{context}"] :_mod-docs-content-type: PROCEDURE -= Running your playbook with `ansible-navigator` += Run your playbook with `ansible-navigator` [role="_abstract"] You can run an Ansible playbook through `ansible-navigator` by right-clicking the playbook name in the Explorer pane. This procedure explains how to view the playbook's output and navigate the results for each play and task within the terminal. diff --git a/downstream/modules/devtools/proc-devtools-extension-run-ansible-playbook.adoc b/downstream/modules/devtools/proc-devtools-extension-run-ansible-playbook.adoc index 03e0c6b531..307c6642c8 100644 --- a/downstream/modules/devtools/proc-devtools-extension-run-ansible-playbook.adoc +++ b/downstream/modules/devtools/proc-devtools-extension-run-ansible-playbook.adoc @@ -1,7 +1,7 @@ [id="extension-run-ansible-playbook_{context}"] :_mod-docs-content-type: PROCEDURE -= Running your playbook with `ansible-playbook` += Run your playbook with `ansible-playbook` [role="_abstract"] You can run your Ansible playbook locally by using the `ansible-playbook` command directly within the VS Code extension. diff --git a/downstream/modules/devtools/proc-devtools-extension-set-language.adoc b/downstream/modules/devtools/proc-devtools-extension-set-language.adoc index bc2c69b761..ca1dd2cc53 100644 --- a/downstream/modules/devtools/proc-devtools-extension-set-language.adoc +++ b/downstream/modules/devtools/proc-devtools-extension-set-language.adoc @@ -1,7 +1,7 @@ [id="devtools-extension-set-language_{context}"] :_mod-docs-content-type: PROCEDURE -= Associating the Ansible language to YAML files += Associate the Ansible language to YAML files [role="_abstract"] The following procedure describes how to manually assign the Ansible language to a YAML file that is open in {VSCode}. diff --git a/downstream/modules/devtools/proc-devtools-extension-set-persistant-file.adoc b/downstream/modules/devtools/proc-devtools-extension-set-persistant-file.adoc index 4c092b8c2a..3a50727515 100644 --- a/downstream/modules/devtools/proc-devtools-extension-set-persistant-file.adoc +++ b/downstream/modules/devtools/proc-devtools-extension-set-persistant-file.adoc @@ -1,7 +1,7 @@ [id="devtools-extension-set-persistant-file_{context}"] :_mod-docs-content-type: PROCEDURE -= Adding persistent file association for the Ansible language to `settings.json` += Add the persistent file association for the Ansible language to `settings.json` [role="_abstract"] Instead of manually associating the Ansible language to YAML files, you can add file association for the Ansible language in your `settings.json` file. diff --git a/downstream/modules/devtools/proc-devtools-extension-settings.adoc b/downstream/modules/devtools/proc-devtools-extension-settings.adoc index 6d1a373d86..d418c140ce 100644 --- a/downstream/modules/devtools/proc-devtools-extension-settings.adoc +++ b/downstream/modules/devtools/proc-devtools-extension-settings.adoc @@ -1,7 +1,7 @@ [id="devtools-extension-settings_{context}"] :_mod-docs-content-type: PROCEDURE -= Configuring Ansible extension settings += Configure Ansible extension settings [role="_abstract"] The Ansible extension supports multiple configuration options. diff --git a/downstream/modules/devtools/proc-devtools-inspect-playbook.adoc b/downstream/modules/devtools/proc-devtools-inspect-playbook.adoc index c2b6398e12..2f26da1c92 100644 --- a/downstream/modules/devtools/proc-devtools-inspect-playbook.adoc +++ b/downstream/modules/devtools/proc-devtools-inspect-playbook.adoc @@ -1,7 +1,7 @@ [id="inspect-playbook_context_{context}"] :_mod-docs-content-type: PROCEDURE -= Inspecting your playbook += Inspect your playbook [role="_abstract"] The Ansible {VSCode} extension provides inline help, syntax highlighting, and assists you with indentation in `.yml` files. diff --git a/downstream/modules/devtools/proc-devtools-install-container.adoc b/downstream/modules/devtools/proc-devtools-install-container.adoc index 9f19079224..fb0aa3314d 100644 --- a/downstream/modules/devtools/proc-devtools-install-container.adoc +++ b/downstream/modules/devtools/proc-devtools-install-container.adoc @@ -1,7 +1,7 @@ [id="devtools-install-container_{context}"] :_mod-docs-content-type: PROCEDURE -= Installing {ToolsName} on a container inside {VSCode} += Install {ToolsName} on a container inside {VSCode} [role="_abstract"] The Dev Containers {VSCode} extension requires a `.devcontainer` file to store settings for your dev containers. diff --git a/downstream/modules/devtools/proc-devtools-install-rpm.adoc b/downstream/modules/devtools/proc-devtools-install-rpm.adoc index da40019323..c4415536d5 100644 --- a/downstream/modules/devtools/proc-devtools-install-rpm.adoc +++ b/downstream/modules/devtools/proc-devtools-install-rpm.adoc @@ -1,7 +1,7 @@ [id="devtools-install_{context}"] :_mod-docs-content-type: PROCEDURE -= Installing {ToolsName} from a package on RHEL += Install {ToolsName} from an RPM package [role="_abstract"] diff --git a/downstream/modules/devtools/proc-devtools-install-vsc.adoc b/downstream/modules/devtools/proc-devtools-install-vsc.adoc index 6a29fe75df..1eccccfe7e 100644 --- a/downstream/modules/devtools/proc-devtools-install-vsc.adoc +++ b/downstream/modules/devtools/proc-devtools-install-vsc.adoc @@ -1,7 +1,7 @@ [id="devtools-install-vsc_{context}"] :_mod-docs-content-type: PROCEDURE -= Installing {VScode} += Install and configure the {VScode} Ansible extension [role="_abstract"] Install {VScode} by following the instructions found on the Download Visual Studio Code page in the official documentation. diff --git a/downstream/modules/devtools/proc-devtools-install-vscode-extension.adoc b/downstream/modules/devtools/proc-devtools-install-vscode-extension.adoc index 788739f461..ef92dd4718 100644 --- a/downstream/modules/devtools/proc-devtools-install-vscode-extension.adoc +++ b/downstream/modules/devtools/proc-devtools-install-vscode-extension.adoc @@ -1,7 +1,7 @@ [id="devtools-install-extension_{context}"] :_mod-docs-content-type: PROCEDURE -= Installing the {VSCode} Ansible extension += Install the {VSCode} Ansible extension [role="_abstract"] diff --git a/downstream/modules/devtools/proc-devtools-migrate-existing-roles-collection.adoc b/downstream/modules/devtools/proc-devtools-migrate-existing-roles-collection.adoc index aa243cdad4..122edb4083 100644 --- a/downstream/modules/devtools/proc-devtools-migrate-existing-roles-collection.adoc +++ b/downstream/modules/devtools/proc-devtools-migrate-existing-roles-collection.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="devtools-migrate-existing-roles-collection_{context}"] -= Migrating existing roles to your collection += Migrate existing roles to your collection [role="_abstract"] Migrate existing standalone roles into the `roles/` directory of your new collection. You must rename roles to remove hyphens and update playbooks to use the fully qualified collection name. diff --git a/downstream/modules/devtools/proc-devtools-ms-dev-containers-ext.adoc b/downstream/modules/devtools/proc-devtools-ms-dev-containers-ext.adoc index 9ba5275598..fad7188327 100644 --- a/downstream/modules/devtools/proc-devtools-ms-dev-containers-ext.adoc +++ b/downstream/modules/devtools/proc-devtools-ms-dev-containers-ext.adoc @@ -1,7 +1,7 @@ [id="devtools-ms-dev-containers-ext_{context}"] :_mod-docs-content-type: PROCEDURE -= Installing and configuring the `Dev Containers` extension += Install the containerized Ansible `Dev Containers` [role="_abstract"] If you are installing the containerized version of {ToolsName}, you must install the diff --git a/downstream/modules/devtools/proc-devtools-publish-roles-collection-pah.adoc b/downstream/modules/devtools/proc-devtools-publish-roles-collection-pah.adoc index ddf3b0e269..b7e3c258b8 100644 --- a/downstream/modules/devtools/proc-devtools-publish-roles-collection-pah.adoc +++ b/downstream/modules/devtools/proc-devtools-publish-roles-collection-pah.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="devtools-publish-roles-collection-pah_{context}"] -= Publishing your collection in {PrivateHubName} += Publish your collection in {PrivateHubName} [role="_abstract"] Publish your collection by packaging it into a tarball and uploading it to a namespace in {PrivateHubName}. This makes the collection available for internal use in Ansible Automation Platform projects. diff --git a/downstream/modules/devtools/proc-devtools-run-playbook-extension.adoc b/downstream/modules/devtools/proc-devtools-run-playbook-extension.adoc index 95cd752bc4..9084ba9bc6 100644 --- a/downstream/modules/devtools/proc-devtools-run-playbook-extension.adoc +++ b/downstream/modules/devtools/proc-devtools-run-playbook-extension.adoc @@ -1,7 +1,7 @@ [id="running-playbook-extension_{context}"] :_mod-docs-content-type: PROCEDURE -= Running your playbook += Run your playbook automation to test behavior [role="_abstract"] Run your playbook using two methods provided by the Ansible {VSCode} extension. diff --git a/downstream/modules/devtools/proc-devtools-save-scm.adoc b/downstream/modules/devtools/proc-devtools-save-scm.adoc index 7531069edd..492c8a2fb6 100644 --- a/downstream/modules/devtools/proc-devtools-save-scm.adoc +++ b/downstream/modules/devtools/proc-devtools-save-scm.adoc @@ -1,7 +1,7 @@ [id="devtools-save-scm_{context}"] :_mod-docs-content-type: PROCEDURE -= Saving your project in SCM += Save your project in SCM [role="_abstract"] Save your playbook project as a repository in your source control management system, for example GitHub. diff --git a/downstream/modules/devtools/proc-devtools-scaffold-roles-collection.adoc b/downstream/modules/devtools/proc-devtools-scaffold-roles-collection.adoc index ce7c89ed72..df06dec4f1 100644 --- a/downstream/modules/devtools/proc-devtools-scaffold-roles-collection.adoc +++ b/downstream/modules/devtools/proc-devtools-scaffold-roles-collection.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="devtools-scaffold-roles-collection_{context}"] -= Scaffolding a collection for your roles += Generate the collection structure for roles [role="_abstract"] Scaffold a collection using the Ansible extension in {VSCode}. This process creates the necessary directory structure for packaging and distributing your roles and plug-ins. diff --git a/downstream/modules/devtools/proc-devtools-set-up-ansible-config.adoc b/downstream/modules/devtools/proc-devtools-set-up-ansible-config.adoc index 8a132ca33a..a7540bc958 100644 --- a/downstream/modules/devtools/proc-devtools-set-up-ansible-config.adoc +++ b/downstream/modules/devtools/proc-devtools-set-up-ansible-config.adoc @@ -1,7 +1,7 @@ [id="devtools-set-up-ansible-config_{context}"] :_mod-docs-content-type: PROCEDURE -= Setting up the Ansible configuration file for your playbook project += Set up the Ansible configuration file [role="_abstract"] When you scaffolded your playbook project, an Ansible configuration file, `ansible.cfg`, diff --git a/downstream/modules/devtools/proc-devtools-use-roles-collections-aap.adoc b/downstream/modules/devtools/proc-devtools-use-roles-collections-aap.adoc index eb2401ad01..1864f43478 100644 --- a/downstream/modules/devtools/proc-devtools-use-roles-collections-aap.adoc +++ b/downstream/modules/devtools/proc-devtools-use-roles-collections-aap.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="devtools-use-roles-collections-aap_{context}"] -= Using your collection in projects in {PlatformName} += Use your collection in projects in {PlatformName} [role="_abstract"] To use your collection in {ControllerName} projects, add the collection to a custom {ExecEnvShort}. Then tag the new image and push it to {PrivateHubName}. diff --git a/downstream/modules/devtools/proc-devtools-writing-first-playbook.adoc b/downstream/modules/devtools/proc-devtools-writing-first-playbook.adoc index e78e441902..a1a8a919e4 100644 --- a/downstream/modules/devtools/proc-devtools-writing-first-playbook.adoc +++ b/downstream/modules/devtools/proc-devtools-writing-first-playbook.adoc @@ -1,7 +1,7 @@ [id="writing-playbook_{context}"] :_mod-docs-content-type: PROCEDURE -= Writing your first playbook += Write your first playbook [role="_abstract"] Create your first Ansible playbook within {VSCode} using the Ansible extension. The tools available help ensure that your syntax is correct and ready to run. diff --git a/downstream/modules/devtools/proc-disable-mcp-server.adoc b/downstream/modules/devtools/proc-disable-mcp-server.adoc new file mode 100644 index 0000000000..a32f572912 --- /dev/null +++ b/downstream/modules/devtools/proc-disable-mcp-server.adoc @@ -0,0 +1,13 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-20 +:_mod-docs-content-type: PROCEDURE + +[id="disable-mcp-server_{context}"] += Disable the MCP server + +[role="_abstract"] +Take the following steps to disable the MCP server in {VSCode}. + +.Procedure +* To disable the server from the {VSCode} command palette, find and select *Disable {ToolsName} MCP Server*. +* To disable the server from the Ansible {VSCode} settings menu, navigate to *Extensions* > *Ansible* > *MCP Server*, and clear the checkbox next to *Enable the Ansible MCP server for AI integration*. \ No newline at end of file diff --git a/downstream/modules/devtools/proc-enable-mcp-command-palette.adoc b/downstream/modules/devtools/proc-enable-mcp-command-palette.adoc new file mode 100644 index 0000000000..044d4fb02f --- /dev/null +++ b/downstream/modules/devtools/proc-enable-mcp-command-palette.adoc @@ -0,0 +1,22 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-20 +:_mod-docs-content-type: PROCEDURE + +[id="enable-mcp-command-palette_{context}"] += Enable the MCP server through the {VSCode} command palette + +[role="_abstract"] +Take the following steps to enable the MCP server through the {VSCode} command palette. + +.Procedure +. In {VSCode}, click into the command palette at the top of the window, or type `ctrl + Shift + P` or `Cmd + Shift + P`. +. Find and select *Ansible: Enable {ToolsName} MCP Server*. ++ +A message confirms that you have successfully enabled the MCP server and that it is now available for AI assistants that support MCP. ++ +. Find and select *MCP: List servers* in the command palette. In the list you should see an entry for *{ToolsName} MCP Server*. +. Select *{ToolsName} MCP Server* to start the server. + +.Verification +Verify that the server has started by looking for `Discovered 10 tools` in your {VSCode} output window. + diff --git a/downstream/modules/devtools/proc-enable-mcp-settings.adoc b/downstream/modules/devtools/proc-enable-mcp-settings.adoc new file mode 100644 index 0000000000..7c485f5f75 --- /dev/null +++ b/downstream/modules/devtools/proc-enable-mcp-settings.adoc @@ -0,0 +1,27 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-20 +:_mod-docs-content-type: PROCEDURE + +[id="enable-mcp-settings_{context}"] += Enable the MCP server through the {VSCode} settings menu + +[role="_abstract"] +Take the following steps to enable the MCP server through the {VSCode} settings menu. + +.Procedure +. In {VSCode}, select the *Extensions* icon in the left menu. +. Find the Ansible {VSCode} extension and click the settings wheel. +. Select *Settings* from the menu that appears. +. In the Settings window, select *Extensions* > *Ansible* > *MCP Server*. +. Click the checkbox next to *Enable the {ToolsName} MCP server for AI integration*. ++ +A message confirms that the MCP server is enabled. +. Find and select *Ansible: Enable {ToolsName} MCP Server*. ++ +A message confirms that you have successfully enabled the MCP server and that it is now available for AI assistants that support MCP. ++ +. Find and select *MCP: List servers* in the command palette at the top of the window. In the list that appears you should see an entry for *{ToolsName} MCP Server*. +. Select *{ToolsName} MCP Server* to start the server. + +.Verification +Verify that the server has started by looking for `Discovered 10 tools` in your {VSCode} output window. diff --git a/downstream/modules/devtools/proc-generate-ee-from-playbook.adoc b/downstream/modules/devtools/proc-generate-ee-from-playbook.adoc new file mode 100644 index 0000000000..3ee74b2045 --- /dev/null +++ b/downstream/modules/devtools/proc-generate-ee-from-playbook.adoc @@ -0,0 +1,16 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-21 +:_mod-docs-content-type: PROCEDURE + +[id="generate-ee-from-playbook_{context}"] += Generate an {ExecEnvShort} from an existing playbook + +[role="_abstract"] +Prompt the AI assistant to inspect an existing playbook to determine the necessary collections and dependencies for a new {ExecEnvShort} based on the playbook. + +.Procedure +. Open the playbook you want to analyze in the {VSCode} editor. +. In the Copilot chat window, prompt the assistant to analyze the playbook. For example: + +* _Analyze my current playbook, determine the necessary collections, and generate an {ExecEnvShort} definition file that includes them_. +. Review the output and confirm that the assistant has imported collections (for example, `community.general`, `amazon.aws`) required by the tasks in your playbook. diff --git a/downstream/modules/devtools/proc-implement-fixes-with-the-assistant.adoc b/downstream/modules/devtools/proc-implement-fixes-with-the-assistant.adoc new file mode 100644 index 0000000000..bf8b04f0d1 --- /dev/null +++ b/downstream/modules/devtools/proc-implement-fixes-with-the-assistant.adoc @@ -0,0 +1,33 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-21 +:_mod-docs-content-type: PROCEDURE + +[id="implement-fixes-with-the-assistant_{context}"] += Implement fixes with the AI assistant + +[role="_abstract"] +After the AI assistant has generated a list of fixes, you can ask the assistant to help you implement those fixes. + +.Procedure +. Review the assistant's response. It should highlight sections of the code that have errors or that could be improved. ++ +The analysis might include: + +* Identification of Anti-patterns: Flagging inefficient or insecure practices. +* Failure Analysis: Explaining logical errors that could cause runtime failures. +* Best Practice Gaps: Noting where the code deviates from the "prescriptive rule sets" derived from Ansible content best practices. ++ +. Prompt the assistant to provide a solution. For example: + +* _How do I fix this error?_ +* _Refactor this task to follow best practices._ ++ +The assistant generates a corrected code block, ensuring that it adheres to best practice recommendations (such as correct indentation, valid parameters, and proper module usage). + +.Next steps +After applying the suggested changes, verify that there are no further issues. + +. Apply the changes to your playbook. +. (Optional) Ask the assistant to confirm the new structure. For example, you can ask _Does this look correct now?_ ++ +The assistant might trigger `ansible_lint` again or perform a final static check to ensure the debugging session resolved the issues. \ No newline at end of file diff --git a/downstream/modules/devtools/proc-install-mcp-devtools.adoc b/downstream/modules/devtools/proc-install-mcp-devtools.adoc new file mode 100644 index 0000000000..9ee88f3c79 --- /dev/null +++ b/downstream/modules/devtools/proc-install-mcp-devtools.adoc @@ -0,0 +1,18 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-19 +:_mod-docs-content-type: PROCEDURE + +[id="install-mcp-devtools_{context}"] += Install {ToolsName} with the AI assistant + +[role="_abstract"] +If you do not have {ToolsName} (ADT) installed, you can instruct the AI assistant to install them. + +.Procedure +. Open GitHub Copilot chat. +. Enter the prompt: _Make sure I have `ansible-dev-tools` installed_. ++ +The system then checks if {ToolsName} is installed. If so, the assistant will report that `ansible-dev-tools` is installed. If {ToolsName} is not installed, the AI assistant chooses a package manager (`pip` or `pipx`) and installs ADT automatically. + +.Verification +When installation is complete, the AI assistant will return a message in the Copilot chat window confirming that ADT has been installed successfully. You can also prompt the AI assistant to _check my Ansible environment_ again. If the installation was successful, the AI assistant will verify that ADT is installed in your environment. diff --git a/downstream/modules/devtools/proc-list-available-mcp-tools.adoc b/downstream/modules/devtools/proc-list-available-mcp-tools.adoc new file mode 100644 index 0000000000..dfe79ede57 --- /dev/null +++ b/downstream/modules/devtools/proc-list-available-mcp-tools.adoc @@ -0,0 +1,26 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-21 +:_mod-docs-content-type: PROCEDURE + +[id="list-available-mcp-tools_{context}"] += List available Ansible MCP server tools + +[role="_abstract"] +To discover other automation tasks the AI assistant can perform with the MCP server, you can query the toolset directly. + +.Procedure +. In the GitHub Copilot chat window, enter the following prompt: +* _What Ansible tools are available through the MCP server?_ ++ +The assistant triggers the `list_available_tools` function and returns a list of tools, including: + +* `zen_of_ansible` +* `ansible_content_best_practices` +* `list_available_tools` +* `ansible_lint` +* `ansible_navigator` +* `ade_environment_info` +* `ade_setup_environment` +* `adt_check_env` +* `create_ansible_projects` +* `define_and_build_execution_env` diff --git a/downstream/modules/devtools/proc-portal-config-conditional-access.adoc b/downstream/modules/devtools/proc-portal-config-conditional-access.adoc index cc8eb561f1..dd77b10b40 100644 --- a/downstream/modules/devtools/proc-portal-config-conditional-access.adoc +++ b/downstream/modules/devtools/proc-portal-config-conditional-access.adoc @@ -2,7 +2,7 @@ [id="portal-config-conditional-access_{context}"] -= Configuring conditional access += Configure conditional access [role="_abstract"] Optionally, you can configure conditional {SelfServiceShort} RBAC policies to filter role access to specific {PlatformNameShort} job templates by tag for specific {PlatformNameShort} teams or users. diff --git a/downstream/modules/devtools/proc-portal-configure-rbac-sync.adoc b/downstream/modules/devtools/proc-portal-configure-rbac-sync.adoc index 962c865cd7..5e92f50194 100644 --- a/downstream/modules/devtools/proc-portal-configure-rbac-sync.adoc +++ b/downstream/modules/devtools/proc-portal-configure-rbac-sync.adoc @@ -2,7 +2,7 @@ [id="proc-portal-configure-rbac-sync_{context}"] -= Configuring RBAC for synchronization += Configure RBAC for synchronization [role="_abstract"] Synchronization uses an {PlatformNameShort} token configured in the {SelfService} to determine which data to synchronize from {PlatformNameShort}. diff --git a/downstream/modules/devtools/proc-rhdh-add-custom-configmap.adoc b/downstream/modules/devtools/proc-rhdh-add-custom-configmap.adoc index 1d25d02627..2dfcc250c2 100644 --- a/downstream/modules/devtools/proc-rhdh-add-custom-configmap.adoc +++ b/downstream/modules/devtools/proc-rhdh-add-custom-configmap.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-add-custom-configmap_{context}"] -= Adding a custom ConfigMap += Add a custom ConfigMap [role="_abstract"] Create a custom {RHDH} ConfigMap, typically named `app-config-rhdh`, to store custom application settings. diff --git a/downstream/modules/devtools/proc-rhdh-add-devtools-container.adoc b/downstream/modules/devtools/proc-rhdh-add-devtools-container.adoc index 92a4127602..475deefc44 100644 --- a/downstream/modules/devtools/proc-rhdh-add-devtools-container.adoc +++ b/downstream/modules/devtools/proc-rhdh-add-devtools-container.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-add-devtools-container_{context}"] -= Adding the Ansible Developer Tools container += Add the Ansible Developer Tools container [role="_abstract"] You must update the Helm chart configuration to add an extra container. diff --git a/downstream/modules/devtools/proc-rhdh-add-plugin-config.adoc b/downstream/modules/devtools/proc-rhdh-add-plugin-config.adoc index 873f3994aa..e0cf379f52 100644 --- a/downstream/modules/devtools/proc-rhdh-add-plugin-config.adoc +++ b/downstream/modules/devtools/proc-rhdh-add-plugin-config.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-add-plugin-config_{context}"] -= Adding the Ansible plug-ins configuration += Add the Ansible plug-ins configuration [role="_abstract"] Modify the {RHDH} Helm chart by adding the local path of the extracted dynamic plug-in files to the `appConfig.dynamicPlugins.rootDirectory` parameter. diff --git a/downstream/modules/devtools/proc-rhdh-add-plugin-software-templates.adoc b/downstream/modules/devtools/proc-rhdh-add-plugin-software-templates.adoc index 4f74e9546a..27b3d550d5 100644 --- a/downstream/modules/devtools/proc-rhdh-add-plugin-software-templates.adoc +++ b/downstream/modules/devtools/proc-rhdh-add-plugin-software-templates.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-add-plugin-software-templates_{context}"] -= Adding Ansible plug-ins software templates += Add Ansible plug-ins software templates [role="_abstract"] {PlatformNameShort} provides software templates for {RHDH} to provision new playbooks and collection projects based on Ansible best practices. diff --git a/downstream/modules/devtools/proc-rhdh-add-pull-secret-helm.adoc b/downstream/modules/devtools/proc-rhdh-add-pull-secret-helm.adoc index a6c70ec3b7..2051b928b2 100644 --- a/downstream/modules/devtools/proc-rhdh-add-pull-secret-helm.adoc +++ b/downstream/modules/devtools/proc-rhdh-add-pull-secret-helm.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-add-pull-secret-helm_{context}"] -= Adding a pull secret to the {RHDH} Helm configuration += Add a pull secret to the {RHDH} Helm configuration [role="_abstract"] You must add a pull secret to the {RHDH} Helm configuration to enable the dynamic plug-ins to pull container images from authenticated registries. diff --git a/downstream/modules/devtools/proc-rhdh-configure-aap-details.adoc b/downstream/modules/devtools/proc-rhdh-configure-aap-details.adoc index fa250159a5..3b405394d5 100644 --- a/downstream/modules/devtools/proc-rhdh-configure-aap-details.adoc +++ b/downstream/modules/devtools/proc-rhdh-configure-aap-details.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-configure-aap-details_{context}"] -= Configuring Ansible Automation Platform details += Configure {PlatformNameShort} details [role="_abstract"] The Ansible plug-ins query your {PlatformNameShort} subscription status with the controller API using a token. diff --git a/downstream/modules/devtools/proc-rhdh-configure-devspaces.adoc b/downstream/modules/devtools/proc-rhdh-configure-devspaces.adoc index 2b4dc05d12..2f987a2fcf 100644 --- a/downstream/modules/devtools/proc-rhdh-configure-devspaces.adoc +++ b/downstream/modules/devtools/proc-rhdh-configure-devspaces.adoc @@ -1,20 +1,20 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-configure-devspaces_{context}"] -= Configuring OpenShift Dev Spaces += Configure {DevSpacesShort} [role="_abstract"] -When OpenShift Dev Spaces is configured for the Ansible plug-ins, users can click a link from the catalog item view in {RHDH} and edit their provisioned Ansible Git projects using Dev Spaces. +When {DevSpacesShort} is configured for the Ansible plug-ins, users can click a link from the catalog item view in {RHDH} and edit their provisioned Ansible Git projects using Dev Spaces. [NOTE] ==== -OpenShift Dev Spaces is a separate product and it is optional. +{DevSpacesShort} is a separate product and it is optional. The plug-ins will function without it. It is a separate Red Hat product and is not included in the {PlatformNameShort} or {RHDH} subscription. ==== -If the OpenShift Dev Spaces link is not configured in the Ansible plug-ins, +If the {DevSpacesShort} link is not configured in the Ansible plug-ins, the *Go to OpenShift Dev Spaces dashboard* link in the *DEVELOP* section of the Ansible plug-ins landing page redirects users to the link:https://www.redhat.com/en/technologies/management/ansible/development-tools[Ansible development tools home page]. diff --git a/downstream/modules/devtools/proc-rhdh-configure-devtools-server.adoc b/downstream/modules/devtools/proc-rhdh-configure-devtools-server.adoc index 1b6b9a4358..018e78cf6c 100644 --- a/downstream/modules/devtools/proc-rhdh-configure-devtools-server.adoc +++ b/downstream/modules/devtools/proc-rhdh-configure-devtools-server.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-configure-devtools-server_{context}"] -= Configuring the Ansible Dev Tools Server += Configure the {ToolsName} Server [role="_abstract"] The `creatorService` URL is required for the {AAPRHDHShort} to provision new projects using the provided software templates. diff --git a/downstream/modules/devtools/proc-rhdh-configure-optional-integrations.adoc b/downstream/modules/devtools/proc-rhdh-configure-optional-integrations.adoc index 60e5f41813..121118425c 100644 --- a/downstream/modules/devtools/proc-rhdh-configure-optional-integrations.adoc +++ b/downstream/modules/devtools/proc-rhdh-configure-optional-integrations.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-configure-optional-integrations_{context}"] -= Configuring Ansible plug-ins optional integrations += Configure Ansible plug-ins optional integrations [role="_abstract"] The Ansible plug-ins provide integrations with {PlatformNameShort} and other optional Red Hat products. diff --git a/downstream/modules/devtools/proc-rhdh-configure-pah-url.adoc b/downstream/modules/devtools/proc-rhdh-configure-pah-url.adoc index fb43dd1042..224512d8a4 100644 --- a/downstream/modules/devtools/proc-rhdh-configure-pah-url.adoc +++ b/downstream/modules/devtools/proc-rhdh-configure-pah-url.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-configure-pah-url_{context}"] -= Configuring the private automation hub URL += Configure the private automation hub URL [role="_abstract"] {PrivateHubNameStart} provides a centralized, on-premise repository for certified Ansible collections, execution environments and any additional, vetted content provided by your organization. diff --git a/downstream/modules/devtools/proc-rhdh-configure-rbac.adoc b/downstream/modules/devtools/proc-rhdh-configure-rbac.adoc index 21b3f78b18..43692c431a 100644 --- a/downstream/modules/devtools/proc-rhdh-configure-rbac.adoc +++ b/downstream/modules/devtools/proc-rhdh-configure-rbac.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-configure-rbac_{context}"] -= Configuring Role Based Access Control += Configure Role Based Access Control [role="_abstract"] {RHDH} offers Role-based Access Control (RBAC) functionality. diff --git a/downstream/modules/devtools/proc-rhdh-create-plugin-registry.adoc b/downstream/modules/devtools/proc-rhdh-create-plugin-registry.adoc index 0fc0d68589..d5a5fcc600 100644 --- a/downstream/modules/devtools/proc-rhdh-create-plugin-registry.adoc +++ b/downstream/modules/devtools/proc-rhdh-create-plugin-registry.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-create-plugin-registry_{context}"] -= Creating a registry for the {AAPRHDHShort} += Create a registry for the {AAPRHDHShort} [role="_abstract"] Set up a registry in your OpenShift cluster to host the {AAPRHDHShort} and make them available for installation in {RHDH} ({RHDHShort}). diff --git a/downstream/modules/devtools/proc-rhdh-create.adoc b/downstream/modules/devtools/proc-rhdh-create.adoc index 421a56bd99..b18021cab9 100644 --- a/downstream/modules/devtools/proc-rhdh-create.adoc +++ b/downstream/modules/devtools/proc-rhdh-create.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-create_{context}"] -= Creating a project += Create a project in the {RHDH} UI [role="_abstract"] Create a new Ansible Playbook project in the Red Hat Developer Hub by logging in, navigating to the Ansible section, and selecting the project creation template. You must have the correct access (RBAC) assigned by your administrator to view the templates. diff --git a/downstream/modules/devtools/proc-rhdh-develop-projects-devspaces.adoc b/downstream/modules/devtools/proc-rhdh-develop-projects-devspaces.adoc index e8c5ea1ff8..3f4cade2b4 100644 --- a/downstream/modules/devtools/proc-rhdh-develop-projects-devspaces.adoc +++ b/downstream/modules/devtools/proc-rhdh-develop-projects-devspaces.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-develop-projects-devspaces_{context}"] -= Developing projects on Dev Spaces += Develop and execute projects in Dev Spaces [role="_abstract"] {DevSpacesShort} provides a web-based Integrated Development Environment that includes the Ansible VS Code extension and command line tools. You can use this environment to develop and test your automation code. diff --git a/downstream/modules/devtools/proc-rhdh-devtools-sidecar.adoc b/downstream/modules/devtools/proc-rhdh-devtools-sidecar.adoc index d4359c0292..fb38e0d2db 100644 --- a/downstream/modules/devtools/proc-rhdh-devtools-sidecar.adoc +++ b/downstream/modules/devtools/proc-rhdh-devtools-sidecar.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-devtools-sidecar_{context}"] -= Adding the Ansible Development Tools sidecar container += Add the {ToolsName} sidecar container [role="_abstract"] After the plug-ins load, add the Ansible Development Container (ansible-devtools-server) as a sidecar container to the {RHDH} pod. diff --git a/downstream/modules/devtools/proc-rhdh-download-plugins.adoc b/downstream/modules/devtools/proc-rhdh-download-plugins.adoc index 68e4ece628..b1459b90e4 100644 --- a/downstream/modules/devtools/proc-rhdh-download-plugins.adoc +++ b/downstream/modules/devtools/proc-rhdh-download-plugins.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-download-plugins_{context}"] -= Downloading the Ansible plug-ins files += Download the Ansible plug-ins files [role="_abstract"] Download the {AAPRHDH} *Setup Bundle* from the {PlatformName} Product Software downloads page. diff --git a/downstream/modules/devtools/proc-rhdh-enable-rhdh-authentication.adoc b/downstream/modules/devtools/proc-rhdh-enable-rhdh-authentication.adoc index 3230f39175..bda84d9466 100644 --- a/downstream/modules/devtools/proc-rhdh-enable-rhdh-authentication.adoc +++ b/downstream/modules/devtools/proc-rhdh-enable-rhdh-authentication.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-enable-rhdh-authentication_{context}"] -= Enabling {RHDH} authentication += Enable {RHDH} authentication [role="_abstract"] Enable {RHDH} (RHDH) authentication to integrate with Source Control Management (SCM) systems. This capability is necessary for the plug-ins to create repositories. diff --git a/downstream/modules/devtools/proc-rhdh-execute-automation-devspaces.adoc b/downstream/modules/devtools/proc-rhdh-execute-automation-devspaces.adoc index c8f1e3e57f..96ac512705 100644 --- a/downstream/modules/devtools/proc-rhdh-execute-automation-devspaces.adoc +++ b/downstream/modules/devtools/proc-rhdh-execute-automation-devspaces.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-execute-automation-devspaces_{context}"] -= Executing automation tasks in Dev Spaces += Execute automation tasks in Dev Spaces [role="_abstract"] The default configuration for Dev Spaces provides access to the Ansible command line tools. diff --git a/downstream/modules/devtools/proc-rhdh-firewall-example-discover.adoc b/downstream/modules/devtools/proc-rhdh-firewall-example-discover.adoc index aa5bde7fd0..d526c314c0 100644 --- a/downstream/modules/devtools/proc-rhdh-firewall-example-discover.adoc +++ b/downstream/modules/devtools/proc-rhdh-firewall-example-discover.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-firewall-example-discover_{context}"] -= Discovering existing Ansible content for RHEL system roles += Discover existing Ansible content for RHEL system roles [role="_abstract"] Red Hat recommends that you use trusted automation content that has been tested and approved by Red Hat or your organization. diff --git a/downstream/modules/devtools/proc-rhdh-firewall-example-edit.adoc b/downstream/modules/devtools/proc-rhdh-firewall-example-edit.adoc index 4e58353668..d01636eb13 100644 --- a/downstream/modules/devtools/proc-rhdh-firewall-example-edit.adoc +++ b/downstream/modules/devtools/proc-rhdh-firewall-example-edit.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-firewall-example-edit_{context}"] -= Editing your firewall playbook project += Edit your firewall playbook project [role="_abstract"] The Ansible plug-ins integrate OpenShift Dev Spaces to edit your Ansible projects. diff --git a/downstream/modules/devtools/proc-rhdh-firewall-example-learn.adoc b/downstream/modules/devtools/proc-rhdh-firewall-example-learn.adoc index 43dac6516f..5d183b27ff 100644 --- a/downstream/modules/devtools/proc-rhdh-firewall-example-learn.adoc +++ b/downstream/modules/devtools/proc-rhdh-firewall-example-learn.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-firewall-example-learn_{context}"] -= Learning more about playbooks += Learn more about playbooks [role="_abstract"] The first step is to learn more about Ansible playbooks using the available learning paths. diff --git a/downstream/modules/devtools/proc-rhdh-firewall-example-new-playbook.adoc b/downstream/modules/devtools/proc-rhdh-firewall-example-new-playbook.adoc index e7551e3797..6af29fc6cc 100644 --- a/downstream/modules/devtools/proc-rhdh-firewall-example-new-playbook.adoc +++ b/downstream/modules/devtools/proc-rhdh-firewall-example-new-playbook.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-firewall-example-new-playbook_{context}"] -= Creating a new playbook to automate the firewall configuration += Create a new playbook to automate the firewall configuration [role="_abstract"] Create a new playbook and use the RHEL System Role collection to automate your {RHEL} firewall configuration. diff --git a/downstream/modules/devtools/proc-rhdh-install-dynamic-plugins-operator.adoc b/downstream/modules/devtools/proc-rhdh-install-dynamic-plugins-operator.adoc index 39e82acee8..0112238074 100644 --- a/downstream/modules/devtools/proc-rhdh-install-dynamic-plugins-operator.adoc +++ b/downstream/modules/devtools/proc-rhdh-install-dynamic-plugins-operator.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-install-dynamic-plugins-operator_{context}"] -= Installing the dynamic plug-ins += Install the dynamic plug-ins [role="_abstract"] To install the dynamic plugins, add them to your ConfigMap for your {RHDHShort} plugin settings (for example, `rhaap-dynamic-plugins-config`). diff --git a/downstream/modules/devtools/proc-rhdh-operator-add-sidecar-container.adoc b/downstream/modules/devtools/proc-rhdh-operator-add-sidecar-container.adoc index 7d153747ae..4ee786707f 100644 --- a/downstream/modules/devtools/proc-rhdh-operator-add-sidecar-container.adoc +++ b/downstream/modules/devtools/proc-rhdh-operator-add-sidecar-container.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-operator-add-sidecar-container_{context}"] -= Adding a sidecar container for {ToolsName} to the {RHDHShort} Operator Custom Resource += Add a sidecar container for {ToolsName} [role="_abstract"] Add a sidecar container for {ToolsName} in the Developer Hub pod. diff --git a/downstream/modules/devtools/proc-rhdh-set-up-controller-project.adoc b/downstream/modules/devtools/proc-rhdh-set-up-controller-project.adoc index f5103db85a..30efa63aba 100644 --- a/downstream/modules/devtools/proc-rhdh-set-up-controller-project.adoc +++ b/downstream/modules/devtools/proc-rhdh-set-up-controller-project.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-set-up-controller-project_{context}"] -= Setting up a controller project to run your playbook project += Connect your project to {PlatformNameShort} [role="_abstract"] Access {PlatformNameShort}through the {RHDH} to create a project in {ControllerNameShort} for your playbook repository and then set up a job template that uses the playbook. You can navigate directly to your {ControllerNameShort} instance if it was not configured during the plug-in installation. diff --git a/downstream/modules/devtools/proc-rhdh-uninstall-ocp-helm.adoc b/downstream/modules/devtools/proc-rhdh-uninstall-ocp-helm.adoc index 2b6133aeda..82e05c514f 100644 --- a/downstream/modules/devtools/proc-rhdh-uninstall-ocp-helm.adoc +++ b/downstream/modules/devtools/proc-rhdh-uninstall-ocp-helm.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-uninstall-ocp-helm_{context}"] -= Uninstalling a Helm chart installation += Uninstall a Helm chart installation [role="_abstract"] To uninstall the Ansible plug-ins from a Helm chart installation, you remove templates using the ansible:content:create action first. Then, you delete the plug-in configuration from the Helm chart YAML, remove the extraContainers section, delete the Ansible block from the custom ConfigMap, restart the deployment, and remove the plug-in registry application. diff --git a/downstream/modules/devtools/proc-rhdh-uninstall-ocp-operator-plugins-cm.adoc b/downstream/modules/devtools/proc-rhdh-uninstall-ocp-operator-plugins-cm.adoc index b4b309bb39..17a5a2888b 100644 --- a/downstream/modules/devtools/proc-rhdh-uninstall-ocp-operator-plugins-cm.adoc +++ b/downstream/modules/devtools/proc-rhdh-uninstall-ocp-operator-plugins-cm.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-uninstall-ocp-operator-plugins-cm_{context}"] -= Removing the {AAPRHDHShort} from the ConfigMap += Remove the {AAPRHDHShort} from the ConfigMap // (this section covers uninstalling plugins only, not unloading or updating the sidecar container) // To uninstall the dynamic plugins, you must update the `rhaap-dynamic-plugins-config` ConfigMap diff --git a/downstream/modules/devtools/proc-rhdh-uninstall-ocp-operator-rhdh-cm.adoc b/downstream/modules/devtools/proc-rhdh-uninstall-ocp-operator-rhdh-cm.adoc index 95727a5aa8..28de1723d9 100644 --- a/downstream/modules/devtools/proc-rhdh-uninstall-ocp-operator-rhdh-cm.adoc +++ b/downstream/modules/devtools/proc-rhdh-uninstall-ocp-operator-rhdh-cm.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-uninstall-ocp-operator-rhdh-cm_{context}"] -= Removing {PlatformNameShort} and Dev Spaces from the custom {RHDH} ConfigMap += Remove {PlatformNameShort} and Dev Spaces from the custom {RHDH} ConfigMap [role="_abstract"] To remove {PlatformNameShort} and Dev Spaces configuration from an Operator installation, you must edit the custom {RHDH} ConfigMap. diff --git a/downstream/modules/devtools/proc-rhdh-uninstall-ocp-operator-sidecar-container.adoc b/downstream/modules/devtools/proc-rhdh-uninstall-ocp-operator-sidecar-container.adoc index 1c7d4359ba..ebb13c3aae 100644 --- a/downstream/modules/devtools/proc-rhdh-uninstall-ocp-operator-sidecar-container.adoc +++ b/downstream/modules/devtools/proc-rhdh-uninstall-ocp-operator-sidecar-container.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-uninstall-ocp-operator-sidecar-container_{context}"] -= Uninstalling the sidecar container += Uninstall the sidecar container [role="_abstract"] To remove the sidecar container for {ToolsName} from the developer-hub pod, diff --git a/downstream/modules/devtools/proc-rhdh-update-plugin-registry.adoc b/downstream/modules/devtools/proc-rhdh-update-plugin-registry.adoc index 8e9912fa4c..7ae26c3b5f 100644 --- a/downstream/modules/devtools/proc-rhdh-update-plugin-registry.adoc +++ b/downstream/modules/devtools/proc-rhdh-update-plugin-registry.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-update-plugin-registry_{context}"] -= Updating the plug-in registry += Update the plug-in registry [role="_abstract"] Rebuild your plug-in registry application in your OpenShift cluster with the latest Ansible plug-ins files. diff --git a/downstream/modules/devtools/proc-rhdh-update-plugins-helm-version-numbers.adoc b/downstream/modules/devtools/proc-rhdh-update-plugins-helm-version-numbers.adoc index ffc63b0be1..8fb2c88e5c 100644 --- a/downstream/modules/devtools/proc-rhdh-update-plugins-helm-version-numbers.adoc +++ b/downstream/modules/devtools/proc-rhdh-update-plugins-helm-version-numbers.adoc @@ -1,8 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-update-plugins-helm-version-numbers_{context}"] -= Updating the Ansible plug-ins version numbers for a Helm installation - += Update version numbers [role="_abstract"] You must navigate to the Helm chart's YAML view in the OpenShift Developer UI and replace the old version numbers and integrity hash values for both Ansible plug-ins, which triggers a restart of the Developer Hub pods to finalize the upgrade. diff --git a/downstream/modules/devtools/proc-run-environment-diagnostics.adoc b/downstream/modules/devtools/proc-run-environment-diagnostics.adoc new file mode 100644 index 0000000000..06c8d3aa94 --- /dev/null +++ b/downstream/modules/devtools/proc-run-environment-diagnostics.adoc @@ -0,0 +1,27 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-19 +:_mod-docs-content-type: PROCEDURE + +[id="run-environment-diagnostics_{context}"] += Run environment diagnostics + +[role="_abstract"] +Use the AI assistant to assess your local environment to understand what tools, versions, and collections are currently installed. + + +.Procedure +. Open GitHub Copilot chat. +. Enter a prompt in natural language asking the AI assistant what is installed in your environment. For example: +.. _Check my Ansible environment and tell me what's installed_. +.. _What collections are installed_? ++ +The assistant then triggers the `ade_environment_info` tool. ++ +. Review the output, which typically includes: +.. Workspace path and Python version +.. Virtual environment status +.. {PlatformNameShort} and `ansible_lint` versions +.. A list of installed collections +.. The installation status of {ToolsName} (ADT). + + diff --git a/downstream/modules/devtools/proc-run-playbook-with-assistant.adoc b/downstream/modules/devtools/proc-run-playbook-with-assistant.adoc new file mode 100644 index 0000000000..d1d9ab0982 --- /dev/null +++ b/downstream/modules/devtools/proc-run-playbook-with-assistant.adoc @@ -0,0 +1,24 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-21 +:_mod-docs-content-type: PROCEDURE + +[id="run-playbook-with-assistant_{context}"] += Run a playbook with ansible-navigator + +[role="_abstract"] +Prompt the AI assistant for help with running playbooks. + +.Procedure +. Prompt the assistant to generate a command that runs the playbook in your {ExecEnvShort}. For example: +* _Give me the command to run this playbook in the {ExecEnvShort} _. ++ +The assistant then generates an appropriate `ansible-navigator` command, ensuring the `--execution-environment-image` flag points to your newly-built tag. ++ +A generated command might look like the following: ++ +[source,python] +---- +ansible-navigator run playbook.yml --execution-environment-image webserver-ee:1.0 --mode stdout +---- ++ +. Execute the command in the {VSCode} terminal to run your automation within the custom environment. \ No newline at end of file diff --git a/downstream/modules/devtools/proc-scaffold-content-assistant.adoc b/downstream/modules/devtools/proc-scaffold-content-assistant.adoc new file mode 100644 index 0000000000..196c1290fd --- /dev/null +++ b/downstream/modules/devtools/proc-scaffold-content-assistant.adoc @@ -0,0 +1,15 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-21 +:_mod-docs-content-type: PROCEDURE + +[id="scaffold-content-assistant_{context}"] += Scaffold content with the AI assistant + +[role="_abstract"] +If you need to generate specific content within the project using specific templates (such as a playbook or execution environment), you can continue the conversation. + +.Procedure +* In the GitHub Copilot chat window, enter a natural language prompt requesting help with creating the type of content you need. For example: +** For a playbook project, enter the prompt: _Following best practices, help me create a playbook called 'webserver'..."_ +** For an execution environment, enter the prompt: _Create an execution environment definition file using Fedora minimal as the base"_ + diff --git a/downstream/modules/devtools/proc-scaffolding-playbook-project.adoc b/downstream/modules/devtools/proc-scaffolding-playbook-project.adoc index 04f199ce2b..990b3667e5 100644 --- a/downstream/modules/devtools/proc-scaffolding-playbook-project.adoc +++ b/downstream/modules/devtools/proc-scaffolding-playbook-project.adoc @@ -1,7 +1,7 @@ [id="scaffolding-playbook-project_{context}"] :_mod-docs-content-type: PROCEDURE -= Scaffolding a playbook project += Scaffold a playbook project [role="_abstract"] The following steps describe the process for scaffolding a new playbook project with the Ansible {VSCode} extension. diff --git a/downstream/modules/devtools/proc-self-service-add-deployment-url-oauth-app.adoc b/downstream/modules/devtools/proc-self-service-add-deployment-url-oauth-app.adoc index 859156a332..0e164a4a30 100644 --- a/downstream/modules/devtools/proc-self-service-add-deployment-url-oauth-app.adoc +++ b/downstream/modules/devtools/proc-self-service-add-deployment-url-oauth-app.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-add-deployment-url-oauth-app_{context}"] -= Adding the deployment URL to the OAuth Application += Add the deployment URL to the OAuth Application [role="_abstract"] When you set up your OAuth application in {PlatformNameShort} before deploying {SelfServiceShort}, diff --git a/downstream/modules/devtools/proc-self-service-add-template.adoc b/downstream/modules/devtools/proc-self-service-add-template.adoc index 7f3ccb4cdf..3c8ba7de34 100644 --- a/downstream/modules/devtools/proc-self-service-add-template.adoc +++ b/downstream/modules/devtools/proc-self-service-add-template.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-add-template_{context}"] -= Adding a template to {SelfServiceShort} += Add a template to {SelfServiceShort} [role="_abstract"] You can add a custom self-service template to the *Templates* view of your {SelfServiceShort} instance. diff --git a/downstream/modules/devtools/proc-self-service-create-oauth-app.adoc b/downstream/modules/devtools/proc-self-service-create-oauth-app.adoc index caa2be9a78..93f540e750 100644 --- a/downstream/modules/devtools/proc-self-service-create-oauth-app.adoc +++ b/downstream/modules/devtools/proc-self-service-create-oauth-app.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-create-oauth-app_{context}"] -= Creating an OAuth application += Create an OAuth application [role="_abstract"] To use the Helm chart to deploy {SelfServiceShort}, you must have set up an OAuth application on your {PlatformNameShort} instance. diff --git a/downstream/modules/devtools/proc-self-service-deregister-dynamic-templates.adoc b/downstream/modules/devtools/proc-self-service-deregister-dynamic-templates.adoc index 318c2bd54a..fa4b84fa21 100644 --- a/downstream/modules/devtools/proc-self-service-deregister-dynamic-templates.adoc +++ b/downstream/modules/devtools/proc-self-service-deregister-dynamic-templates.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-deregister-templates_{context}"] -= Deregistering custom self-service templates += Deregister custom self-service templates [role="_abstract"] You can deregister custom self-service templates. diff --git a/downstream/modules/devtools/proc-self-service-download-tar.adoc b/downstream/modules/devtools/proc-self-service-download-tar.adoc index 5b8cabd127..f73f3bec2b 100644 --- a/downstream/modules/devtools/proc-self-service-download-tar.adoc +++ b/downstream/modules/devtools/proc-self-service-download-tar.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-download-tar_{context}"] -= Downloading the plug-in TAR files += Download the plug-in TAR files [role="_abstract"] Download the latest `.tar.gz` plug-in files for {SelfServiceShort} from the Red Hat Customer Portal. diff --git a/downstream/modules/devtools/proc-self-service-enable-oauth-external.adoc b/downstream/modules/devtools/proc-self-service-enable-oauth-external.adoc index d0f544a633..6b50cfcc78 100644 --- a/downstream/modules/devtools/proc-self-service-enable-oauth-external.adoc +++ b/downstream/modules/devtools/proc-self-service-enable-oauth-external.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-enable-oauth-external_{context}"] -= Enabling Oauth token creation for external users += Enable Oauth token creation for external users [role="_abstract"] {SelfServiceShortStart} uses {PlatformNameShort} or authentication and as an OAuth provider. diff --git a/downstream/modules/devtools/proc-self-service-install-disconnected-access-ocp.adoc b/downstream/modules/devtools/proc-self-service-install-disconnected-access-ocp.adoc index 5a301647a9..c6130598a1 100644 --- a/downstream/modules/devtools/proc-self-service-install-disconnected-access-ocp.adoc +++ b/downstream/modules/devtools/proc-self-service-install-disconnected-access-ocp.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-install-disconnected-access-ocp_{context}"] -= Accessing the disconnected OpenShift environment += Access the disconnected OpenShift environment [role="_abstract"] Ensure your disconnected OpenShift cluster is configured to trust the private registry containing the mirrored container images. This step is crucial for successful image pulling during installation. diff --git a/downstream/modules/devtools/proc-self-service-install-disconnected-define-parameters.adoc b/downstream/modules/devtools/proc-self-service-install-disconnected-define-parameters.adoc index e7215e5aa9..99b84e6ce3 100644 --- a/downstream/modules/devtools/proc-self-service-install-disconnected-define-parameters.adoc +++ b/downstream/modules/devtools/proc-self-service-install-disconnected-define-parameters.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-install-disconnected-define-parameters_{context}"] -= Defining Parameters and Navigate to Chart Location += Define parameters and navigate to chart location [role="_abstract"] Navigate to the transferred Helm chart directory on your jump box. Define environment variables for the installation namespace and cluster router base URL before beginning the installation. diff --git a/downstream/modules/devtools/proc-self-service-install-disconnected-download-helm.adoc b/downstream/modules/devtools/proc-self-service-install-disconnected-download-helm.adoc index 0239b7cb58..27434c8154 100644 --- a/downstream/modules/devtools/proc-self-service-install-disconnected-download-helm.adoc +++ b/downstream/modules/devtools/proc-self-service-install-disconnected-download-helm.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-install-disconnected-download-helm_{context}"] -= Downloading the helm chart package += Download the helm chart package [role="_abstract"] Download the Helm chart package and modify the internal image references to point to your disconnected registry. This prepares the installation package for the air-gapped environment. diff --git a/downstream/modules/devtools/proc-self-service-install-disconnected-installing-chart.adoc b/downstream/modules/devtools/proc-self-service-install-disconnected-installing-chart.adoc index 7ca2a5762e..be6ab816c0 100644 --- a/downstream/modules/devtools/proc-self-service-install-disconnected-installing-chart.adoc +++ b/downstream/modules/devtools/proc-self-service-install-disconnected-installing-chart.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-install-disconnected-installing-chart_{context}"] -= Installing the Helm chart += Install the Helm chart [role="_abstract"] Install the self-service automation portal by using the `helm install` command. You must reference the local Helm chart file and include the required cluster overrides using the `--set` flags. diff --git a/downstream/modules/devtools/proc-self-service-install-disconnected-mirror-images.adoc b/downstream/modules/devtools/proc-self-service-install-disconnected-mirror-images.adoc index 37fe232b25..1e42911eab 100644 --- a/downstream/modules/devtools/proc-self-service-install-disconnected-mirror-images.adoc +++ b/downstream/modules/devtools/proc-self-service-install-disconnected-mirror-images.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-install-disconnected-mirror-images_{context}"] -= Mirroring container images += Mirror container images [role="_abstract"] Mirror the required container images from the Red Hat registry to your local disconnected registry. This action prepares the images needed to install the self-service automation portal in an isolated environment. diff --git a/downstream/modules/devtools/proc-self-service-install-disconnected-transfer-assets.adoc b/downstream/modules/devtools/proc-self-service-install-disconnected-transfer-assets.adoc index 67f2310089..a9225318b0 100644 --- a/downstream/modules/devtools/proc-self-service-install-disconnected-transfer-assets.adoc +++ b/downstream/modules/devtools/proc-self-service-install-disconnected-transfer-assets.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-install-disconnected-transfer-assets_{context}"] -= Transferring assets to the disconnected environment += Transfer assets to the disconnected environment [role="_abstract"] Transfer the modified Helm chart package from the connected bastion host to a machine inside your disconnected network. This action stages the installation assets for deployment within the isolated OpenShift environment. diff --git a/downstream/modules/devtools/proc-self-service-install-disconnected-verify.adoc b/downstream/modules/devtools/proc-self-service-install-disconnected-verify.adoc index 39393e8b33..7734d48058 100644 --- a/downstream/modules/devtools/proc-self-service-install-disconnected-verify.adoc +++ b/downstream/modules/devtools/proc-self-service-install-disconnected-verify.adoc @@ -2,7 +2,7 @@ [id="self-service-install-disconnected-verify_{context}"] -= Verifying the disconnected installation += Verify the deployment [role="_abstract"] Verify the successful installation of the Helm chart in the disconnected environment. Check the Helm release status, monitor the pods, and verify that the application routes are accessible. diff --git a/downstream/modules/devtools/proc-self-service-install-helm-from-catalog.adoc b/downstream/modules/devtools/proc-self-service-install-helm-from-catalog.adoc index 42f4eec093..838d23cc89 100644 --- a/downstream/modules/devtools/proc-self-service-install-helm-from-catalog.adoc +++ b/downstream/modules/devtools/proc-self-service-install-helm-from-catalog.adoc @@ -1,10 +1,10 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-install-helm-from-catalog_{context}"] -= Configuring the {SelfServiceShort} Helm chart from the OpenShift catalog += Install the Helm chart [role="_abstract"] -Deploy the Helm chart from the OpenShift catalog by configuring the base URL and organization name in the YAML view. This launches the self-service automation portal installation. +Deploy the {SelfServiceShort} Helm chart from the OpenShift catalog by configuring the base URL and organization name in the YAML view. This launches the self-service automation portal installation. .Prerequisites * You have created a project for {SelfServiceShort} in {OCPShort}. diff --git a/downstream/modules/devtools/proc-self-service-launch-template.adoc b/downstream/modules/devtools/proc-self-service-launch-template.adoc index cb0f2fc698..f11e4fba43 100644 --- a/downstream/modules/devtools/proc-self-service-launch-template.adoc +++ b/downstream/modules/devtools/proc-self-service-launch-template.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-launch-template_{context}"] -= Launching a template += Launch a template [role="_abstract"] This procedure describes how to launch a template from a tile in the *Templates* view of your {SelfServiceShort} instance. diff --git a/downstream/modules/devtools/proc-self-service-select-org.adoc b/downstream/modules/devtools/proc-self-service-select-org.adoc index 6e7052d649..556d6e3ef3 100644 --- a/downstream/modules/devtools/proc-self-service-select-org.adoc +++ b/downstream/modules/devtools/proc-self-service-select-org.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-select-org_{context}"] -= Selecting an {PlatformNameShort} organization += Select an organization [role="_abstract"] You must choose an organization in {PlatformNameShort} to use with {SelfServiceShort}. diff --git a/downstream/modules/devtools/proc-self-service-set-up-rbac.adoc b/downstream/modules/devtools/proc-self-service-set-up-rbac.adoc index b1e88ab2b0..249c87a381 100644 --- a/downstream/modules/devtools/proc-self-service-set-up-rbac.adoc +++ b/downstream/modules/devtools/proc-self-service-set-up-rbac.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-set-up-rbac_{context}"] -= Setting up RBAC for custom self-service templates += Set up RBAC for custom self-service templates [role="_abstract"] By default, {PlatformNameShort} administrators can define {SelfServiceShort} RBAC roles. diff --git a/downstream/modules/devtools/proc-self-service-sign-in.adoc b/downstream/modules/devtools/proc-self-service-sign-in.adoc index 22adfebcc5..b1464df036 100644 --- a/downstream/modules/devtools/proc-self-service-sign-in.adoc +++ b/downstream/modules/devtools/proc-self-service-sign-in.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-sign-in_{context}"] -= Signing in to {SelfServiceShort} += Sign in to {SelfServiceShort} [role="_abstract"] Log in to the deployed self-service automation portal using your existing {PlatformNameShort} credentials. The portal uses these credentials for authentication. diff --git a/downstream/modules/devtools/proc-self-service-sync-frequency.adoc b/downstream/modules/devtools/proc-self-service-sync-frequency.adoc index 02e74dad73..b242a0aec2 100644 --- a/downstream/modules/devtools/proc-self-service-sync-frequency.adoc +++ b/downstream/modules/devtools/proc-self-service-sync-frequency.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-sync-frequency_{context}"] -= Adjusting synchronization frequency between {PlatformNameShort} and {SelfServiceShort} += Adjust synchronization frequency between {PlatformNameShort} and {SelfServiceShort} [role="_abstract"] The Helm chart defines how frequently users, diff --git a/downstream/modules/devtools/proc-self-service-templates-page.adoc b/downstream/modules/devtools/proc-self-service-templates-page.adoc index 2c506297a4..8ae89ed1d1 100644 --- a/downstream/modules/devtools/proc-self-service-templates-page.adoc +++ b/downstream/modules/devtools/proc-self-service-templates-page.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-templates-page_{context}"] -= Viewing templates += View templates [role="_abstract"] View your accessible automation templates, displayed as tiles, on the *Templates* landing page of the self-service automation portal console. diff --git a/downstream/modules/devtools/proc-self-service-templates-sync.adoc b/downstream/modules/devtools/proc-self-service-templates-sync.adoc index f1135fca90..4ffb4c3718 100644 --- a/downstream/modules/devtools/proc-self-service-templates-sync.adoc +++ b/downstream/modules/devtools/proc-self-service-templates-sync.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-templates-sync_{context}"] -= Synchronizing auto-generated templates += Synchronize auto-generated templates [role="_abstract"] The auto-generated self-service templates are synchronized from the job templates in {PlatformNameShort} to {SelfServiceShort}. diff --git a/downstream/modules/devtools/proc-self-service-update-helm.adoc b/downstream/modules/devtools/proc-self-service-update-helm.adoc index b74c452cc2..8b62221b7a 100644 --- a/downstream/modules/devtools/proc-self-service-update-helm.adoc +++ b/downstream/modules/devtools/proc-self-service-update-helm.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-update-helm_{context}"] -= Updating the {SelfServiceShort} version numbers for a Helm installation += Update the {SelfServiceShort} version numbers for a Helm installation [role="_abstract"] After you have updated your plug-in registry for your {SelfServiceShort} project on your {OCPShort} instance, diff --git a/downstream/modules/devtools/proc-self-service-update-registry.adoc b/downstream/modules/devtools/proc-self-service-update-registry.adoc index a66935e409..dcfd4e491c 100644 --- a/downstream/modules/devtools/proc-self-service-update-registry.adoc +++ b/downstream/modules/devtools/proc-self-service-update-registry.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-update-registry_{context}"] -= Updating the plug-in registry += Update the plug-in registry [role="_abstract"] To update the plug-in registry, you must upload your plug-in files to OpenShift, diff --git a/downstream/modules/devtools/proc-self-service-verify-rbac.adoc b/downstream/modules/devtools/proc-self-service-verify-rbac.adoc index 709487ff3c..321b4d1ad5 100644 --- a/downstream/modules/devtools/proc-self-service-verify-rbac.adoc +++ b/downstream/modules/devtools/proc-self-service-verify-rbac.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-verify-rbac_{context}"] -= Verifying RBAC += Verify RBAC [role="_abstract"] This procedure describes how to verify that the role you set up is working correctly. diff --git a/downstream/modules/devtools/proc-self-service-view-deployment-logs.adoc b/downstream/modules/devtools/proc-self-service-view-deployment-logs.adoc index ca735450cb..71720353f8 100644 --- a/downstream/modules/devtools/proc-self-service-view-deployment-logs.adoc +++ b/downstream/modules/devtools/proc-self-service-view-deployment-logs.adoc @@ -1,10 +1,10 @@ :_mod-docs-content-type: PROCEDURE [id="self-service-view-deployment-logs_{context}"] -= Viewing the deployment logs += View the deployment logs -[role="_abstract"] -You can view the deployment logs in the OpenShift console. Pay close attention to the install-dynamic-plugins container logs. This helps confirm that the required plug-ins installed successfully. +[role="_abstdeploymentract"] +You can view the logs in the OpenShift console. Pay close attention to the install-dynamic-plugins container logs. This helps confirm that the required plug-ins installed successfully. .Procedure diff --git a/downstream/modules/devtools/proc-understand-automation-with-assistant.adoc b/downstream/modules/devtools/proc-understand-automation-with-assistant.adoc new file mode 100644 index 0000000000..6e651d153d --- /dev/null +++ b/downstream/modules/devtools/proc-understand-automation-with-assistant.adoc @@ -0,0 +1,20 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-21 +:_mod-docs-content-type: PROCEDURE + +[id="understand-automation-with-assistant_{context}"] += Understand your existing automation with the AI assistant + +[role="_abstract"] +If you are working with an existing playbook and need to understand its components, you can ask the assistant to analyze the file. + +.Procedure +. Open the playbook you want to investigate in the {VSCode} editor. +. In the Copilot chat window, enter a prompt instructing the AI assistant to analyze dependencies. For example: +* _Analyze my web server playbook and tell me which Ansible collections are being used_. ++ +The assistant then analyzes the playbook content and identifies: + +* Which collections are required. +* Which modules are used within the tasks. +* Whether automations are referenced with Fully Qualified Collection Names (FQCN). diff --git a/downstream/modules/devtools/proc-understand-env-with-assistant.adoc b/downstream/modules/devtools/proc-understand-env-with-assistant.adoc new file mode 100644 index 0000000000..6559d522c0 --- /dev/null +++ b/downstream/modules/devtools/proc-understand-env-with-assistant.adoc @@ -0,0 +1,23 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-21 +:_mod-docs-content-type: PROCEDURE + +[id="understand-env-with-assistant_{context}"] += Understand your local environment with the AI asistant + +[role="_abstract"] +You can ask the AI assistant to list the automations (collections and tools) available in your local environment. This way, you can verify which tools are available to you before starting development. + +.Procedure +. In the GitHub Copilot chat window, enter a natural language prompt to check the environment. For example: +* _Check my Ansible environment and tell me what's installed._ +* _What collections are installed?_ ++ +The assistant then triggers the `ade_environment_info` tool. ++ +. Review the output, which displays: +.. Ansible version +.. `ansible_lint` version +.. Installed collections +.. Python environment details + diff --git a/downstream/modules/devtools/proc-validate-content-with-assistant.adoc b/downstream/modules/devtools/proc-validate-content-with-assistant.adoc new file mode 100644 index 0000000000..56412a6b10 --- /dev/null +++ b/downstream/modules/devtools/proc-validate-content-with-assistant.adoc @@ -0,0 +1,25 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-21 +:_mod-docs-content-type: PROCEDURE + +[id="validate-content-with-assistant_{context}"] += Validate content with the AI assistant + +[role="_abstract"] +Ask the AI assistant to analyze the current playbook without modifying it. This identifies specific rule violations and potential errors. +If errors are found, `ansible_lint` has autofix functionality, enabling it to suggest changes, and, with your permission, implement those changes in your code. + +.Procedure +. Open the playbook file in the {VSCode} editor. +. Open the Copilot chat window. +. In the chat window, enter a natural language prompt such as: +* _Validate my webserver playbook to check for any issues_. ++ +This triggers the `ansible-lint` tool in check-only mode. The assistant displays a list of the issues it found, including Rule IDs, line numbers, and descriptions of the errors (for example, missing FQCN, or YAML formatting issues). ++ +The assistant will ask "_Would you like ansible-lint to apply automatic fixes?_” You must grant the AI assistant permission to make any changes to your code. ++ +. Enter “yes” or “no” depending on whether you want the assistant to apply the suggested changes. +. Select the option to *allow* or *skip* to grant the assistant permission to make changes. +.. If you select *allow*, the AI assistant will update your code. +.. If you select *skip*, the AI assistant will output a list of issues and the suggested fix for each. \ No newline at end of file diff --git a/downstream/modules/devtools/proc-validate-ee-with-assistant.adoc b/downstream/modules/devtools/proc-validate-ee-with-assistant.adoc new file mode 100644 index 0000000000..51a546fb53 --- /dev/null +++ b/downstream/modules/devtools/proc-validate-ee-with-assistant.adoc @@ -0,0 +1,21 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-21 +:_mod-docs-content-type: PROCEDURE + +[id="validate-ee-with-assistant_{context}"] += Validate an {ExecEnvShort} definition file using the AI assistant + +[role="_abstract"] +You can use the AI assistant to validate an existing {ExecEnvShort} definition file against the schema and Ansible best practices. + +.Prerequisites +* The `execution-environment.yml` file is open in the editor. +* Copilot chat is active. + +.Procedure +. Prompt the assistant to validate your {ExecEnvShort} definition file. For example: +* _Check if my `execution-environment.yaml` file is valid and follows best practices_. ++ +The assistant then analyzes the file structure against the {ExecEnvShort} v3 schema and rules. It verifies required sections (for example, version, images, dependencies) and identifies missing fields or incorrect formatting. ++ +. Review the assessment to confirm that it includes your requirements. diff --git a/downstream/modules/devtools/proc-view-best-practices-for-content.adoc b/downstream/modules/devtools/proc-view-best-practices-for-content.adoc new file mode 100644 index 0000000000..3e68bb52d1 --- /dev/null +++ b/downstream/modules/devtools/proc-view-best-practices-for-content.adoc @@ -0,0 +1,23 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-01-21 +:_mod-docs-content-type: PROCEDURE + +[id="view-best-practices-for-content_{context}"] += Generate and view best practices for creating Ansible content + +[role="_abstract"] +Before starting to create content, use the MCP server-enabled Ansible {VSCode} extension to generate and view Ansible best practices and coding guidelines. + +.Procedure +. Open the Copilot chat window by clicking the GitHub Copilot icon in the {VSCode} sidebar. +. Enter a natural language prompt requesting Ansible best practices. For example: + +* _Show me Ansible best practices and coding guidelines so that I can write high-quality playbooks._ ++ +This triggers the `ansible_content_best_practices` tool, which displays the guidelines for you to read within the editor. ++ +. Enter a prompt requesting The Zen of Ansible. For example: + +* _Show me the Zen of Ansible_ ++ +This triggers the `zen_of_ansible` tool, which will list Zen of Ansible principles for you to read within the editor. diff --git a/downstream/modules/devtools/proc-workspaces-delete.adoc b/downstream/modules/devtools/proc-workspaces-delete.adoc index 9f0e0b4aaa..a5cb0b69ce 100644 --- a/downstream/modules/devtools/proc-workspaces-delete.adoc +++ b/downstream/modules/devtools/proc-workspaces-delete.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="workspaces-delete_{context}"] -= Deleting an {AnsibleWorkspaceSing} += Delete an {AnsibleWorkspaceSing} [role="_abstract"] To delete the contents of an {AnsibleWorkspaceSing}, you delete the workspace itself. diff --git a/downstream/modules/devtools/proc_implementing-automation-content-for-ephemeral-mcp-agents.adoc b/downstream/modules/devtools/proc_implementing-automation-content-for-ephemeral-mcp-agents.adoc index 7a67342d0b..190fa9c3e1 100644 --- a/downstream/modules/devtools/proc_implementing-automation-content-for-ephemeral-mcp-agents.adoc +++ b/downstream/modules/devtools/proc_implementing-automation-content-for-ephemeral-mcp-agents.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="implementing-automation-content-for-ephemeral-mcp-agents_{context}"] -= Implementing automation content for ephemeral MCP agents += Implement automation content for ephemeral MCP agents [role="_abstract"] You can create an Ansible playbook leveraging the Execution Environment (EE) setup so that ephemeral MCP servers are provisioned during Ansible Automation Platform (AAP) controller job creation. This way you can safely use AI as an operational assistant, which can take assigned actions in your enterprise platform. diff --git a/downstream/modules/devtools/ref-devtools-custom-backstage-actions.adoc b/downstream/modules/devtools/ref-devtools-custom-backstage-actions.adoc index 61b8ac2fc0..a33116ffe5 100644 --- a/downstream/modules/devtools/ref-devtools-custom-backstage-actions.adoc +++ b/downstream/modules/devtools/ref-devtools-custom-backstage-actions.adoc @@ -2,7 +2,7 @@ [id="devtools-ansible-backstage-actions_{context}"] -= Custom backstage actions += Custom Backstage actions [role="_abstract"] The following actions enable you to manage {PlatformNameShort} resources within a software template workflow. diff --git a/downstream/modules/devtools/ref-devtools-custom-filters.adoc b/downstream/modules/devtools/ref-devtools-custom-filters.adoc index 46fcd7abd4..6fe676b8a1 100644 --- a/downstream/modules/devtools/ref-devtools-custom-filters.adoc +++ b/downstream/modules/devtools/ref-devtools-custom-filters.adoc @@ -13,9 +13,9 @@ The plugins provide custom filters to extract specific properties from resource |`resourceFilter` |Extracts a single, specific property from a resource object. -|`$!{{ parameters.organization | resourceFilter('name') }}` +|`$!{{ parameters.organization \| resourceFilter('name') }}` |`multiResourceFilter` |Extracts a specific property from multiple resource objects (when the input is an array). -|`$!{{ parameters.organization | multiResourceFilter('name') }}` +|`$!{{ parameters.organization \| multiResourceFilter('name') }}` |=== diff --git a/downstream/modules/devtools/ref-rhdh-discover-collections.adoc b/downstream/modules/devtools/ref-rhdh-discover-collections.adoc index de9652d819..ca3d298dd4 100644 --- a/downstream/modules/devtools/ref-rhdh-discover-collections.adoc +++ b/downstream/modules/devtools/ref-rhdh-discover-collections.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: REFERENCE [id="rhdh-discover-collections_{context}"] -= Discovering existing collections += Discover existing collections [role="_abstract"] From the *Overview* page in the Ansible plug-ins dashboard on {RHDH}, click *Discover Existing Collections*. diff --git a/downstream/modules/devtools/ref-rhdh-full-aap-configmap-example.adoc b/downstream/modules/devtools/ref-rhdh-full-aap-configmap-example.adoc index 25882dba08..9a22314be3 100644 --- a/downstream/modules/devtools/ref-rhdh-full-aap-configmap-example.adoc +++ b/downstream/modules/devtools/ref-rhdh-full-aap-configmap-example.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: REFERENCE [id="rhdh-full-aap-configmap-example_{context}"] -= Full app-config-rhdh ConfigMap example for Ansible plug-ins entries += app-config-rhdh ConfigMap example for Ansible plug-ins [role="_abstract"] This example details necessary settings like the creatorService URL, optional integrations for {PlatformNameShort} and OpenShift Dev Spaces, and the addition of Ansible software templates to the catalog. diff --git a/downstream/modules/devtools/ref-rhdh-learning.adoc b/downstream/modules/devtools/ref-rhdh-learning.adoc index 5108764342..6f7e0f4f49 100644 --- a/downstream/modules/devtools/ref-rhdh-learning.adoc +++ b/downstream/modules/devtools/ref-rhdh-learning.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: REFERENCE [id="rhdh-learning_{context}"] -= Learning about Ansible += Access learning paths, labs, and collections [role="_abstract"] To learn more about getting started with automation, click *Learn* from the *Overview* page of the plug-in dashboard. diff --git a/downstream/modules/eda/con-characterizing-your-workload.adoc b/downstream/modules/eda/con-characterizing-your-workload.adoc index ff4701eb3e..0daeec63ae 100644 --- a/downstream/modules/eda/con-characterizing-your-workload.adoc +++ b/downstream/modules/eda/con-characterizing-your-workload.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="characterizing-your-workload"] -= Characterizing your workload += Characterize your workload [role="_abstract"] Characterize your workload by quantifying event ingestion rate and concurrent rulebook activations to effectively optimize performance and capacity. diff --git a/downstream/modules/eda/con-custom-credential-types.adoc b/downstream/modules/eda/con-custom-credential-types.adoc index fb14ade9e0..d0e31d828e 100644 --- a/downstream/modules/eda/con-custom-credential-types.adoc +++ b/downstream/modules/eda/con-custom-credential-types.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: [id="eda-custom-credential-types"] -= Custom credential types += Create custom credentials for {EDAName} [role="_abstract"] Create custom credential types (via JSON/YAML) to define unique security fields and logic, enabling support for proprietary event sources or specialized authentication. diff --git a/downstream/modules/eda/con-replacing-controller-tokens.adoc b/downstream/modules/eda/con-replacing-controller-tokens.adoc index dc5dfad43e..3c10788c4d 100644 --- a/downstream/modules/eda/con-replacing-controller-tokens.adoc +++ b/downstream/modules/eda/con-replacing-controller-tokens.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="replacing-controller-tokens"] -= Replacing controller tokens in {PlatformName} {PlatformVers} += Replace controller tokens in {PlatformName} {PlatformVers} [role="_abstract"] To use {EDAcontroller} in {PlatformName} {PlatformVers}, you must replace legacy controller tokens configured in your environment with {PlatformName} credentials because controller tokens have been deprecated. \ No newline at end of file diff --git a/downstream/modules/eda/proc-eda-activate-webhook.adoc b/downstream/modules/eda/proc-eda-activate-webhook.adoc index e7e064da96..62261d239d 100644 --- a/downstream/modules/eda/proc-eda-activate-webhook.adoc +++ b/downstream/modules/eda/proc-eda-activate-webhook.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-activate-webhook"] -= Activating webhook rulebooks += Activate webhook-based automation in Openshift [role="_abstract"] In Openshift environments, you can activate webhooks by creating a route to expose the activation's service, enabling external systems to send events and trigger automation. @@ -76,3 +76,4 @@ test-sync-bug-dynatrace.apps.aap-dt.ocp4.testing.ansible.com -d ----- +An \ No newline at end of file diff --git a/downstream/modules/eda/proc-eda-activation-keeps-restarting.adoc b/downstream/modules/eda/proc-eda-activation-keeps-restarting.adoc index b668679ab6..bca754bab9 100644 --- a/downstream/modules/eda/proc-eda-activation-keeps-restarting.adoc +++ b/downstream/modules/eda/proc-eda-activation-keeps-restarting.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-activation-keeps-restarting"] -= Activation keeps restarting += Fix rulebook activations stuck in a restart loop [role="_abstract"] Troubleshoot rulebook activations that restart repeatedly (indicating persistent errors) to diagnose and fix core issues preventing stable, continuous automation execution. diff --git a/downstream/modules/eda/proc-eda-activation-not-processing-event.adoc b/downstream/modules/eda/proc-eda-activation-not-processing-event.adoc index 1f2b27b37b..d60cdc8912 100644 --- a/downstream/modules/eda/proc-eda-activation-not-processing-event.adoc +++ b/downstream/modules/eda/proc-eda-activation-not-processing-event.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-activation-not-processing-event"] -= Events are not being processed by rulebook activation += Resolve event processing failures in rulebook activations [role="_abstract"] Troubleshoot why a running rulebook activation is failing to process events, focusing on common causes like source definition mismatches or internal processing errors. diff --git a/downstream/modules/eda/proc-eda-activation-receives-events-no-actions.adoc b/downstream/modules/eda/proc-eda-activation-receives-events-no-actions.adoc index 99059479f6..8c6a35fcb6 100644 --- a/downstream/modules/eda/proc-eda-activation-receives-events-no-actions.adoc +++ b/downstream/modules/eda/proc-eda-activation-receives-events-no-actions.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-activation-receives-events-no-actions"] -= Actions not triggering despite receiving events += Troubleshoot actions that fail to trigger after receiving events [role="_abstract"] If your rulebook activation is *Running* and successfully receiving events, but no actions are being executed, the issue is likely within the logic of your rulebook. diff --git a/downstream/modules/eda/proc-eda-activation-stuck-pending.adoc b/downstream/modules/eda/proc-eda-activation-stuck-pending.adoc index 5cf3a65661..3999d85964 100644 --- a/downstream/modules/eda/proc-eda-activation-stuck-pending.adoc +++ b/downstream/modules/eda/proc-eda-activation-stuck-pending.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-activation-stuck-pending"] -= Activation stuck in Pending state += Resolve rulebook activations stuck in pending state [role="_abstract"] Diagnose and resolve issues preventing a rulebook activation from transitioning from Pending to a running, operational state. diff --git a/downstream/modules/eda/proc-eda-build-a-custom-decision-environment.adoc b/downstream/modules/eda/proc-eda-build-a-custom-decision-environment.adoc index a643ed99e6..352fb14aaa 100644 --- a/downstream/modules/eda/proc-eda-build-a-custom-decision-environment.adoc +++ b/downstream/modules/eda/proc-eda-build-a-custom-decision-environment.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-build-a-custom-decision-environment"] -= Building a custom decision environment for {EDAName} += Build a custom decision environment for {EDAName} [role="_abstract"] Customize a decision environment container image to ensure your rulebook activations run with the precise, custom-maintained collections and dependencies they require. diff --git a/downstream/modules/eda/proc-eda-config-remote-sys-to-events.adoc b/downstream/modules/eda/proc-eda-config-remote-sys-to-events.adoc index 89777e42d6..10c35cd88c 100644 --- a/downstream/modules/eda/proc-eda-config-remote-sys-to-events.adoc +++ b/downstream/modules/eda/proc-eda-config-remote-sys-to-events.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-config-remote-sys-to-events"] -= Configuring your remote system to send events += Configure your remote system to send events [role="_abstract"] After you have created your event stream, you must configure your remote system to send events to {EDAcontroller}. The method used for this configuration varies, depending on the vendor for the event stream credential type you select. diff --git a/downstream/modules/eda/proc-eda-copy-rulebook-activation.adoc b/downstream/modules/eda/proc-eda-copy-rulebook-activation.adoc index 8b974a97ee..a51bb46123 100644 --- a/downstream/modules/eda/proc-eda-copy-rulebook-activation.adoc +++ b/downstream/modules/eda/proc-eda-copy-rulebook-activation.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-copy-rulebook-activation"] -= Duplicating a rulebook activation += Duplicate a rulebook activation [role="_abstract"] When setting up a new rulebook activation with field inputs that are similar to one of your existing rulebook activations, you can use the *Duplicate rulebook activation* feature instead of manually entering input into each field. diff --git a/downstream/modules/eda/proc-eda-create-event-stream-credential.adoc b/downstream/modules/eda/proc-eda-create-event-stream-credential.adoc index 6ea0174332..bd7d49f292 100644 --- a/downstream/modules/eda/proc-eda-create-event-stream-credential.adoc +++ b/downstream/modules/eda/proc-eda-create-event-stream-credential.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-create-event-stream-credential"] -= Creating an event stream credential += Create an event stream credential [role="_abstract"] Create a credential to establish the authentication mechanism (like basic auth or HMAC) required for external systems to securely send events to an event stream. diff --git a/downstream/modules/eda/proc-eda-create-event-stream.adoc b/downstream/modules/eda/proc-eda-create-event-stream.adoc index 4de00c2f53..30c392f1be 100644 --- a/downstream/modules/eda/proc-eda-create-event-stream.adoc +++ b/downstream/modules/eda/proc-eda-create-event-stream.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-create-event-stream"] -= Creating an event stream += Create an event stream [role="_abstract"] Create a dedicated stream endpoint to simplify how external systems send events, making it easier to route data to multiple rulebook activations. diff --git a/downstream/modules/eda/proc-eda-delete-controller-token.adoc b/downstream/modules/eda/proc-eda-delete-controller-token.adoc index ab0ac04547..c7e496e5ed 100644 --- a/downstream/modules/eda/proc-eda-delete-controller-token.adoc +++ b/downstream/modules/eda/proc-eda-delete-controller-token.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-delete-controller-token"] -= Deleting controller tokens += Delete controller tokens [role="_abstract"] Before configuring the new {PlatformName} credentials, delete all existing controller tokens, which are now deprecated and will conflict with the new {PlatformName} credentials. diff --git a/downstream/modules/eda/proc-eda-delete-credential.adoc b/downstream/modules/eda/proc-eda-delete-credential.adoc index 5d0d1894cb..a9ffe8c5c1 100644 --- a/downstream/modules/eda/proc-eda-delete-credential.adoc +++ b/downstream/modules/eda/proc-eda-delete-credential.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-delete-credential"] -= Deleting a credential += Delete a credential [role="_abstract"] You can permanently delete unused credentials. You must first ensure they are detached from any event stream before the deletion process can be completed. diff --git a/downstream/modules/eda/proc-eda-delete-project.adoc b/downstream/modules/eda/proc-eda-delete-project.adoc index ea2309ad18..27b48de2db 100644 --- a/downstream/modules/eda/proc-eda-delete-project.adoc +++ b/downstream/modules/eda/proc-eda-delete-project.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-delete-project"] -= Deleting a project += Delete a project [role="_abstract"] Use the {Gateway} interface to delete a project that is no longer required from {EDAcontroller}. diff --git a/downstream/modules/eda/proc-eda-delete-rulebook-activations-with-cont-tokens.adoc b/downstream/modules/eda/proc-eda-delete-rulebook-activations-with-cont-tokens.adoc index b9efeaaf76..78fba9d27a 100644 --- a/downstream/modules/eda/proc-eda-delete-rulebook-activations-with-cont-tokens.adoc +++ b/downstream/modules/eda/proc-eda-delete-rulebook-activations-with-cont-tokens.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-delete-rulebook-activations-with-cont-tokens"] -= Deleting rulebook activations with controller tokens += Delete rulebook activations with controller tokens [role="_abstract"] Delete rulebook activations that rely on deprecated controller tokens. This mandatory step prevents conflicts before migrating to the new, required {PlatformName} credentials. diff --git a/downstream/modules/eda/proc-eda-delete-rulebook-activations.adoc b/downstream/modules/eda/proc-eda-delete-rulebook-activations.adoc index 7fc25b1762..adfc8bab75 100644 --- a/downstream/modules/eda/proc-eda-delete-rulebook-activations.adoc +++ b/downstream/modules/eda/proc-eda-delete-rulebook-activations.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-delete-rulebook-activations"] -= Deleting rulebook activations += Delete rulebook activations [role="_abstract"] End and permanently remove a rulebook activation and its configuration when its automated event-driven workflow is no longer required. diff --git a/downstream/modules/eda/proc-eda-duplicate-credential.adoc b/downstream/modules/eda/proc-eda-duplicate-credential.adoc index 7f6cd1ff44..1c020b953e 100644 --- a/downstream/modules/eda/proc-eda-duplicate-credential.adoc +++ b/downstream/modules/eda/proc-eda-duplicate-credential.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-duplicate-credential"] -= Duplicating a credential += Duplicate a credential [role="_abstract"] Use the *Duplicate credential* feature to rapidly generate a new credential based on an existing one, saving configuration time and reducing potential errors. diff --git a/downstream/modules/eda/proc-eda-edit-credential.adoc b/downstream/modules/eda/proc-eda-edit-credential.adoc index 92f350eb25..3590799dbb 100644 --- a/downstream/modules/eda/proc-eda-edit-credential.adoc +++ b/downstream/modules/eda/proc-eda-edit-credential.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-edit-credential"] -= Editing a credential += Edit a credential [role="_abstract"] Edit credentials to update expired tokens, rotate secrets, or adjust permissions, ensuring secure and continuous access to external systems. diff --git a/downstream/modules/eda/proc-eda-editing-a-project.adoc b/downstream/modules/eda/proc-eda-editing-a-project.adoc index 625eec3c09..dfa645d2d9 100644 --- a/downstream/modules/eda/proc-eda-editing-a-project.adoc +++ b/downstream/modules/eda/proc-eda-editing-a-project.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-editing-a-project"] -= Editing a project += Edit a project [role="_abstract"] Edit project details (like the source repository URL or credential) to manage where Event-Driven Ansible fetches its rulebooks from and how it authenticates. diff --git a/downstream/modules/eda/proc-eda-enable-rulebook-activations.adoc b/downstream/modules/eda/proc-eda-enable-rulebook-activations.adoc index 4f6cb8eebb..82c196762c 100644 --- a/downstream/modules/eda/proc-eda-enable-rulebook-activations.adoc +++ b/downstream/modules/eda/proc-eda-enable-rulebook-activations.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-enable-rulebook-activations"] -= Enabling and disabling rulebook activations += Enable and disable rulebook activations [role="_abstract"] Toggle the state of an activation to start or stop event processing instantly, allowing for temporary pauses, maintenance, or troubleshooting without deletion. diff --git a/downstream/modules/eda/proc-eda-event-streams-not-sending-events.adoc b/downstream/modules/eda/proc-eda-event-streams-not-sending-events.adoc index 8d4deab630..1a71062bf0 100644 --- a/downstream/modules/eda/proc-eda-event-streams-not-sending-events.adoc +++ b/downstream/modules/eda/proc-eda-event-streams-not-sending-events.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-event-streams-not-sending-events"] -= Event streams not sending events to activation += Troubleshoot event streams that fail to send events [role="_abstract"] Diagnose issues where an event stream is receiving data but failing to forward it, ensuring proper connectivity and correct credential setup. diff --git a/downstream/modules/eda/proc-eda-replace-sources-with-event-streams.adoc b/downstream/modules/eda/proc-eda-replace-sources-with-event-streams.adoc index f80967375e..f70aa9e4d1 100644 --- a/downstream/modules/eda/proc-eda-replace-sources-with-event-streams.adoc +++ b/downstream/modules/eda/proc-eda-replace-sources-with-event-streams.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-replace-sources-with-event-streams"] -= Replacing sources and attaching event streams to activations += Replace sources and attach event streams to activations [role="_abstract"] Replace complex source mappings with pre-configured event streams to simplify rulebook activation design and centralize incoming event routing. diff --git a/downstream/modules/eda/proc-eda-restart-rulebook-activations.adoc b/downstream/modules/eda/proc-eda-restart-rulebook-activations.adoc index b61382c920..771b1eb315 100644 --- a/downstream/modules/eda/proc-eda-restart-rulebook-activations.adoc +++ b/downstream/modules/eda/proc-eda-restart-rulebook-activations.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-restart-rulebook-activations"] -= Restarting rulebook activations += Restart rulebook activations [role="_abstract"] Restart an activation to immediately apply configuration changes, update rulebook content, or quickly recover from unexpected failures. diff --git a/downstream/modules/eda/proc-eda-set-up-credential-types.adoc b/downstream/modules/eda/proc-eda-set-up-credential-types.adoc index 413f80015a..ae741ef49e 100644 --- a/downstream/modules/eda/proc-eda-set-up-credential-types.adoc +++ b/downstream/modules/eda/proc-eda-set-up-credential-types.adoc @@ -2,7 +2,7 @@ [id="eda-set-up-new-credential-types"] -= Creating a new credential type += Create a new credential type [role="_abstract"] Build a reusable credential type template to enforce consistent input fields and authentication mechanisms for custom integrations across your organization. diff --git a/downstream/modules/eda/proc-eda-set-up-credential.adoc b/downstream/modules/eda/proc-eda-set-up-credential.adoc index df6df1e12d..04dfba1be2 100644 --- a/downstream/modules/eda/proc-eda-set-up-credential.adoc +++ b/downstream/modules/eda/proc-eda-set-up-credential.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-set-up-credential"] -= Setting up credentials += Set up credentials [role="_abstract"] Create a credential to securely store sensitive data (like tokens and passwords) required for rulebook activations to connect to source plugins or private registries. diff --git a/downstream/modules/eda/proc-eda-set-up-new-project.adoc b/downstream/modules/eda/proc-eda-set-up-new-project.adoc index 155a290203..3f334285ab 100644 --- a/downstream/modules/eda/proc-eda-set-up-new-project.adoc +++ b/downstream/modules/eda/proc-eda-set-up-new-project.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-set-up-new-project"] -= Setting up a new project += Set up a new project [role="_abstract"] Set up a project to connect {EDAcontroller} to a Git repository, enabling it to pull, sync, and manage the rulebooks used by your automation. diff --git a/downstream/modules/eda/proc-eda-test-with-K8s.adoc b/downstream/modules/eda/proc-eda-test-with-K8s.adoc index 91cd5d4d7b..2fa5b94dc7 100644 --- a/downstream/modules/eda/proc-eda-test-with-K8s.adoc +++ b/downstream/modules/eda/proc-eda-test-with-K8s.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-test-with-K8s"] -= Testing with Kubernetes += Testing with OpenShift (Kubernetes) [role="_abstract"] Configure Kubernetes networking (for example, Ingress) to temporarily expose activation webhooks for non-production testing and debugging. diff --git a/downstream/modules/eda/proc-eda-update-static-UUID-API.adoc b/downstream/modules/eda/proc-eda-update-static-UUID-API.adoc index 8e55c6100a..f5bdfffcf9 100644 --- a/downstream/modules/eda/proc-eda-update-static-UUID-API.adoc +++ b/downstream/modules/eda/proc-eda-update-static-UUID-API.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-update-static-UUID-API"] -= Updating an event stream with a static UUID (API Method) += Update an event stream with a static UUID (API Method) [role="_abstract"] Access the API to set a static UUID, a feature critical for maintaining webhook URL consistency across service recreations, such as in disaster recovery scenarios. diff --git a/downstream/modules/eda/proc-eda-using-log-filtering.adoc b/downstream/modules/eda/proc-eda-using-log-filtering.adoc index 46e537ffb8..495592e9ee 100644 --- a/downstream/modules/eda/proc-eda-using-log-filtering.adoc +++ b/downstream/modules/eda/proc-eda-using-log-filtering.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-using-log-filtering"] -= Using log filtering for troubleshooting += Use log filtering for troubleshooting [role="_abstract"] Learn to filter logs using specialized tracking identifiers for efficient troubleshooting of activation issues and API request lifecycles. diff --git a/downstream/modules/eda/proc-eda-verify-event-streams-work.adoc b/downstream/modules/eda/proc-eda-verify-event-streams-work.adoc index 16f43a49ef..9a5610f98a 100644 --- a/downstream/modules/eda/proc-eda-verify-event-streams-work.adoc +++ b/downstream/modules/eda/proc-eda-verify-event-streams-work.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-verify-event-streams"] -= Verifying your event streams work += Verify your event streams work [role="_abstract"] Confirm end-to-end event flow by verifying the event stream receives data from the remote system, validating the webhook URL and authentication setup. diff --git a/downstream/modules/eda/proc-eda-view-activation-output.adoc b/downstream/modules/eda/proc-eda-view-activation-output.adoc index 01736018cb..49b460c3e8 100644 --- a/downstream/modules/eda/proc-eda-view-activation-output.adoc +++ b/downstream/modules/eda/proc-eda-view-activation-output.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-view-activations-output"] -= Viewing activation output += View activation output [role="_abstract"] View the activation output in the History tab to inspect the execution results, confirm successful automation runs, and diagnose runtime errors or task failures. diff --git a/downstream/modules/eda/proc-eda-view-rule-audit-actions.adoc b/downstream/modules/eda/proc-eda-view-rule-audit-actions.adoc index 74377adfe0..365b4d5dca 100644 --- a/downstream/modules/eda/proc-eda-view-rule-audit-actions.adoc +++ b/downstream/modules/eda/proc-eda-view-rule-audit-actions.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-view-rule-audit-actions"] -= Viewing rule audit actions += View rule audit actions [role="_abstract"] Review the output of executed actions within a triggered rule to confirm that the desired automated response was initiated and completed successfully. diff --git a/downstream/modules/eda/proc-eda-view-rule-audit-details.adoc b/downstream/modules/eda/proc-eda-view-rule-audit-details.adoc index 4103377553..b5f77d1e26 100644 --- a/downstream/modules/eda/proc-eda-view-rule-audit-details.adoc +++ b/downstream/modules/eda/proc-eda-view-rule-audit-details.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-view-rule-audit-details"] -= Viewing rule audit details += View rule audit details [role="_abstract"] View the rule audit details to quickly identify the rulebook activation responsible, the event that matched the condition, and the overall execution history of the rule. diff --git a/downstream/modules/eda/proc-eda-view-rule-audit-events.adoc b/downstream/modules/eda/proc-eda-view-rule-audit-events.adoc index 7d6e34edc3..0c60893ccf 100644 --- a/downstream/modules/eda/proc-eda-view-rule-audit-events.adoc +++ b/downstream/modules/eda/proc-eda-view-rule-audit-events.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="eda-view-rule-audit-events"] -= Viewing rule audit events += View rule audit events [role="_abstract"] Review a rule's event history to inspect the payload, source type, and timestamp of the raw event data that matched the condition and triggered the rule. diff --git a/downstream/modules/eda/proc-modifying-memory-during-or-after-install.adoc b/downstream/modules/eda/proc-modifying-memory-during-or-after-install.adoc index 613a3dfa1c..096d865d7a 100644 --- a/downstream/modules/eda/proc-modifying-memory-during-or-after-install.adoc +++ b/downstream/modules/eda/proc-modifying-memory-during-or-after-install.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="modifying-memory-during-or-after-install"] -= Modifying the default memory limit for each rulebook activation += Modify the default memory limit for each rulebook activation [role="_abstract"] Memory usage is based on the number of events that {EDAcontroller} has to process. By default, each rulebook activation container has a 200 MB memory limit. diff --git a/downstream/modules/eda/ref-eda-logging-samples.adoc b/downstream/modules/eda/ref-eda-logging-samples.adoc index 89bbb885c1..238c040af5 100644 --- a/downstream/modules/eda/ref-eda-logging-samples.adoc +++ b/downstream/modules/eda/ref-eda-logging-samples.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: REFERENCE [id="eda-logging-samples"] -= Logging samples += Log samples [role="_abstract"] Review logging samples for various API operations (CRUD, sync, and the like) to understand the expected audit format and efficiently monitor resource changes. diff --git a/downstream/modules/hub/con-token-management-hub.adoc b/downstream/modules/hub/con-token-management-hub.adoc index 18e5ed3dd0..16b0c3f1a7 100644 --- a/downstream/modules/hub/con-token-management-hub.adoc +++ b/downstream/modules/hub/con-token-management-hub.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: CONCEPT [id="token-management-hub_{context}"] -= Token management in {HubName} += Configure automation hub tokens [role="_abstract"] You must create an API token before you can upload or download collections. The {HubName} API token authenticates your `ansible-galaxy` client to the Red Hat {HubName} server. diff --git a/downstream/modules/hub/proc-add-container-readme.adoc b/downstream/modules/hub/proc-add-container-readme.adoc index 5a5ddb85c2..574eb05328 100644 --- a/downstream/modules/hub/proc-add-container-readme.adoc +++ b/downstream/modules/hub/proc-add-container-readme.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="adding-readme-container-repo"] -= Adding a README to your container repository += Add a README to your container repository [role="_abstract"] diff --git a/downstream/modules/hub/proc-add-group-to-container-repo.adoc b/downstream/modules/hub/proc-add-group-to-container-repo.adoc index 13fd18455c..cda7af3053 100644 --- a/downstream/modules/hub/proc-add-group-to-container-repo.adoc +++ b/downstream/modules/hub/proc-add-group-to-container-repo.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="providing-access-to-containers"] -= Providing access to your {ExecEnvName} += Provide access to your {ExecEnvName} [role="_abstract"] Provide users with access to your {ExecEnvName} by adding them to a team. Then, modify the permissions the team can have to a particular {ExecEnvShort}. diff --git a/downstream/modules/hub/proc-adding-an-execution-environment.adoc b/downstream/modules/hub/proc-adding-an-execution-environment.adoc index 46a6b84ce9..b5965dd0ee 100644 --- a/downstream/modules/hub/proc-adding-an-execution-environment.adoc +++ b/downstream/modules/hub/proc-adding-an-execution-environment.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="adding-an-execution-environment"] -= Adding and signing an {ExecEnvShort} += Add and sign an {ExecEnvShort} [role="_abstract"] Push a signed {ExecEnvShort} to your {PrivateHubName} for added security. diff --git a/downstream/modules/hub/proc-configure-content-signing-on-pah.adoc b/downstream/modules/hub/proc-configure-content-signing-on-pah.adoc index fd7ffaffb8..33063e1fc9 100644 --- a/downstream/modules/hub/proc-configure-content-signing-on-pah.adoc +++ b/downstream/modules/hub/proc-configure-content-signing-on-pah.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="proc-configure-content-signing-on-pah"] -= Configuring content signing on {PrivateHubName} += Configure content signing on {PrivateHubName} [role="_abstract"] To successfully sign and publish {CertifiedName}, you must configure {PrivateHubName} for signing. diff --git a/downstream/modules/hub/proc-configuring-the-client-to-verify-signatures.adoc b/downstream/modules/hub/proc-configuring-the-client-to-verify-signatures.adoc index 9fe7eab43d..e530a8e3ce 100644 --- a/downstream/modules/hub/proc-configuring-the-client-to-verify-signatures.adoc +++ b/downstream/modules/hub/proc-configuring-the-client-to-verify-signatures.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="configuring-the-client-to-verify-signatures"] -= Configure the client to verify signatures += Configure a client to verify signatures [role="_abstract"] To ensure an {ExecEnvShort} pulled from the remote registry is properly signed, first configure the {ExecEnvShort} with the proper public key in a policy file. diff --git a/downstream/modules/hub/proc-create-api-token-pah.adoc b/downstream/modules/hub/proc-create-api-token-pah.adoc index cf03053f7e..263bcfdb83 100644 --- a/downstream/modules/hub/proc-create-api-token-pah.adoc +++ b/downstream/modules/hub/proc-create-api-token-pah.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE [id="proc-create-api-token-pah_{context}"] -= Creating the API token in {PrivateHubName} += Create the API token in {PrivateHubName} [role="_abstract"] In {PrivateHubName}, you can create an API token using API token management. The API token is a secret token used to protect your content, so be sure to store it in a secure location. diff --git a/downstream/modules/hub/proc-create-api-token.adoc b/downstream/modules/hub/proc-create-api-token.adoc index d964b6f709..a0fcdf66e5 100644 --- a/downstream/modules/hub/proc-create-api-token.adoc +++ b/downstream/modules/hub/proc-create-api-token.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE [id="proc-create-api-token_{context}"] -= Creating the offline token in {HubName} += Create the offline token in {HubName} [role="_abstract"] In {HubName}, you can create an offline token using *Token management*. The offline token is a secret token used to protect your content, so be sure to store it in a secure location. diff --git a/downstream/modules/hub/proc-create-credential.adoc b/downstream/modules/hub/proc-create-credential.adoc index 9824285af3..08720c1c88 100644 --- a/downstream/modules/hub/proc-create-credential.adoc +++ b/downstream/modules/hub/proc-create-credential.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="proc-create-credential"] -= Creating a credential += Create a credential [role="_abstract"] To pull {ExecEnvName} images from a password or token-protected registry, you must create a credential. diff --git a/downstream/modules/hub/proc-deploying-your-system-for-container-signing.adoc b/downstream/modules/hub/proc-deploying-your-system-for-container-signing.adoc index 65781a0a1e..84521d4453 100644 --- a/downstream/modules/hub/proc-deploying-your-system-for-container-signing.adoc +++ b/downstream/modules/hub/proc-deploying-your-system-for-container-signing.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="deploying-your-system-for-container-signing"] -= Deploying your system for container signing += Deploy your system for container signing [role="_abstract"] To deploy your system so that it is ready for container signing, first ensure that you have diff --git a/downstream/modules/hub/proc-obtain-images.adoc b/downstream/modules/hub/proc-obtain-images.adoc index 9ce4cad9be..e23c7bd881 100644 --- a/downstream/modules/hub/proc-obtain-images.adoc +++ b/downstream/modules/hub/proc-obtain-images.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE [id="obtain-images"] -= Pulling {ExecEnvShort}s for use in {HubName} += Pull {ExecEnvShort}s for use in {HubName} [role="_abstract"] Before you can push {ExecEnvShort}s to your {PrivateHubName}, you must first pull them from an existing registry and tag them for use. The following example details how to pull an {ExecEnvShort} from the Red Hat Ecosystem Catalog (`registry.redhat.io`). diff --git a/downstream/modules/hub/proc-pull-image.adoc b/downstream/modules/hub/proc-pull-image.adoc index a5032fcceb..1acbd2e582 100644 --- a/downstream/modules/hub/proc-pull-image.adoc +++ b/downstream/modules/hub/proc-pull-image.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="pulling-image"] -= Pulling an image += Pull an image [role="_abstract"] diff --git a/downstream/modules/hub/proc-push-container.adoc b/downstream/modules/hub/proc-push-container.adoc index ab17cbb99c..eafe51bd6f 100644 --- a/downstream/modules/hub/proc-push-container.adoc +++ b/downstream/modules/hub/proc-push-container.adoc @@ -2,7 +2,7 @@ [id="push-containers"] -= Pushing an {ExecEnvShort} to {PrivateHubName} += Push an {ExecEnvShort} to {PrivateHubName} [role="_abstract"] diff --git a/downstream/modules/hub/proc-pushing-container-images-from-your-local.adoc b/downstream/modules/hub/proc-pushing-container-images-from-your-local.adoc index ade5ff704b..21de0cde4a 100644 --- a/downstream/modules/hub/proc-pushing-container-images-from-your-local.adoc +++ b/downstream/modules/hub/proc-pushing-container-images-from-your-local.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="pushing-container-images-from-your-local"] -= Pushing signed {ExecEnvShort}s from your local environment += Push a signed {ExecEnvShort} from your local system [role="_abstract"] Sign an {ExecEnvNameSing} on a local system and push the signed {ExecEnvShort} to the {HubName} registry. diff --git a/downstream/modules/hub/proc-set-community-remote.adoc b/downstream/modules/hub/proc-set-community-remote.adoc index eb75155ab4..3310c2e68c 100644 --- a/downstream/modules/hub/proc-set-community-remote.adoc +++ b/downstream/modules/hub/proc-set-community-remote.adoc @@ -8,7 +8,7 @@ You can edit the *community* remote repository to synchronize chosen collections By default, your {PrivateHubName} community repository directs to `galaxy.ansible.com/api/`. endif::operationG[] ifdef::operationG[] -= Configuring Proxy settings on {HubName} += Configure proxy settings for private automation hub If your private automation hub is behind a network proxy, you can configure proxy settings on the remote to sync content located outside of your local network. endif::operationG[] diff --git a/downstream/modules/hub/proc-sync-image.adoc b/downstream/modules/hub/proc-sync-image.adoc index c911c14fea..1e20b0d53b 100644 --- a/downstream/modules/hub/proc-sync-image.adoc +++ b/downstream/modules/hub/proc-sync-image.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="proc-sync-image-adoc_{context}"] -= Syncing images from a container repository += Sync images from a container repository [role="_abstract"] You can pull {ExecEnvName} from the {PrivateHubName} remote registry to sync an image to your local machine. diff --git a/downstream/modules/hub/proc-tag-image.adoc b/downstream/modules/hub/proc-tag-image.adoc index ab2a925212..99aafcec62 100644 --- a/downstream/modules/hub/proc-tag-image.adoc +++ b/downstream/modules/hub/proc-tag-image.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="proc-tag-image"] -= Tagging container images += Tag container images [role="_abstract"] Tag {ExecEnvName} to add an additional name to {ExecEnvName} stored in your {HubName} container repository. If no tag is added to an {ExecEnvNameSing}, {HubName} defaults to `latest` for the name. diff --git a/downstream/modules/hub/proc-tag-pulled-image.adoc b/downstream/modules/hub/proc-tag-pulled-image.adoc index 3d7ea6f0b3..c8b4a520fe 100644 --- a/downstream/modules/hub/proc-tag-pulled-image.adoc +++ b/downstream/modules/hub/proc-tag-pulled-image.adoc @@ -2,7 +2,7 @@ [id="tag-pulled-images"] -= Tagging {ExecEnvShort}s for use in {HubName} += Tag and push {ExecEnvShort}s to {PrivateHubName} [role="_abstract"] diff --git a/downstream/modules/hub/proc-using-podman-ensure-image-signed.adoc b/downstream/modules/hub/proc-using-podman-ensure-image-signed.adoc index 9f3105ba52..d85df26d5a 100644 --- a/downstream/modules/hub/proc-using-podman-ensure-image-signed.adoc +++ b/downstream/modules/hub/proc-using-podman-ensure-image-signed.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE [id="using-podman-ensure-image-signed"] -= Using Podman to ensure an image is signed by a specific signature += Confirm signatures are on your local environment [role="_abstract"] Podman and other image clients can use policies to ensure the validity of an image. To enable this capability, assign a policy to the signature. diff --git a/downstream/modules/navigator/con-about-navigator-settings.adoc b/downstream/modules/navigator/con-about-navigator-settings.adoc index 261814d7e3..ccaf1ce666 100644 --- a/downstream/modules/navigator/con-about-navigator-settings.adoc +++ b/downstream/modules/navigator/con-about-navigator-settings.adoc @@ -2,7 +2,7 @@ [id="ref-navigator-overview-settings_{context}"] -= Creating an {Navigator} settings file += Create an {Navigator} settings file [role="_abstract"] Alter default {Navigator} settings using the command line, environment variables, or a dedicated settings file. Using a settings file helps ensure consistent configuration across sessions. diff --git a/downstream/modules/navigator/proc-browse-collections-tui.adoc b/downstream/modules/navigator/proc-browse-collections-tui.adoc index 152f85bba7..daa6388acd 100644 --- a/downstream/modules/navigator/proc-browse-collections-tui.adoc +++ b/downstream/modules/navigator/proc-browse-collections-tui.adoc @@ -2,7 +2,7 @@ [id="proc-browse-collections-tui_{context}"] -= Browsing collections from {Navigator} += Browse collections from {Navigator} [role="_abstract"] diff --git a/downstream/modules/navigator/proc-execute-playbook-tui.adoc b/downstream/modules/navigator/proc-execute-playbook-tui.adoc index f88273339a..ef62136277 100644 --- a/downstream/modules/navigator/proc-execute-playbook-tui.adoc +++ b/downstream/modules/navigator/proc-execute-playbook-tui.adoc @@ -2,7 +2,7 @@ [id="proc-execute-playbook-tui_{context}"] -= Executing a playbook from {Navigator} += Run a playbook from {Navigator} [role="_abstract"] diff --git a/downstream/modules/navigator/proc-review-ansible-config-tui.adoc b/downstream/modules/navigator/proc-review-ansible-config-tui.adoc index 7b9ce21aba..cbf15e59ac 100644 --- a/downstream/modules/navigator/proc-review-ansible-config-tui.adoc +++ b/downstream/modules/navigator/proc-review-ansible-config-tui.adoc @@ -2,7 +2,7 @@ [id="proc-review-config-tui_{context}"] -= Reviewing your Ansible configuration from {Navigator} += Review your Ansible configuration from {Navigator} [role="_abstract"] diff --git a/downstream/modules/navigator/proc-review-artifact.adoc b/downstream/modules/navigator/proc-review-artifact.adoc index daaf78b85a..80e0b6f0e2 100644 --- a/downstream/modules/navigator/proc-review-artifact.adoc +++ b/downstream/modules/navigator/proc-review-artifact.adoc @@ -2,7 +2,7 @@ [id="proc-review-artifact_{context}"] -= Reviewing playbook results with an {Navigator} artifact file += Review playbook results [role="_abstract"] diff --git a/downstream/modules/navigator/proc-review-docs-tui.adoc b/downstream/modules/navigator/proc-review-docs-tui.adoc index 33404b7e6b..fe090bfc01 100644 --- a/downstream/modules/navigator/proc-review-docs-tui.adoc +++ b/downstream/modules/navigator/proc-review-docs-tui.adoc @@ -2,7 +2,7 @@ [id="proc-review-docs-tui_{context}"] -= Review documentation from {Navigator} += Review collection and plugin documentation [role="_abstract"] diff --git a/downstream/modules/navigator/proc-review-ee-tui.adoc b/downstream/modules/navigator/proc-review-ee-tui.adoc index 624086480c..9d3661d86e 100644 --- a/downstream/modules/navigator/proc-review-ee-tui.adoc +++ b/downstream/modules/navigator/proc-review-ee-tui.adoc @@ -2,7 +2,7 @@ [id="proc-review-ee-tui_{context}"] -= Reviewing {ExecEnvName} from {Navigator} += Review {ExecEnvName} from {Navigator} [role="_abstract"] Use the {Navigator} text-based interface to review your {ExecEnvName}. This allows you to quickly inspect packages, versions, and collections installed in the environment. diff --git a/downstream/modules/navigator/proc-review-inventory-tui.adoc b/downstream/modules/navigator/proc-review-inventory-tui.adoc index 57a49675ae..f0f866c3ca 100644 --- a/downstream/modules/navigator/proc-review-inventory-tui.adoc +++ b/downstream/modules/navigator/proc-review-inventory-tui.adoc @@ -4,7 +4,7 @@ -= Reviewing inventory from {Navigator} += Review inventory from {Navigator} [role="_abstract"] diff --git a/downstream/modules/performance-tuning/con-collection-sync.adoc b/downstream/modules/performance-tuning/con-collection-sync.adoc index 81511ba6b4..c488c0e8b4 100644 --- a/downstream/modules/performance-tuning/con-collection-sync.adoc +++ b/downstream/modules/performance-tuning/con-collection-sync.adoc @@ -1,7 +1,7 @@ // Module file name: con-collection-sync.adoc :_mod-docs-content-type: CONCEPT [id="collection-synchronization_{context}"] -= Collection synchronization += Minimize the impact of collection syncing [role="_abstract"] {PrivateHubNameStart} can synchronize collections from remote `ansible-galaxy` repositories, such as `galaxy.ansible.com` or {HubName} on `console.redhat.com`. diff --git a/downstream/modules/performance-tuning/con-container-image-hosting.adoc b/downstream/modules/performance-tuning/con-container-image-hosting.adoc index 1e47564922..bb6e854969 100644 --- a/downstream/modules/performance-tuning/con-container-image-hosting.adoc +++ b/downstream/modules/performance-tuning/con-container-image-hosting.adoc @@ -1,7 +1,7 @@ // Module file name: con-container-image-hosting.adoc :_mod-docs-content-type: CONCEPT [id="container-image-hosting-and-performance_{context}"] -= Container image hosting and performance += Pull hosted container images from {PrivateHubName} [role="_abstract"] {PrivateHubNameStart} has the capability to host container images for {ExecEnvName} and decision environments. diff --git a/downstream/modules/performance-tuning/con-eda-activations.adoc b/downstream/modules/performance-tuning/con-eda-activations.adoc index d4a4e13b50..542f9175a6 100644 --- a/downstream/modules/performance-tuning/con-eda-activations.adoc +++ b/downstream/modules/performance-tuning/con-eda-activations.adoc @@ -1,7 +1,7 @@ // Module file name: con-eda-activations.adoc :_mod-docs-content-type: CONCEPT [id="event-driven-automation-activations_{context}"] -= {EDAName} activations += Tune {EDAName} activations [role="_abstract"] Activations are used by {EDAName} to run instances of `ansible-rulebook`. diff --git a/downstream/modules/performance-tuning/con-horizontal-scaling-for-performance.adoc b/downstream/modules/performance-tuning/con-horizontal-scaling-for-performance.adoc index fb22cebf50..96cac74aa7 100644 --- a/downstream/modules/performance-tuning/con-horizontal-scaling-for-performance.adoc +++ b/downstream/modules/performance-tuning/con-horizontal-scaling-for-performance.adoc @@ -1,7 +1,7 @@ // Module file name: con-horizontal-scaling-for-performance.adoc :_mod-docs-content-type: CONCEPT [id="horizontal-scaling-for-performance_{context}"] -= Horizontal scaling for performance += Horizontally scale tested deployment models to improve performance [role="_abstract"] Horizontal scaling involves increasing the number of replicas (pods or virtual machines) for a given service. diff --git a/downstream/modules/performance-tuning/con-key-perf-indicators-scaling-API-services.adoc b/downstream/modules/performance-tuning/con-key-perf-indicators-scaling-API-services.adoc index 322a9a106b..282c936280 100644 --- a/downstream/modules/performance-tuning/con-key-perf-indicators-scaling-API-services.adoc +++ b/downstream/modules/performance-tuning/con-key-perf-indicators-scaling-API-services.adoc @@ -1,7 +1,7 @@ // Module file name: con-key-perf-indicators-scaling-API-services.adoc :_mod-docs-content-type: CONCEPT [id="key-per-indicators-scaling-API-services_{context}"] -= Key performance indicators for scaling the API services += Key performance indicators to guide scaling plans [role="_abstract"] Scaling adds resources to handle increased load. diff --git a/downstream/modules/performance-tuning/con-motivations-for-migrating-to-enterprise-topology.adoc b/downstream/modules/performance-tuning/con-motivations-for-migrating-to-enterprise-topology.adoc index 7afd6c9278..b2ca7275c2 100644 --- a/downstream/modules/performance-tuning/con-motivations-for-migrating-to-enterprise-topology.adoc +++ b/downstream/modules/performance-tuning/con-motivations-for-migrating-to-enterprise-topology.adoc @@ -1,7 +1,7 @@ // Module file name: con-motivations-for-migrating-to-enterprise-topology.adoc :_mod-docs-content-type: CONCEPT [id="motivations-for-migrating-to-enterprise-topology_{context}"] -= Motivations for migrating to an {EnterpriseTopology} += Scale up to an {EnterpriseTopology} [role="_abstract"] Growth topologies model a minimal {PlatformNameShort} installation. diff --git a/downstream/modules/performance-tuning/con-scaling-automation-hub-apis.adoc b/downstream/modules/performance-tuning/con-scaling-automation-hub-apis.adoc index f871b49a23..52dacc0098 100644 --- a/downstream/modules/performance-tuning/con-scaling-automation-hub-apis.adoc +++ b/downstream/modules/performance-tuning/con-scaling-automation-hub-apis.adoc @@ -1,7 +1,7 @@ // Module file name: con-scaling-automation-hub-apis.adoc :_mod-docs-content-type: CONCEPT [id="scaling-automation-hub-apis_{context}"] -= Considerations for scaling the {HubName} APIs += Scale the {HubName} API service [role="_abstract"] Scaling {HubName} involves considerations for each of its service types: diff --git a/downstream/modules/performance-tuning/con-scaling-controller-api-service.adoc b/downstream/modules/performance-tuning/con-scaling-controller-api-service.adoc index 827366cc6e..43cb16d73c 100644 --- a/downstream/modules/performance-tuning/con-scaling-controller-api-service.adoc +++ b/downstream/modules/performance-tuning/con-scaling-controller-api-service.adoc @@ -1,7 +1,7 @@ // Module file name: con-scaling-controller-api-service.adoc :_mod-docs-content-type: CONCEPT [id="scaling-controller-api-service_{context}"] -= Considerations for scaling the {ControllerName} API service += Scale the {ControllerName} API service [role="_abstract"] The {ControllerName} API service handles HTTP requests to the application, including information about user roles in {ControllerName}, project creation, inventory creation or updates, job launches, and job result checks. diff --git a/downstream/modules/performance-tuning/con-scaling-eda-apis.adoc b/downstream/modules/performance-tuning/con-scaling-eda-apis.adoc index 3f60254c5d..c2d73854fe 100644 --- a/downstream/modules/performance-tuning/con-scaling-eda-apis.adoc +++ b/downstream/modules/performance-tuning/con-scaling-eda-apis.adoc @@ -1,7 +1,7 @@ // Module file name: con-scaling-eda-apis.adoc :_mod-docs-content-type: CONCEPT [id="scaling-event-driven-automation-apis_{context}"] -= Considerations for scaling the {EDAName} APIs += Scale the {EDAName} API service [role="_abstract"] Scaling {EDAName} involves considerations for each of its service types: diff --git a/downstream/modules/performance-tuning/con-scaling-gateway-proxy-authentication.adoc b/downstream/modules/performance-tuning/con-scaling-gateway-proxy-authentication.adoc index 8709b123cc..64bf32788e 100644 --- a/downstream/modules/performance-tuning/con-scaling-gateway-proxy-authentication.adoc +++ b/downstream/modules/performance-tuning/con-scaling-gateway-proxy-authentication.adoc @@ -1,7 +1,7 @@ // Module file name: con-scaling-gateway-proxy-authentication.adoc :_mod-docs-content-type: CONCEPT [id="scaling-gateway-proxy-and-authentication_{context}"] -= Considerations for scaling the {Gateway} proxy and authentication service += Scale the {Gateway} proxy and authentication service [role="_abstract"] Scaling the {Gateway} proxy and authentication service might be appropriate if the volume of requests to proxy or authenticate exceeds existing {Gateway} service capabilities. diff --git a/downstream/modules/performance-tuning/con-vertical-scaling-for-performance.adoc b/downstream/modules/performance-tuning/con-vertical-scaling-for-performance.adoc index 73310e171b..f0ceb7d47b 100644 --- a/downstream/modules/performance-tuning/con-vertical-scaling-for-performance.adoc +++ b/downstream/modules/performance-tuning/con-vertical-scaling-for-performance.adoc @@ -1,7 +1,7 @@ // Module file name: con-vertical-scaling-for-performance.adoc :_mod-docs-content-type: CONCEPT [id="vertical-scaling-for-performance_{context}"] -= Vertical scaling for performance += Vertically scale tested deployment models to improve performance [role="_abstract"] Vertical scaling increases the physical resources available to a service, including the CPU, memory, disk volume, and disk Input/Output Operations per Second (IOPS). diff --git a/downstream/modules/performance-tuning/ref-api-request-flow-and-latency.adoc b/downstream/modules/performance-tuning/ref-api-request-flow-and-latency.adoc index b303c89567..4ac38ca9ff 100644 --- a/downstream/modules/performance-tuning/ref-api-request-flow-and-latency.adoc +++ b/downstream/modules/performance-tuning/ref-api-request-flow-and-latency.adoc @@ -1,7 +1,7 @@ // Module file name: ref-api-request-flow-and-latency.adoc :_mod-docs-content-type: REFERENCE [id="api-request-flow-and-latency_{context}"] -= API request flow and latency sources += API request flow and latency sources for performance tuning ifdef::context[:parent-context: {context}] diff --git a/downstream/modules/performance-tuning/ref-scaling-management-by-installer.adoc b/downstream/modules/performance-tuning/ref-scaling-management-by-installer.adoc index a9a3b0d5bf..412e88a518 100644 --- a/downstream/modules/performance-tuning/ref-scaling-management-by-installer.adoc +++ b/downstream/modules/performance-tuning/ref-scaling-management-by-installer.adoc @@ -1,7 +1,7 @@ // Module file name: ref-scaling-management-by-installer.adoc :_mod-docs-content-type: REFERENCE [id="scaling-and-management-by-installer-type_{context}"] -= Scaling and management considerations by installation type += Scale and manage by installation type [role="_abstract"] Considerations for scaling and managing each {PlatformNameShort} component differ based on the installation type. diff --git a/downstream/modules/platform/con-aap-containerized-installation-intro.adoc b/downstream/modules/platform/con-aap-containerized-installation-intro.adoc index 76ed8efbcd..a2ea064366 100644 --- a/downstream/modules/platform/con-aap-containerized-installation-intro.adoc +++ b/downstream/modules/platform/con-aap-containerized-installation-intro.adoc @@ -2,7 +2,7 @@ [id="aap-containerized-installation"] -= Containerized {PlatformNameShort} installation += Install containerized {PlatformNameShort} [role="_abstract"] Containerized {PlatformNameShort} uses Podman to run the platform in containers on {RHEL} host machines. diff --git a/downstream/modules/platform/con-aap-installation-on-disconnected-rhel.adoc b/downstream/modules/platform/con-aap-installation-on-disconnected-rhel.adoc index 3c67064eea..87ce5787ae 100644 --- a/downstream/modules/platform/con-aap-installation-on-disconnected-rhel.adoc +++ b/downstream/modules/platform/con-aap-installation-on-disconnected-rhel.adoc @@ -27,7 +27,7 @@ For more information, see link:{URLCentralAuth}/assembly-gateway-licensing#assem * The link:https://docs.ansible.com/ansible/latest/collections/community/general/nsupdate_module.html[DNS records] for the {ControllerName} and {PrivateHubName} servers are created. -== RPM Source +== Obtain and configure RPM source dependencies RPM dependencies for {PlatformNameShort} that come from the BaseOS and AppStream repositories are not included in the setup bundle. To add these dependencies, you must first obtain access to BaseOS and AppStream repositories. Use Satellite to sync repositories and add dependencies. If you prefer an alternative tool, you can choose between the following options: diff --git a/downstream/modules/platform/con-aap-override-backup-configs.adoc b/downstream/modules/platform/con-aap-override-backup-configs.adoc new file mode 100644 index 0000000000..c6b4156d31 --- /dev/null +++ b/downstream/modules/platform/con-aap-override-backup-configs.adoc @@ -0,0 +1,39 @@ +:_mod-docs-content-type: CONCEPT + +[id="aap-override-backup-configs_{context}"] + += Override backup configurations for specific components + +[role="_abstract"] + +You can override the global backup configuration for specific components, such as {ControllerName}, {PrivateHubName}, or {EDAcontroller}. +This ensures that each component uses the appropriate storage class or resource limits during the backup process. + +*Example: Overriding component resources* +This example shows a backup custom resource that applies a fast SSD storage class to the {ControllerName} while using standard storage for the {PrivateHubName}: ++ +[source, none] +---- +apiVersion: aap.ansible.com/v1alpha1 +kind: AnsibleAutomationPlatformBackup +metadata: + name: custom-backup +spec: + deployment_name: myaap + no_log: false + backup_storage_class: rook-cephfs +# Override component-level backup specs: + hub: + backup_storage_requirements: 25Gi + no_log: false + controller: + backup_pvc: custom-controller-backup-pvc + backup_storage_requirements: 15Gi + backup_storage_class: rook-block + no_log: false + eda: + backup_storage_requirements: 7Gi + backup_storage_class: rook-block + no_log: false + +---- diff --git a/downstream/modules/platform/con-aap-upgrade-overview.adoc b/downstream/modules/platform/con-aap-upgrade-overview.adoc index 2c35dc943d..f1b4837e2d 100644 --- a/downstream/modules/platform/con-aap-upgrade-overview.adoc +++ b/downstream/modules/platform/con-aap-upgrade-overview.adoc @@ -2,7 +2,7 @@ [id="con-upgrade-improvements-overview"] -= Upgrade path details += Plan your upgrade to {PlatformNameShort} {PlatformVers} [role="_abstract"] diff --git a/downstream/modules/platform/con-aap-upgrade-planning.adoc b/downstream/modules/platform/con-aap-upgrade-planning.adoc index 7bd1efa827..faf6412c04 100644 --- a/downstream/modules/platform/con-aap-upgrade-planning.adoc +++ b/downstream/modules/platform/con-aap-upgrade-planning.adoc @@ -2,7 +2,7 @@ [id="aap-upgrade-planning_{context}"] -= Upgrade prerequisites += System requirements [role="_abstract"] Before you begin the upgrade process, review the following considerations to plan and prepare your {PlatformNameShort} deployment: diff --git a/downstream/modules/platform/con-about-ansible-mcp-server-operator-install.adoc b/downstream/modules/platform/con-about-ansible-mcp-server-operator-install.adoc index 9b0fbc72aa..4a5ce95d1d 100644 --- a/downstream/modules/platform/con-about-ansible-mcp-server-operator-install.adoc +++ b/downstream/modules/platform/con-about-ansible-mcp-server-operator-install.adoc @@ -136,7 +136,17 @@ You can grant the following access types to the Ansible MCP server: [WARNING] ==== -Enabling read-write access for the Ansible MCP server grants the AI agent autonomy to execute automation jobs. The AI agent can directly make changes in your {PlatformNameShort} environment only if the user has write permissions. Large Language Models (LLMs) can occasionally misinterpret prompts or hallucinate commands. Therefore, enabling read-write access may introduce a risk of unintended changes to your environment. +Enabling read-write access for the Ansible MCP server grants the AI agent autonomy to directly make changes in your {PlatformNameShort} environment, for example, executing automation jobs. The AI agent can directly make changes in your {PlatformNameShort} environment only if the user has write permissions. Large Language Models (LLMs) can occasionally misinterpret prompts or hallucinate commands. Therefore, enabling read-write access may introduce a risk of unintended changes to your environment. +==== + +== Telemetry data collection for Ansible MCP server +Red Hat collects anonymized telemetry data from the Ansible MCP server. The telemetry data includes metrics related to MCP server performance, adoption trends, and usage patterns. + +Telemetry data will be automatically collected for Ansible MCP server deployments using {PlatformNameShort} patch release on 21 January 2026 and later versions. Red Hat will use this data to monitor the operational health of your MCP servers and to ensure the long-term scalability of the MCP ecosystem. + +[IMPORTANT] +==== +Telemetry data collection cannot be disabled, but strict user privacy is maintained. Red Hat does not collect users' personal information, such as usernames or passwords. If any personal information is inadvertently received, the data is deleted. Refer to the link:https://www.redhat.com/en/about/privacy-policy[Red Hat Privacy Statement] for more information about Red Hat's privacy practices. ==== == Prerequisites @@ -149,7 +159,7 @@ Enabling read-write access for the Ansible MCP server grants the AI agent autono * Access credentials: A valid user or service account within {PlatformNameShort} with permissions to execute the desired automation jobs. You will need to generate an API token for this account. -== Process +== Overview of deploying the Ansible MCP server Perform the following tasks to deploy and configure an Ansible MCP server and integrate it with your preferred AI tool: diff --git a/downstream/modules/platform/con-about-ansible-mcp-server.adoc b/downstream/modules/platform/con-about-ansible-mcp-server.adoc index fa72ac2e54..cd1190fdc2 100644 --- a/downstream/modules/platform/con-about-ansible-mcp-server.adoc +++ b/downstream/modules/platform/con-about-ansible-mcp-server.adoc @@ -136,7 +136,17 @@ You can grant the following access types to the Ansible MCP server: [WARNING] ==== -Enabling read-write access for the Ansible MCP server grants the AI agent autonomy to execute automation jobs. The AI agent can directly make changes in your {PlatformNameShort} environment only if the user has write permissions. Large Language Models (LLMs) can occasionally misinterpret prompts or hallucinate commands. Therefore, enabling read-write access may introduce a risk of unintended changes to your environment. +Enabling read-write access for the Ansible MCP server grants the AI agent autonomy to directly make changes in your {PlatformNameShort} environment, for example, executing automation jobs. The AI agent can directly make changes in your {PlatformNameShort} environment only if the user has write permissions. Large Language Models (LLMs) can occasionally misinterpret prompts or hallucinate commands. Therefore, enabling read-write access may introduce a risk of unintended changes to your environment. +==== + +== Telemetry data collection for Ansible MCP server +Red Hat collects anonymized telemetry data from the Ansible MCP server. The telemetry data includes metrics related to MCP server performance, adoption trends, and usage patterns. + +Telemetry data will be automatically collected for Ansible MCP server deployments using {PlatformNameShort} patch release on 21 January 2026 and later versions. Red Hat will use this data to monitor the operational health of your MCP servers and to ensure the long-term scalability of the MCP ecosystem. + +[IMPORTANT] +==== +Telemetry data collection cannot be disabled, but strict user privacy is maintained. Red Hat does not collect users' personal information, such as usernames or passwords. If any personal information is inadvertently received, the data is deleted. Refer to the link:https://www.redhat.com/en/about/privacy-policy[Red Hat Privacy Statement] for more information about Red Hat's privacy practices. ==== == Prerequisites diff --git a/downstream/modules/platform/con-about-lightspeed-intelligent-assistant.adoc b/downstream/modules/platform/con-about-lightspeed-intelligent-assistant.adoc index e8d86c0a0e..6d1e0592e7 100644 --- a/downstream/modules/platform/con-about-lightspeed-intelligent-assistant.adoc +++ b/downstream/modules/platform/con-about-lightspeed-intelligent-assistant.adoc @@ -32,7 +32,7 @@ MCP is an open protocol that standardizes how applications provide context to LL Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope]. ==== -== {PlatformNameShort} requirements +== Ansible Automation Platform 2.6 requirements * You have installed {PlatformNameShort} {PlatformVers} on your {OCPShort} environment. * You have administrator privileges for the {PlatformNameShort}. @@ -85,7 +85,7 @@ To use {OpenAI} with the {AAPchatbot}, you need access to the link:https://opena To use {Azure} with the {AAPchatbot}, you need access to link:https://azure.microsoft.com/en-us/products/ai-foundry/models/openai/[{AzureOpenAI}] product page. -== Process for configuring and using the {AAPchatbot} +== Process for configuring and using the Ansible Lightspeed intelligent assistant Perform the following tasks to set up and use the {AAPchatbot} in your {PlatformNameShort} instance on the {OCPShort} environment: [%header,cols="35%,65%"] diff --git a/downstream/modules/platform/con-building-an-execution-environment-in-a-disconnected-environment.adoc b/downstream/modules/platform/con-building-an-execution-environment-in-a-disconnected-environment.adoc index 3e355f9271..087fe4dfbd 100644 --- a/downstream/modules/platform/con-building-an-execution-environment-in-a-disconnected-environment.adoc +++ b/downstream/modules/platform/con-building-an-execution-environment-in-a-disconnected-environment.adoc @@ -4,7 +4,7 @@ [id="building-an-execution-environment-in-a-disconnected-environment"] -= Build an {ExecEnvShort} in a disconnected environment += Disconnected environment customizations [role="_abstract"] Creating execution environments for {PlatformNameShort} is a common task which works differently in disconnected environments. When building a custom {ExecEnvShort}, the ansible-builder tool defaults to downloading content from the following locations on the internet: diff --git a/downstream/modules/platform/con-change-ssl-tls-operator-based-install.adoc b/downstream/modules/platform/con-change-ssl-tls-operator-based-install.adoc index c03e3dfe3d..89ffa19993 100644 --- a/downstream/modules/platform/con-change-ssl-tls-operator-based-install.adoc +++ b/downstream/modules/platform/con-change-ssl-tls-operator-based-install.adoc @@ -1,4 +1,4 @@ -:mod-docs-content-type: CONCEPT +:_mod-docs-content-type: CONCEPT [id=con-change-ssl-tls-operator-install] = Operator-based installations diff --git a/downstream/modules/platform/con-change-ssl-tls-rpm-based-install.adoc b/downstream/modules/platform/con-change-ssl-tls-rpm-based-install.adoc index efd6fa0784..5fdcd7ef3d 100644 --- a/downstream/modules/platform/con-change-ssl-tls-rpm-based-install.adoc +++ b/downstream/modules/platform/con-change-ssl-tls-rpm-based-install.adoc @@ -1,6 +1,7 @@ -:mod-docs-content-type: CONCEPT +:_mod-docs-content-type: CONCEPT [id="con-change-ssl-tls-rpm-based-install"] + = RPM-based installations [role="_abstract"] diff --git a/downstream/modules/platform/con-change-tls-container-based-install.adoc b/downstream/modules/platform/con-change-tls-container-based-install.adoc index a38d975bc6..585ad75a58 100644 --- a/downstream/modules/platform/con-change-tls-container-based-install.adoc +++ b/downstream/modules/platform/con-change-tls-container-based-install.adoc @@ -1,6 +1,7 @@ -:mod-docs-content-type: CONCEPT +:_mod-docs-content-type: CONCEPT [id="con-change-tls-container-based-install"] = Container-based installations +[role="_abstract"] You can change the TLS certificates and keys for your container-based {PlatformNameShort} installation. This process involves a preparation step, either providing new custom certificates or deleting or moving the old certificates, followed by running the installation program. \ No newline at end of file diff --git a/downstream/modules/platform/con-choosing-installation-type.adoc b/downstream/modules/platform/con-choosing-installation-type.adoc index dda5235cb2..966d1da422 100644 --- a/downstream/modules/platform/con-choosing-installation-type.adoc +++ b/downstream/modules/platform/con-choosing-installation-type.adoc @@ -2,7 +2,7 @@ [id="choosing-installation-type"] -= Choosing an installation type += Choose an installation type [role="_abstract"] Containerized {PlatformNameShort} supports two installation types: online and disconnected. Review the requirements for each to decide which is appropriate for your environment. diff --git a/downstream/modules/platform/con-configuring-the-metrics-utility.adoc b/downstream/modules/platform/con-configuring-the-metrics-utility.adoc index 2f47df0d66..18550f553f 100644 --- a/downstream/modules/platform/con-configuring-the-metrics-utility.adoc +++ b/downstream/modules/platform/con-configuring-the-metrics-utility.adoc @@ -2,7 +2,7 @@ [id="configuring-the-metrics-utility"] -= Configuring `metrics-utility` += Configure the `metrics-utility` [role="_abstract"] Configure the `metrics-utility` to gather and report usage data for your {PlatformNameShort}, both on {RHEL} and {OCPShort}. diff --git a/downstream/modules/platform/con-container-upgrade-enterprise-topology.adoc b/downstream/modules/platform/con-container-upgrade-enterprise-topology.adoc index 3acc0497b7..e1af7e6e44 100644 --- a/downstream/modules/platform/con-container-upgrade-enterprise-topology.adoc +++ b/downstream/modules/platform/con-container-upgrade-enterprise-topology.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="container-upgrade-enterprise-topology"] -= Upgrading a 2.5 {EnterpriseTopology} to a {PlatformVers} {EnterpriseTopology} += Upgrade a 2.5 {EnterpriseTopology} to a {PlatformVers} {EnterpriseTopology} [role="_abstract"] You can upgrade your 2.5 container-based {EnterpriseTopology} to a {PlatformVers} container-based {EnterpriseTopology}. The topologies are the same between {PlatformNameShort} 2.5 and {PlatformVers}. diff --git a/downstream/modules/platform/con-container-upgrade-growth-topology.adoc b/downstream/modules/platform/con-container-upgrade-growth-topology.adoc index 8a8661ae9e..f04499395d 100644 --- a/downstream/modules/platform/con-container-upgrade-growth-topology.adoc +++ b/downstream/modules/platform/con-container-upgrade-growth-topology.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="container-upgrade-growth-topology"] -= Upgrading a 2.5 {GrowthTopology} to a {PlatformVers} {GrowthTopology} += Upgrade a 2.5 {GrowthTopology} to a {PlatformVers} {GrowthTopology} [role="_abstract"] You can upgrade your 2.5 container-based {GrowthTopology} to a {PlatformVers} container-based {GrowthTopology}. The topologies are the same between {PlatformNameShort} 2.5 and {PlatformVers}. diff --git a/downstream/modules/platform/con-controller-access-organizations.adoc b/downstream/modules/platform/con-controller-access-organizations.adoc index c79485839a..4a4fbd984b 100644 --- a/downstream/modules/platform/con-controller-access-organizations.adoc +++ b/downstream/modules/platform/con-controller-access-organizations.adoc @@ -2,7 +2,7 @@ [id="con-controller-access-organizations"] -= Access to organizations += Manage access to organizations [role="_abstract"] diff --git a/downstream/modules/platform/con-controller-api-identifier-format-protocol.adoc b/downstream/modules/platform/con-controller-api-identifier-format-protocol.adoc index e679a7fcbc..31cae04cef 100644 --- a/downstream/modules/platform/con-controller-api-identifier-format-protocol.adoc +++ b/downstream/modules/platform/con-controller-api-identifier-format-protocol.adoc @@ -2,7 +2,7 @@ [id="controller-api-identifier-format-protocol"] -= Identifier format protocol += Understand how to identify resources by name [role="_abstract"] {ControllerName} uses a consistent protocol to generate human-readable unique identifiers for resources that can be addressed by name in the API and the web interface. diff --git a/downstream/modules/platform/con-controller-backup-restore-rpm.adoc b/downstream/modules/platform/con-controller-backup-restore-rpm.adoc new file mode 100644 index 0000000000..9354beb925 --- /dev/null +++ b/downstream/modules/platform/con-controller-backup-restore-rpm.adoc @@ -0,0 +1,8 @@ +:_mod-docs-content-type: CONCEPT + +[id="controller-backup-restore-rpm-overview"] + += Backup and restore your RPM deployment + +[role="_abstract"] +Backup and restoration are critical tasks used to ensure business continuity and disaster recovery. These processes capture the current state of the automation controller and recover it if a system failure occurs or when migrating to a new environment. \ No newline at end of file diff --git a/downstream/modules/platform/con-controller-capacity-determination.adoc b/downstream/modules/platform/con-controller-capacity-determination.adoc index cd17a4416b..c2b5238aad 100644 --- a/downstream/modules/platform/con-controller-capacity-determination.adoc +++ b/downstream/modules/platform/con-controller-capacity-determination.adoc @@ -2,7 +2,7 @@ [id="controller-capacity-determination"] -= {ControllerNameStart} capacity determination and job impact += How job capacity is determined and impacts job runs [role="_abstract"] The {ControllerName} capacity system determines how many jobs can run on an instance given the amount of resources available to the instance and the size of the jobs that are running (referred to as Impact). diff --git a/downstream/modules/platform/con-controller-capacity-job-impacts.adoc b/downstream/modules/platform/con-controller-capacity-job-impacts.adoc index d3189e4452..d115643ec4 100644 --- a/downstream/modules/platform/con-controller-capacity-job-impacts.adoc +++ b/downstream/modules/platform/con-controller-capacity-job-impacts.adoc @@ -2,7 +2,7 @@ [id="controller-capacity-job-impacts"] -= Capacity job impacts += Job type impact on capacity [role="_abstract"] When configuring {ControllerName} capacity, it is important to understand how different job types impact the system capacity. diff --git a/downstream/modules/platform/con-controller-cloud-credentials.adoc b/downstream/modules/platform/con-controller-cloud-credentials.adoc index 241b0a834d..1649958a71 100644 --- a/downstream/modules/platform/con-controller-cloud-credentials.adoc +++ b/downstream/modules/platform/con-controller-cloud-credentials.adoc @@ -2,7 +2,7 @@ [id="controller-cloud-credentials"] -= Use Cloud Credentials with a cloud inventory += Associate cloud credentials with a job template [role="_abstract"] {ControllerNameStart} can use Cloud Credentials to authenticate to cloud providers. diff --git a/downstream/modules/platform/con-controller-configure-hostname-notifications.adoc b/downstream/modules/platform/con-controller-configure-hostname-notifications.adoc index 27809dc7ef..86510353ca 100644 --- a/downstream/modules/platform/con-controller-configure-hostname-notifications.adoc +++ b/downstream/modules/platform/con-controller-configure-hostname-notifications.adoc @@ -2,7 +2,7 @@ [id="controller-configure-hostname-notifications"] -= Configure the host hostname for notifications += Notification reference [role="_abstract"] By default, {ControllerName} uses the system hostname for notifications. diff --git a/downstream/modules/platform/con-controller-container-groups.adoc b/downstream/modules/platform/con-controller-container-groups.adoc index a99af85b64..72387c2236 100644 --- a/downstream/modules/platform/con-controller-container-groups.adoc +++ b/downstream/modules/platform/con-controller-container-groups.adoc @@ -2,7 +2,7 @@ [id="controller-container-groups"] -= Container groups += Control where automation runs with container groups [role="_abstract"] {PlatformNameShort} supports container groups, which enable you to run jobs in {ControllerName} regardless of whether {ControllerName} is installed as a standalone, in a virtual environment, or in a container. diff --git a/downstream/modules/platform/con-controller-control-job-run.adoc b/downstream/modules/platform/con-controller-control-job-run.adoc index 1329c8a67e..50df8fd0d0 100644 --- a/downstream/modules/platform/con-controller-control-job-run.adoc +++ b/downstream/modules/platform/con-controller-control-job-run.adoc @@ -2,7 +2,7 @@ [id="controller-control-job-run"] -= Control where a job runs += Control where an automation job runs [role="_abstract"] You can control where jobs run by using instance groups. diff --git a/downstream/modules/platform/con-controller-fact-caching.adoc b/downstream/modules/platform/con-controller-fact-caching.adoc index b2025dfbe1..905441ffd4 100644 --- a/downstream/modules/platform/con-controller-fact-caching.adoc +++ b/downstream/modules/platform/con-controller-fact-caching.adoc @@ -2,7 +2,7 @@ [id="controller-fact-caching"] -= Fact caching += Store host facts in cache for faster playbook execution [role="_abstract"] {ControllerNameStart} can store and retrieve facts on a per-host basis through an Ansible Fact Cache plugin. diff --git a/downstream/modules/platform/con-controller-inventory-sync-jobs.adoc b/downstream/modules/platform/con-controller-inventory-sync-jobs.adoc index f0d6dcd9b3..c3db5870b0 100644 --- a/downstream/modules/platform/con-controller-inventory-sync-jobs.adoc +++ b/downstream/modules/platform/con-controller-inventory-sync-jobs.adoc @@ -2,7 +2,7 @@ [id="controller-inventory-sync-jobs_{context}"] -= Inventory sync jobs += Sync inventory data with external sources [role="_abstract"] Inventory synchronization jobs update the inventory data in {ControllerNameStart} by pulling the latest information from the configured inventory sources. diff --git a/downstream/modules/platform/con-controller-job-branch-overriding.adoc b/downstream/modules/platform/con-controller-job-branch-overriding.adoc index 3884571fb9..ad1e06b4b0 100644 --- a/downstream/modules/platform/con-controller-job-branch-overriding.adoc +++ b/downstream/modules/platform/con-controller-job-branch-overriding.adoc @@ -2,7 +2,7 @@ [id="controller-job-branch-overriding"] -= Job branch overriding += Advanced configuration for jobs tied to source control management systems [role="_abstract"] In {ControllerName}, you can configure projects to allow job templates to override the branch, tag, or reference used for source control. diff --git a/downstream/modules/platform/con-controller-keep-subscription-in-compliance.adoc b/downstream/modules/platform/con-controller-keep-subscription-in-compliance.adoc index be25667063..fea492ba46 100644 --- a/downstream/modules/platform/con-controller-keep-subscription-in-compliance.adoc +++ b/downstream/modules/platform/con-controller-keep-subscription-in-compliance.adoc @@ -2,7 +2,7 @@ [id="controller-keep-subscription-in-compliance_{context}"] -= Keeping your subscription in compliance += Keep subscriptions for managed hosts in compliance [role="_abstract"] To ensure that your {ControllerName} installation remains compliant with your Red Hat subscription, {ControllerName} provides a way to monitor your subscription status and usage. diff --git a/downstream/modules/platform/con-controller-metrics-monitor-controller.adoc b/downstream/modules/platform/con-controller-metrics-monitor-controller.adoc index 7454c22ecb..704f14778f 100644 --- a/downstream/modules/platform/con-controller-metrics-monitor-controller.adoc +++ b/downstream/modules/platform/con-controller-metrics-monitor-controller.adoc @@ -2,7 +2,7 @@ [id="con-controller-metrics-monitor-controller"] -= Metrics to monitor {ControllerName} += Monitor automation host metrics at the system and application level [role="_abstract"] Monitor your {ControllerName} hosts at the system and application levels. diff --git a/downstream/modules/platform/con-controller-metrics-utility-containerized.adoc b/downstream/modules/platform/con-controller-metrics-utility-containerized.adoc index 8d94cb1330..c6076eb2d2 100644 --- a/downstream/modules/platform/con-controller-metrics-utility-containerized.adoc +++ b/downstream/modules/platform/con-controller-metrics-utility-containerized.adoc @@ -2,7 +2,7 @@ [id="controller-metrics-utility-containerized"] -= Configuring `metrics-utility` on a manual containerized installation of {PlatformNameShort} += Configure the `metrics-utility` on a manual containerized installation of {PlatformNameShort} [role="_abstract"] The `metrics-utility` tool generates performance metrics and reports for {PlatformNameShort} installations. diff --git a/downstream/modules/platform/con-controller-metrics-utility-ocp.adoc b/downstream/modules/platform/con-controller-metrics-utility-ocp.adoc index d4901dca08..5276264afb 100644 --- a/downstream/modules/platform/con-controller-metrics-utility-ocp.adoc +++ b/downstream/modules/platform/con-controller-metrics-utility-ocp.adoc @@ -2,7 +2,7 @@ [id="controller-metrics-utility-ocp"] -= Configuring `metrics-utility` on {OCPShort} from the {PlatformNameShort} operator += Configure the `metrics-utility` on {OCPShort} from the {PlatformNameShort} operator [role="_abstract"] The `metrics-utility` is a command-line tool that collects and reports metrics from your {OCPShort} cluster to your {ControllerName} instance. diff --git a/downstream/modules/platform/con-controller-playbook-run-jobs.adoc b/downstream/modules/platform/con-controller-playbook-run-jobs.adoc index cd014f6f2f..cb933f7ee9 100644 --- a/downstream/modules/platform/con-controller-playbook-run-jobs.adoc +++ b/downstream/modules/platform/con-controller-playbook-run-jobs.adoc @@ -2,7 +2,7 @@ [id="controller-playbook-run-jobs_{context}"] -= Playbook run jobs += View output for your playbook job runs [role="_abstract"] You can run playbook jobs to run Ansible playbooks on one or more managed nodes directly from the {ControllerName} interface without creating a job template. diff --git a/downstream/modules/platform/con-controller-provisioning-callbacks.adoc b/downstream/modules/platform/con-controller-provisioning-callbacks.adoc index 14868d1a13..64956d2e24 100644 --- a/downstream/modules/platform/con-controller-provisioning-callbacks.adoc +++ b/downstream/modules/platform/con-controller-provisioning-callbacks.adoc @@ -2,7 +2,7 @@ [id="controller-provisioning-callbacks"] -= Provisioning callbacks += Increase capacity through cloud bursting by provisioning callbacks [role="_abstract"] Provisioning Callbacks are a feature of {ControllerName} that enable a host to start a playbook run against itself, rather than waiting for a user to launch a job to manage the host from the {ControllerName} console. diff --git a/downstream/modules/platform/con-controller-scm-inventory-jobs.adoc b/downstream/modules/platform/con-controller-scm-inventory-jobs.adoc index 8f962050ab..48796ed7b2 100644 --- a/downstream/modules/platform/con-controller-scm-inventory-jobs.adoc +++ b/downstream/modules/platform/con-controller-scm-inventory-jobs.adoc @@ -2,7 +2,7 @@ [id="controller-scm-inventory-jobs_{context}"] -= SCM inventory jobs += Sync inventory data with a source control management system [role="_abstract"] When you synchronize an inventory source that is configured to use a source control management (SCM) system, such as Git, {ControllerName} creates and runs an SCM inventory job. This job pulls the latest inventory data from the SCM repository and updates the inventory in {ControllerName}. diff --git a/downstream/modules/platform/con-controller-secret-handling.adoc b/downstream/modules/platform/con-controller-secret-handling.adoc index e87892e852..7e0d3602f4 100644 --- a/downstream/modules/platform/con-controller-secret-handling.adoc +++ b/downstream/modules/platform/con-controller-secret-handling.adoc @@ -2,7 +2,7 @@ [id="controller-secret-handling"] -= Secret handling += Understand secret handling [role="_abstract"] {ControllerNameStart} manages three sets of secrets: diff --git a/downstream/modules/platform/con-controller-tuning.adoc b/downstream/modules/platform/con-controller-tuning.adoc index 9d381f4f3b..10f7fa90e7 100644 --- a/downstream/modules/platform/con-controller-tuning.adoc +++ b/downstream/modules/platform/con-controller-tuning.adoc @@ -2,7 +2,7 @@ [id="controller-tuning"] -= {ControllerNameStart} tuning += Performance tuning for {PlatformNameShort} [role="_abstract"] You can configure many {ControllerName} settings by using the UI, API, and file settings including: diff --git a/downstream/modules/platform/con-controller-workflow-visualizer.adoc b/downstream/modules/platform/con-controller-workflow-visualizer.adoc index 8347e6d31e..66537ffa21 100644 --- a/downstream/modules/platform/con-controller-workflow-visualizer.adoc +++ b/downstream/modules/platform/con-controller-workflow-visualizer.adoc @@ -2,7 +2,7 @@ [id="controller-workflow-visualizer"] -= Workflow visualizer += Build a graphical workflow representation with workflow visualizer [role="_abstract"] The Workflow Visualizer provides a graphical way of linking together job templates, workflow templates, project syncs, and inventory syncs to build a workflow template. diff --git a/downstream/modules/platform/con-create-crs-resource-operator.adoc b/downstream/modules/platform/con-create-crs-resource-operator.adoc index fffa096167..9cac3f6d36 100644 --- a/downstream/modules/platform/con-create-crs-resource-operator.adoc +++ b/downstream/modules/platform/con-create-crs-resource-operator.adoc @@ -2,7 +2,7 @@ [id="con-create-crs-resource-operator_{context}"] -= Create custom resources for {OperatorResourceShort} += Create a custom resource for {OperatorResourceShort} [role="_abstract"] diff --git a/downstream/modules/platform/con-edge-manager-build-bootc.adoc b/downstream/modules/platform/con-edge-manager-build-bootc.adoc index 5761b547be..e6f6cf5ef5 100644 --- a/downstream/modules/platform/con-edge-manager-build-bootc.adoc +++ b/downstream/modules/platform/con-edge-manager-build-bootc.adoc @@ -2,7 +2,7 @@ [id="edge-manager-build-bootc"] -= Building a _bootc_ operating system image for the {RedHatEdge} += Build a _bootc_ operating system image for {RedHatEdge} [role="_abstract"] diff --git a/downstream/modules/platform/con-edge-manager-rollout-disruption.adoc b/downstream/modules/platform/con-edge-manager-rollout-disruption.adoc index a3c914e702..d1bcd6f3dc 100644 --- a/downstream/modules/platform/con-edge-manager-rollout-disruption.adoc +++ b/downstream/modules/platform/con-edge-manager-rollout-disruption.adoc @@ -2,7 +2,7 @@ [id="edge-manager-rollout-disruption"] -= Rollout disruption budget += Define a rollout disruption budget [role="_abstract"] diff --git a/downstream/modules/platform/con-gs-about-sources-targets.adoc b/downstream/modules/platform/con-gs-about-sources-targets.adoc new file mode 100644 index 0000000000..df7afad8ad --- /dev/null +++ b/downstream/modules/platform/con-gs-about-sources-targets.adoc @@ -0,0 +1,8 @@ +:_mod-docs-content-type: CONCEPT + +[id="con-gs-about-sources-targets"] + += Organize and define automation sources and targets + +[role="_abstract"] +Projects and inventory files help you organize your automation sources and targets. \ No newline at end of file diff --git a/downstream/modules/platform/con-gs-ansible-roles.adoc b/downstream/modules/platform/con-gs-ansible-roles.adoc index d7a7738f6d..c9ec522617 100644 --- a/downstream/modules/platform/con-gs-ansible-roles.adoc +++ b/downstream/modules/platform/con-gs-ansible-roles.adoc @@ -2,7 +2,7 @@ [id="con-gs-ansible-roles_{context}"] -= Bundle automation content with roles += Package and reuse content with roles [role="_abstract"] A role is a customized piece of automation content that bundles together relevant bits from playbooks to fit your system's specific needs. Roles are self-contained and portable, and can include groupings of tasks, variables, configuration templates, handlers, and other supporting files to orchestrate complicated automation flows. diff --git a/downstream/modules/platform/con-gs-auto-dev-job-templates.adoc b/downstream/modules/platform/con-gs-auto-dev-job-templates.adoc index 275ed167a9..635e00cb6f 100644 --- a/downstream/modules/platform/con-gs-auto-dev-job-templates.adoc +++ b/downstream/modules/platform/con-gs-auto-dev-job-templates.adoc @@ -2,7 +2,7 @@ [id="con-gs-auto-dev-job-templates"] -= Work with job templates += Reliably run playbooks with job templates [role="_abstract"] A job template is a definition and set of parameters for running an Ansible job. diff --git a/downstream/modules/platform/con-gs-auto-op-about-inv.adoc b/downstream/modules/platform/con-gs-auto-op-about-inv.adoc index 4324b7d352..64eaad6e15 100644 --- a/downstream/modules/platform/con-gs-auto-op-about-inv.adoc +++ b/downstream/modules/platform/con-gs-auto-op-about-inv.adoc @@ -2,7 +2,7 @@ [id="con-gs-auto-op-about-inv"] -= About inventories += View hosts being automated in inventory files [role="_abstract"] An inventory is a file listing the collection of hosts managed by {PlatformNameShort}. diff --git a/downstream/modules/platform/con-gs-automation-execution-jobs.adoc b/downstream/modules/platform/con-gs-automation-execution-jobs.adoc index 0407c2ac68..3c38a862aa 100644 --- a/downstream/modules/platform/con-gs-automation-execution-jobs.adoc +++ b/downstream/modules/platform/con-gs-automation-execution-jobs.adoc @@ -2,7 +2,7 @@ [id="con-gs-automation-execution-jobs"] -= Automation execution jobs += View the status and output of automation jobs [role="_abstract"] -A job is an instance of {PlatformNameShort} launching an Ansible Playbook against an inventory of hosts. +A job is an instance of {PlatformNameShort} launching an Ansible Playbook against an inventory of hosts. You can view the status and output of automation jobs. diff --git a/downstream/modules/platform/con-gs-execution-env.adoc b/downstream/modules/platform/con-gs-execution-env.adoc index fd657c5b7b..2b26dac576 100644 --- a/downstream/modules/platform/con-gs-execution-env.adoc +++ b/downstream/modules/platform/con-gs-execution-env.adoc @@ -2,7 +2,7 @@ [id="con-gs-execution-env_{context}"] -= Build and use an {ExecEnvShort} += Create automation runtimes with execution and decision environments [role="_abstract"] All automation in {PlatformName} runs on container images called {ExecEnvName}. diff --git a/downstream/modules/platform/con-gs-learn-about-collections.adoc b/downstream/modules/platform/con-gs-learn-about-collections.adoc index d70bf37957..15eb7e4509 100644 --- a/downstream/modules/platform/con-gs-learn-about-collections.adoc +++ b/downstream/modules/platform/con-gs-learn-about-collections.adoc @@ -2,7 +2,7 @@ [id="con-gs-learn-about-collections_{context}"] -= About content collections += Publish and distribute automation content with collections [role="_abstract"] Ansible content collections are assemblages of automation content. There are two types of Ansible collections: diff --git a/downstream/modules/platform/con-gs-rulebook-activations.adoc b/downstream/modules/platform/con-gs-rulebook-activations.adoc index 3bde4c835c..d731e3e396 100644 --- a/downstream/modules/platform/con-gs-rulebook-activations.adoc +++ b/downstream/modules/platform/con-gs-rulebook-activations.adoc @@ -2,7 +2,7 @@ [id="con-gs-rulebook-activations"] -= Create and run a rulebook activation += Configure rulebooks to take action in response to events or conditions [role="_abstract"] In {EDAName}, a rulebook activation is a process running in the background defined by a decision environment executing a specific rulebook. diff --git a/downstream/modules/platform/con-gs-setting-up-dev-env.adoc b/downstream/modules/platform/con-gs-setting-up-dev-env.adoc index a4f6d77361..04a60fdc7f 100644 --- a/downstream/modules/platform/con-gs-setting-up-dev-env.adoc +++ b/downstream/modules/platform/con-gs-setting-up-dev-env.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: CONCEPT [id="setting-up-dev-env_{context}"] -= Setting up your development environment += Set up your development environment [role="_abstract"] Before you begin to create content, consult our guide to {LinkDevelopAutomationContent}. There you can find information on {ToolsName}, which you can integrate into your environment, and learn how to scaffold a playbook project. diff --git a/downstream/modules/platform/con-gw-create-authentication.adoc b/downstream/modules/platform/con-gw-create-authentication.adoc index 342a805e24..219ba58931 100644 --- a/downstream/modules/platform/con-gw-create-authentication.adoc +++ b/downstream/modules/platform/con-gw-create-authentication.adoc @@ -2,7 +2,7 @@ [id="gw-create-authentication"] -= Creating an authentication method += Select an authentication type [role="_abstract"] diff --git a/downstream/modules/platform/con-gw-gcp-network-port-limits.adoc b/downstream/modules/platform/con-gw-gcp-network-port-limits.adoc index a2a9c47dce..d4d39cbadd 100644 --- a/downstream/modules/platform/con-gw-gcp-network-port-limits.adoc +++ b/downstream/modules/platform/con-gw-gcp-network-port-limits.adoc @@ -2,7 +2,7 @@ [id="gw-gcp-network-port-limits"] -= Google Cloud Platform network configuration for increased authentication performance += Configure Google Cloud for increased authentication performance [role="_abstract"] diff --git a/downstream/modules/platform/con-gw-manage-oauth2-external-users.adoc b/downstream/modules/platform/con-gw-manage-oauth2-external-users.adoc index 10051355e6..1e112ce59d 100644 --- a/downstream/modules/platform/con-gw-manage-oauth2-external-users.adoc +++ b/downstream/modules/platform/con-gw-manage-oauth2-external-users.adoc @@ -2,7 +2,7 @@ [id="gw-manage-oauth2-external-users"] -= Manage OAuth2 token creation for external users += Security settings for OAuth2 tokens and external users [role="_abstract"] diff --git a/downstream/modules/platform/con-gw-review-mapping-results.adoc b/downstream/modules/platform/con-gw-review-mapping-results.adoc index 35846c8aa7..833c1eb97d 100644 --- a/downstream/modules/platform/con-gw-review-mapping-results.adoc +++ b/downstream/modules/platform/con-gw-review-mapping-results.adoc @@ -2,7 +2,7 @@ [id="gw-review-mapping-results"] -= Reviewing authenticator map results += Review authenticator map results [role="_abstract"] diff --git a/downstream/modules/platform/con-gw-understanding-authenticator-mapping.adoc b/downstream/modules/platform/con-gw-understanding-authenticator-mapping.adoc index 5f424455e8..9199ab7b46 100644 --- a/downstream/modules/platform/con-gw-understanding-authenticator-mapping.adoc +++ b/downstream/modules/platform/con-gw-understanding-authenticator-mapping.adoc @@ -2,7 +2,7 @@ [id="gw-understanding-authenticator-mapping"] -= Understanding authenticator mapping += Understand authenticator mapping [role="_abstract"] diff --git a/downstream/modules/platform/con-gw-user-association-and-attr-sync.adoc b/downstream/modules/platform/con-gw-user-association-and-attr-sync.adoc index 47b1f481e6..75dd542ec1 100644 --- a/downstream/modules/platform/con-gw-user-association-and-attr-sync.adoc +++ b/downstream/modules/platform/con-gw-user-association-and-attr-sync.adoc @@ -2,7 +2,7 @@ [id="user-association-and-attr-sync"] -= User association and attribute synchronization += User and external authentication mapping in {PlatformVers} [role="_abstract"] diff --git a/downstream/modules/platform/con-install-mesh.adoc b/downstream/modules/platform/con-install-mesh.adoc index 172377d81f..1fd9222286 100644 --- a/downstream/modules/platform/con-install-mesh.adoc +++ b/downstream/modules/platform/con-install-mesh.adoc @@ -2,7 +2,7 @@ [id="install-mesh_{context}"] -= {AutomationMesh} Installation += Specify automation mesh nodes in the inventory file [role="_abstract"] For an RPM or Containerized VM-based install of {PlatformNameShort} you use an {Installer} to set up {AutomationMesh} or to upgrade {AutomationMesh}. diff --git a/downstream/modules/platform/con-install-scenario-examples.adoc b/downstream/modules/platform/con-install-scenario-examples.adoc index fa508fa60d..102255ddc4 100644 --- a/downstream/modules/platform/con-install-scenario-examples.adoc +++ b/downstream/modules/platform/con-install-scenario-examples.adoc @@ -2,7 +2,7 @@ [id="con-install-scenario-examples"] -= Inventory file examples based on installation scenarios += Example inventory files [role="_abstract"] Red Hat supports several installation scenarios for {PlatformNameShort}. You can develop your own inventory files using the example files as a basis, or you can use the example closest to your preferred installation scenario. diff --git a/downstream/modules/platform/con-install-scenario-recommendations.adoc b/downstream/modules/platform/con-install-scenario-recommendations.adoc index 2c7fe0ddec..b6fe4b0899 100644 --- a/downstream/modules/platform/con-install-scenario-recommendations.adoc +++ b/downstream/modules/platform/con-install-scenario-recommendations.adoc @@ -2,7 +2,7 @@ [id="con-install-scenario-recommendations"] -= Inventory file recommendations based on installation scenarios += Guidelines for configuring your inventory file [role="_abstract"] Inventory file recommendations define critical variables and configuration rules for installing {PlatformNameShort} in various scenarios. diff --git a/downstream/modules/platform/con-operator-understand-operator-logs.adoc b/downstream/modules/platform/con-operator-understand-operator-logs.adoc index 2e5aebfbe8..42d5c07561 100644 --- a/downstream/modules/platform/con-operator-understand-operator-logs.adoc +++ b/downstream/modules/platform/con-operator-understand-operator-logs.adoc @@ -2,7 +2,7 @@ [id="con-operator-understand-operator-logs_{context}"] -= Understanding {ControllerName} operator logs += Understand the {ControllerName} operator logs [role="_abstract"] diff --git a/downstream/modules/platform/con-operator-upgrade-growth-topology.adoc b/downstream/modules/platform/con-operator-upgrade-growth-topology.adoc index da3f66ba57..f1cb618871 100644 --- a/downstream/modules/platform/con-operator-upgrade-growth-topology.adoc +++ b/downstream/modules/platform/con-operator-upgrade-growth-topology.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="operator-upgrade-growth-topology"] -= Upgrading a 2.5 {GrowthTopology} to a {PlatformVers} {GrowthTopology} += Upgrade a 2.5 {GrowthTopology} to a {PlatformVers} {GrowthTopology} [role="_abstract"] You can upgrade your 2.5 {GrowthTopology} to a {PlatformVers} {GrowthTopology} on {OCPShort}. The topologies are the same between {PlatformNameShort} 2.5 and {PlatformVers}. diff --git a/downstream/modules/platform/con-operator-upgrade-multi-controller-enterprise.adoc b/downstream/modules/platform/con-operator-upgrade-multi-controller-enterprise.adoc index 988c6e045b..dd330eec05 100644 --- a/downstream/modules/platform/con-operator-upgrade-multi-controller-enterprise.adoc +++ b/downstream/modules/platform/con-operator-upgrade-multi-controller-enterprise.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="operator-upgrade-multi-controller-enterprise"] -= Upgrading a 2.4 multi node {ControllerName} deployment to a {PlatformVers} {EnterpriseTopology} += 2.4 multi node {ControllerName} deployment to a {PlatformVers} {EnterpriseTopology} [role="_abstract"] Upgrade your 2.4 multi-node {ControllerName} setup to a {PlatformVers} {EnterpriseTopology}. diff --git a/downstream/modules/platform/con-operator-upgrade-multi-controller-hub-enterprise.adoc b/downstream/modules/platform/con-operator-upgrade-multi-controller-hub-enterprise.adoc index ec0b063cfb..47b7e13ea4 100644 --- a/downstream/modules/platform/con-operator-upgrade-multi-controller-hub-enterprise.adoc +++ b/downstream/modules/platform/con-operator-upgrade-multi-controller-hub-enterprise.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="operator-upgrade-multi-controller-hub-enterprise"] -= Upgrading a 2.4 multi node {ControllerName} and {HubName} deployment to a {PlatformVers} {EnterpriseTopology} += 2.4 multi node {ControllerName} and {HubName} deployment to a {PlatformVers} {EnterpriseTopology} [role="_abstract"] Upgrade your 2.4 multi-node deployment ({ControllerName} and {HubName}) to a {PlatformVers} {EnterpriseTopology}. diff --git a/downstream/modules/platform/con-operator-upgrade-prereq.adoc b/downstream/modules/platform/con-operator-upgrade-prereq.adoc index ad0c7ab909..c6989f48b5 100644 --- a/downstream/modules/platform/con-operator-upgrade-prereq.adoc +++ b/downstream/modules/platform/con-operator-upgrade-prereq.adoc @@ -2,7 +2,7 @@ [id="operator-upgrade-prereq_{context}"] -= Prerequisites += Prerequisites and channel upgrades [role="_abstract"] diff --git a/downstream/modules/platform/con-operator-upgrade-single-controller-growth.adoc b/downstream/modules/platform/con-operator-upgrade-single-controller-growth.adoc index d56eac5471..b0f939b198 100644 --- a/downstream/modules/platform/con-operator-upgrade-single-controller-growth.adoc +++ b/downstream/modules/platform/con-operator-upgrade-single-controller-growth.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="operator-upgrade-single-controller-growth"] -= Upgrading a 2.4 single {ControllerName} node deployment to a {PlatformVers} {GrowthTopology} += 2.4 single {ControllerName} node deployment to a {PlatformVers} {GrowthTopology} [role="_abstract"] Plan your upgrade from a 2.4 single {ControllerName} node setup to a {PlatformVers} {GrowthTopology}. diff --git a/downstream/modules/platform/con-operator-upgrade-single-controller-hub-growth.adoc b/downstream/modules/platform/con-operator-upgrade-single-controller-hub-growth.adoc index f511713497..4b9c25e584 100644 --- a/downstream/modules/platform/con-operator-upgrade-single-controller-hub-growth.adoc +++ b/downstream/modules/platform/con-operator-upgrade-single-controller-hub-growth.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="operator-upgrade-single-controller-hub-growth"] -= Upgrading a 2.4 single {ControllerName} and {HubName} deployment to a {PlatformVers} {GrowthTopology} += 2.4 single {ControllerName} and {HubName} deployment to a {PlatformVers} {GrowthTopology} [role="_abstract"] Upgrade your 2.4 single-node deployment ({ControllerName} and {HubName}) to a {PlatformVers} {GrowthTopology}. diff --git a/downstream/modules/platform/con-pac-policies-rules.adoc b/downstream/modules/platform/con-pac-policies-rules.adoc index 1912c4ad64..150d785da5 100644 --- a/downstream/modules/platform/con-pac-policies-rules.adoc +++ b/downstream/modules/platform/con-pac-policies-rules.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: CONCEPT [id="pac-policies-rules_{context}"] -= Understanding OPA packages and rules += Understand OPA packages and rules [role="_abstract"] An OPA policy is organized in packages, which are namespaced collections of rules. The basic structure of an OPA policy looks like this: diff --git a/downstream/modules/platform/con-sticky-sessions.adoc b/downstream/modules/platform/con-sticky-sessions.adoc index 3ebc104f6f..47caf2b9d5 100644 --- a/downstream/modules/platform/con-sticky-sessions.adoc +++ b/downstream/modules/platform/con-sticky-sessions.adoc @@ -2,7 +2,7 @@ [id="con-sticky-sessions_{context}"] -= Enable sticky sessions += Enable sticky sessions for automation hub [role="_abstract"] By default, an application load balancer routes each request independently to a registered target based on the chosen load balancing algorithm. diff --git a/downstream/modules/platform/con-storage-options-for-operator-installation-on-ocp.adoc b/downstream/modules/platform/con-storage-options-for-operator-installation-on-ocp.adoc index 323e2aa06b..0b77b7296f 100644 --- a/downstream/modules/platform/con-storage-options-for-operator-installation-on-ocp.adoc +++ b/downstream/modules/platform/con-storage-options-for-operator-installation-on-ocp.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="con-storage-options-for-operator-installation-on-ocp_{context}"] -= Storage options for {OperatorPlatformNameShort} installation on {OCP} += Storage options for {HubName} [role="_abstract"] diff --git a/downstream/modules/platform/con-upgrade-controller-hub-eda-unified-ui.adoc b/downstream/modules/platform/con-upgrade-controller-hub-eda-unified-ui.adoc index bdfdf6a7ac..1cbd85bd18 100644 --- a/downstream/modules/platform/con-upgrade-controller-hub-eda-unified-ui.adoc +++ b/downstream/modules/platform/con-upgrade-controller-hub-eda-unified-ui.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="con-upgrade-controller-hub-eda-unified-ui_{context}"] -= Automation controller and automation hub 2.4 and Event-Driven Ansible 2.6 with unified UI upgrades += {ControllerNameStart} and {HubName} 2.4 and {EDAName} 2.6 with unified UI upgrades [role="_abstract"] {PlatformNameShort} {PlatformVers} supports upgrades from {PlatformNameShort} 2.4 environments for all components, with the exception of {EDAName}. You can also configure a mixed environment with {EDAName} from 2.6 connected to an existing 2.4 cluster. diff --git a/downstream/modules/platform/con-upgrade-infrastructure-container-deployments.adoc b/downstream/modules/platform/con-upgrade-infrastructure-container-deployments.adoc index efeccfc58a..30d59c87f7 100644 --- a/downstream/modules/platform/con-upgrade-infrastructure-container-deployments.adoc +++ b/downstream/modules/platform/con-upgrade-infrastructure-container-deployments.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="upgrade-infrastructure-container-deployments] -= Container-based deployments += Infrastructure changes for container-based deployments [role="_abstract"] Container-based deployments require specific infrastructure changes during upgrade. For step-by-step upgrade instructions, see link:{URLContainerizedInstall}/maintaining-containerized-aap#updating-containerized-ansible-automation-platform[Upgrading containerized {PlatformNameShort}]. diff --git a/downstream/modules/platform/con-upgrade-infrastructure-operator-deployments.adoc b/downstream/modules/platform/con-upgrade-infrastructure-operator-deployments.adoc index 5cecdb3ea3..af3165eee9 100644 --- a/downstream/modules/platform/con-upgrade-infrastructure-operator-deployments.adoc +++ b/downstream/modules/platform/con-upgrade-infrastructure-operator-deployments.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="upgrade-infrastructure-operator-deployments] -= Operator-based deployments += Infrastructure changes for Operator-based deployments [role="_abstract"] The following sections describe the tested infrastructure changes for Operator-based deployments. For step-by-step upgrade instructions, see link:{URLOperatorInstallation}/operator-upgrade_licensing-gw[Upgrading {OperatorPlatformName} on {OCP}]. \ No newline at end of file diff --git a/downstream/modules/platform/con-upgrade-infrastructure-rpm-deployments.adoc b/downstream/modules/platform/con-upgrade-infrastructure-rpm-deployments.adoc index 583e25e944..e45f139489 100644 --- a/downstream/modules/platform/con-upgrade-infrastructure-rpm-deployments.adoc +++ b/downstream/modules/platform/con-upgrade-infrastructure-rpm-deployments.adoc @@ -1,7 +1,8 @@ :_mod-docs-content-type: CONCEPT [id="upgrade-infrastructure-rpm-deployments] -= RPM-based deployments + += Infrastructure changes for RPM deployments [role="_abstract"] The following sections describe the tested infrastructure changes for RPM-based deployments. For step-by-step upgrade instructions, see {LinkUpgrade}. \ No newline at end of file diff --git a/downstream/modules/platform/con-upgrade-multi-controller-enterprise.adoc b/downstream/modules/platform/con-upgrade-multi-controller-enterprise.adoc index c39187f7a0..4293323f99 100644 --- a/downstream/modules/platform/con-upgrade-multi-controller-enterprise.adoc +++ b/downstream/modules/platform/con-upgrade-multi-controller-enterprise.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="upgrade-multi-controller-enterprise"] -= Upgrading a 2.4 multi node {ControllerName} deployment to a {PlatformVers} {EnterpriseTopology} += 2.4 multi node {ControllerName} deployment to a {PlatformVers} {EnterpriseTopology} [role="_abstract"] Upgrade your 2.4 multi-node {ControllerName} setup to a {PlatformVers} {EnterpriseTopology}. diff --git a/downstream/modules/platform/con-upgrade-multi-controller-hub-enterprise.adoc b/downstream/modules/platform/con-upgrade-multi-controller-hub-enterprise.adoc index a4bb139229..ad51b88a0d 100644 --- a/downstream/modules/platform/con-upgrade-multi-controller-hub-enterprise.adoc +++ b/downstream/modules/platform/con-upgrade-multi-controller-hub-enterprise.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="upgrade-multi-controller-hub-enterprise"] -= Upgrading a 2.4 multi node {ControllerName} and {HubName} deployment to a {PlatformVers} {EnterpriseTopology} += 2.4 multi node {ControllerName} and {HubName} deployment to a {PlatformVers} {EnterpriseTopology} [role="_abstract"] You can upgrade your 2.4 multi node {ControllerName} and {HubName} deployment to a {PlatformVers} {EnterpriseTopology}. This section outlines the infrastructure changes, requirements, and an example inventory for upgrading. diff --git a/downstream/modules/platform/con-upgrade-single-controller-growth.adoc b/downstream/modules/platform/con-upgrade-single-controller-growth.adoc index 027d746fc2..508e08dc12 100644 --- a/downstream/modules/platform/con-upgrade-single-controller-growth.adoc +++ b/downstream/modules/platform/con-upgrade-single-controller-growth.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="upgrade-single-controller-growth"] -= Upgrading a 2.4 single {ControllerName} node deployment to a {PlatformVers} {GrowthTopology} += 2.4 single {ControllerName} node deployment to a {PlatformVers} {GrowthTopology} [role="_abstract"] Successfully upgrade your single {ControllerName} node deployment (version 2.4) to a {PlatformVers} {GrowthTopology}. diff --git a/downstream/modules/platform/con-upgrade-single-controller-hub-growth.adoc b/downstream/modules/platform/con-upgrade-single-controller-hub-growth.adoc index feb16b7828..106396784d 100644 --- a/downstream/modules/platform/con-upgrade-single-controller-hub-growth.adoc +++ b/downstream/modules/platform/con-upgrade-single-controller-hub-growth.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="upgrade-single-controller-hub-growth"] -= Upgrading a 2.4 single node {ControllerName} and {HubName} deployment to a {PlatformVers} {GrowthTopology} += 2.4 single node {ControllerName} and {HubName} deployment to a {PlatformVers} {GrowthTopology} [role="_abstract"] Upgrade your 2.4 single-node deployment ({ControllerName} and {HubName}) to a {PlatformVers} {GrowthTopology}. diff --git a/downstream/modules/platform/con-user-data-tracking.adoc b/downstream/modules/platform/con-user-data-tracking.adoc index 1f746aa11a..0c1ccc3fc1 100644 --- a/downstream/modules/platform/con-user-data-tracking.adoc +++ b/downstream/modules/platform/con-user-data-tracking.adoc @@ -2,7 +2,7 @@ [id="con-usability-analytics_{context}"] -= Usability analytics and data collection += Get insights on automation across your environment with {Analytics} [role="_abstract"] Usability data collection is included with {ControllerName} to collect data to better understand how {ControllerName} users specifically interact with {ControllerName}, to help enhance future releases, and to continue streamlining your user experience. diff --git a/downstream/modules/platform/con-using-chatbot.adoc b/downstream/modules/platform/con-using-chatbot.adoc index 92741b6677..f54a241934 100644 --- a/downstream/modules/platform/con-using-chatbot.adoc +++ b/downstream/modules/platform/con-using-chatbot.adoc @@ -2,13 +2,13 @@ [id="con-using-chatbot_{context}"] -= Using the {AAPchatbot} += Use the Ansible Lightspeed intelligent assistant [role="_abstract"] After you deploy the {AAPchatbot}, all Ansible users within the organization can access and use the chat interface to ask questions and receive information about the {PlatformNameShort}. -== Accessing the {AAPchatbot} +== Access the {AAPchatbot} . Log in to the {PlatformNameShort}. . Click the {AAPchatbot} icon image:chatbot-icon.png[{AAPchatbot} icon] that is displayed at the top right corner of the taskbar. + @@ -16,7 +16,7 @@ The {AAPchatbot} window opens with a welcome message, as shown in the following + image:aap-ansible-lightspeed-intelligent-assistant.png[{AAPchatbot}] -== Using the {AAPchatbot} +== Use the {AAPchatbot} You can perform the following tasks: diff --git a/downstream/modules/platform/con-using-custom-tls-certificates.adoc b/downstream/modules/platform/con-using-custom-tls-certificates.adoc index 2eec13c231..b7cb0dd57b 100644 --- a/downstream/modules/platform/con-using-custom-tls-certificates.adoc +++ b/downstream/modules/platform/con-using-custom-tls-certificates.adoc @@ -2,7 +2,7 @@ [id="using-custom-tls-certificates"] -= Configuring custom TLS certificates += Configure custom TLS certificates [role="_abstract"] {PlatformName} uses X.509 certificate and key pairs to secure traffic. These certificates secure internal traffic between {PlatformNameShort} components and external traffic for public UI and API connections. diff --git a/downstream/modules/platform/con-websocket-setup.adoc b/downstream/modules/platform/con-websocket-setup.adoc index 908b27f57a..b688e0f63e 100644 --- a/downstream/modules/platform/con-websocket-setup.adoc +++ b/downstream/modules/platform/con-websocket-setup.adoc @@ -2,7 +2,7 @@ [id="con-websocket-setup"] -= WebSocket configuration for {ControllerName} += Configure WebSocket load balancing [role="_abstract"] You can configure {ControllerName} to align the WebSocket configuration with your nginx or load balancer configuration. diff --git a/downstream/modules/platform/proc-aap-add-allowed-registries.adoc b/downstream/modules/platform/proc-aap-add-allowed-registries.adoc index 890dd649d8..6d06419dcf 100644 --- a/downstream/modules/platform/proc-aap-add-allowed-registries.adoc +++ b/downstream/modules/platform/proc-aap-add-allowed-registries.adoc @@ -2,7 +2,7 @@ [id="aap-add-allowed-registries_{context}"] -= Adding allowed registries to the {ControllerName} image configuration += Add allowed container registries [role="_abstract"] diff --git a/downstream/modules/platform/proc-aap-add-merge-subscriptions.adoc b/downstream/modules/platform/proc-aap-add-merge-subscriptions.adoc index 10baf04ac8..856d4b4be6 100644 --- a/downstream/modules/platform/proc-aap-add-merge-subscriptions.adoc +++ b/downstream/modules/platform/proc-aap-add-merge-subscriptions.adoc @@ -3,7 +3,7 @@ [id="proc-add-merge-subscriptions"] -= Adding subscriptions to a subscription allocation += Add subscriptions to a subscription allocation [role="_abstract"] diff --git a/downstream/modules/platform/proc-aap-define-backup-pvc.adoc b/downstream/modules/platform/proc-aap-define-backup-pvc.adoc new file mode 100644 index 0000000000..b488d289c8 --- /dev/null +++ b/downstream/modules/platform/proc-aap-define-backup-pvc.adoc @@ -0,0 +1,45 @@ +:_mod-docs-content-type: PROCEDURE + +[id="aap-define-backup-pvc_{context}"] + += Define a custom backup Persistent Volume Claim + +[role="_abstract"] +Define a custom Persistent Volume Claim (PVC) to automate the allocation of specific storage classes and volume sizes for backups. This configuration ensures your backup storage is appropriately sized and adheres to environment-specific storage policies. + +.Prerequisites +* You have an active {PlatformName} deployment on {OCPShort}. +* You have the `oc` CLI tool installed and cluster administrator access. + +.Procedure +. Create a backup YAML file (for example, `custom-pvc-backup.yaml`) with the `backup_pvc` and `backup_storage_requirements` parameters: ++ +[source, none] +---- +apiVersion: aap.ansible.com/v1alpha1 +kind: AnsibleAutomationPlatformBackup +metadata: + name: custom-backup + namespace: aap +spec: + deployment_name: myaap + backup_pvc: custom-controller-backup-pvc + backup_storage_class: rook-block + backup_storage_requirements: 7Gi + +---- ++ +. Apply the configuration: ++ +[source, none] +---- +oc apply -f custom-pvc-backup.yaml +---- + +.Verification +* Confirm the creation of the PVC by running the following command: ++ +[source, none] +---- +oc get pvc custom-aap-backup-pvc -n +---- diff --git a/downstream/modules/platform/proc-aap-enable-disable-auth.adoc b/downstream/modules/platform/proc-aap-enable-disable-auth.adoc index ee8757e106..cf6417124a 100644 --- a/downstream/modules/platform/proc-aap-enable-disable-auth.adoc +++ b/downstream/modules/platform/proc-aap-enable-disable-auth.adoc @@ -2,7 +2,7 @@ [id="aap-enable-disable-auth"] -= Enabling and disabling the local authenticator += Enable and disable the local authenticator [role="_abstract"] diff --git a/downstream/modules/platform/proc-aap-generate-manifest-file.adoc b/downstream/modules/platform/proc-aap-generate-manifest-file.adoc index 2b591b52d1..6c18c48394 100644 --- a/downstream/modules/platform/proc-aap-generate-manifest-file.adoc +++ b/downstream/modules/platform/proc-aap-generate-manifest-file.adoc @@ -3,7 +3,7 @@ [id="proc-aap-generate-manifest-file"] -= Downloading a manifest file += Download a manifest file [role="_abstract"] diff --git a/downstream/modules/platform/proc-aap-platform-ext-DB-restore.adoc b/downstream/modules/platform/proc-aap-platform-ext-DB-restore.adoc index 9f7625edbd..60f512c3a1 100644 --- a/downstream/modules/platform/proc-aap-platform-ext-DB-restore.adoc +++ b/downstream/modules/platform/proc-aap-platform-ext-DB-restore.adoc @@ -2,7 +2,7 @@ [id="aap-platform-ext-DB-restore_{context}"] -= Recovering your {PlatformNameShort} deployment from an external database += Restore from an external database [role="_abstract"] You can restore an external database on {OCP} using the Operator. Use the following procedure to restore from an external database. diff --git a/downstream/modules/platform/proc-aap-platform-gateway-backup.adoc b/downstream/modules/platform/proc-aap-platform-gateway-backup.adoc index 86ee31515b..277b514979 100644 --- a/downstream/modules/platform/proc-aap-platform-gateway-backup.adoc +++ b/downstream/modules/platform/proc-aap-platform-gateway-backup.adoc @@ -2,7 +2,7 @@ [id="aap-platform-gateway-backup_{context}"] -= Backing up your {PlatformNameShort} deployment += Back up your {PlatformNameShort} deployment [role="_abstract"] diff --git a/downstream/modules/platform/proc-aap-platform-gateway-restore.adoc b/downstream/modules/platform/proc-aap-platform-gateway-restore.adoc index e04c0280dd..ba03a08ab8 100644 --- a/downstream/modules/platform/proc-aap-platform-gateway-restore.adoc +++ b/downstream/modules/platform/proc-aap-platform-gateway-restore.adoc @@ -2,7 +2,7 @@ [id="aap-platform-gateway-restore_{context}"] -= Recovering your {PlatformNameShort} deployment += Restore your {PlatformNameShort} deployment [role="_abstract"] diff --git a/downstream/modules/platform/proc-aap-platform-pvc-restore.adoc b/downstream/modules/platform/proc-aap-platform-pvc-restore.adoc index f03ad6b9c9..64b3fcf50a 100644 --- a/downstream/modules/platform/proc-aap-platform-pvc-restore.adoc +++ b/downstream/modules/platform/proc-aap-platform-pvc-restore.adoc @@ -2,7 +2,7 @@ [id="aap-platform-pvc-restore_{context}"] -= Recovering your {PlatformNameShort} deployment from a PVC += Restore from a persistent volume claim (PVC) [role="_abstract"] A persistent volume claim (PVC) is a storage volume that stores data for {HubName} and {ControllerName} applications. diff --git a/downstream/modules/platform/proc-accessing-rpm-repositories-for-locally-mounted-dvd.adoc b/downstream/modules/platform/proc-accessing-rpm-repositories-for-locally-mounted-dvd.adoc index 9f1ab76ffd..5876b13f77 100644 --- a/downstream/modules/platform/proc-accessing-rpm-repositories-for-locally-mounted-dvd.adoc +++ b/downstream/modules/platform/proc-accessing-rpm-repositories-for-locally-mounted-dvd.adoc @@ -2,7 +2,7 @@ [id="accessing-rpm-repositories-for-locally-mounted-dvd_{context}"] -= Accessing RPM repositories from a locally mounted DVD += Access RPM repositories from a locally mounted DVD [role="_abstract"] In disconnected or air-gapped environments, you can install {PlatformNameShort} by using packages from a locally mounted RHEL DVD or ISO image. Learn how to mount the media and configure yum repositories to access BaseOS and AppStream packages for offline installation. diff --git a/downstream/modules/platform/proc-add-controller-access-token.adoc b/downstream/modules/platform/proc-add-controller-access-token.adoc index 7283d531de..51ebd50e8a 100644 --- a/downstream/modules/platform/proc-add-controller-access-token.adoc +++ b/downstream/modules/platform/proc-add-controller-access-token.adoc @@ -2,7 +2,7 @@ [id="proc-add-controller-access-token_{context}"] -= Connecting {OperatorResourceShort} to {Gateway} += Connect {OperatorResourceShort} to {PlatformNameShort} [role="_abstract"] diff --git a/downstream/modules/platform/proc-add-eda-safe-plugin-var.adoc b/downstream/modules/platform/proc-add-eda-safe-plugin-var.adoc index 76cdb66fb9..bebceb3dd2 100644 --- a/downstream/modules/platform/proc-add-eda-safe-plugin-var.adoc +++ b/downstream/modules/platform/proc-add-eda-safe-plugin-var.adoc @@ -2,7 +2,7 @@ [id="proc-add-eda-safe-plugin-var"] -= Adding a safe plugin variable to {EDAcontroller} += Add a safe plugin variable to {EDAcontroller} [role="_abstract"] When using `redhat.insights_eda` or similar plugins to run rulebook activations in {EDAcontroller}, you must add a safe plugin variable to a directory in {PlatformNameShort}. This ensures connection between {EDAcontroller} and the source plugin, and displays port mappings correctly. diff --git a/downstream/modules/platform/proc-adding-a-subscription.adoc b/downstream/modules/platform/proc-adding-a-subscription.adoc index 2c65d0af93..34eb5132ae 100644 --- a/downstream/modules/platform/proc-adding-a-subscription.adoc +++ b/downstream/modules/platform/proc-adding-a-subscription.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="adding-a-subscription"] -= Adding a subscription += Add your subscription [role="_abstract"] To add your subscription information, you can either upload your subscription manifest, or use your service account credentials to find the subscription associated with your account. diff --git a/downstream/modules/platform/proc-apply-selinux-context.adoc b/downstream/modules/platform/proc-apply-selinux-context.adoc index a50891a339..f0ccdd08a2 100644 --- a/downstream/modules/platform/proc-apply-selinux-context.adoc +++ b/downstream/modules/platform/proc-apply-selinux-context.adoc @@ -2,7 +2,7 @@ [id="proc-apply-selinux-context"] -= Applying the SELinux context += Apply the SELinux context [role="_abstract"] By applying the necessary SELinux context to the Pulp directories you ensure proper file access permissions and security policy compliance. They are essential for enabling the high availability (HA) deployment of {HubName} on SELinux. diff --git a/downstream/modules/platform/proc-applying-your-metrics-utility-config.adoc b/downstream/modules/platform/proc-applying-your-metrics-utility-config.adoc index 78101350e3..00be295095 100644 --- a/downstream/modules/platform/proc-applying-your-metrics-utility-config.adoc +++ b/downstream/modules/platform/proc-applying-your-metrics-utility-config.adoc @@ -1,7 +1,7 @@ // Module file name: proc-applying-your-metrics-utility-config.adoc :_mod-docs-content-type: PROCEDURE [id="proc-applying-your-metrics-utility-config_{context}"] -= Applying your `metrics-utility` configuration += Apply your `metrics-utility` configuration [role="_abstract"] If you are running `metrics-utility` on a new installation, you do not need to take any additional actions to apply your configuration. diff --git a/downstream/modules/platform/proc-attaching-subscriptions.adoc b/downstream/modules/platform/proc-attaching-subscriptions.adoc index 9f4d17ae12..5793c8d093 100644 --- a/downstream/modules/platform/proc-attaching-subscriptions.adoc +++ b/downstream/modules/platform/proc-attaching-subscriptions.adoc @@ -4,7 +4,7 @@ [id="proc-attaching-subscriptions"] -= Attaching your {PlatformName} subscription += Attach your {PlatformNameShort} subscription [role="_abstract"] diff --git a/downstream/modules/platform/proc-backup-aap-container.adoc b/downstream/modules/platform/proc-backup-aap-container.adoc index 210241a76e..340afeb3f0 100644 --- a/downstream/modules/platform/proc-backup-aap-container.adoc +++ b/downstream/modules/platform/proc-backup-aap-container.adoc @@ -2,7 +2,7 @@ [id="backing-up-containerized-ansible-automation-platform"] -= Backing up containerized {PlatformNameShort} += Back up containerized {PlatformNameShort} [role="_abstract"] Perform a backup of your {ContainerBase} of {PlatformNameShort}. diff --git a/downstream/modules/platform/proc-backup-aap.adoc b/downstream/modules/platform/proc-backup-aap.adoc index c94a727f5e..2b914627e8 100644 --- a/downstream/modules/platform/proc-backup-aap.adoc +++ b/downstream/modules/platform/proc-backup-aap.adoc @@ -2,7 +2,7 @@ [id="proc-backup-aap_{context}"] -= Backing up your {PlatformNameShort} instance += Back up your {PlatformNameShort} instance [role="_abstract"] Back up an existing {PlatformNameShort} instance by running the `.setup.sh` script with the `backup_dest` flag. This saves the content and configuration of your current environment. Use the compression flags `use_archive_compression` and `use_db_compression` to compress the backup artifacts before they are sent to the host running the backup operation. diff --git a/downstream/modules/platform/proc-benchmark-postgresql.adoc b/downstream/modules/platform/proc-benchmark-postgresql.adoc index e87f879719..a6830d7d9e 100644 --- a/downstream/modules/platform/proc-benchmark-postgresql.adoc +++ b/downstream/modules/platform/proc-benchmark-postgresql.adoc @@ -2,7 +2,7 @@ [id="benchmark-postgresql"] -= Benchmarking storage performance for the {PlatformNameShort} PostgreSQL database += Benchmark storage performance for the {PlatformNameShort} PostgreSQL database [role="_abstract"] Use the Flexible I/O Tester (FIO) tool to verify that your storage system meets minimum {PlatformNameShort} PostgreSQL database requirements. FIO benchmarks read and write IOPS performance to help you evaluate storage capabilities. diff --git a/downstream/modules/platform/proc-change-llm-model-chatbot-containerized-install.adoc b/downstream/modules/platform/proc-change-llm-model-chatbot-containerized-install.adoc index e6aca8dc7a..671008151f 100644 --- a/downstream/modules/platform/proc-change-llm-model-chatbot-containerized-install.adoc +++ b/downstream/modules/platform/proc-change-llm-model-chatbot-containerized-install.adoc @@ -2,7 +2,7 @@ [id="proc-change-llm-model-containerized-install_{context}"] -= Changing your LLM model += Change your LLM model [role="_abstract"] diff --git a/downstream/modules/platform/proc-change-llm-model-chatbot.adoc b/downstream/modules/platform/proc-change-llm-model-chatbot.adoc index f63b0b733d..00180dd96a 100644 --- a/downstream/modules/platform/proc-change-llm-model-chatbot.adoc +++ b/downstream/modules/platform/proc-change-llm-model-chatbot.adoc @@ -2,7 +2,7 @@ [id="proc-change-llm-model"] -= Changing your LLM model += Change your LLM model [role="_abstract"] diff --git a/downstream/modules/platform/proc-change-ssl-controller-ocp.adoc b/downstream/modules/platform/proc-change-ssl-controller-ocp.adoc index e3620319ab..1db5d9ae2c 100644 --- a/downstream/modules/platform/proc-change-ssl-controller-ocp.adoc +++ b/downstream/modules/platform/proc-change-ssl-controller-ocp.adoc @@ -2,7 +2,7 @@ [id="change-ssl-controller-ocp_{context}"] -= Changing the {ControllerName} SSL/TLS certificate and key on {OCPShort} += Change the SSL/TLS certificate and key on {ControllerName} on {OCPShort} [role="_abstract"] The following procedure describes how to change the SSL/TLS certificate and key for {ControllerName} running on {OCPShort}. diff --git a/downstream/modules/platform/proc-change-ssl-hub-ocp.adoc b/downstream/modules/platform/proc-change-ssl-hub-ocp.adoc index 808e1bac72..f4a765ecc1 100644 --- a/downstream/modules/platform/proc-change-ssl-hub-ocp.adoc +++ b/downstream/modules/platform/proc-change-ssl-hub-ocp.adoc @@ -2,7 +2,7 @@ [id="change-ssl-hub-ocp_{context}"] -= Changing the SSL/TLS certificate and key for {HubName} on {OCPShort} += Change the SSL/TLS certificate and key for {HubName} on {OCPShort} [role="_abstract"] The following procedure describes how to change the SSL/TLS certificate and key for your operator-based {PlatformNameShort} installation of {HubName} running on {OCPShort}. diff --git a/downstream/modules/platform/proc-change-ssl-installer.adoc b/downstream/modules/platform/proc-change-ssl-installer.adoc index f8e8feb782..b99e70426c 100644 --- a/downstream/modules/platform/proc-change-ssl-installer.adoc +++ b/downstream/modules/platform/proc-change-ssl-installer.adoc @@ -2,7 +2,7 @@ [id="change-ssl-installer"] -= Changing SSL/TLS certificates and keys using the installation program += Change SSL/TLS certificates and keys using the installation program [role="_abstract"] The following procedure describes how to change the SSL/TLS certificate and key in the inventory file. diff --git a/downstream/modules/platform/proc-change-ssl-manual-rpm.adoc b/downstream/modules/platform/proc-change-ssl-manual-rpm.adoc index 2d1fc79bd3..5889399dd3 100644 --- a/downstream/modules/platform/proc-change-ssl-manual-rpm.adoc +++ b/downstream/modules/platform/proc-change-ssl-manual-rpm.adoc @@ -2,7 +2,7 @@ [id="change-ssl-manual-rpm"] -= Changing SSL/TLS certificates and keys manually += Change SSL/TLS certificates and keys manually [role="_abstract"] The following procedure describes how to change SSL/TLS certificates and keys manually for all {PlatformNameShort} components. diff --git a/downstream/modules/platform/proc-change-tls-certs-installer.adoc b/downstream/modules/platform/proc-change-tls-certs-installer.adoc index 697e46a8b1..359c071ffd 100644 --- a/downstream/modules/platform/proc-change-tls-certs-installer.adoc +++ b/downstream/modules/platform/proc-change-tls-certs-installer.adoc @@ -2,7 +2,7 @@ [id="changing-tls-certificates-keys-using-installation-program"] -= Changing TLS certificates and keys using the installation program += Change TLS certificates and keys using the installation program [role="_abstract"] The following procedure describes how to update the TLS certificates and keys by using the installation program. diff --git a/downstream/modules/platform/proc-choosing-obtaining-installer-no-internet.adoc b/downstream/modules/platform/proc-choosing-obtaining-installer-no-internet.adoc index aa0d81d997..95fed8aa74 100644 --- a/downstream/modules/platform/proc-choosing-obtaining-installer-no-internet.adoc +++ b/downstream/modules/platform/proc-choosing-obtaining-installer-no-internet.adoc @@ -3,7 +3,7 @@ [id="proc-choosing-obtaining-installer-no-internet_{context}"] -= Installing without internet access += Install without internet access [role="_abstract"] Use the {PlatformName} *Bundle* installation program if you are unable to access the internet, or would prefer not to install separate components and dependencies from online repositories. diff --git a/downstream/modules/platform/proc-choosing-obtaining-installer.adoc b/downstream/modules/platform/proc-choosing-obtaining-installer.adoc index 4c6729cf15..5089d49e71 100644 --- a/downstream/modules/platform/proc-choosing-obtaining-installer.adoc +++ b/downstream/modules/platform/proc-choosing-obtaining-installer.adoc @@ -2,7 +2,7 @@ [id="proc-choosing-obtaining-installer_{context}"] -= Installing with internet access += Install with internet access [role="_abstract"] Choose the {PlatformName} installation program if your {RHEL} environment is connected to the internet. diff --git a/downstream/modules/platform/proc-cli-get-controller-address.adoc b/downstream/modules/platform/proc-cli-get-controller-address.adoc index 004d3a0e6b..e13f34af52 100644 --- a/downstream/modules/platform/proc-cli-get-controller-address.adoc +++ b/downstream/modules/platform/proc-cli-get-controller-address.adoc @@ -3,7 +3,7 @@ [id="proc-cli-get-controller-address{context}"] -= Fetching the {Gateway} web address += Fetch the {Gateway} web address [role="_abstract"] diff --git a/downstream/modules/platform/proc-cli-get-controller-pwd-decode.adoc b/downstream/modules/platform/proc-cli-get-controller-pwd-decode.adoc index df1dc8873a..c62d3578c2 100644 --- a/downstream/modules/platform/proc-cli-get-controller-pwd-decode.adoc +++ b/downstream/modules/platform/proc-cli-get-controller-pwd-decode.adoc @@ -3,7 +3,7 @@ [id="proc-cli-get-controller-pwd-decode{context}"] -= Decoding the {Gateway} password += Decode the {Gateway} password [role="_abstract"] diff --git a/downstream/modules/platform/proc-cli-get-controller-pwd.adoc b/downstream/modules/platform/proc-cli-get-controller-pwd.adoc index 1080668216..a10f6ec0ec 100644 --- a/downstream/modules/platform/proc-cli-get-controller-pwd.adoc +++ b/downstream/modules/platform/proc-cli-get-controller-pwd.adoc @@ -6,7 +6,7 @@ [id="proc-cli-get-controller-pwd{context}"] -= Fetching the {Gateway} password += Fetch the {Gateway} password [role="_abstract"] diff --git a/downstream/modules/platform/proc-configure-a-config-map.adoc b/downstream/modules/platform/proc-configure-a-config-map.adoc index 7e1b4915d9..d2d162f6a6 100644 --- a/downstream/modules/platform/proc-configure-a-config-map.adoc +++ b/downstream/modules/platform/proc-configure-a-config-map.adoc @@ -2,7 +2,7 @@ [id="proc-configure-a-config-map"] -= Creating a ConfigMap in the OpenShift UI YAML view += Create a ConfigMap in the OpenShift UI YAML view [role="_abstract"] Learn how to create a ConfigMap in the OpenShift UI YAML view to inject configuration data for the `metrics-utility` cronjobs. diff --git a/downstream/modules/platform/proc-configure-controller-OCP.adoc b/downstream/modules/platform/proc-configure-controller-OCP.adoc index fd50c8d16f..8eb3fb0a36 100644 --- a/downstream/modules/platform/proc-configure-controller-OCP.adoc +++ b/downstream/modules/platform/proc-configure-controller-OCP.adoc @@ -2,7 +2,7 @@ [id="configure-controller-OCP_{context}"] -= Minimizing downtime during {OCPShort} upgrade += Minimize downtime during {OCPShort} upgrade [role="_abstract"] Make the following configuration changes in {ControllerName} to minimize downtime during the upgrade. diff --git a/downstream/modules/platform/proc-configure-ext-db-mtls.adoc b/downstream/modules/platform/proc-configure-ext-db-mtls.adoc index d6f5b0ac40..64036444da 100644 --- a/downstream/modules/platform/proc-configure-ext-db-mtls.adoc +++ b/downstream/modules/platform/proc-configure-ext-db-mtls.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="configure-ext-db-mtls"] -= Optional: configuring mutual TLS (mTLS) authentication for an external database += Optional: configure mutual TLS (mTLS) authentication for an external database [role="_abstract"] mTLS authentication is disabled by default. To configure each component's database with mTLS authentication, add the following variables to your inventory file under the `[all:vars]` group and ensure each component has a different TLS certificate and key: diff --git a/downstream/modules/platform/proc-configure-haproxy-load-balancer.adoc b/downstream/modules/platform/proc-configure-haproxy-load-balancer.adoc index d5a090bb0c..db1501911d 100644 --- a/downstream/modules/platform/proc-configure-haproxy-load-balancer.adoc +++ b/downstream/modules/platform/proc-configure-haproxy-load-balancer.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="configuring-haproxy-load-balancer"] -= Configuring a HAProxy load balancer += Configure a HAProxy load balancer [role="_abstract"] Configure a HAProxy load balancer in front of {Gateway} with a custom CA cert. diff --git a/downstream/modules/platform/proc-configure-hub-azure-storage.adoc b/downstream/modules/platform/proc-configure-hub-azure-storage.adoc index 20302f35c3..3bcc00ea7d 100644 --- a/downstream/modules/platform/proc-configure-hub-azure-storage.adoc +++ b/downstream/modules/platform/proc-configure-hub-azure-storage.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="configure-hub-azure-storage"] -= Configuring Azure Blob Storage for {HubName} += Configure Azure Blob Storage for {HubName} [role="_abstract"] Azure Blob storage is a type of object storage that is supported in containerized installations. When using an Azure blob storage backend, set `hub_storage_backend` to `azure`. The Azure container needs to exist before running the installation program. diff --git a/downstream/modules/platform/proc-configure-hub-nfs-storage.adoc b/downstream/modules/platform/proc-configure-hub-nfs-storage.adoc index fc6ad478ee..01404e7f0f 100644 --- a/downstream/modules/platform/proc-configure-hub-nfs-storage.adoc +++ b/downstream/modules/platform/proc-configure-hub-nfs-storage.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="configure-hub-nfs-storage"] -= Configuring Network File System (NFS) storage for {HubName} += Configure Network File System (NFS) storage for {HubName} [role="_abstract"] NFS is a type of shared storage that is supported in containerized installations. Shared storage is required when installing more than one instance of {HubName} with a `file` storage backend. When installing a single instance of the {HubName}, shared storage is optional. diff --git a/downstream/modules/platform/proc-configure-hub-s3-storage.adoc b/downstream/modules/platform/proc-configure-hub-s3-storage.adoc index c65a0a654f..1de1a75f75 100644 --- a/downstream/modules/platform/proc-configure-hub-s3-storage.adoc +++ b/downstream/modules/platform/proc-configure-hub-s3-storage.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="configure-hub-s3-storage"] -= Configuring Amazon S3 storage for {HubName} += Configure Amazon S3 storage for {HubName} [role="_abstract"] Amazon S3 storage is a type of object storage that is supported in containerized installations. When using an AWS S3 storage backend, set `hub_storage_backend` to `s3`. The AWS S3 bucket needs to exist before running the installation program. diff --git a/downstream/modules/platform/proc-configure-known-proxies.adoc b/downstream/modules/platform/proc-configure-known-proxies.adoc index d2b90018d7..635619d010 100644 --- a/downstream/modules/platform/proc-configure-known-proxies.adoc +++ b/downstream/modules/platform/proc-configure-known-proxies.adoc @@ -2,7 +2,7 @@ [id="proc-configuring-known-proxies_{context}"] -= Configuring known proxies += Configure known proxies [role="_abstract"] diff --git a/downstream/modules/platform/proc-configure-lightspeed-variables-container-install.adoc b/downstream/modules/platform/proc-configure-lightspeed-variables-container-install.adoc index edb2c6daf1..a7872e177e 100644 --- a/downstream/modules/platform/proc-configure-lightspeed-variables-container-install.adoc +++ b/downstream/modules/platform/proc-configure-lightspeed-variables-container-install.adoc @@ -2,7 +2,7 @@ [id="proc-configure-lightspeed-variables_{context}"] -= Configuring {LightspeedShortName} variables in the inventory file += Configure Red Hat Ansible Lightspeed variables [role="_abstract"] To deploy {LightspeedShortName}, configure the required installation variables in your inventory file. diff --git a/downstream/modules/platform/proc-configure-local-repo-iso.adoc b/downstream/modules/platform/proc-configure-local-repo-iso.adoc index 0ac47f3c40..cf13641f93 100644 --- a/downstream/modules/platform/proc-configure-local-repo-iso.adoc +++ b/downstream/modules/platform/proc-configure-local-repo-iso.adoc @@ -2,7 +2,7 @@ [id="configure-local-repo-iso"] -= Configuring a local repository from a mounted ISO += Configure a local repository from a mounted ISO [role="_abstract"] You can use a {RHEL} Binary DVD image to access the necessary RPM source dependencies in a disconnected environment. diff --git a/downstream/modules/platform/proc-configure-local-repo-reposync.adoc b/downstream/modules/platform/proc-configure-local-repo-reposync.adoc index ffdcf49236..0df0a1d9ff 100644 --- a/downstream/modules/platform/proc-configure-local-repo-reposync.adoc +++ b/downstream/modules/platform/proc-configure-local-repo-reposync.adoc @@ -2,7 +2,7 @@ [id="configure-local-repo-reposync"] -= Configuring a local repository using reposync += Configure a local repository using reposync [role="_abstract"] With the `reposync` command you can to synchronize the BaseOS and AppStream repositories to a local directory on a {RHEL} host with an active internet connection. You can then transfer the repositories to your disconnected environment. diff --git a/downstream/modules/platform/proc-configure-mcp-server-containerized-install.adoc b/downstream/modules/platform/proc-configure-mcp-server-containerized-install.adoc index 7ed64ed3aa..15111f4282 100644 --- a/downstream/modules/platform/proc-configure-mcp-server-containerized-install.adoc +++ b/downstream/modules/platform/proc-configure-mcp-server-containerized-install.adoc @@ -2,7 +2,7 @@ [id="proc-configure-mcp-server-containerized-install_{context}"] -= Deploying an Ansible MCP server on a {ContainerBase} += Deploy the Ansible MCP server on a {ContainerBase} [role="_abstract"] As an organization administrator, you can deploy and configure an Ansible MCP server on a {ContainerBase} of {PlatformNameShort} {PlatformVers}. Use the following procedure to deploy and configure the Ansible MCP server. diff --git a/downstream/modules/platform/proc-configure-mcp-server-operator-install.adoc b/downstream/modules/platform/proc-configure-mcp-server-operator-install.adoc index 5c7e133a78..88b7e209c9 100644 --- a/downstream/modules/platform/proc-configure-mcp-server-operator-install.adoc +++ b/downstream/modules/platform/proc-configure-mcp-server-operator-install.adoc @@ -2,7 +2,7 @@ [id="proc-configure-mcp-server-operator-install_{context}"] -= Deploying an Ansible MCP server on an {OperatorBase} += Deploy the Ansible MCP server on {OperatorBase} [role="_abstract"] diff --git a/downstream/modules/platform/proc-configure-pac-enforcement.adoc b/downstream/modules/platform/proc-configure-pac-enforcement.adoc index 952bf19c08..425858c46c 100644 --- a/downstream/modules/platform/proc-configure-pac-enforcement.adoc +++ b/downstream/modules/platform/proc-configure-pac-enforcement.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="configure-enforcement-points_{context}"] -= Configuring enforcement points += Configure enforcement points [role="_abstract"] After you have set up your {PlatformNameShort} instance to communicate with the OPA server, you can set up enforcement points where you want the policy to be applied. diff --git a/downstream/modules/platform/proc-configure-pac-settings.adoc b/downstream/modules/platform/proc-configure-pac-settings.adoc index 7a22bf8c9e..a37b9d020d 100644 --- a/downstream/modules/platform/proc-configure-pac-settings.adoc +++ b/downstream/modules/platform/proc-configure-pac-settings.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="configure-pac-settings_{context}"] -= Configuring policy enforcement settings += Configure policy enforcement settings [role="_abstract"] diff --git a/downstream/modules/platform/proc-configure-pg-extra-settings.adoc b/downstream/modules/platform/proc-configure-pg-extra-settings.adoc index 9eb11e829b..72863446e8 100644 --- a/downstream/modules/platform/proc-configure-pg-extra-settings.adoc +++ b/downstream/modules/platform/proc-configure-pg-extra-settings.adoc @@ -2,7 +2,7 @@ [id="proc-configure-pg-extra-settings"] -= Configuring custom PostgreSQL settings for {PlatformNameShort} += Configure custom PostgreSQL settings [role="_abstract"] diff --git a/downstream/modules/platform/proc-configure-pulpcore-service.adoc b/downstream/modules/platform/proc-configure-pulpcore-service.adoc index a73671442d..98ee5a8a87 100644 --- a/downstream/modules/platform/proc-configure-pulpcore-service.adoc +++ b/downstream/modules/platform/proc-configure-pulpcore-service.adoc @@ -2,7 +2,7 @@ [id="proc-configure-pulpcore-service"] -= Configuring pulpcore.service += Configure pulpcore.service [role="_abstract"] You can configure the `pulp` service to ensure that {HubName} services start only after the network and the mounting of the remote mount points. diff --git a/downstream/modules/platform/proc-configure-vs-code-containerized-install.adoc b/downstream/modules/platform/proc-configure-vs-code-containerized-install.adoc index 04c881191f..9619a603bb 100644 --- a/downstream/modules/platform/proc-configure-vs-code-containerized-install.adoc +++ b/downstream/modules/platform/proc-configure-vs-code-containerized-install.adoc @@ -2,7 +2,7 @@ [id="proc-configure-vs-code-containerized-install_{context}"] -= Configuring the Ansible {VSCode} extension += Configure the Ansible {VSCode} extension [role="_abstract"] If you deployed the Ansible Lightspeed coding assistant, you must also configure the Ansible {VSCode} extension with the generated Ansible Lightspeed URL. diff --git a/downstream/modules/platform/proc-configuring-controller-image-pull-policy.adoc b/downstream/modules/platform/proc-configuring-controller-image-pull-policy.adoc index 1d3ee87ea2..7b81e54b01 100644 --- a/downstream/modules/platform/proc-configuring-controller-image-pull-policy.adoc +++ b/downstream/modules/platform/proc-configuring-controller-image-pull-policy.adoc @@ -2,7 +2,7 @@ [id="proc-configuring-controller-image-pull-policy_{context}"] -= Configuring your controller image pull policy += Configure your {ControllerName} image pull policy [role="_abstract"] diff --git a/downstream/modules/platform/proc-configuring-controller-ldap-security.adoc b/downstream/modules/platform/proc-configuring-controller-ldap-security.adoc index e3ccf8b410..915b0253b9 100644 --- a/downstream/modules/platform/proc-configuring-controller-ldap-security.adoc +++ b/downstream/modules/platform/proc-configuring-controller-ldap-security.adoc @@ -2,7 +2,7 @@ [id="proc_configuring-controller-ldap-security_{context}"] -= Configuring your controller LDAP security += Configure your LDAP for {ControllerName} [role="_abstract"] diff --git a/downstream/modules/platform/proc-configuring-controller-route-options.adoc b/downstream/modules/platform/proc-configuring-controller-route-options.adoc index 7a4b428a0e..6f7a400517 100644 --- a/downstream/modules/platform/proc-configuring-controller-route-options.adoc +++ b/downstream/modules/platform/proc-configuring-controller-route-options.adoc @@ -2,7 +2,7 @@ [id="proc-configuring-controller-route-options_{context}"] -= Configuring your {ControllerName} operator route options += Configure {ControllerName} route options [role="_abstract"] diff --git a/downstream/modules/platform/proc-configuring-discovery.adoc b/downstream/modules/platform/proc-configuring-discovery.adoc index 1ddf8c6f22..dcc82d714a 100644 --- a/downstream/modules/platform/proc-configuring-discovery.adoc +++ b/downstream/modules/platform/proc-configuring-discovery.adoc @@ -2,7 +2,7 @@ [id="proc-configuring-discovery"] -= Configuring automatic discovery of other {ControllerName} nodes += Configure automatic discovery of other {ControllerName} nodes [role="_abstract"] You can configure WebsSocket connections to enable {ControllerName} to automatically handle discovery of other {ControllerName} nodes through the Instance record in the database. diff --git a/downstream/modules/platform/proc-configuring-reverse-proxy.adoc b/downstream/modules/platform/proc-configuring-reverse-proxy.adoc index ae2636172c..2e51e74d83 100644 --- a/downstream/modules/platform/proc-configuring-reverse-proxy.adoc +++ b/downstream/modules/platform/proc-configuring-reverse-proxy.adoc @@ -2,7 +2,7 @@ [id="proc-configuring-reverse-proxy_{context}"] -= Configuring a reverse proxy through a load balancer += Configure a reverse proxy through a load balancer [role="_abstract"] A reverse proxy manages external requests to servers, offering load balancing and concealing server identities for added security. diff --git a/downstream/modules/platform/proc-connect-ai-agent-ansible-mcp-server.adoc b/downstream/modules/platform/proc-connect-ai-agent-ansible-mcp-server.adoc index 3499224cca..66e8c57b17 100644 --- a/downstream/modules/platform/proc-connect-ai-agent-ansible-mcp-server.adoc +++ b/downstream/modules/platform/proc-connect-ai-agent-ansible-mcp-server.adoc @@ -2,7 +2,7 @@ [id="proc-connect-ai-agent-ansible-mcp-server_{context}"] -= Connecting an AI agent to the Ansible MCP server += Connect an AI agent to the Ansible MCP server [role="_abstract"] diff --git a/downstream/modules/platform/proc-connecting-nodes-through-mesh-ingress.adoc b/downstream/modules/platform/proc-connecting-nodes-through-mesh-ingress.adoc index 62126693ba..8696dbb5cd 100644 --- a/downstream/modules/platform/proc-connecting-nodes-through-mesh-ingress.adoc +++ b/downstream/modules/platform/proc-connecting-nodes-through-mesh-ingress.adoc @@ -2,7 +2,7 @@ [id="proc-connecting-nodes-through-mesh-ingress"] -= Connecting nodes through mesh ingress += Set up mesh ingress for environments that forbid inbound connections [role="_abstract"] If you are using a network which restricts or does not permit inbound connections, using an instance to set up a hop node peered to the control plane can cause problems. diff --git a/downstream/modules/platform/proc-containerized-troubleshoot-gathering-logs.adoc b/downstream/modules/platform/proc-containerized-troubleshoot-gathering-logs.adoc index 45b8287f62..c076e57b41 100644 --- a/downstream/modules/platform/proc-containerized-troubleshoot-gathering-logs.adoc +++ b/downstream/modules/platform/proc-containerized-troubleshoot-gathering-logs.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="gathering-ansible-automation-platform-logs"] -= Gathering {PlatformNameShort} logs += Gather logs from your containerized deployment [role="_abstract"] With the `sos` utility, you can collect configuration, diagnostic, and troubleshooting data, and give those files to Red Hat Technical Support. An `sos` report is a common starting point for Red Hat technical support engineers when performing analysis of a service request for {PlatformNameShort}. diff --git a/downstream/modules/platform/proc-content-signing-hub-on-ocp.adoc b/downstream/modules/platform/proc-content-signing-hub-on-ocp.adoc index fe94912a95..989fef0c73 100644 --- a/downstream/modules/platform/proc-content-signing-hub-on-ocp.adoc +++ b/downstream/modules/platform/proc-content-signing-hub-on-ocp.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="content-signing-hub-on-ocp_{context}"] -= Configuring content signing for {OperatorHub} += Configure content signing for {HubName} [role="_abstract"] diff --git a/downstream/modules/platform/proc-control-data-collection.adoc b/downstream/modules/platform/proc-control-data-collection.adoc index 39d48c02e1..d7bd5c5bdc 100644 --- a/downstream/modules/platform/proc-control-data-collection.adoc +++ b/downstream/modules/platform/proc-control-data-collection.adoc @@ -2,7 +2,7 @@ [id="proc-controlling-data-collection_{context}"] -= Controlling data collection from {ControllerName} += Control data collection from {ControllerName} [role="_abstract"] You can control how {ControllerName} collects data from the {MenuSetSystem} menu. diff --git a/downstream/modules/platform/proc-controller-access-topology-viewer.adoc b/downstream/modules/platform/proc-controller-access-topology-viewer.adoc index a584fed62c..de6e88a069 100644 --- a/downstream/modules/platform/proc-controller-access-topology-viewer.adoc +++ b/downstream/modules/platform/proc-controller-access-topology-viewer.adoc @@ -2,7 +2,7 @@ [id="proc-controller-access-topology-viewer"] -= Accessing the topology viewer += Access the topology viewer [role="_abstract"] Use the following procedure to access the topology viewer from the {ControllerName} UI. diff --git a/downstream/modules/platform/proc-controller-add-groups-to-groups.adoc b/downstream/modules/platform/proc-controller-add-groups-to-groups.adoc index e50c5b5eb9..fb2ebfb7e6 100644 --- a/downstream/modules/platform/proc-controller-add-groups-to-groups.adoc +++ b/downstream/modules/platform/proc-controller-add-groups-to-groups.adoc @@ -2,7 +2,7 @@ [id="proc-controller-add-groups-to-groups"] -= Adding groups within groups += Add groups within groups [role="_abstract"] You can create a hierarchy of groups by adding groups within groups. diff --git a/downstream/modules/platform/proc-controller-add-groups.adoc b/downstream/modules/platform/proc-controller-add-groups.adoc index 9948e62db8..d876207739 100644 --- a/downstream/modules/platform/proc-controller-add-groups.adoc +++ b/downstream/modules/platform/proc-controller-add-groups.adoc @@ -2,7 +2,7 @@ [id="proc-controller-add-groups"] -= Adding groups to inventories += Add groups to inventories [role="_abstract"] You can add groups to standard inventories in {ControllerName} to organize hosts. diff --git a/downstream/modules/platform/proc-controller-add-hosts.adoc b/downstream/modules/platform/proc-controller-add-hosts.adoc index a58d09c39f..a868f64bb4 100644 --- a/downstream/modules/platform/proc-controller-add-hosts.adoc +++ b/downstream/modules/platform/proc-controller-add-hosts.adoc @@ -2,7 +2,7 @@ [id="proc-controller-add-hosts"] -= Adding hosts to an inventory += Add hosts to inventory groups [role="_abstract"] You can add hosts to an inventory either by creating new hosts or by associating existing hosts with the inventory. diff --git a/downstream/modules/platform/proc-controller-add-new-schedule-from-resource.adoc b/downstream/modules/platform/proc-controller-add-new-schedule-from-resource.adoc index d76078d161..f10a197904 100644 --- a/downstream/modules/platform/proc-controller-add-new-schedule-from-resource.adoc +++ b/downstream/modules/platform/proc-controller-add-new-schedule-from-resource.adoc @@ -2,7 +2,7 @@ [id="controller-adding-new-schedule-from-resource"] -= Adding a new schedule from a resource page += Add a new schedule from a resource page [role="_abstract"] You can create a new schedule from the *Schedules* tab of a resource page, such as a template, project, or inventory source. diff --git a/downstream/modules/platform/proc-controller-add-organization-user.adoc b/downstream/modules/platform/proc-controller-add-organization-user.adoc index 5bdd5c6a23..7ee502f7e8 100644 --- a/downstream/modules/platform/proc-controller-add-organization-user.adoc +++ b/downstream/modules/platform/proc-controller-add-organization-user.adoc @@ -2,7 +2,7 @@ [id="proc-controller-add-organization-user"] -= Assigning a user to an organization += Assign a user to an organization [role="_abstract"] You can give a user with access to an organization, and therefore the resources within the organization, by assigning them to the organization and managing the organization roles associated with the user. diff --git a/downstream/modules/platform/proc-controller-add-source.adoc b/downstream/modules/platform/proc-controller-add-source.adoc index 2fe82b1291..214876e32b 100644 --- a/downstream/modules/platform/proc-controller-add-source.adoc +++ b/downstream/modules/platform/proc-controller-add-source.adoc @@ -2,7 +2,7 @@ [id="proc-controller-add-source"] -= Adding a source += Add a source to an inventory [role="_abstract"] Use the following procedure to add a source to an inventory. diff --git a/downstream/modules/platform/proc-controller-add-users-job-templates.adoc b/downstream/modules/platform/proc-controller-add-users-job-templates.adoc index e5addd5433..d93e24d209 100644 --- a/downstream/modules/platform/proc-controller-add-users-job-templates.adoc +++ b/downstream/modules/platform/proc-controller-add-users-job-templates.adoc @@ -2,7 +2,7 @@ [id="controller-credential-add-users-job-templates"] -= Adding new users and job templates to existing credentials += Add new users and job templates to existing credentials [role="_abstract"] You can add new users and job templates to existing credentials in {ControllerName}. diff --git a/downstream/modules/platform/proc-controller-adding-a-project.adoc b/downstream/modules/platform/proc-controller-adding-a-project.adoc index af338bf78f..5c3a3f9e16 100644 --- a/downstream/modules/platform/proc-controller-adding-a-project.adoc +++ b/downstream/modules/platform/proc-controller-adding-a-project.adoc @@ -2,7 +2,7 @@ [id="proc-controller-adding-a-project"] -= Adding a new project += Add a new project [role="_abstract"] You can create a logical collection of playbooks, called projects in {ControllerName}. diff --git a/downstream/modules/platform/proc-controller-adding-gpg-key.adoc b/downstream/modules/platform/proc-controller-adding-gpg-key.adoc index 5964bd5db9..b25fd2138c 100644 --- a/downstream/modules/platform/proc-controller-adding-gpg-key.adoc +++ b/downstream/modules/platform/proc-controller-adding-gpg-key.adoc @@ -2,7 +2,7 @@ [id="proc-controller-adding-gpg-key"] -= Adding a GPG key to {ControllerName} += Add a GPG key to {ControllerName} [role="_abstract"] You can add a GPG public key to {ControllerName} and enable content signing and validation for your projects. diff --git a/downstream/modules/platform/proc-controller-adding-inv-permissions.adoc b/downstream/modules/platform/proc-controller-adding-inv-permissions.adoc index d26ef78330..4bfecbfe40 100644 --- a/downstream/modules/platform/proc-controller-adding-inv-permissions.adoc +++ b/downstream/modules/platform/proc-controller-adding-inv-permissions.adoc @@ -2,7 +2,7 @@ [id="proc-controller-adding-inv-permissions"] -= Adding permissions to inventories += Add permissions to inventories [role="_abstract"] Use the following procedure to add permissions to inventories: diff --git a/downstream/modules/platform/proc-controller-adding-new-schedule.adoc b/downstream/modules/platform/proc-controller-adding-new-schedule.adoc index 036972f8c9..28ae5c1271 100644 --- a/downstream/modules/platform/proc-controller-adding-new-schedule.adoc +++ b/downstream/modules/platform/proc-controller-adding-new-schedule.adoc @@ -2,7 +2,7 @@ [id="controller-adding-new-schedule"] -= Adding a new schedule += Add a new schedule [role="_abstract"] You can create a new schedule for a job template, workflow job template, inventory source, project sync, or management job template. diff --git a/downstream/modules/platform/proc-controller-adding-permissions.adoc b/downstream/modules/platform/proc-controller-adding-permissions.adoc index adcd737302..ee3af56dfb 100644 --- a/downstream/modules/platform/proc-controller-adding-permissions.adoc +++ b/downstream/modules/platform/proc-controller-adding-permissions.adoc @@ -2,7 +2,7 @@ [id="proc-controller-adding-permissions"] -= Adding permissions to templates += Add permissions to templates [role="_abstract"] You can add permissions to a template to allow specific users or teams to have access to it. diff --git a/downstream/modules/platform/proc-controller-amazon-ec2.adoc b/downstream/modules/platform/proc-controller-amazon-ec2.adoc index 2646747868..04787aeb53 100644 --- a/downstream/modules/platform/proc-controller-amazon-ec2.adoc +++ b/downstream/modules/platform/proc-controller-amazon-ec2.adoc @@ -2,7 +2,7 @@ [id="proc-controller-amazon-ec2"] -= {AWS} EC2 += Source an inventory from {AWS} EC2 [role="_abstract"] Use the following procedure to configure an AWS EC2-sourced inventory. diff --git a/downstream/modules/platform/proc-controller-api-disable-basic-auth.adoc b/downstream/modules/platform/proc-controller-api-disable-basic-auth.adoc index 2e05babfdc..8ab45cab0e 100644 --- a/downstream/modules/platform/proc-controller-api-disable-basic-auth.adoc +++ b/downstream/modules/platform/proc-controller-api-disable-basic-auth.adoc @@ -2,7 +2,7 @@ [id="proc-controller-api-disable-basic-auth"] -= Disabling basic authentication += Disable basic authentication [role="_abstract"] You can disable basic authentication for security purposes. diff --git a/downstream/modules/platform/proc-controller-api-enable-users-oauth.adoc b/downstream/modules/platform/proc-controller-api-enable-users-oauth.adoc index 719d55734a..feb4bc510b 100644 --- a/downstream/modules/platform/proc-controller-api-enable-users-oauth.adoc +++ b/downstream/modules/platform/proc-controller-api-enable-users-oauth.adoc @@ -2,7 +2,7 @@ [id="api-enable-users-oauth"] -= Enabling external users to create OAuth 2 tokens += Enable external users to create OAuth 2 tokens [role="_abstract"] By default, external users such as those created by single sign-on are not able to generate OAuth tokens for security purposes. diff --git a/downstream/modules/platform/proc-controller-api-session-auth.adoc b/downstream/modules/platform/proc-controller-api-session-auth.adoc index 113fdf02e3..2dcf672d89 100644 --- a/downstream/modules/platform/proc-controller-api-session-auth.adoc +++ b/downstream/modules/platform/proc-controller-api-session-auth.adoc @@ -2,7 +2,7 @@ [id="controller-api-session-auth"] -= Using session authentication += Use session authentication [role="_abstract"] You can use session authentication when logging in directly to the {ControllerName}'s API or UI to manually create resources, such as inventories, projects, and job templates and start jobs in the browser. diff --git a/downstream/modules/platform/proc-controller-apps-create-tokens.adoc b/downstream/modules/platform/proc-controller-apps-create-tokens.adoc index 367b190878..3cdaea6774 100644 --- a/downstream/modules/platform/proc-controller-apps-create-tokens.adoc +++ b/downstream/modules/platform/proc-controller-apps-create-tokens.adoc @@ -2,7 +2,7 @@ [id="proc-controller-apps-create-tokens"] -= Adding tokens += Associate tokens with applications [role="_abstract"] You can view a list of users that have tokens to access an application by selecting the *Tokens* tab in the *OAuth Applications* details page. diff --git a/downstream/modules/platform/proc-controller-associate-instances-to-instance-group.adoc b/downstream/modules/platform/proc-controller-associate-instances-to-instance-group.adoc index 248ae3af20..a1b0a29c8f 100644 --- a/downstream/modules/platform/proc-controller-associate-instances-to-instance-group.adoc +++ b/downstream/modules/platform/proc-controller-associate-instances-to-instance-group.adoc @@ -2,7 +2,7 @@ [id="controller-associate-instances-to-instance-group"] -= Associating instances to an instance group += Associate instances to an instance group [role="_abstract"] Learn how to associate instances to an instance group in {ControllerName}. diff --git a/downstream/modules/platform/proc-controller-azure-resource-manager.adoc b/downstream/modules/platform/proc-controller-azure-resource-manager.adoc index 2970892c6b..1e3c9d1996 100644 --- a/downstream/modules/platform/proc-controller-azure-resource-manager.adoc +++ b/downstream/modules/platform/proc-controller-azure-resource-manager.adoc @@ -2,7 +2,7 @@ [id="proc-controller-azure-resource-manager"] -= {Azure} resource manager += Source an inventory from {Azure} resource manager [role="_abstract"] Use the following procedure to configure an {Azure} Resource Manager-sourced inventory. diff --git a/downstream/modules/platform/proc-controller-build-workflow.adoc b/downstream/modules/platform/proc-controller-build-workflow.adoc index d67aa9c531..18f9fc7f8f 100644 --- a/downstream/modules/platform/proc-controller-build-workflow.adoc +++ b/downstream/modules/platform/proc-controller-build-workflow.adoc @@ -2,7 +2,7 @@ [id="controller-build-workflow"] -= Building a workflow += Build a workflow [role="_abstract"] You can build a workflow by adding nodes and defining their relationships in the workflow visualizer. diff --git a/downstream/modules/platform/proc-controller-building-nodes-scenarios.adoc b/downstream/modules/platform/proc-controller-building-nodes-scenarios.adoc index 2af1ebeddc..72067fb699 100644 --- a/downstream/modules/platform/proc-controller-building-nodes-scenarios.adoc +++ b/downstream/modules/platform/proc-controller-building-nodes-scenarios.adoc @@ -2,7 +2,7 @@ [id="controller-building-nodes-scenarios"] -= Building nodes scenarios += Build nodes scenarios [role="_abstract"] Learn how to manage nodes in the following scenarios. diff --git a/downstream/modules/platform/proc-controller-config-notifications-source.adoc b/downstream/modules/platform/proc-controller-config-notifications-source.adoc index 08fc21af7d..b5894ff2ea 100644 --- a/downstream/modules/platform/proc-controller-config-notifications-source.adoc +++ b/downstream/modules/platform/proc-controller-config-notifications-source.adoc @@ -2,7 +2,7 @@ [id="controller-config-notifications-source"] -= Configuring notifications for the source += Configure notifications for the source [role="_abstract"] After you create a source for an inventory in {ControllerName}, you can configure notifications for that source. diff --git a/downstream/modules/platform/proc-controller-configure-analytics.adoc b/downstream/modules/platform/proc-controller-configure-analytics.adoc index 3635bf115d..0143822187 100644 --- a/downstream/modules/platform/proc-controller-configure-analytics.adoc +++ b/downstream/modules/platform/proc-controller-configure-analytics.adoc @@ -2,7 +2,7 @@ [id="proc-controller-configure-analytics"] -= Configuring {Analytics} += Configure {Analytics} [role="_abstract"] When you imported your license for the first time, you were automatically opted in for the collection of data that powers {Analytics}, a cloud service that is part of the {PlatformNameShort} subscription. diff --git a/downstream/modules/platform/proc-controller-configure-transparent-SAML.adoc b/downstream/modules/platform/proc-controller-configure-transparent-SAML.adoc index 6826b7ebb1..8cf82b86cf 100644 --- a/downstream/modules/platform/proc-controller-configure-transparent-SAML.adoc +++ b/downstream/modules/platform/proc-controller-configure-transparent-SAML.adoc @@ -2,7 +2,7 @@ [id="controller-configure-transparent-SAML"] -= Configuring transparent SAML logins += Configure transparent SAML logins [role="_abstract"] diff --git a/downstream/modules/platform/proc-controller-copy-workflow-job-template.adoc b/downstream/modules/platform/proc-controller-copy-workflow-job-template.adoc index 60f7fec61b..6364e9120d 100644 --- a/downstream/modules/platform/proc-controller-copy-workflow-job-template.adoc +++ b/downstream/modules/platform/proc-controller-copy-workflow-job-template.adoc @@ -2,7 +2,7 @@ [id="controller-copy-workflow-job-template"] -= Duplicating a workflow job template += Duplicate a workflow job template [role="_abstract"] With {ControllerName} you can duplicate a workflow job template. diff --git a/downstream/modules/platform/proc-controller-create-application.adoc b/downstream/modules/platform/proc-controller-create-application.adoc index 36d67dbf70..b9e9d13f4a 100644 --- a/downstream/modules/platform/proc-controller-create-application.adoc +++ b/downstream/modules/platform/proc-controller-create-application.adoc @@ -2,7 +2,7 @@ [id="proc-controller-create-application"] -= Creating a new application += Create a new application [role="_abstract"] diff --git a/downstream/modules/platform/proc-controller-create-container-group.adoc b/downstream/modules/platform/proc-controller-create-container-group.adoc index 4e602e5ead..db6cfe758a 100644 --- a/downstream/modules/platform/proc-controller-create-container-group.adoc +++ b/downstream/modules/platform/proc-controller-create-container-group.adoc @@ -2,7 +2,7 @@ [id="controller-create-container-group"] -= Creating a container group += Create a container group [role="_abstract"] You can create a `ContainerGroup` in {ControllerName} to run jobs in containers on an OpenShift or Kubernetes cluster. diff --git a/downstream/modules/platform/proc-controller-create-credential.adoc b/downstream/modules/platform/proc-controller-create-credential.adoc index b9954b816c..9ecd09fb4e 100644 --- a/downstream/modules/platform/proc-controller-create-credential.adoc +++ b/downstream/modules/platform/proc-controller-create-credential.adoc @@ -2,7 +2,7 @@ [id="controller-create-credential"] -= Creating new credentials += Create new credentials [role="_abstract"] Learn how to create new credentials in {ControllerNameStart}. diff --git a/downstream/modules/platform/proc-controller-create-custom-notifications.adoc b/downstream/modules/platform/proc-controller-create-custom-notifications.adoc index 2dbb668721..342d280323 100644 --- a/downstream/modules/platform/proc-controller-create-custom-notifications.adoc +++ b/downstream/modules/platform/proc-controller-create-custom-notifications.adoc @@ -2,7 +2,7 @@ [id="controller-create-custom-notifications"] -= Creating custom notifications += Create custom notifications [role="_abstract"] You can xref:controller-attributes-custom-notifications[customize the text content] of each xref:controller-notification-types[Notification type] on the notification form. diff --git a/downstream/modules/platform/proc-controller-create-host.adoc b/downstream/modules/platform/proc-controller-create-host.adoc index d4f0d4c719..ea823cbee7 100644 --- a/downstream/modules/platform/proc-controller-create-host.adoc +++ b/downstream/modules/platform/proc-controller-create-host.adoc @@ -2,7 +2,7 @@ [id="proc-controller-create-host"] -= Creating a host += Create a host [role="_abstract"] Learn how to create a new host by providing a name, selecting an inventory, and optionally defining a description and associated variables. diff --git a/downstream/modules/platform/proc-controller-create-insights-credential.adoc b/downstream/modules/platform/proc-controller-create-insights-credential.adoc index eeb647c470..88cecc3153 100644 --- a/downstream/modules/platform/proc-controller-create-insights-credential.adoc +++ b/downstream/modules/platform/proc-controller-create-insights-credential.adoc @@ -2,7 +2,7 @@ [id="controller-create-insights-credential"] -= Creating {RHLightspeed} credentials += Create {RHLightspeed} credentials [role="_abstract"] To create a {RHLightspeed} credential, use the following procedure. diff --git a/downstream/modules/platform/proc-controller-create-insights-project.adoc b/downstream/modules/platform/proc-controller-create-insights-project.adoc index c89d382fb4..3396427112 100644 --- a/downstream/modules/platform/proc-controller-create-insights-project.adoc +++ b/downstream/modules/platform/proc-controller-create-insights-project.adoc @@ -2,7 +2,7 @@ [id="controller-create-insights-project"] -= Creating a {RHLightspeed} project += Create a {RHLightspeed} project [role="_abstract"] Create an {ControllerName} project linked to {RHLightspeed} and retrieve remediation playbooks. diff --git a/downstream/modules/platform/proc-controller-create-instance-group.adoc b/downstream/modules/platform/proc-controller-create-instance-group.adoc index 3f2b15914b..23d726dea6 100644 --- a/downstream/modules/platform/proc-controller-create-instance-group.adoc +++ b/downstream/modules/platform/proc-controller-create-instance-group.adoc @@ -2,7 +2,7 @@ [id="controller-create-instance-group"] -= Creating an instance group += Create an instance group [role="_abstract"] You can create instance groups with {ControllerNameStart} to organize and manage your instances. diff --git a/downstream/modules/platform/proc-controller-create-job-template.adoc b/downstream/modules/platform/proc-controller-create-job-template.adoc index b4dc0a47ee..0b177a4131 100644 --- a/downstream/modules/platform/proc-controller-create-job-template.adoc +++ b/downstream/modules/platform/proc-controller-create-job-template.adoc @@ -2,7 +2,7 @@ [id="controller-create-job-template"] -= Creating a job template += Create repeatable, shareable job templates to standardize automation runs [role="_abstract"] A job template is a definition and set of parameters for running an Ansible job. Use job templates to launch jobs. @@ -25,43 +25,68 @@ Note the exceptions in the following table. [cols="33%,33%,33%",options="header"] |=== | *Field* | *Options* | *Prompt on Launch* -| *Name* | Enter a name for the job.| N/A -| *Description* | Enter an arbitrary description as appropriate (optional). | N/A -| *Job type* a| Choose a job type: + +| *Name* +| Enter a name for the job. +| N/A + +| *Description* +| Enter an arbitrary description as appropriate (optional). +| N/A + +| *Job type* +a| Choose a job type: - Run: Start the playbook when launched, running Ansible tasks on the selected hosts. - Check: Perform a "dry run" of the playbook and report changes that would be made without actually making them. Tasks that do not support check mode are missed and do not report potential changes. -For more information about job types see the xref:controller-jobs[Jobs in automation controller].| Yes -| *Inventory* | Choose the inventory to use with this job template from the inventories available to the logged in user. +For more information about job types see the xref:controller-jobs[Jobs in automation controller]. +| Yes -A System Administrator must grant you or your team permissions to be able to use certain inventories in a job template. | Yes. +| *Inventory* +a| Choose the inventory to use with this job template from the inventories available to the logged in user. + +A System Administrator must grant you or your team permissions to be able to use certain inventories in a job template. +a| Yes Inventory prompts show up as its own step in a later prompt window. -| *Project* | Select the project to use with this job template from the projects available to the user that is logged in. | N/A -| *Source control branch* | This field is only present if you chose a project that allows branch override. + +| *Project* +| Select the project to use with this job template from the projects available to the user that is logged in. +| N/A + +| *Source control branch* +a| This field is only present if you chose a project that allows branch override. Specify the overriding branch to use in your job run. If left blank, the specified SCM branch (or commit hash or tag) from the project is used. -For more information, see xref:controller-job-branch-overriding[Job branch overriding]. | Yes -| *Playbook* | Choose the playbook to be launched with this job template from the available playbooks. +For more information, see xref:controller-job-branch-overriding[Job branch overriding]. +| Yes + +| *Playbook* +a| Choose the playbook to be launched with this job template from the available playbooks. This field automatically populates with the names of the playbooks found in the project base path for the selected project. Alternatively, you can enter the name of the playbook if it is not listed, such as the name of a file (such as `test.yml`) you want to use to run with that playbook. -If you enter a filename that is not valid, the template displays an error, or causes the job to fail. | N/A -| *Execution Environment* | Select the container image to be used to run this job. -You must select a project before you can select an {ExecEnvShort}. | Yes. +If you enter a filename that is not valid, the template displays an error, or causes the job to fail. +| N/A + +| *Execution Environment* +| Select the container image to be used to run this job. +You must select a project before you can select an {ExecEnvShort}. +a| Yes Execution environment prompts show up as its own step in a later prompt window. -| *Credentials* | Select the image:examine.png[examine,15,15] icon to open a separate window. +| *Credentials* +a| Select the image:examine.png[examine,15,15] icon to open a separate window. Choose the credential from the available options to use with this job template. Use the drop-down menu list to filter by credential type if the list is extensive. -Some credential types are not listed because they do not apply to certain job templates. a| -- If selected, when launching a job template that has a default credential and supplying another credential replaces the default credential if it is the same type. +Some credential types are not listed because they do not apply to certain job templates. +a| - If selected, when launching a job template that has a default credential and supplying another credential replaces the default credential if it is the same type. The following is an example this message: `Job Template default credentials must be replaced @@ -71,7 +96,9 @@ for the following types in order to proceed: Machine.` - You can add more credentials as you see fit. - Credential prompts show up as its own step in a later prompt window. -| *Labels* a| - Optionally supply labels that describe this job template, such as `dev` or `test`. + +| *Labels* +a| - Optionally supply labels that describe this job template, such as `dev` or `test`. - Use labels to group and filter job templates and completed jobs in the display. @@ -85,11 +112,17 @@ Members of the Organization can create labels on a job template if they have edi When a label is removed, it is no longer associated with that particular Job or Job Template, but it remains associated with any other jobs that reference it. - Jobs inherit labels from the Job Template at the time of launch. -If you delete a label from a Job Template, it is also deleted from the Job. a| - If selected, even if a default value is supplied, you are prompted when launching to supply additional labels, if needed. +If you delete a label from a Job Template, it is also deleted from the Job. +a| - If selected, even if a default value is supplied, you are prompted when launching to supply additional labels, if needed. - You cannot delete existing labels, selecting image:disassociate.png[Disassociate,10,10] only removes the newly added labels, not existing default labels. -| *Forks* | The number of parallel or simultaneous processes to use while executing the playbook. -A value of zero uses the Ansible default setting, which is five parallel processes unless overridden in `/etc/ansible/ansible.cfg`. | Yes -| *Limit* a| A host pattern to further constrain the list of hosts managed or affected by the playbook. You can separate many patterns by colons (:). + +| *Forks* +| The number of parallel or simultaneous processes to use while executing the playbook. +A value of zero uses the Ansible default setting, which is five parallel processes unless overridden in `/etc/ansible/ansible.cfg`. +| Yes + +| *Limit* +a| A host pattern to further constrain the list of hosts managed or affected by the playbook. You can separate many patterns by colons (:). As with core Ansible: * a:b means "in group a or b" @@ -101,43 +134,65 @@ As with core Ansible: If not selected, the job template executes against all nodes in the inventory or only the nodes predefined on the *Limit* field. When running as part of a workflow, the workflow job template limit is used instead. -| *Verbosity* | Control the level of output Ansible produces as the playbook executes. +| {empty} + +| *Verbosity* +a| Control the level of output Ansible produces as the playbook executes. Choose the verbosity from Normal to various Verbose or Debug settings. This is only displayed in the *details* report view. Verbose logging includes the output of all commands. Debug logging is exceedingly verbose and includes information about SSH operations that can be useful in certain support instances. -Verbosity `5` causes {ControllerName} to block heavily when jobs are running, which could delay reporting that the job has finished (even though it has) and can cause the browser tab to lock up.| Yes -| *Job slicing* | Specify the number of slices you want this job template to run. +Verbosity `5` causes {ControllerName} to block heavily when jobs are running, which could delay reporting that the job has finished (even though it has) and can cause the browser tab to lock up. +| Yes + +| *Job slicing* +| Specify the number of slices you want this job template to run. Each slice runs the same tasks against a part of the inventory. -For more information about job slices, see xref:controller-job-slicing[Job Slicing]. | Yes -| *Timeout* a| This enables you to specify the length of time (in seconds) that the job can run before it is canceled. Consider the following for setting the timeout value: +For more information about job slices, see xref:controller-job-slicing[Job Slicing]. +| Yes + +| *Timeout* +a| This enables you to specify the length of time (in seconds) that the job can run before it is canceled. Consider the following for setting the timeout value: - There is a global timeout defined in the settings which defaults to 0, indicating no timeout. - A negative timeout (<0) on a job template is a true "no timeout" on the job. - A timeout of 0 on a job template defaults the job to the global timeout (which is no timeout by default). -- A positive timeout sets the timeout for that job template. | Yes -| *Show changes* | Enables you to see the changes made by Ansible tasks. | Yes -| *Instance groups* | Choose xref:controller-instance-and-container-groups[Instance and Container Groups] to associate with this job template. +- A positive timeout sets the timeout for that job template. +| Yes + +| *Show changes* +| Enables you to see the changes made by Ansible tasks. +| Yes + +| *Instance groups* +a| Choose xref:controller-instance-and-container-groups[Instance and Container Groups] to associate with this job template. If the list is extensive, use the image:examine.png[examine,15,15] icon to narrow the options. Job template instance groups contribute to the job scheduling criteria, see link:{URLControllerAdminGuide}/controller-clustering#controller-cluster-job-runtime[Job Runtime Behavior] and xref:controller-control-job-run[Control where a job runs] for rules. A System Administrator must grant you or your team permissions to be able to use an instance group in a job template. -Use of a container group requires admin rights. a| - Yes. +Use of a container group requires admin rights. +a| Yes If selected, you are providing the jobs preferred instance groups in order of preference. If the first group is out of capacity, later groups in the list are considered until one with capacity is available, at which point that is selected to run the job. - If you prompt for an instance group, what you enter replaces the normal instance group hierarchy and overrides all of the organizations' and inventories' instance groups. - The Instance Groups prompt shows up as its own step in a later prompt window. -| *Job tags* | Type and select the *Create* menu to specify which parts of the playbook should be executed. + +| *Job tags* +a| Type and select the *Create* menu to specify which parts of the playbook should be executed. //Commenting out as no downstream alternative [AAP-57435] //For more information and examples see link:https://docs.ansible.com/projects/ansible/latest/playbook_guide/playbooks_tags.html[Tags] in the Ansible documentation. | Yes -| *Skip tags* | Type and select the *Create* menu to specify certain tasks or parts of the playbook to skip. + +| *Skip tags* +a| Type and select the *Create* menu to specify certain tasks or parts of the playbook to skip. //Commenting out as no downstream alternative [AAP-57435] //For more information and examples see link:https://docs.ansible.com/projects/ansible/latest/playbook_guide/playbooks_tags.html[Tags] in the Ansible documentation. | Yes -| *Extra variables* a| - Pass extra command line variables to the playbook. + +| *Extra variables* +a| - Pass extra command line variables to the playbook. This is the "-e" or "-extra-vars" command line parameter for ansible-playbook. //Commenting out as no downstream alternative [AAP-57435] //that is documented in the Ansible documentation at xref:controller-extra-variables[Extra variables]. @@ -145,7 +200,8 @@ This is the "-e" or "-extra-vars" command line parameter for ansible-playbook. These variables have a maximum value of precedence and overrides other variables specified elsewhere. The following is an example value: `git_branch: production -release_version: 1.5` | Yes. +release_version: 1.5` +a| Yes If you want to be able to specify `extra_vars` on a schedule, you must select *Prompt on launch* for Variables on the job template, or enable a survey on the job template. Those answered survey questions become `extra_vars`. |=== diff --git a/downstream/modules/platform/proc-controller-create-notification-template.adoc b/downstream/modules/platform/proc-controller-create-notification-template.adoc index 42d460478b..de5f570d89 100644 --- a/downstream/modules/platform/proc-controller-create-notification-template.adoc +++ b/downstream/modules/platform/proc-controller-create-notification-template.adoc @@ -2,7 +2,7 @@ [id="controller-create-notification-template"] -= Creating a notification template += Create a notification template [role="_abstract"] Use the following procedure to create a notification template. diff --git a/downstream/modules/platform/proc-controller-create-organization.adoc b/downstream/modules/platform/proc-controller-create-organization.adoc index db0317db31..3736f49d9a 100644 --- a/downstream/modules/platform/proc-controller-create-organization.adoc +++ b/downstream/modules/platform/proc-controller-create-organization.adoc @@ -2,7 +2,7 @@ [id="proc-controller-create-organization"] -= Creating an organization += Create an organization [role="_abstract"] diff --git a/downstream/modules/platform/proc-controller-create-service-account.adoc b/downstream/modules/platform/proc-controller-create-service-account.adoc index a154eb274a..3ff5ac6b5e 100644 --- a/downstream/modules/platform/proc-controller-create-service-account.adoc +++ b/downstream/modules/platform/proc-controller-create-service-account.adoc @@ -2,7 +2,7 @@ [id="controller-create-service-account"] -= Creating a service account in {OCPShort} or Kubernetes += Create a service account in {OCPShort} or Kubernetes [role="_abstract"] Use service accounts in an OpenShift cluster or Kubernetes to run jobs in a container group through {ControllerName}. diff --git a/downstream/modules/platform/proc-controller-create-survey.adoc b/downstream/modules/platform/proc-controller-create-survey.adoc index f21e170831..04dc393aa5 100644 --- a/downstream/modules/platform/proc-controller-create-survey.adoc +++ b/downstream/modules/platform/proc-controller-create-survey.adoc @@ -2,7 +2,7 @@ [id="controller-create-survey"] -= Creating a survey += Create a survey [role="_abstract"] You can create a survey for a job template to prompt users for input when they launch a job based on that template. diff --git a/downstream/modules/platform/proc-controller-create-workflow-template.adoc b/downstream/modules/platform/proc-controller-create-workflow-template.adoc index 25535f7be4..03a7112b1d 100644 --- a/downstream/modules/platform/proc-controller-create-workflow-template.adoc +++ b/downstream/modules/platform/proc-controller-create-workflow-template.adoc @@ -2,7 +2,7 @@ [id="controller-create-workflow-template"] -= Creating a workflow job template += Create a workflow job template :context: create-worklow-job-templates diff --git a/downstream/modules/platform/proc-controller-creating-a-team.adoc b/downstream/modules/platform/proc-controller-creating-a-team.adoc index 53536a5478..fe38b23ae3 100644 --- a/downstream/modules/platform/proc-controller-creating-a-team.adoc +++ b/downstream/modules/platform/proc-controller-creating-a-team.adoc @@ -2,7 +2,7 @@ [id="proc-controller-creating-a-team"] -= Creating a team += Create a team [role="_abstract"] diff --git a/downstream/modules/platform/proc-controller-creating-a-user.adoc b/downstream/modules/platform/proc-controller-creating-a-user.adoc index 9b8a5d63f8..d68f201679 100644 --- a/downstream/modules/platform/proc-controller-creating-a-user.adoc +++ b/downstream/modules/platform/proc-controller-creating-a-user.adoc @@ -2,7 +2,7 @@ [id="proc-controller-creating-a-user"] -= Creating a user += Create a user [role="_abstract"] You can create three types of users in {PlatformNameShort}: diff --git a/downstream/modules/platform/proc-controller-customize-pod-spec.adoc b/downstream/modules/platform/proc-controller-customize-pod-spec.adoc index 3f522c3511..f921bbf08f 100644 --- a/downstream/modules/platform/proc-controller-customize-pod-spec.adoc +++ b/downstream/modules/platform/proc-controller-customize-pod-spec.adoc @@ -2,7 +2,7 @@ [id="controller-customize-pod-spec"] -= Customizing the pod specification += Customize the pod specification [role="_abstract"] {PlatformNameShort} provides a simple default pod specification, however, you can provide a custom YAML or JSON document that overrides the default pod specification. diff --git a/downstream/modules/platform/proc-controller-define-schedule-exceptions.adoc b/downstream/modules/platform/proc-controller-define-schedule-exceptions.adoc index 527885ffb4..1c268bf24e 100644 --- a/downstream/modules/platform/proc-controller-define-schedule-exceptions.adoc +++ b/downstream/modules/platform/proc-controller-define-schedule-exceptions.adoc @@ -2,7 +2,7 @@ [id="proc-controller-define-schedule-exceptions"] -= Setting exceptions to the schedule += Set exceptions to the schedule [role="_abstract"] Define specific dates or times when automated jobs should skip execution by using schedule exceptions. diff --git a/downstream/modules/platform/proc-controller-define-schedule-rules.adoc b/downstream/modules/platform/proc-controller-define-schedule-rules.adoc index ce36270fc1..4d67ade629 100644 --- a/downstream/modules/platform/proc-controller-define-schedule-rules.adoc +++ b/downstream/modules/platform/proc-controller-define-schedule-rules.adoc @@ -2,7 +2,7 @@ [id="proc-controller-define-schedule-rules"] -= Defining rules for the schedule += Define rules for the schedule [role="_abstract"] After you create a schedule, you can define rules for when the schedule runs. diff --git a/downstream/modules/platform/proc-controller-delete-job-template.adoc b/downstream/modules/platform/proc-controller-delete-job-template.adoc index 1c8a38ec28..f5d30f2d53 100644 --- a/downstream/modules/platform/proc-controller-delete-job-template.adoc +++ b/downstream/modules/platform/proc-controller-delete-job-template.adoc @@ -2,7 +2,7 @@ [id="controller-delete-job-template"] -= Deleting a job template += Delete a job template [role="_abstract"] You can delete job templates in {ControllerName} when they are no longer needed. diff --git a/downstream/modules/platform/proc-controller-deleting-a-user.adoc b/downstream/modules/platform/proc-controller-deleting-a-user.adoc index 6ba0f2e8f6..11396a9fc2 100644 --- a/downstream/modules/platform/proc-controller-deleting-a-user.adoc +++ b/downstream/modules/platform/proc-controller-deleting-a-user.adoc @@ -2,7 +2,7 @@ [id="proc-controller-deleting-a-user"] -= Deleting a user += Delete a user [role="_abstract"] diff --git a/downstream/modules/platform/proc-controller-deprovision-instance-groups.adoc b/downstream/modules/platform/proc-controller-deprovision-instance-groups.adoc index 2df89e803b..e013d5b37a 100644 --- a/downstream/modules/platform/proc-controller-deprovision-instance-groups.adoc +++ b/downstream/modules/platform/proc-controller-deprovision-instance-groups.adoc @@ -2,7 +2,7 @@ [id="controller-deprovision-instance-group"] -= Deprovisioning instance groups += Deprovision instance groups [role="_abstract"] Re-running the setup playbook does not deprovision instances because clusters do not currently distinguish between an instance that you took offline intentionally or due to failure. diff --git a/downstream/modules/platform/proc-controller-disabling-live-events.adoc b/downstream/modules/platform/proc-controller-disabling-live-events.adoc index e559024d9d..9c2bd92543 100644 --- a/downstream/modules/platform/proc-controller-disabling-live-events.adoc +++ b/downstream/modules/platform/proc-controller-disabling-live-events.adoc @@ -2,7 +2,7 @@ [id="proc-controller-disabling-live-events"] -= Disabling live streaming events += Disable live streaming events [role="_abstract"] You can disable live streaming events in {ControllerName} to reduce system load or for troubleshooting purposes. diff --git a/downstream/modules/platform/proc-controller-ec2-vpc-instances.adoc b/downstream/modules/platform/proc-controller-ec2-vpc-instances.adoc index 543228c96d..fd68bc8ed8 100644 --- a/downstream/modules/platform/proc-controller-ec2-vpc-instances.adoc +++ b/downstream/modules/platform/proc-controller-ec2-vpc-instances.adoc @@ -2,7 +2,7 @@ [id="controller-ec2-vpc-instances"] -= Viewing private EC2 VPC instances in the {ControllerName} inventory += View private EC2 VPC instances in the {ControllerName} inventory [role="_abstract"] By default, {ControllerName} only shows instances in a VPC that have an Elastic IP (EIP) associated with them. diff --git a/downstream/modules/platform/proc-controller-edit-job-template.adoc b/downstream/modules/platform/proc-controller-edit-job-template.adoc index 07079659e4..a1cc81e5c5 100644 --- a/downstream/modules/platform/proc-controller-edit-job-template.adoc +++ b/downstream/modules/platform/proc-controller-edit-job-template.adoc @@ -2,7 +2,7 @@ [id="controller-edit-job-templates"] -= Editing a job template += Edit a job template [role="_abstract"] As part of the initial setup, you can leave the default *Demo Job Template* as it is, but you can edit it later. diff --git a/downstream/modules/platform/proc-controller-edit-nodes.adoc b/downstream/modules/platform/proc-controller-edit-nodes.adoc index e6d6db2261..a982cd5379 100644 --- a/downstream/modules/platform/proc-controller-edit-nodes.adoc +++ b/downstream/modules/platform/proc-controller-edit-nodes.adoc @@ -2,7 +2,7 @@ [id="controller-edit-nodes"] -= Editing a node += Edit a node [role="_abstract"] Learn how to edit a node's details or link edge type (Run on success/fail/always) and remove links within a workflow, and how to adjust the workflow diagram's view. diff --git a/downstream/modules/platform/proc-controller-enable-provision-callbacks.adoc b/downstream/modules/platform/proc-controller-enable-provision-callbacks.adoc index 28b777c67a..1d9b0c4071 100644 --- a/downstream/modules/platform/proc-controller-enable-provision-callbacks.adoc +++ b/downstream/modules/platform/proc-controller-enable-provision-callbacks.adoc @@ -2,7 +2,7 @@ [id="controller-enable-provision-callbacks"] -= Enabling Provisioning Callbacks += Enable Provisioning Callbacks [role="_abstract"] Use the following procedure to enable provisioning callbacks for a job template. diff --git a/downstream/modules/platform/proc-controller-getting-started-with-job-templates.adoc b/downstream/modules/platform/proc-controller-getting-started-with-job-templates.adoc index 253a074d3e..4aaa1b245e 100644 --- a/downstream/modules/platform/proc-controller-getting-started-with-job-templates.adoc +++ b/downstream/modules/platform/proc-controller-getting-started-with-job-templates.adoc @@ -2,7 +2,7 @@ [id="controller-getting-started-with-job-templates"] -= Getting started with job templates += Get started with job templates [role="_abstract"] Job templates are definitions and sets of parameters for running an Ansible job. A job template ties together all the necessary information to launch an Ansible job. diff --git a/downstream/modules/platform/proc-controller-github-enterprise-org-settings.adoc b/downstream/modules/platform/proc-controller-github-enterprise-org-settings.adoc index 82abfa1a1c..b137901695 100644 --- a/downstream/modules/platform/proc-controller-github-enterprise-org-settings.adoc +++ b/downstream/modules/platform/proc-controller-github-enterprise-org-settings.adoc @@ -2,7 +2,7 @@ [id="proc-controller-github-enterprise-org-settings"] -= Configuring GitHub enterprise organization authentication += Configure GitHub enterprise organization authentication [role="_abstract"] To set up social authentication for a GitHub enterprise organization, you must obtain a GitHub enterprise organization URL, an Organization API URL, an Organization OAuth2 key and secret for a web application. diff --git a/downstream/modules/platform/proc-controller-github-enterprise-settings.adoc b/downstream/modules/platform/proc-controller-github-enterprise-settings.adoc index 952c95bca1..53619163c2 100644 --- a/downstream/modules/platform/proc-controller-github-enterprise-settings.adoc +++ b/downstream/modules/platform/proc-controller-github-enterprise-settings.adoc @@ -2,7 +2,7 @@ [id="proc-controller-github-enterprise-settings"] -= Configuring GitHub enterprise authentication += Configure GitHub enterprise authentication [role="_abstract"] To set up social authentication for a GitHub enterprise, you must obtain a GitHub Enterprise URL, an API URL, OAuth2 key and secret for a web application. diff --git a/downstream/modules/platform/proc-controller-github-enterprise-team-settings.adoc b/downstream/modules/platform/proc-controller-github-enterprise-team-settings.adoc index cdcdc1c971..8ff490bdb5 100644 --- a/downstream/modules/platform/proc-controller-github-enterprise-team-settings.adoc +++ b/downstream/modules/platform/proc-controller-github-enterprise-team-settings.adoc @@ -2,7 +2,7 @@ [id="proc-controller-github-enterprise-team-settings"] -= Configuring GitHub enterprise team authentication += Configure GitHub enterprise team authentication [role="_abstract"] To set up social authentication for a GitHub enterprise team, you must obtain a GitHub Enterprise Organization URL, an Organization API URL, an Organization OAuth2 key and secret for a web application. diff --git a/downstream/modules/platform/proc-controller-github-organization-settings.adoc b/downstream/modules/platform/proc-controller-github-organization-settings.adoc index 52c16a39e4..9315bd5c6f 100644 --- a/downstream/modules/platform/proc-controller-github-organization-settings.adoc +++ b/downstream/modules/platform/proc-controller-github-organization-settings.adoc @@ -2,7 +2,7 @@ [id="proc-controller-github-organization-settings"] -= Configuring GitHub organization authentication += Configure GitHub organization authentication [role="_abstract"] When defining account authentication with either an organization or a team within an organization, you should use the specific organization and team settings. Account authentication can be limited by an organization and by a team within an organization. diff --git a/downstream/modules/platform/proc-controller-github-settings.adoc b/downstream/modules/platform/proc-controller-github-settings.adoc index 01d396bd80..8e7a3b2af6 100644 --- a/downstream/modules/platform/proc-controller-github-settings.adoc +++ b/downstream/modules/platform/proc-controller-github-settings.adoc @@ -2,7 +2,7 @@ [id="proc-controller-github-settings"] -= Configuring GitHub authentication += Configure GitHub authentication [role="_abstract"] You can connect GitHub identities to {PlatformNameShort} using OAuth. To set up GitHub authentication, you need to obtain an OAuth2 key and secret by registering your organization-owned application from GitHub by using the link:https://docs.github.com/en/apps/using-github-apps/installing-your-own-github-app[registering the new application with GitHub]. diff --git a/downstream/modules/platform/proc-controller-github-team-settings.adoc b/downstream/modules/platform/proc-controller-github-team-settings.adoc index 4e41fe722c..d301d6b01c 100644 --- a/downstream/modules/platform/proc-controller-github-team-settings.adoc +++ b/downstream/modules/platform/proc-controller-github-team-settings.adoc @@ -2,7 +2,7 @@ [id="proc-controller-github-team-settings"] -= Configuring GitHub team authentication += Configure GitHub team authentication [role="_abstract"] diff --git a/downstream/modules/platform/proc-controller-google-oauth2-settings.adoc b/downstream/modules/platform/proc-controller-google-oauth2-settings.adoc index dffc10bf2f..783c548971 100644 --- a/downstream/modules/platform/proc-controller-google-oauth2-settings.adoc +++ b/downstream/modules/platform/proc-controller-google-oauth2-settings.adoc @@ -2,7 +2,7 @@ [id="proc-controller-google-oauth2-settings"] -= Configuring Google OAuth2 authentication += Configure Google OAuth2 authentication [role="_abstract"] To set up social authentication for Google, you must obtain an OAuth2 key and secret for a web application. To do this, you must first create a project and set it up with Google. diff --git a/downstream/modules/platform/proc-controller-ingress-options.adoc b/downstream/modules/platform/proc-controller-ingress-options.adoc index b801637105..069d8cea3c 100644 --- a/downstream/modules/platform/proc-controller-ingress-options.adoc +++ b/downstream/modules/platform/proc-controller-ingress-options.adoc @@ -2,7 +2,7 @@ [id="proc-controller-ingress-options_{context}"] -= Configuring the ingress type for your {ControllerName} operator += Configure ingress options for {ControllerName} [role="_abstract"] diff --git a/downstream/modules/platform/proc-controller-inv-source-aap.adoc b/downstream/modules/platform/proc-controller-inv-source-aap.adoc index 8ea94d1707..5eaa174d45 100644 --- a/downstream/modules/platform/proc-controller-inv-source-aap.adoc +++ b/downstream/modules/platform/proc-controller-inv-source-aap.adoc @@ -2,7 +2,7 @@ [id="proc-controller-inv-source-aap"] -= {PlatformName} += Source an inventory from {PlatformName} [role="_abstract"] An inventory that is sourced from {PlatformName} uses the {PlatformName} inventory plugin to gather inventory data from the {PlatformName} platform. diff --git a/downstream/modules/platform/proc-controller-inv-source-gce.adoc b/downstream/modules/platform/proc-controller-inv-source-gce.adoc index acacd4c8b0..892279ec01 100644 --- a/downstream/modules/platform/proc-controller-inv-source-gce.adoc +++ b/downstream/modules/platform/proc-controller-inv-source-gce.adoc @@ -2,7 +2,7 @@ [id="proc-controller-inv-source-gce"] -= Google Compute Engine += Source an inventory from Google Compute Engine [role="_abstract"] Learn how to configure a Google-sourced inventory: diff --git a/downstream/modules/platform/proc-controller-inv-source-open-shift-virt.adoc b/downstream/modules/platform/proc-controller-inv-source-open-shift-virt.adoc index fb094cce46..0d45de4034 100644 --- a/downstream/modules/platform/proc-controller-inv-source-open-shift-virt.adoc +++ b/downstream/modules/platform/proc-controller-inv-source-open-shift-virt.adoc @@ -2,7 +2,7 @@ [id="proc-controller-inv-source-open-shift-virt"] -= OpenShift Virtualization += Source an inventory from OpenShift Virtualization [role="_abstract"] Learn how to add an OpenShift Virtualization inventory source to an existing inventory. diff --git a/downstream/modules/platform/proc-controller-inv-source-openstack.adoc b/downstream/modules/platform/proc-controller-inv-source-openstack.adoc index 638d39dd7c..c94977d654 100644 --- a/downstream/modules/platform/proc-controller-inv-source-openstack.adoc +++ b/downstream/modules/platform/proc-controller-inv-source-openstack.adoc @@ -2,7 +2,7 @@ [id="proc-controller-inv-source-openstack"] -= OpenStack += Source an inventory from OpenStack [role="_abstract"] You can create an inventory source that uses the OpenStack inventory plugin to dynamically generate inventory from your OpenStack cloud. diff --git a/downstream/modules/platform/proc-controller-inv-source-rh-virt.adoc b/downstream/modules/platform/proc-controller-inv-source-rh-virt.adoc index f800cb5f49..0032a357be 100644 --- a/downstream/modules/platform/proc-controller-inv-source-rh-virt.adoc +++ b/downstream/modules/platform/proc-controller-inv-source-rh-virt.adoc @@ -2,7 +2,7 @@ [id="proc-controller-inv-source-rh-virt"] -= Red Hat Virtualization += Source an inventory from Red Hat Virtualization [role="_abstract"] Learn how to configure a Red Hat virtualization-sourced inventory. diff --git a/downstream/modules/platform/proc-controller-inv-source-insights.adoc b/downstream/modules/platform/proc-controller-inv-source-rhlightspeed.adoc similarity index 94% rename from downstream/modules/platform/proc-controller-inv-source-insights.adoc rename to downstream/modules/platform/proc-controller-inv-source-rhlightspeed.adoc index 0494acbec9..a38c668e15 100644 --- a/downstream/modules/platform/proc-controller-inv-source-insights.adoc +++ b/downstream/modules/platform/proc-controller-inv-source-rhlightspeed.adoc @@ -1,8 +1,8 @@ :_mod-docs-content-type: PROCEDURE -[id="proc-controller-inv-source-insights"] +[id="proc-controller-inv-source-rhlightspeed"] -= {RHLightspeed} += Source an inventory from {RHLightspeed} [role="_abstract"] You can create an inventory source that uses {RHLightspeed} as the source of hosts. diff --git a/downstream/modules/platform/proc-controller-inv-source-satellite.adoc b/downstream/modules/platform/proc-controller-inv-source-satellite.adoc index d5bf622a35..cf296ad49c 100644 --- a/downstream/modules/platform/proc-controller-inv-source-satellite.adoc +++ b/downstream/modules/platform/proc-controller-inv-source-satellite.adoc @@ -2,7 +2,7 @@ [id="proc-controller-inv-source-satellite"] -= Red Hat Satellite 6 += Source an inventory from Red Hat Satellite 6 [role="_abstract"] {ControllerName} can integrate with Red Hat Satellite 6 as a dynamic inventory source. diff --git a/downstream/modules/platform/proc-controller-inv-source-terraform.adoc b/downstream/modules/platform/proc-controller-inv-source-terraform.adoc index f747d6c109..0929e41233 100644 --- a/downstream/modules/platform/proc-controller-inv-source-terraform.adoc +++ b/downstream/modules/platform/proc-controller-inv-source-terraform.adoc @@ -2,9 +2,7 @@ [id="proc-controller-inv-source-terraform"] -// This Terraform module is for AAP 2.5 - -= Terraform State += Source an inventory from Terraform State [role="_abstract"] Use the following procedure to create a Terraform State inventory source. diff --git a/downstream/modules/platform/proc-controller-inv-source-vm-esxi.adoc b/downstream/modules/platform/proc-controller-inv-source-vm-esxi.adoc index 032de4d031..e1345937c3 100644 --- a/downstream/modules/platform/proc-controller-inv-source-vm-esxi.adoc +++ b/downstream/modules/platform/proc-controller-inv-source-vm-esxi.adoc @@ -2,10 +2,10 @@ [id="proc-controller-inv-source-vm-esxi"] -= VMware ESXi += Source an inventory from VMware ESXi [role="_abstract"] -Learn how to configure a VMWare-ESXI sourced inventory. +Learn how to configure a VMWare ESXi sourced inventory. .Procedure . From the navigation panel, select {MenuInfrastructureInventories}. diff --git a/downstream/modules/platform/proc-controller-inv-source-vm-vcenter.adoc b/downstream/modules/platform/proc-controller-inv-source-vm-vcenter.adoc index 48497fedfc..4ae2c65c04 100644 --- a/downstream/modules/platform/proc-controller-inv-source-vm-vcenter.adoc +++ b/downstream/modules/platform/proc-controller-inv-source-vm-vcenter.adoc @@ -2,7 +2,7 @@ [id="proc-controller-inv-source-vm-vcenter"] -= VMware vCenter += Source an inventory from VMware vCenter [role="_abstract"] You can configure {ControllerName} to synchronize inventory from a VMware vCenter server. diff --git a/downstream/modules/platform/proc-controller-launch-job-template.adoc b/downstream/modules/platform/proc-controller-launch-job-template.adoc index 292f4a17d0..8e121f5d45 100644 --- a/downstream/modules/platform/proc-controller-launch-job-template.adoc +++ b/downstream/modules/platform/proc-controller-launch-job-template.adoc @@ -2,7 +2,7 @@ [id="controller-launch-job-template"] -= Launching a job template += Launch a job template [role="_abstract"] A benefit of {ControllerName} is the push-button deployment of Ansible playbooks. diff --git a/downstream/modules/platform/proc-controller-launch-workflow-template.adoc b/downstream/modules/platform/proc-controller-launch-workflow-template.adoc index e4c84c5c32..a808f4a965 100644 --- a/downstream/modules/platform/proc-controller-launch-workflow-template.adoc +++ b/downstream/modules/platform/proc-controller-launch-workflow-template.adoc @@ -2,7 +2,7 @@ [id="controller-launch-workflow-template"] -= Launching a workflow job template += Launch a workflow job template [role="_abstract"] You can launch a workflow job template to run a series of job templates and workflow nodes in a defined order. diff --git a/downstream/modules/platform/proc-controller-managing-live-events.adoc b/downstream/modules/platform/proc-controller-managing-live-events.adoc index 6a043c845a..75001da7a0 100644 --- a/downstream/modules/platform/proc-controller-managing-live-events.adoc +++ b/downstream/modules/platform/proc-controller-managing-live-events.adoc @@ -2,7 +2,7 @@ [id="proc-controller-managing-live-events"] -= Managing live events in the {ControllerName} UI += Manage live event streams to the UI [role="_abstract"] By default, {ControllerName} streams live events to the user interface (UI) for jobs that are running. diff --git a/downstream/modules/platform/proc-controller-metrics-utility-rhel.adoc b/downstream/modules/platform/proc-controller-metrics-utility-rhel.adoc index 1378a7ae57..89646f350d 100644 --- a/downstream/modules/platform/proc-controller-metrics-utility-rhel.adoc +++ b/downstream/modules/platform/proc-controller-metrics-utility-rhel.adoc @@ -2,7 +2,7 @@ [id="controller-metrics-utility-rhel"] -= Configuring `metrics-utility` on {RHEL} += Configure the `metrics-utility` on {RHEL} [role="_abstract"] You can configure the `metrics-utility` on a {RHEL} system to gather and report usage metrics for {ControllerName}. diff --git a/downstream/modules/platform/proc-controller-modify-run-schedule-OCP.adoc b/downstream/modules/platform/proc-controller-modify-run-schedule-OCP.adoc index dbd5f0ba5b..65bde3da9c 100644 --- a/downstream/modules/platform/proc-controller-modify-run-schedule-OCP.adoc +++ b/downstream/modules/platform/proc-controller-modify-run-schedule-OCP.adoc @@ -2,7 +2,7 @@ [id="modify-the-run-schedule-on-OCP"] -= Modifying the run schedule on {OCPShort} from the {PlatformNameShort} operator += Modify the run schedule on {OCPShort} from the {PlatformNameShort} operator [role="_abstract"] To adjust the execution schedule of the `metrics-utility` within your {PlatformNameShort} deployment running on {OCPShort}, use the following procedure. diff --git a/downstream/modules/platform/proc-controller-organization-mapping.adoc b/downstream/modules/platform/proc-controller-organization-mapping.adoc index 100cbd6705..8d8095d82b 100644 --- a/downstream/modules/platform/proc-controller-organization-mapping.adoc +++ b/downstream/modules/platform/proc-controller-organization-mapping.adoc @@ -2,7 +2,7 @@ [id="proc-controller-organization-mapping"] -= Organization mapping += Map users to organizations [role="_abstract"] diff --git a/downstream/modules/platform/proc-controller-organization-notifications.adoc b/downstream/modules/platform/proc-controller-organization-notifications.adoc index 511a0e0afc..0716c101ee 100644 --- a/downstream/modules/platform/proc-controller-organization-notifications.adoc +++ b/downstream/modules/platform/proc-controller-organization-notifications.adoc @@ -2,7 +2,7 @@ [id="proc-controller-organization-notifications"] -= Working with notifiers += Assign notifiers and execution environments to organizations [role="_abstract"] diff --git a/downstream/modules/platform/proc-controller-pass-extra-variables-provisioning-callbacks.adoc b/downstream/modules/platform/proc-controller-pass-extra-variables-provisioning-callbacks.adoc index c343630ca5..5a27232c45 100644 --- a/downstream/modules/platform/proc-controller-pass-extra-variables-provisioning-callbacks.adoc +++ b/downstream/modules/platform/proc-controller-pass-extra-variables-provisioning-callbacks.adoc @@ -2,7 +2,7 @@ [id="controller-pass-extra-variables-provisioning-callbacks"] -= Passing extra variables to Provisioning Callbacks += Pass extra variables to Provisioning Callbacks [role="_abstract"] You can pass `extra_vars` in Provisioning Callbacks the same way you can in a regular job template. diff --git a/downstream/modules/platform/proc-controller-pin-instances.adoc b/downstream/modules/platform/proc-controller-pin-instances.adoc index fc6814fcff..2df8a78934 100644 --- a/downstream/modules/platform/proc-controller-pin-instances.adoc +++ b/downstream/modules/platform/proc-controller-pin-instances.adoc @@ -2,7 +2,7 @@ [id="controller-pin-instances"] -= Pinning instances manually to specific groups += Pin instances manually to specific instance groups [role="_abstract"] If you have a special instance that needs to be only assigned to a specific instance group but do not want it to automatically join other groups by "percentage" or "minimum" policies, you can pin an instance manually to specific groups., diff --git a/downstream/modules/platform/proc-controller-project-add-permissions.adoc b/downstream/modules/platform/proc-controller-project-add-permissions.adoc index 45a1f44a02..c1abc6150a 100644 --- a/downstream/modules/platform/proc-controller-project-add-permissions.adoc +++ b/downstream/modules/platform/proc-controller-project-add-permissions.adoc @@ -2,7 +2,7 @@ [id="proc-controller-project-add-permission"] -= Adding project permissions += Add project permissions [role="_abstract"] Manage the permissions that users and teams have to access a project. diff --git a/downstream/modules/platform/proc-controller-project-remove-permissions.adoc b/downstream/modules/platform/proc-controller-project-remove-permissions.adoc index 8e0d37aef8..02d2c1e40d 100644 --- a/downstream/modules/platform/proc-controller-project-remove-permissions.adoc +++ b/downstream/modules/platform/proc-controller-project-remove-permissions.adoc @@ -2,7 +2,7 @@ [id="controller-project-remove-permissions"] -= Removing permissions from a project += Remove permissions from a project [role="_abstract"] Remove existing roles assigned to users and teams within an {ControllerName} project. diff --git a/downstream/modules/platform/proc-controller-proxy-settings.adoc b/downstream/modules/platform/proc-controller-proxy-settings.adoc index d725f61d06..656096117a 100644 --- a/downstream/modules/platform/proc-controller-proxy-settings.adoc +++ b/downstream/modules/platform/proc-controller-proxy-settings.adoc @@ -2,7 +2,7 @@ [id="proc-controller-proxy-settings"] -= {ControllerNameStart} settings += Configure component-level proxy settings [role="_abstract"] After using the RPM installation program, you must configure {ControllerName} to use egress proxy. diff --git a/downstream/modules/platform/proc-controller-remediate-insights-inventory.adoc b/downstream/modules/platform/proc-controller-remediate-insights-inventory.adoc index cc3862704c..7fb2aab3f1 100644 --- a/downstream/modules/platform/proc-controller-remediate-insights-inventory.adoc +++ b/downstream/modules/platform/proc-controller-remediate-insights-inventory.adoc @@ -2,7 +2,7 @@ [id="controller-remediate-insights-inventory"] -= Remediating a {RHLightspeed} inventory += Remediate a {RHLightspeed} inventory [role="_abstract"] Remediation of a {RHLightspeed} inventory enables {ControllerName} to run {RHLightspeed} playbooks with a single click. diff --git a/downstream/modules/platform/proc-controller-reset-tower-base.adoc b/downstream/modules/platform/proc-controller-reset-tower-base.adoc index 6cb2d2a7fb..a3bd5aacb5 100644 --- a/downstream/modules/platform/proc-controller-reset-tower-base.adoc +++ b/downstream/modules/platform/proc-controller-reset-tower-base.adoc @@ -2,7 +2,7 @@ [id="controller-reset-tower-base"] -= Resetting TOWER_URL_BASE += Reset TOWER_URL_BASE [role="_abstract"] {ControllerNameStart} determines how the base URL (`TOWER_URL_BASE`) is defined by looking at an incoming request and setting the server address based on that incoming request. diff --git a/downstream/modules/platform/proc-controller-review-organizations.adoc b/downstream/modules/platform/proc-controller-review-organizations.adoc index 9327a5720b..62f125fd00 100644 --- a/downstream/modules/platform/proc-controller-review-organizations.adoc +++ b/downstream/modules/platform/proc-controller-review-organizations.adoc @@ -2,7 +2,7 @@ [id="controller-review-organizations"] -= Organizations list view += View the Organizations list [role="_abstract"] diff --git a/downstream/modules/platform/proc-controller-run-ad-hoc-commands.adoc b/downstream/modules/platform/proc-controller-run-ad-hoc-commands.adoc index 3483c4b77c..a5458e764e 100644 --- a/downstream/modules/platform/proc-controller-run-ad-hoc-commands.adoc +++ b/downstream/modules/platform/proc-controller-run-ad-hoc-commands.adoc @@ -2,7 +2,7 @@ [id="proc-controller-run-ad-hoc-commands"] -= Running Ad Hoc commands += Run ad hoc commands against a host in an inventory [role="_abstract"] Learn how to run ad hoc commands against hosts in an inventory. diff --git a/downstream/modules/platform/proc-controller-scheduling-job-templates.adoc b/downstream/modules/platform/proc-controller-scheduling-job-templates.adoc index 99ab972491..207ae8caba 100644 --- a/downstream/modules/platform/proc-controller-scheduling-job-templates.adoc +++ b/downstream/modules/platform/proc-controller-scheduling-job-templates.adoc @@ -2,7 +2,7 @@ [id="controller-scheduling-job-templates"] -= Scheduling job templates += Schedule job templates [role="_abstract"] You can schedule job templates in {ControllerName} to run at specific times or intervals. diff --git a/downstream/modules/platform/proc-controller-scm-ssh-proxy-config.adoc b/downstream/modules/platform/proc-controller-scm-ssh-proxy-config.adoc index 472fc8f7c4..e3f557d32d 100644 --- a/downstream/modules/platform/proc-controller-scm-ssh-proxy-config.adoc +++ b/downstream/modules/platform/proc-controller-scm-ssh-proxy-config.adoc @@ -2,7 +2,7 @@ [id="proc-controller-scm-ssh-proxy-config"] -= Configuring SCM project sync using SSH to work with a proxy in {ControllerName} += Configure project syncing using SSH to work with a proxy server [role="_abstract"] The following procedure for RPM-based {PlatformNameShort} describes how to use {ControllerName} Project Sync by using the SSH protocol to work with a proxy server. diff --git a/downstream/modules/platform/proc-controller-search-job-slices.adoc b/downstream/modules/platform/proc-controller-search-job-slices.adoc index ba60ed8dec..76a24c96c8 100644 --- a/downstream/modules/platform/proc-controller-search-job-slices.adoc +++ b/downstream/modules/platform/proc-controller-search-job-slices.adoc @@ -2,7 +2,7 @@ [id="controller-search-job-slices"] -= Searching job slices += Search job slices [role="_abstract"] You can search for job slices and their parent workflow jobs by using the search functionality in {ControllerNameStart}. diff --git a/downstream/modules/platform/proc-controller-select-capacity.adoc b/downstream/modules/platform/proc-controller-select-capacity.adoc index 7a23a6283f..953cbc60dd 100644 --- a/downstream/modules/platform/proc-controller-select-capacity.adoc +++ b/downstream/modules/platform/proc-controller-select-capacity.adoc @@ -2,7 +2,7 @@ [id="controller-select-capacity"] -= Selecting the correct capacity += Select the correct capacity [role="_abstract"] When an instance is created, {ControllerName} calculates the capacity of the instance based on two algorithms: CPU-bound and memory-bound. diff --git a/downstream/modules/platform/proc-controller-set-up-LDAP.adoc b/downstream/modules/platform/proc-controller-set-up-LDAP.adoc index 4988459b17..482e5659a1 100644 --- a/downstream/modules/platform/proc-controller-set-up-LDAP.adoc +++ b/downstream/modules/platform/proc-controller-set-up-LDAP.adoc @@ -2,7 +2,7 @@ [id="controller-set-up-LDAP"] -= Configuring LDAP authentication += Configure LDAP authentication [role="_abstract"] diff --git a/downstream/modules/platform/proc-controller-set-up-SAML.adoc b/downstream/modules/platform/proc-controller-set-up-SAML.adoc index c58b91b9c7..59d80d04ca 100644 --- a/downstream/modules/platform/proc-controller-set-up-SAML.adoc +++ b/downstream/modules/platform/proc-controller-set-up-SAML.adoc @@ -2,7 +2,7 @@ [id="controller-set-up-SAML"] -= Configuring SAML authentication += Configure SAML authentication [role="_abstract"] SAML allows the exchange of authentication and authorization data between an Identity Provider (IdP) and a Service Provider (SP). diff --git a/downstream/modules/platform/proc-controller-set-up-azure.adoc b/downstream/modules/platform/proc-controller-set-up-azure.adoc index 6ddaac21d1..8efbbef875 100644 --- a/downstream/modules/platform/proc-controller-set-up-azure.adoc +++ b/downstream/modules/platform/proc-controller-set-up-azure.adoc @@ -3,7 +3,7 @@ [id="controller-set-up-azure"] ifndef::controller-AG[] -= Configuring {MSEntraID} authentication += Configure {MSEntraID} authentication endif::[] ifdef::controller-AG[] diff --git a/downstream/modules/platform/proc-controller-set-up-generic-oidc.adoc b/downstream/modules/platform/proc-controller-set-up-generic-oidc.adoc index d9e832dc2d..68b7207295 100644 --- a/downstream/modules/platform/proc-controller-set-up-generic-oidc.adoc +++ b/downstream/modules/platform/proc-controller-set-up-generic-oidc.adoc @@ -2,7 +2,7 @@ [id="controller-set-up-generic-oidc"] -= Configuring generic OIDC authentication += Configure generic OIDC authentication [role="_abstract"] diff --git a/downstream/modules/platform/proc-controller-set-up-github-webhook.adoc b/downstream/modules/platform/proc-controller-set-up-github-webhook.adoc index 64084df465..3fe8df2b25 100644 --- a/downstream/modules/platform/proc-controller-set-up-github-webhook.adoc +++ b/downstream/modules/platform/proc-controller-set-up-github-webhook.adoc @@ -2,7 +2,7 @@ [id="controller-set-up-github-webhook"] -= Setting up a GitHub webhook += Set up a GitHub webhook to trigger automation jobs [role="_abstract"] {ControllerNameStart} has the ability to run jobs based on a triggered webhook event coming in. diff --git a/downstream/modules/platform/proc-controller-set-up-gitlab-webhook.adoc b/downstream/modules/platform/proc-controller-set-up-gitlab-webhook.adoc index a2df99a494..fbc93f752e 100644 --- a/downstream/modules/platform/proc-controller-set-up-gitlab-webhook.adoc +++ b/downstream/modules/platform/proc-controller-set-up-gitlab-webhook.adoc @@ -2,7 +2,7 @@ [id="controller-set-up-gitlab-webhook"] -= Setting up a GitLab webhook += Set up a GitLab webhook [role="_abstract"] {ControllerNameStart} has the ability to run jobs based on a triggered webhook event coming in. diff --git a/downstream/modules/platform/proc-controller-set-up-logging.adoc b/downstream/modules/platform/proc-controller-set-up-logging.adoc index f50d01ebd5..1350aa8b53 100644 --- a/downstream/modules/platform/proc-controller-set-up-logging.adoc +++ b/downstream/modules/platform/proc-controller-set-up-logging.adoc @@ -2,7 +2,7 @@ [id="proc-controller-set-up-logging"] -= Setting up logging += Set up logging [role="_abstract"] ifdef::controller-AG[] diff --git a/downstream/modules/platform/proc-controller-set-up-prometheus.adoc b/downstream/modules/platform/proc-controller-set-up-prometheus.adoc index 47a6d25d0c..de1e6a663b 100644 --- a/downstream/modules/platform/proc-controller-set-up-prometheus.adoc +++ b/downstream/modules/platform/proc-controller-set-up-prometheus.adoc @@ -2,7 +2,7 @@ [id="proc-controller-set-up-prometheus"] -= Setting up Prometheus += Set up Prometheus [role="_abstract"] Learn how to use Prometheus to collect and visualize metrics from {ControllerName}. diff --git a/downstream/modules/platform/proc-controller-set-up-radius.adoc b/downstream/modules/platform/proc-controller-set-up-radius.adoc index 71d9a5f255..a353c6053b 100644 --- a/downstream/modules/platform/proc-controller-set-up-radius.adoc +++ b/downstream/modules/platform/proc-controller-set-up-radius.adoc @@ -2,7 +2,7 @@ [id="controller-set-up-radius"] -= Configuring RADIUS authentication += Configure RADIUS authentication [role="_abstract"] diff --git a/downstream/modules/platform/proc-controller-set-up-tacacs+.adoc b/downstream/modules/platform/proc-controller-set-up-tacacs+.adoc index 61d7e861a7..3d60a36734 100644 --- a/downstream/modules/platform/proc-controller-set-up-tacacs+.adoc +++ b/downstream/modules/platform/proc-controller-set-up-tacacs+.adoc @@ -2,7 +2,7 @@ [id="controller-set-up-tacacs"] -= Configuring TACACS+ authentication += Configure TACACS+ authentication [role="_abstract"] diff --git a/downstream/modules/platform/proc-controller-sourced-from-project.adoc b/downstream/modules/platform/proc-controller-sourced-from-project.adoc index c63391d0f3..49f2a04938 100644 --- a/downstream/modules/platform/proc-controller-sourced-from-project.adoc +++ b/downstream/modules/platform/proc-controller-sourced-from-project.adoc @@ -2,7 +2,7 @@ [id="proc-controller-sourced-from-project"] -= Sourcing from a Project += Source from a project's source control management [role="_abstract"] An inventory that is sourced from a project means that it uses the SCM type from the project it is tied to. diff --git a/downstream/modules/platform/proc-controller-team-mapping.adoc b/downstream/modules/platform/proc-controller-team-mapping.adoc index 2198c149d3..2aa988516d 100644 --- a/downstream/modules/platform/proc-controller-team-mapping.adoc +++ b/downstream/modules/platform/proc-controller-team-mapping.adoc @@ -2,7 +2,7 @@ [id="proc-controller-team-mapping"] -= Team mapping += Map users to teams [role="_abstract"] diff --git a/downstream/modules/platform/proc-controller-use-REST-manually.adoc b/downstream/modules/platform/proc-controller-use-REST-manually.adoc index 035e081ae6..7bed254139 100644 --- a/downstream/modules/platform/proc-controller-use-REST-manually.adoc +++ b/downstream/modules/platform/proc-controller-use-REST-manually.adoc @@ -2,7 +2,7 @@ [id="controller-use-REST-manually"] -= Using REST manually to callback += Use REST manually to callback [role="_abstract"] You can use REST to callback manually. diff --git a/downstream/modules/platform/proc-controller-use-ansible-sign.adoc b/downstream/modules/platform/proc-controller-use-ansible-sign.adoc index 2f3a0101b6..d0cc727170 100644 --- a/downstream/modules/platform/proc-controller-use-ansible-sign.adoc +++ b/downstream/modules/platform/proc-controller-use-ansible-sign.adoc @@ -2,7 +2,7 @@ [id="proc-controller-use-ansible-sign"] -= Installing the ansible-sign CLI utility += Install the ansible-sign CLI utility [role="_abstract"] Use the `ansible-sign` utility to offer options for you to sign and verify whether the project is signed. diff --git a/downstream/modules/platform/proc-controller-use-custom-inventory.adoc b/downstream/modules/platform/proc-controller-use-custom-inventory.adoc index 5bbda6f35b..ab2bc7e60d 100644 --- a/downstream/modules/platform/proc-controller-use-custom-inventory.adoc +++ b/downstream/modules/platform/proc-controller-use-custom-inventory.adoc @@ -2,7 +2,7 @@ [id="proc-controller-use-custom-inventory"] -= Using a custom inventory plugin += Source an inventory from a custom inventory plugin [role="_abstract"] This describes how to use the `servicenow.itsm` collection inventory plugin to sync inventory on {PlatformNameShort}. diff --git a/downstream/modules/platform/proc-controller-user-permissions.adoc b/downstream/modules/platform/proc-controller-user-permissions.adoc index 667e8134d0..bb1d9070fa 100644 --- a/downstream/modules/platform/proc-controller-user-permissions.adoc +++ b/downstream/modules/platform/proc-controller-user-permissions.adoc @@ -2,7 +2,7 @@ [id="proc-controller-user-permissions"] -= Assigning roles to a team += Assign roles to a team [role="_abstract"] diff --git a/downstream/modules/platform/proc-controller-user-roles.adoc b/downstream/modules/platform/proc-controller-user-roles.adoc index 89e145679f..08ef5c6664 100644 --- a/downstream/modules/platform/proc-controller-user-roles.adoc +++ b/downstream/modules/platform/proc-controller-user-roles.adoc @@ -2,7 +2,7 @@ [id="proc-controller-user-roles"] -= Assigning roles to a user += Assign roles to a user [role="_abstract"] diff --git a/downstream/modules/platform/proc-controller-verify-container-group.adoc b/downstream/modules/platform/proc-controller-verify-container-group.adoc index d92f492d83..795d0bacdc 100644 --- a/downstream/modules/platform/proc-controller-verify-container-group.adoc +++ b/downstream/modules/platform/proc-controller-verify-container-group.adoc @@ -2,7 +2,7 @@ [id="controller-verify-container-group"] -= Verifying container group functions += Verify the container group functions [role="_abstract"] Verify the deployment and termination of your container. diff --git a/downstream/modules/platform/proc-controller-view-container-group-jobs.adoc b/downstream/modules/platform/proc-controller-view-container-group-jobs.adoc index b38e9c2586..b9b9dfd17a 100644 --- a/downstream/modules/platform/proc-controller-view-container-group-jobs.adoc +++ b/downstream/modules/platform/proc-controller-view-container-group-jobs.adoc @@ -2,7 +2,7 @@ [id="controller-view-container-group-jobs"] -= Viewing container group jobs += View container group jobs [role="_abstract"] When you run a job associated with a container group, you can see the details of that job in the *Details* tab. diff --git a/downstream/modules/platform/proc-controller-view-host.adoc b/downstream/modules/platform/proc-controller-view-host.adoc index e4cf1ef1cf..d87240f389 100644 --- a/downstream/modules/platform/proc-controller-view-host.adoc +++ b/downstream/modules/platform/proc-controller-view-host.adoc @@ -2,7 +2,7 @@ [id="proc-controller-view-host"] -= Viewing the host details += View the host details [role="_abstract"] View the Host details for a job run. diff --git a/downstream/modules/platform/proc-controller-view-jobs-associated-with-instance-group.adoc b/downstream/modules/platform/proc-controller-view-jobs-associated-with-instance-group.adoc index 53c7076a40..42a43a9875 100644 --- a/downstream/modules/platform/proc-controller-view-jobs-associated-with-instance-group.adoc +++ b/downstream/modules/platform/proc-controller-view-jobs-associated-with-instance-group.adoc @@ -2,7 +2,7 @@ [id="controller-view-jobs-associated-with-instance-group"] -= Viewing jobs associated with an instance group += View jobs associated with an instance group [role="_abstract"] You can view jobs associated with an instance group to monitor their status and details. diff --git a/downstream/modules/platform/proc-controller-view-payload-output.adoc b/downstream/modules/platform/proc-controller-view-payload-output.adoc index 33d668a079..38ca71e75d 100644 --- a/downstream/modules/platform/proc-controller-view-payload-output.adoc +++ b/downstream/modules/platform/proc-controller-view-payload-output.adoc @@ -2,7 +2,7 @@ [id="controller-view-payload-output"] -= Viewing the payload output += View the payload output [role="_abstract"] When a webhook is triggered in {ControllerName}, the payload data is sent to the specified URL. diff --git a/downstream/modules/platform/proc-create-a-connection-secret.adoc b/downstream/modules/platform/proc-create-a-connection-secret.adoc index 2f0720cfe6..2724473f85 100644 --- a/downstream/modules/platform/proc-create-a-connection-secret.adoc +++ b/downstream/modules/platform/proc-create-a-connection-secret.adoc @@ -2,7 +2,7 @@ [id="proc-create-connection-secret_{context}"] -= Creating a {ControllerName} connection secret for {OperatorResourceShort} += Create an {ControllerName} connection secret for {OperatorResourceShort} [role="_abstract"] diff --git a/downstream/modules/platform/proc-create-a-jobtemplate.adoc b/downstream/modules/platform/proc-create-a-jobtemplate.adoc index 50e30ed6de..11ce1b3f66 100644 --- a/downstream/modules/platform/proc-create-a-jobtemplate.adoc +++ b/downstream/modules/platform/proc-create-a-jobtemplate.adoc @@ -3,7 +3,7 @@ [id="proc-create-a-jobtemplate_{context}"] -= Creating a JobTemplate custom resource += Create a JobTemplate custom resource [role="_abstract"] diff --git a/downstream/modules/platform/proc-create-an-ansiblejob.adoc b/downstream/modules/platform/proc-create-an-ansiblejob.adoc index f0ba53816e..6e0a714794 100644 --- a/downstream/modules/platform/proc-create-an-ansiblejob.adoc +++ b/downstream/modules/platform/proc-create-an-ansiblejob.adoc @@ -2,7 +2,7 @@ [id="proc-create-an-ansiblejob_{context}"] -= Creating an AnsibleJob custom resource += Create an AnsibleJob custom resource [role="_abstract"] diff --git a/downstream/modules/platform/proc-create-api-token-ansible-mcp-server.adoc b/downstream/modules/platform/proc-create-api-token-ansible-mcp-server.adoc index ad90dafa3f..7b28c7b6ce 100644 --- a/downstream/modules/platform/proc-create-api-token-ansible-mcp-server.adoc +++ b/downstream/modules/platform/proc-create-api-token-ansible-mcp-server.adoc @@ -2,7 +2,7 @@ [id="proc-create-api-token-ansible-mcp-server_{context}"] -= Creating an API token for the Ansible MCP server += Create an API token for the Ansible MCP server [role="_abstract"] diff --git a/downstream/modules/platform/proc-create-chatbot-config-secret.adoc b/downstream/modules/platform/proc-create-chatbot-config-secret.adoc index 95c908407f..638a72d7ea 100644 --- a/downstream/modules/platform/proc-create-chatbot-config-secret.adoc +++ b/downstream/modules/platform/proc-create-chatbot-config-secret.adoc @@ -2,7 +2,7 @@ [id="proc-create-chatbot-config-secret"] -= Creating a chatbot configuration secret += Create a chatbot configuration secret [role="_abstract"] diff --git a/downstream/modules/platform/proc-create-password-hashes.adoc b/downstream/modules/platform/proc-create-password-hashes.adoc index 069c47eba4..80e854df1c 100644 --- a/downstream/modules/platform/proc-create-password-hashes.adoc +++ b/downstream/modules/platform/proc-create-password-hashes.adoc @@ -2,7 +2,7 @@ [id="proc-create-password-hashes"] -= Creating PostgreSQL password hashes += Create PostgreSQL password hashes [role="_abstract"] Learn how to supply the hash values that replace the plain text passwords within the {ControllerName} configuration files. diff --git a/downstream/modules/platform/proc-creating-a-new-web-server-to-host-repositories.adoc b/downstream/modules/platform/proc-creating-a-new-web-server-to-host-repositories.adoc index 6dcb9cf949..80bd0c4f66 100644 --- a/downstream/modules/platform/proc-creating-a-new-web-server-to-host-repositories.adoc +++ b/downstream/modules/platform/proc-creating-a-new-web-server-to-host-repositories.adoc @@ -2,7 +2,7 @@ [id="proc-creating-a-new-web-server-to-host-repositories_{context}"] -= Creating a new web server to host repositories += Create a new web server to host repositories [role="_abstract"] Create and configure a dedicated web server to host repositories for a disconnected environment. This procedure ensures local access to synchronized RPM packages and enables you to streamline content installation and updates on isolated systems. diff --git a/downstream/modules/platform/proc-creating-ansible-role.adoc b/downstream/modules/platform/proc-creating-ansible-role.adoc index 0f0b2ceb19..57adb2b765 100644 --- a/downstream/modules/platform/proc-creating-ansible-role.adoc +++ b/downstream/modules/platform/proc-creating-ansible-role.adoc @@ -2,7 +2,7 @@ [id="creating-ansible-role_{context}"] -= Creating a role += Create a role [role="_abstract"] Create an Ansible role by using the `ansible-galaxy` CLI tool to build reusable automation components. diff --git a/downstream/modules/platform/proc-creating-the-custom-execution-environment-definition.adoc b/downstream/modules/platform/proc-creating-the-custom-execution-environment-definition.adoc index 8575003919..33c38f027d 100644 --- a/downstream/modules/platform/proc-creating-the-custom-execution-environment-definition.adoc +++ b/downstream/modules/platform/proc-creating-the-custom-execution-environment-definition.adoc @@ -5,7 +5,7 @@ :_mod-docs-content-type: PROCEDURE [id="creating-the-custom-execution-environment-definition"] -= Creating the custom {ExecEnvShort} definition += Create the custom {ExecEnvShort} definition [role="_abstract"] diff --git a/downstream/modules/platform/proc-customizing-pod-specs.adoc b/downstream/modules/platform/proc-customizing-pod-specs.adoc index d503aef139..54c99c1f4c 100644 --- a/downstream/modules/platform/proc-customizing-pod-specs.adoc +++ b/downstream/modules/platform/proc-customizing-pod-specs.adoc @@ -2,7 +2,7 @@ [id="proc-customizing-pod-specs_{context}"] -= Customizing the pod specification += Customize pod specifications to improve performance [role="_abstract"] You can use the following procedure to customize the pod. diff --git a/downstream/modules/platform/proc-define-mesh-node-types.adoc b/downstream/modules/platform/proc-define-mesh-node-types.adoc index 5857e15bee..2572332e20 100644 --- a/downstream/modules/platform/proc-define-mesh-node-types.adoc +++ b/downstream/modules/platform/proc-define-mesh-node-types.adoc @@ -7,7 +7,7 @@ ifdef::controller-UG[] endif::controller-UG[] ifdef::operator-mesh[] -= Defining {AutomationMesh} node types += Add execution or hop nodes to scale your infrastructure endif::operator-mesh[] diff --git a/downstream/modules/platform/proc-defining-node-types.adoc b/downstream/modules/platform/proc-defining-node-types.adoc index 3351cc92c8..aa19c5e3bc 100644 --- a/downstream/modules/platform/proc-defining-node-types.adoc +++ b/downstream/modules/platform/proc-defining-node-types.adoc @@ -2,7 +2,7 @@ [id="defining-node-types"] -= Defining {AutomationMesh} node types += Define {AutomationMesh} node types [role="_abstract"] The examples in this section demonstrate how to set the node type for the hosts in your inventory file. diff --git a/downstream/modules/platform/proc-downloading-containerized-aap.adoc b/downstream/modules/platform/proc-downloading-containerized-aap.adoc index 39a18bc181..0528a648a2 100644 --- a/downstream/modules/platform/proc-downloading-containerized-aap.adoc +++ b/downstream/modules/platform/proc-downloading-containerized-aap.adoc @@ -2,7 +2,7 @@ [id="downloading-ansible-automation-platform"] -= Downloading {PlatformNameShort} += Download {PlatformNameShort} [role="_abstract"] Choose the installation program you need based on your {RHEL} environment internet connectivity and download the installation program to your {RHEL} host. diff --git a/downstream/modules/platform/proc-edge-manager-add-devices-cli.adoc b/downstream/modules/platform/proc-edge-manager-add-devices-cli.adoc index e9960bc1b0..286cf79410 100644 --- a/downstream/modules/platform/proc-edge-manager-add-devices-cli.adoc +++ b/downstream/modules/platform/proc-edge-manager-add-devices-cli.adoc @@ -2,7 +2,7 @@ [id="edge-manager-add-devices-cli"] -= Adding devices to a fleet on the CLI += Add devices to a fleet on the CLI [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-add-devices-ui.adoc b/downstream/modules/platform/proc-edge-manager-add-devices-ui.adoc index a2d66be335..c17980efd3 100644 --- a/downstream/modules/platform/proc-edge-manager-add-devices-ui.adoc +++ b/downstream/modules/platform/proc-edge-manager-add-devices-ui.adoc @@ -2,7 +2,7 @@ [id="edge-manager-add-devices-ui"] -= Adding devices to a fleet on the web UI += Add devices to a fleet on the web UI [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-build-app-packages.adoc b/downstream/modules/platform/proc-edge-manager-build-app-packages.adoc index acae8f0cb2..345066fc9b 100644 --- a/downstream/modules/platform/proc-edge-manager-build-app-packages.adoc +++ b/downstream/modules/platform/proc-edge-manager-build-app-packages.adoc @@ -2,7 +2,7 @@ [id="edge-manager-build-app-packages"] -= Building an application package image += Build an application package image [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-build-bootc-image.adoc b/downstream/modules/platform/proc-edge-manager-build-bootc-image.adoc index 5f61504e98..caa73893e8 100644 --- a/downstream/modules/platform/proc-edge-manager-build-bootc-image.adoc +++ b/downstream/modules/platform/proc-edge-manager-build-bootc-image.adoc @@ -2,7 +2,7 @@ [id="edge-manager-build-bootc-image"] -= Building the operating system image with _bootc_ += Build the operating system image with _bootc_ [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-build-disk-image.adoc b/downstream/modules/platform/proc-edge-manager-build-disk-image.adoc index 060a2ed56a..2479ecab1d 100644 --- a/downstream/modules/platform/proc-edge-manager-build-disk-image.adoc +++ b/downstream/modules/platform/proc-edge-manager-build-disk-image.adoc @@ -2,7 +2,7 @@ [id="edge-manager-build-disk-image"] -= Building the operating system disk image += Build the operating system disk image [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-build-image-QCoW2.adoc b/downstream/modules/platform/proc-edge-manager-build-image-QCoW2.adoc index c0be2c4cd5..a1934f6e53 100644 --- a/downstream/modules/platform/proc-edge-manager-build-image-QCoW2.adoc +++ b/downstream/modules/platform/proc-edge-manager-build-image-QCoW2.adoc @@ -2,7 +2,7 @@ [id="edge-manager-build-image-QCoW2"] -= Building the QCoW2 disk image += Build the QCoW2 disk image [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-build-image-bootc.adoc b/downstream/modules/platform/proc-edge-manager-build-image-bootc.adoc index f887d3a548..65a056a50a 100644 --- a/downstream/modules/platform/proc-edge-manager-build-image-bootc.adoc +++ b/downstream/modules/platform/proc-edge-manager-build-image-bootc.adoc @@ -2,7 +2,7 @@ [id="edge-manager-build-image-bootc"] -= Building the bootc image += Build the bootc image [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-build-sign-image.adoc b/downstream/modules/platform/proc-edge-manager-build-sign-image.adoc index 40e3b1b063..6e97470d6b 100644 --- a/downstream/modules/platform/proc-edge-manager-build-sign-image.adoc +++ b/downstream/modules/platform/proc-edge-manager-build-sign-image.adoc @@ -2,7 +2,7 @@ [id="edge-manager-build-sign-image"] -= Signing and publishing the _bootc_ operating system image by using Sigstore += Sign and publish the bootc operating system image by using Sigstore [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-config-git-cli.adoc b/downstream/modules/platform/proc-edge-manager-config-git-cli.adoc index 4420cde1e8..1eacf2b963 100644 --- a/downstream/modules/platform/proc-edge-manager-config-git-cli.adoc +++ b/downstream/modules/platform/proc-edge-manager-config-git-cli.adoc @@ -2,7 +2,7 @@ [id="edge-manager-config-git-cli"] -= Managing the device configuration from a Git repository on the CLI += Manage the device configuration from a Git repository on the CLI [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-deploy-apps.adoc b/downstream/modules/platform/proc-edge-manager-deploy-apps.adoc index 0c4f8743eb..06e7a1292f 100644 --- a/downstream/modules/platform/proc-edge-manager-deploy-apps.adoc +++ b/downstream/modules/platform/proc-edge-manager-deploy-apps.adoc @@ -2,7 +2,7 @@ [id="edge-manager-deploy-apps"] -= Deploying applications to a device using the CLI += Deploy applications to a device using the CLI [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-enroll-device-cli.adoc b/downstream/modules/platform/proc-edge-manager-enroll-device-cli.adoc index 7f8f9e8bf4..ecad42ba07 100644 --- a/downstream/modules/platform/proc-edge-manager-enroll-device-cli.adoc +++ b/downstream/modules/platform/proc-edge-manager-enroll-device-cli.adoc @@ -2,7 +2,7 @@ [id="edge-manager-enroll-device-cli"] -= Enrolling devices on the CLI += Enroll devices on the CLI [role="_abstract"] @@ -51,7 +51,6 @@ See the following example output: NAME APPROVAL APPROVER APPROVED LABELS Approved user region=eu-west-1,site=factory-berlin ---- --- .Next steps After you approve the enrollment request, the service issues the management certificate for the device and registers the device in the device inventory. diff --git a/downstream/modules/platform/proc-edge-manager-generate-device-log.adoc b/downstream/modules/platform/proc-edge-manager-generate-device-log.adoc index 348f7d29be..b70d951260 100644 --- a/downstream/modules/platform/proc-edge-manager-generate-device-log.adoc +++ b/downstream/modules/platform/proc-edge-manager-generate-device-log.adoc @@ -2,7 +2,7 @@ [id="edge-manager-generate-device-log"] -= Generating a device log bundle += Generate a device log bundle [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-image-pullsecrets.adoc b/downstream/modules/platform/proc-edge-manager-image-pullsecrets.adoc index 70afdc2994..bed6c3dabb 100644 --- a/downstream/modules/platform/proc-edge-manager-image-pullsecrets.adoc +++ b/downstream/modules/platform/proc-edge-manager-image-pullsecrets.adoc @@ -2,7 +2,7 @@ [id="edge-manager-image-pullsecrets"] -= Optional: Using image pull secrets += Optional: Use image pull secrets [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-install-CLI.adoc b/downstream/modules/platform/proc-edge-manager-install-CLI.adoc index 3482cc90fa..2888048f61 100644 --- a/downstream/modules/platform/proc-edge-manager-install-CLI.adoc +++ b/downstream/modules/platform/proc-edge-manager-install-CLI.adoc @@ -2,7 +2,7 @@ [id="edge-manager-install-CLI"] -= Installing the {RedHatEdge} CLI += Install the {RedHatEdge} CLI [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-install-rpm-package.adoc b/downstream/modules/platform/proc-edge-manager-install-rpm-package.adoc index a317104a31..2d6f9ff517 100644 --- a/downstream/modules/platform/proc-edge-manager-install-rpm-package.adoc +++ b/downstream/modules/platform/proc-edge-manager-install-rpm-package.adoc @@ -2,7 +2,7 @@ [id="edge-manager-install-rpm-package"] -= Installing the {RedHatEdge} RPM package += Install the {RedHatEdge} RPM package [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-integrate-aap.adoc b/downstream/modules/platform/proc-edge-manager-integrate-aap.adoc index c76f5ab904..644a873705 100644 --- a/downstream/modules/platform/proc-edge-manager-integrate-aap.adoc +++ b/downstream/modules/platform/proc-edge-manager-integrate-aap.adoc @@ -2,7 +2,7 @@ [id="edge-manager-integrate-aap"] -= Integrating with {PlatformNameShort} += Integrate with {PlatformNameShort} [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-log-into-CLI.adoc b/downstream/modules/platform/proc-edge-manager-log-into-CLI.adoc index d4d8bd157a..69fb06202f 100644 --- a/downstream/modules/platform/proc-edge-manager-log-into-CLI.adoc +++ b/downstream/modules/platform/proc-edge-manager-log-into-CLI.adoc @@ -2,7 +2,7 @@ [id="edge-manager-log-into-CLI"] -= Logging into the {RedHatEdge} through the CLI += Log in to the {RedHatEdge} through the CLI [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-monitor-device-resources-cli.adoc b/downstream/modules/platform/proc-edge-manager-monitor-device-resources-cli.adoc index 3faf11a822..0e5874d4cb 100644 --- a/downstream/modules/platform/proc-edge-manager-monitor-device-resources-cli.adoc +++ b/downstream/modules/platform/proc-edge-manager-monitor-device-resources-cli.adoc @@ -2,7 +2,7 @@ [id="edge-manager-monitor-device-resources-cli"] -= Monitoring device resources on the CLI += Monitor device resources on the CLI [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-oauth-auto.adoc b/downstream/modules/platform/proc-edge-manager-oauth-auto.adoc index b78cd59d37..565c64a9fd 100644 --- a/downstream/modules/platform/proc-edge-manager-oauth-auto.adoc +++ b/downstream/modules/platform/proc-edge-manager-oauth-auto.adoc @@ -2,7 +2,7 @@ [id="edge-manager-oauth-auto"] -= Setting up the OAuth application automatically += Set up the OAuth application automatically [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-oauth-manually.adoc b/downstream/modules/platform/proc-edge-manager-oauth-manually.adoc index 0b8643308a..f40630dbdb 100644 --- a/downstream/modules/platform/proc-edge-manager-oauth-manually.adoc +++ b/downstream/modules/platform/proc-edge-manager-oauth-manually.adoc @@ -2,7 +2,7 @@ [id="edge-manager-oauth-manually"] -= Setting up the OAuth application manually += Set up the OAuth application manually [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-provision-cloudinit-config.adoc b/downstream/modules/platform/proc-edge-manager-provision-cloudinit-config.adoc index f408e63166..b5bf9389b1 100644 --- a/downstream/modules/platform/proc-edge-manager-provision-cloudinit-config.adoc +++ b/downstream/modules/platform/proc-edge-manager-provision-cloudinit-config.adoc @@ -2,7 +2,7 @@ [id="edge-manager-provision-cloudinit-config"] -= Creating the `cloud-init` configuration += Create the `cloud-init` configuration [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-provision-virt-create.adoc b/downstream/modules/platform/proc-edge-manager-provision-virt-create.adoc index b415f62f99..41940a5bfa 100644 --- a/downstream/modules/platform/proc-edge-manager-provision-virt-create.adoc +++ b/downstream/modules/platform/proc-edge-manager-provision-virt-create.adoc @@ -2,7 +2,7 @@ [id="edge-manager-provision-virt-create"] -= Creating the virtual machine += Create the virtual machine [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-request-cert.adoc b/downstream/modules/platform/proc-edge-manager-request-cert.adoc index 5fb59f02d3..728ef6d567 100644 --- a/downstream/modules/platform/proc-edge-manager-request-cert.adoc +++ b/downstream/modules/platform/proc-edge-manager-request-cert.adoc @@ -2,7 +2,7 @@ [id="edge-manager-request-cert"] -= Optional: Requesting an enrollment certificate for early binding += Optional: Request an enrollment certificate for early binding [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-sign-disk-image.adoc b/downstream/modules/platform/proc-edge-manager-sign-disk-image.adoc index a32680b854..a47026021e 100644 --- a/downstream/modules/platform/proc-edge-manager-sign-disk-image.adoc +++ b/downstream/modules/platform/proc-edge-manager-sign-disk-image.adoc @@ -2,7 +2,7 @@ [id="edge-manager-sign-disk-image"] -= Optional: Signing and publishing the operating system disk image to an Open Container Initiative registry += Optional: Sign and publish the operating system disk image to an Open Container Initiative registry [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-update-labels.adoc b/downstream/modules/platform/proc-edge-manager-update-labels.adoc index 6605ba905a..3f47350554 100644 --- a/downstream/modules/platform/proc-edge-manager-update-labels.adoc +++ b/downstream/modules/platform/proc-edge-manager-update-labels.adoc @@ -2,7 +2,7 @@ [id="edge-manager-update-labels"] -= Updating labels on the CLI += Update labels on the CLI [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-update-os-cli.adoc b/downstream/modules/platform/proc-edge-manager-update-os-cli.adoc index 804e38b89a..602235aa0e 100644 --- a/downstream/modules/platform/proc-edge-manager-update-os-cli.adoc +++ b/downstream/modules/platform/proc-edge-manager-update-os-cli.adoc @@ -2,7 +2,7 @@ [id="edge-manager-update-os-cli"] -= Updating the operating system on the CLI += Update the operating system on the CLI [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-view-device-config.adoc b/downstream/modules/platform/proc-edge-manager-view-device-config.adoc index 19ee7f0c68..a71b9c53d2 100644 --- a/downstream/modules/platform/proc-edge-manager-view-device-config.adoc +++ b/downstream/modules/platform/proc-edge-manager-view-device-config.adoc @@ -2,7 +2,7 @@ [id="edge-manager-view-device-config"] -= Viewing a device's effective target configuration += View a device's effective target configuration [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-view-device-inventory-cli.adoc b/downstream/modules/platform/proc-edge-manager-view-device-inventory-cli.adoc index 54eace4dcb..972629248d 100644 --- a/downstream/modules/platform/proc-edge-manager-view-device-inventory-cli.adoc +++ b/downstream/modules/platform/proc-edge-manager-view-device-inventory-cli.adoc @@ -2,7 +2,7 @@ [id="edge-manager-view-device-inventory-cli"] -= Viewing device inventory and device details on the CLI += View device inventory and device details on the CLI [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-view-device-inventory-ui.adoc b/downstream/modules/platform/proc-edge-manager-view-device-inventory-ui.adoc index 2723bee382..1ddaa292f6 100644 --- a/downstream/modules/platform/proc-edge-manager-view-device-inventory-ui.adoc +++ b/downstream/modules/platform/proc-edge-manager-view-device-inventory-ui.adoc @@ -2,11 +2,11 @@ [id="edge-manager-view-device-inventory-ui"] -= Viewing device inventory and device details on the web UI += View device inventory and device details on the web UI [role="_abstract"] -You can view details for enrolled devices, including their status and health, on the Red Hat Edge Manager web UI +You can view details for enrolled devices, including their status and health, on the {RedHatEdge} web UI. .Prerequisites diff --git a/downstream/modules/platform/proc-edge-manager-view-device-labels-ui.adoc b/downstream/modules/platform/proc-edge-manager-view-device-labels-ui.adoc index 2ee6e83dab..5c566683c9 100644 --- a/downstream/modules/platform/proc-edge-manager-view-device-labels-ui.adoc +++ b/downstream/modules/platform/proc-edge-manager-view-device-labels-ui.adoc @@ -2,7 +2,7 @@ [id="edge-manager-view-device-labels-ui"] -= Viewing devices and their labels on the web UI += View devices and their labels on the web UI [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-view-devices-cli.adoc b/downstream/modules/platform/proc-edge-manager-view-devices-cli.adoc index 92f6107f0d..8a62ba200d 100644 --- a/downstream/modules/platform/proc-edge-manager-view-devices-cli.adoc +++ b/downstream/modules/platform/proc-edge-manager-view-devices-cli.adoc @@ -2,7 +2,7 @@ [id="edge-manager-view-devices-cli"] -= Viewing devices and their labels on the CLI += View devices and their labels on the CLI [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-virt.adoc b/downstream/modules/platform/proc-edge-manager-virt.adoc index 48033d7ee7..8535aca18d 100644 --- a/downstream/modules/platform/proc-edge-manager-virt.adoc +++ b/downstream/modules/platform/proc-edge-manager-virt.adoc @@ -2,7 +2,7 @@ [id="edge-manager-virt"] -= Building images for Red Hat OpenShift Virtualization += Build images for Red Hat OpenShift Virtualization [role="_abstract"] diff --git a/downstream/modules/platform/proc-edge-manager-vmware.adoc b/downstream/modules/platform/proc-edge-manager-vmware.adoc index 5b0c057292..2ad08b327f 100644 --- a/downstream/modules/platform/proc-edge-manager-vmware.adoc +++ b/downstream/modules/platform/proc-edge-manager-vmware.adoc @@ -2,7 +2,7 @@ [id="edge-manager-vmware"] -= Building images for VMware vSphere += Build images for VMware vSphere [role="_abstract"] diff --git a/downstream/modules/platform/proc-editing-inventory-file-for-updates.adoc b/downstream/modules/platform/proc-editing-inventory-file-for-updates.adoc index 249b9cb7fb..6ed07e655b 100644 --- a/downstream/modules/platform/proc-editing-inventory-file-for-updates.adoc +++ b/downstream/modules/platform/proc-editing-inventory-file-for-updates.adoc @@ -2,7 +2,7 @@ [id="editing-inventory-file-for-updates_{context}"] -= Setting up the inventory file += Set up the inventory file [role="_abstract"] Before upgrading your {PlatformName} installation, edit the `inventory` file so that it matches your required configuration. diff --git a/downstream/modules/platform/proc-enable-configure-metrics-utility-inventory-file.adoc b/downstream/modules/platform/proc-enable-configure-metrics-utility-inventory-file.adoc index 06ab2381a1..54fce12d99 100644 --- a/downstream/modules/platform/proc-enable-configure-metrics-utility-inventory-file.adoc +++ b/downstream/modules/platform/proc-enable-configure-metrics-utility-inventory-file.adoc @@ -1,7 +1,7 @@ // Module file name: proc-enable-configure-metrics-utility-inventory-file.adoc :_mod-docs-content-type: PROCEDURE [id="proc-enable-configure-metrics-utility-inventory-file_{context}"] -= Enabling and configuring `metrics-utility` in the inventory file += Enable and configure the `metrics-utility` in the inventory file [role="_abstract"] Modify your {PlatformNameShort} inventory file to enable and configure `metrics-utility`. diff --git a/downstream/modules/platform/proc-enable-hstore-extension.adoc b/downstream/modules/platform/proc-enable-hstore-extension.adoc index b207a9c11d..cd5a2c3194 100644 --- a/downstream/modules/platform/proc-enable-hstore-extension.adoc +++ b/downstream/modules/platform/proc-enable-hstore-extension.adoc @@ -2,7 +2,7 @@ [id="proc-enable-hstore-extension"] -= Enabling the hstore extension for the {HubName} PostgreSQL database += Enable the hstore extension [role="_abstract"] diff --git a/downstream/modules/platform/proc-enable-pods-ref-images.adoc b/downstream/modules/platform/proc-enable-pods-ref-images.adoc index 9af338c32f..2e4a0bc77e 100644 --- a/downstream/modules/platform/proc-enable-pods-ref-images.adoc +++ b/downstream/modules/platform/proc-enable-pods-ref-images.adoc @@ -2,7 +2,7 @@ [id="proc-enable-pods-ref-images_{context}"] -= Enabling pods to reference images from other secured registries += Enable pods to reference images from other secured registries [role="_abstract"] If a container group uses a container from a secured registry that requires a credential, you can associate a Container Registry credential with the Execution Environment that is assigned to the job template. diff --git a/downstream/modules/platform/proc-enable-proxy-support.adoc b/downstream/modules/platform/proc-enable-proxy-support.adoc index bc67d55080..e9c6adb9cd 100644 --- a/downstream/modules/platform/proc-enable-proxy-support.adoc +++ b/downstream/modules/platform/proc-enable-proxy-support.adoc @@ -2,7 +2,7 @@ [id="proc-enable-proxy-support_{context}"] -= Enabling proxy support through a load balancer += Enable proxy support through a load balancer //FYI - In 2.5 EA, the System menu is specific to controller so do not change to AAP. [role="_abstract"] diff --git a/downstream/modules/platform/proc-enabling-automation-hub-collection-and-container-signing.adoc b/downstream/modules/platform/proc-enabling-automation-hub-collection-and-container-signing.adoc index f15000bf18..f3c2c88aba 100644 --- a/downstream/modules/platform/proc-enabling-automation-hub-collection-and-container-signing.adoc +++ b/downstream/modules/platform/proc-enabling-automation-hub-collection-and-container-signing.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="enabling-automation-hub-collection-and-container-signing"] -= Enabling automation content collection and container signing += Enable automation content collection and container signing [role="_abstract"] Automation content signing is disabled by default. To enable it, the following installation variables are required in the inventory file: diff --git a/downstream/modules/platform/proc-encrypt-postgres-password.adoc b/downstream/modules/platform/proc-encrypt-postgres-password.adoc index a0f6a3310d..1019ceb216 100644 --- a/downstream/modules/platform/proc-encrypt-postgres-password.adoc +++ b/downstream/modules/platform/proc-encrypt-postgres-password.adoc @@ -2,7 +2,7 @@ [id="proc-encrypt-postgres-password"] -= Encrypting the Postgres password += Encrypt the PostgreSQL password [role="_abstract"] Learn how to encrypt the PostgreSQL password used by {ControllerName} for database connections. diff --git a/downstream/modules/platform/proc-fetch-a-report-on-ocp.adoc b/downstream/modules/platform/proc-fetch-a-report-on-ocp.adoc index 6a337e3db6..0b2191433a 100644 --- a/downstream/modules/platform/proc-fetch-a-report-on-ocp.adoc +++ b/downstream/modules/platform/proc-fetch-a-report-on-ocp.adoc @@ -2,7 +2,7 @@ [id="proc-fetch-a-report-on-ocp"] -= Fetching a monthly report on {OCPShort} from the {OperatorPlatformNameShort} += Fetch a monthly report on {OCPShort} from the {OperatorPlatformNameShort} [role="_abstract"] Run a dedicated Ansible Playbook to fetch monthly usage reports directly from the {OCPShort} persistent volume claim. This helps ensure accurate consumption-based billing and compliance. diff --git a/downstream/modules/platform/proc-fetch-a-report-on-rhel.adoc b/downstream/modules/platform/proc-fetch-a-report-on-rhel.adoc index 0b89c4964d..769a0b81bd 100644 --- a/downstream/modules/platform/proc-fetch-a-report-on-rhel.adoc +++ b/downstream/modules/platform/proc-fetch-a-report-on-rhel.adoc @@ -2,7 +2,7 @@ [id="proc-fetch-a-report-on-rhel"] -= Fetching a monthly report on {RHEL} += Fetch a monthly report on {RHEL} [role="_abstract"] Use the following procedure to fetch a monthly report on {RHEL}: diff --git a/downstream/modules/platform/proc-find-delete-PVCs.adoc b/downstream/modules/platform/proc-find-delete-PVCs.adoc index 308fb4847d..89ddbd6a65 100644 --- a/downstream/modules/platform/proc-find-delete-PVCs.adoc +++ b/downstream/modules/platform/proc-find-delete-PVCs.adoc @@ -2,7 +2,7 @@ [id="proc-find-delete-PVCs_{context}"] -= Finding and deleting PVCs += Find and delete PVCs [role="_abstract"] diff --git a/downstream/modules/platform/proc-gs-add-ee-to-job-template.adoc b/downstream/modules/platform/proc-gs-add-ee-to-job-template.adoc index d32a954f5a..32dc991800 100644 --- a/downstream/modules/platform/proc-gs-add-ee-to-job-template.adoc +++ b/downstream/modules/platform/proc-gs-add-ee-to-job-template.adoc @@ -2,7 +2,7 @@ [id="proc-gs-add-ee-to-job-template_{context}"] -= Adding an {ExecEnvShort} to a job template += Add an {ExecEnvShort} to a job template [role="_abstract"] After you have built an {ExecEnvShort}, use it to run jobs. To do so, first associate the {ExecEnvShort} with a job template. diff --git a/downstream/modules/platform/proc-gs-auto-dev-create-automation-decision-proj.adoc b/downstream/modules/platform/proc-gs-auto-dev-create-automation-decision-proj.adoc index 3b23b2f457..87fd2c476a 100644 --- a/downstream/modules/platform/proc-gs-auto-dev-create-automation-decision-proj.adoc +++ b/downstream/modules/platform/proc-gs-auto-dev-create-automation-decision-proj.adoc @@ -2,7 +2,7 @@ [id="proc-gs-auto-dev-create-automation-decision-proj"] -= Creating an automation decision project += Create an automation decision project [role="_abstract"] Like automation execution projects, automation decision projects are logical collections of automation decision content. diff --git a/downstream/modules/platform/proc-gs-auto-dev-create-automation-execution-proj.adoc b/downstream/modules/platform/proc-gs-auto-dev-create-automation-execution-proj.adoc index 2120ad834b..b58c80fb57 100644 --- a/downstream/modules/platform/proc-gs-auto-dev-create-automation-execution-proj.adoc +++ b/downstream/modules/platform/proc-gs-auto-dev-create-automation-execution-proj.adoc @@ -2,7 +2,7 @@ [id="proc-gs-auto-dev-create-automation-execution-proj"] -= Creating an automation execution project += Create an automation execution project [role="_abstract"] A project is a logical collection of playbooks. diff --git a/downstream/modules/platform/proc-gs-auto-dev-create-template.adoc b/downstream/modules/platform/proc-gs-auto-dev-create-template.adoc index ac4cb0cefd..d658aa9a36 100644 --- a/downstream/modules/platform/proc-gs-auto-dev-create-template.adoc +++ b/downstream/modules/platform/proc-gs-auto-dev-create-template.adoc @@ -2,7 +2,7 @@ [id="proc-gs-auto-dev-create-template"] -= Creating a job template += Create a job template [role="_abstract"] Use the following procedure to create a job template. diff --git a/downstream/modules/platform/proc-gs-auto-dev-set-up-decision-env.adoc b/downstream/modules/platform/proc-gs-auto-dev-set-up-decision-env.adoc index dac70cf712..71f1231abb 100644 --- a/downstream/modules/platform/proc-gs-auto-dev-set-up-decision-env.adoc +++ b/downstream/modules/platform/proc-gs-auto-dev-set-up-decision-env.adoc @@ -2,7 +2,7 @@ [id="proc-gs-auto-dev-set-up-decision-env"] -= Setting up a new decision environment += Set up a new decision environment [role="_abstract"] The following steps describe how to import a decision environment into the platform. diff --git a/downstream/modules/platform/proc-gs-auto-op-execute-inv.adoc b/downstream/modules/platform/proc-gs-auto-op-execute-inv.adoc index 096ebc2cea..6c96ada606 100644 --- a/downstream/modules/platform/proc-gs-auto-op-execute-inv.adoc +++ b/downstream/modules/platform/proc-gs-auto-op-execute-inv.adoc @@ -2,7 +2,7 @@ [id="proc-gs-auto-op-execute-inv"] -= Executing an inventory += Execute an inventory [role="_abstract"] The following steps describe how to execute an inventory. diff --git a/downstream/modules/platform/proc-gs-auto-op-launch-template.adoc b/downstream/modules/platform/proc-gs-auto-op-launch-template.adoc index 9b87ad472e..60c4f29df7 100644 --- a/downstream/modules/platform/proc-gs-auto-op-launch-template.adoc +++ b/downstream/modules/platform/proc-gs-auto-op-launch-template.adoc @@ -2,7 +2,7 @@ [id="proc-gs-auto-op-launch-template"] -= Launching a job template += Launch a job template [role="_abstract"] {PlatformNameShort} offers push-button deployment of Ansible playbooks. diff --git a/downstream/modules/platform/proc-gs-auto-op-projects.adoc b/downstream/modules/platform/proc-gs-auto-op-projects.adoc index 349098b543..cbee277854 100644 --- a/downstream/modules/platform/proc-gs-auto-op-projects.adoc +++ b/downstream/modules/platform/proc-gs-auto-op-projects.adoc @@ -2,7 +2,7 @@ [id="proc-gs-auto-op-projects"] -= Automation execution projects += View automation execution projects [role="_abstract"] A project is a logical collection of Ansible playbooks that you can manage in {PlatformNameShort}. diff --git a/downstream/modules/platform/proc-gs-auto-op-review-job-output.adoc b/downstream/modules/platform/proc-gs-auto-op-review-job-output.adoc index c5a059a0cf..9fdae3a347 100644 --- a/downstream/modules/platform/proc-gs-auto-op-review-job-output.adoc +++ b/downstream/modules/platform/proc-gs-auto-op-review-job-output.adoc @@ -2,7 +2,7 @@ [id="proc-gs-auto-op-review-job-output"] -= Reviewing job output += Review job output [role="_abstract"] When you relaunch a job, the jobs *Output* view is displayed. diff --git a/downstream/modules/platform/proc-gs-auto-op-review-job-status.adoc b/downstream/modules/platform/proc-gs-auto-op-review-job-status.adoc index ba48485367..9a5207195b 100644 --- a/downstream/modules/platform/proc-gs-auto-op-review-job-status.adoc +++ b/downstream/modules/platform/proc-gs-auto-op-review-job-status.adoc @@ -2,7 +2,7 @@ [id="proc-gs-auto-op-review-job-status"] -= Reviewing a job status += Review a job status [role="_abstract"] The *Jobs* list view displays a list of jobs and their statuses, shown as completed successfully, failed, or as an active (running) job. diff --git a/downstream/modules/platform/proc-gs-eda-set-up-rulebook-activation.adoc b/downstream/modules/platform/proc-gs-eda-set-up-rulebook-activation.adoc index 596af5a4c6..31f75e824b 100644 --- a/downstream/modules/platform/proc-gs-eda-set-up-rulebook-activation.adoc +++ b/downstream/modules/platform/proc-gs-eda-set-up-rulebook-activation.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="gs-eda-set-up-rulebook-activation_{context}"] -= Setting up a rulebook activation += Set up a rulebook activation [role="_abstract"] Follow the steps in this procedure to set up a rulebook activation. diff --git a/downstream/modules/platform/proc-gs-logging-in.adoc b/downstream/modules/platform/proc-gs-logging-in.adoc index ffc73c3301..37ed0fb1d1 100644 --- a/downstream/modules/platform/proc-gs-logging-in.adoc +++ b/downstream/modules/platform/proc-gs-logging-in.adoc @@ -2,7 +2,7 @@ [id="proc-gs-logging-in"] -= Logging in for the first time += Log in for the first time [role="_abstract"] Log in to the {PlatformNameShort} as an administrator and enter your subscription information. diff --git a/downstream/modules/platform/proc-gs-publish-to-a-collection.adoc b/downstream/modules/platform/proc-gs-publish-to-a-collection.adoc index 980f9c0e3a..fe339fc0d7 100644 --- a/downstream/modules/platform/proc-gs-publish-to-a-collection.adoc +++ b/downstream/modules/platform/proc-gs-publish-to-a-collection.adoc @@ -2,7 +2,7 @@ [id="proc-gs-publish-to-a-collection_{context}"] -= Publishing to a collection += Publish to a collection [role="_abstract"] You can configure your projects to be uploaded to Git, or to the source control manager of your choice. diff --git a/downstream/modules/platform/proc-gs-upload-collection.adoc b/downstream/modules/platform/proc-gs-upload-collection.adoc index e1bf841208..cf1bb01f62 100644 --- a/downstream/modules/platform/proc-gs-upload-collection.adoc +++ b/downstream/modules/platform/proc-gs-upload-collection.adoc @@ -2,7 +2,7 @@ [id="proc-gs-upload-collection_{context}"] -= Uploading a collection to {HubName} += Upload a collection to {HubName} [role="_abstract"] If you want to share a collection that you have created with the rest of the Ansible community, you can upload it to {HubName}. diff --git a/downstream/modules/platform/proc-gs-use-base-execution-env.adoc b/downstream/modules/platform/proc-gs-use-base-execution-env.adoc index c7b6d0c46a..64a74b3252 100644 --- a/downstream/modules/platform/proc-gs-use-base-execution-env.adoc +++ b/downstream/modules/platform/proc-gs-use-base-execution-env.adoc @@ -2,7 +2,7 @@ [id="proc-gs-use-base-execution-env_{context}"] -= Using the base {ExecEnvNameSing} += Use the base {ExecEnvNameSing} [role="_abstract"] {PlatformNameShort} provides access to some base {ExecEnvName}. You can use a base {ExecEnvShort} as a starting point for creating a customized {ExecEnvShort}. diff --git a/downstream/modules/platform/proc-gs-write-playbook.adoc b/downstream/modules/platform/proc-gs-write-playbook.adoc index 35e3e80eb8..65df035d5f 100644 --- a/downstream/modules/platform/proc-gs-write-playbook.adoc +++ b/downstream/modules/platform/proc-gs-write-playbook.adoc @@ -2,7 +2,7 @@ [id="proc-gs-write-playbook"] -= Writing a playbook += Write a playbook [role="_abstract"] Create a playbook that pings your hosts and prints a "Hello world" message. diff --git a/downstream/modules/platform/proc-gw-add-admin-organization.adoc b/downstream/modules/platform/proc-gw-add-admin-organization.adoc index 836ae16c44..56d47d159d 100644 --- a/downstream/modules/platform/proc-gw-add-admin-organization.adoc +++ b/downstream/modules/platform/proc-gw-add-admin-organization.adoc @@ -2,7 +2,7 @@ [id="proc-gw-add-admin-organization"] -= Assigning an administrator to an organization += Assign an administrator to an organization [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-add-admin-team.adoc b/downstream/modules/platform/proc-gw-add-admin-team.adoc index 982be68253..0bb0b1940f 100644 --- a/downstream/modules/platform/proc-gw-add-admin-team.adoc +++ b/downstream/modules/platform/proc-gw-add-admin-team.adoc @@ -2,7 +2,7 @@ [id="proc-gw-add-admin-team"] -= Assigning administrators to a team += Assign administrators to a team [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-adjust-mapping-order.adoc b/downstream/modules/platform/proc-gw-adjust-mapping-order.adoc index 26ec478ab8..a085652060 100644 --- a/downstream/modules/platform/proc-gw-adjust-mapping-order.adoc +++ b/downstream/modules/platform/proc-gw-adjust-mapping-order.adoc @@ -2,7 +2,7 @@ [id="gw-adjust-mapping-order"] -= Adjusting the Mapping order += Adjust the mapping order [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-allow-mapping.adoc b/downstream/modules/platform/proc-gw-allow-mapping.adoc index 07fc124b32..d40b3d155b 100644 --- a/downstream/modules/platform/proc-gw-allow-mapping.adoc +++ b/downstream/modules/platform/proc-gw-allow-mapping.adoc @@ -2,7 +2,7 @@ [id="gw-allow-mapping"] -= Allow mapping += Control user access to the system with allow mapping [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-config-jwt-algorithms.adoc b/downstream/modules/platform/proc-gw-config-jwt-algorithms.adoc index 950de0ed1c..921b262957 100644 --- a/downstream/modules/platform/proc-gw-config-jwt-algorithms.adoc +++ b/downstream/modules/platform/proc-gw-config-jwt-algorithms.adoc @@ -2,7 +2,7 @@ [id="config-jwt-algorithms"] -= Configuring JWT_Algorithms manually += Configure JWT_Algorithms manually [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-config-keycloak-settings.adoc b/downstream/modules/platform/proc-gw-config-keycloak-settings.adoc index 55c0cc2730..640f52adfd 100644 --- a/downstream/modules/platform/proc-gw-config-keycloak-settings.adoc +++ b/downstream/modules/platform/proc-gw-config-keycloak-settings.adoc @@ -2,7 +2,7 @@ [id="gw-keycloak-authentication"] -= Configuring keycloak authentication += Configure keycloak authentication [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-create-roles.adoc b/downstream/modules/platform/proc-gw-create-roles.adoc index 8f2c2410c3..b3a288a4f8 100644 --- a/downstream/modules/platform/proc-gw-create-roles.adoc +++ b/downstream/modules/platform/proc-gw-create-roles.adoc @@ -2,7 +2,7 @@ [id="proc-gw-create-roles"] -= Creating a role += Create a role [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-define-rules-triggers.adoc b/downstream/modules/platform/proc-gw-define-rules-triggers.adoc index b3ecaedc33..5085f30ad7 100644 --- a/downstream/modules/platform/proc-gw-define-rules-triggers.adoc +++ b/downstream/modules/platform/proc-gw-define-rules-triggers.adoc @@ -2,7 +2,7 @@ [id="gw-define-rules-triggers"] -= Defining authentication mapping rules and triggers += Define authentication mapping rules and triggers [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-delete-authenticator.adoc b/downstream/modules/platform/proc-gw-delete-authenticator.adoc index b1ae43d09f..e3d0485a21 100644 --- a/downstream/modules/platform/proc-gw-delete-authenticator.adoc +++ b/downstream/modules/platform/proc-gw-delete-authenticator.adoc @@ -4,7 +4,7 @@ [role="_abstract"] -= Deleting an authenticator += Delete an authenticator You can change the settings of previously configured authenticators from the *Authentication* list view. diff --git a/downstream/modules/platform/proc-gw-delete-organization.adoc b/downstream/modules/platform/proc-gw-delete-organization.adoc index 6bfa75261f..41749f4a3a 100644 --- a/downstream/modules/platform/proc-gw-delete-organization.adoc +++ b/downstream/modules/platform/proc-gw-delete-organization.adoc @@ -2,7 +2,7 @@ [id="proc-gw-delete-organization"] -= Deleting an organization += Delete an organization [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-delete-roles.adoc b/downstream/modules/platform/proc-gw-delete-roles.adoc index 05c9724c2e..5386655ea3 100644 --- a/downstream/modules/platform/proc-gw-delete-roles.adoc +++ b/downstream/modules/platform/proc-gw-delete-roles.adoc @@ -2,7 +2,7 @@ [id="proc-gw-delete-roles"] -= Deleting a role += Delete a role [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-delete-team.adoc b/downstream/modules/platform/proc-gw-delete-team.adoc index 97a9325714..2ec8df68a5 100644 --- a/downstream/modules/platform/proc-gw-delete-team.adoc +++ b/downstream/modules/platform/proc-gw-delete-team.adoc @@ -2,7 +2,7 @@ [id="proc-gw-delete-team"] -= Deleting a team += Delete a team [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-display-auth-details.adoc b/downstream/modules/platform/proc-gw-display-auth-details.adoc index af1a61a9ae..54ef3df10e 100644 --- a/downstream/modules/platform/proc-gw-display-auth-details.adoc +++ b/downstream/modules/platform/proc-gw-display-auth-details.adoc @@ -2,7 +2,7 @@ [id="gw-display-auth-details"] -= Displaying authenticator details += Display authenticator details [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-edit-authenticator.adoc b/downstream/modules/platform/proc-gw-edit-authenticator.adoc index 1d42dc42c0..a124811981 100644 --- a/downstream/modules/platform/proc-gw-edit-authenticator.adoc +++ b/downstream/modules/platform/proc-gw-edit-authenticator.adoc @@ -2,7 +2,7 @@ [id="gw-edit-authenticator"] -= Editing an authenticator += Edit an authenticator [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-edit-roles.adoc b/downstream/modules/platform/proc-gw-edit-roles.adoc index 21d756f8cb..ea52a55f10 100644 --- a/downstream/modules/platform/proc-gw-edit-roles.adoc +++ b/downstream/modules/platform/proc-gw-edit-roles.adoc @@ -2,7 +2,7 @@ [id="proc-gw-edit-roles"] -= Editing a role += Edit a role [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-editing-a-user.adoc b/downstream/modules/platform/proc-gw-editing-a-user.adoc index 043514c68f..e4c8e6294d 100644 --- a/downstream/modules/platform/proc-gw-editing-a-user.adoc +++ b/downstream/modules/platform/proc-gw-editing-a-user.adoc @@ -2,7 +2,7 @@ [id="gw-editing-a-user"] -= Editing a user += Edit a user [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-enable-debugging.adoc b/downstream/modules/platform/proc-gw-enable-debugging.adoc index aafabff8d4..53a2538cbe 100644 --- a/downstream/modules/platform/proc-gw-enable-debugging.adoc +++ b/downstream/modules/platform/proc-gw-enable-debugging.adoc @@ -2,7 +2,7 @@ [id="enable-debugging"] -= Enabling debugging for enterprise authentication += Enable debugging for enterprise authentication [role="_abstract"] To further diagnose authentication issues, enable debug logging in {Gateway}. diff --git a/downstream/modules/platform/proc-gw-enable-oauth2-external-users.adoc b/downstream/modules/platform/proc-gw-enable-oauth2-external-users.adoc index b52ada29ec..cfe1929168 100644 --- a/downstream/modules/platform/proc-gw-enable-oauth2-external-users.adoc +++ b/downstream/modules/platform/proc-gw-enable-oauth2-external-users.adoc @@ -2,7 +2,7 @@ [id="gw-enable-oauth2-external-users"] -= Enabling OAuth2 token creation for external users += Enable OAuth2 token creation for external users [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-gcp-increase-port-limits.adoc b/downstream/modules/platform/proc-gw-gcp-increase-port-limits.adoc index b8589bd5c0..27dd90244f 100644 --- a/downstream/modules/platform/proc-gw-gcp-increase-port-limits.adoc +++ b/downstream/modules/platform/proc-gw-gcp-increase-port-limits.adoc @@ -2,7 +2,7 @@ [id="gw-gcp-increase-port-limits"] -= Increasing the minimum ports += Increase the minimum ports [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-import-cert-auth-ldaps.adoc b/downstream/modules/platform/proc-gw-import-cert-auth-ldaps.adoc index 751603457f..f2f2ccc784 100644 --- a/downstream/modules/platform/proc-gw-import-cert-auth-ldaps.adoc +++ b/downstream/modules/platform/proc-gw-import-cert-auth-ldaps.adoc @@ -2,7 +2,7 @@ [id="gw-import-cert-auth-ldaps"] -= Importing a certificate authority in {ControllerName} for LDAPS integration += Import a certificate authority in {ControllerName} for LDAPS integration [role="_abstract"] You can authenticate to the {ControllerName} server by using LDAP. diff --git a/downstream/modules/platform/proc-gw-local-authentication.adoc b/downstream/modules/platform/proc-gw-local-authentication.adoc index d8a4402d74..bb9749b963 100644 --- a/downstream/modules/platform/proc-gw-local-authentication.adoc +++ b/downstream/modules/platform/proc-gw-local-authentication.adoc @@ -2,7 +2,7 @@ [id="gw-local-authentication"] -= Configuring local authentication += Configure local authentication [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-oauth2-security-controls.adoc b/downstream/modules/platform/proc-gw-oauth2-security-controls.adoc index 1ddc39e3e0..8602fd7a3b 100644 --- a/downstream/modules/platform/proc-gw-oauth2-security-controls.adoc +++ b/downstream/modules/platform/proc-gw-oauth2-security-controls.adoc @@ -2,7 +2,7 @@ [id="gw-oauth2-security-controls"] -= Implementing security controls for external user OAuth2 tokens += Implement security controls for external user OAuth2 tokens [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-organizations-exec-env.adoc b/downstream/modules/platform/proc-gw-organizations-exec-env.adoc index 1baa86647a..9e8ee72630 100644 --- a/downstream/modules/platform/proc-gw-organizations-exec-env.adoc +++ b/downstream/modules/platform/proc-gw-organizations-exec-env.adoc @@ -2,7 +2,7 @@ [id="proc-gw-organizations-exec-env"] -= Working with {ExecEnvShort}s += Work with {ExecEnvShort}s [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-remove-roles-team.adoc b/downstream/modules/platform/proc-gw-remove-roles-team.adoc index 4bd6803656..9f5a1f5cf8 100644 --- a/downstream/modules/platform/proc-gw-remove-roles-team.adoc +++ b/downstream/modules/platform/proc-gw-remove-roles-team.adoc @@ -2,7 +2,7 @@ [id="proc-gw-remove-roles-team"] -= Removing roles from a team += Remove roles from a team [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-remove-roles-user.adoc b/downstream/modules/platform/proc-gw-remove-roles-user.adoc index b790bdb98e..41ecc06985 100644 --- a/downstream/modules/platform/proc-gw-remove-roles-user.adoc +++ b/downstream/modules/platform/proc-gw-remove-roles-user.adoc @@ -2,7 +2,7 @@ [id="proc-gw-remove-roles-user"] -= Removing roles from a user += Remove roles from a user [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-role-mapping.adoc b/downstream/modules/platform/proc-gw-role-mapping.adoc index dd02b78146..46eb70f913 100644 --- a/downstream/modules/platform/proc-gw-role-mapping.adoc +++ b/downstream/modules/platform/proc-gw-role-mapping.adoc @@ -2,7 +2,7 @@ [id="gw-role-mapping"] -= Role mapping += Map users to roles [role="_abstract"] Role mapping is the mapping of a user either to a global role, such as Platform Auditor, or team or organization role. diff --git a/downstream/modules/platform/proc-gw-roles.adoc b/downstream/modules/platform/proc-gw-roles.adoc index 4a8d750c27..fbdeb7a2fe 100644 --- a/downstream/modules/platform/proc-gw-roles.adoc +++ b/downstream/modules/platform/proc-gw-roles.adoc @@ -2,7 +2,7 @@ [id="proc-gw-roles"] -= Displaying roles += Display roles [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-searching-authenticator.adoc b/downstream/modules/platform/proc-gw-searching-authenticator.adoc index 0c19540c10..a1bf03e773 100644 --- a/downstream/modules/platform/proc-gw-searching-authenticator.adoc +++ b/downstream/modules/platform/proc-gw-searching-authenticator.adoc @@ -2,7 +2,7 @@ [id="gw-searching-authenticator"] -= Searching for an authenticator += Search for an authenticator [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-select-auth-type.adoc b/downstream/modules/platform/proc-gw-select-auth-type.adoc index bd0649e547..fd993dcc5a 100644 --- a/downstream/modules/platform/proc-gw-select-auth-type.adoc +++ b/downstream/modules/platform/proc-gw-select-auth-type.adoc @@ -2,7 +2,7 @@ [id="gw-select-auth-type"] -= Selecting an authentication type += Select an authentication type [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-setting-timeout-values.adoc b/downstream/modules/platform/proc-gw-setting-timeout-values.adoc index a2bab4d9fd..33e1265a60 100644 --- a/downstream/modules/platform/proc-gw-setting-timeout-values.adoc +++ b/downstream/modules/platform/proc-gw-setting-timeout-values.adoc @@ -2,7 +2,7 @@ [id="gw-setting-timeout-values"] -= Setting timeout values += Set timeout values [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-superuser-mapping.adoc b/downstream/modules/platform/proc-gw-superuser-mapping.adoc index 50044c05d9..120d75353b 100644 --- a/downstream/modules/platform/proc-gw-superuser-mapping.adoc +++ b/downstream/modules/platform/proc-gw-superuser-mapping.adoc @@ -2,7 +2,7 @@ [id="gw-superuser-mapping"] -= Superuser mapping += Map users to the superuser role [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-team-access-resources.adoc b/downstream/modules/platform/proc-gw-team-access-resources.adoc index 4feb7ecaa1..34bb143c2c 100644 --- a/downstream/modules/platform/proc-gw-team-access-resources.adoc +++ b/downstream/modules/platform/proc-gw-team-access-resources.adoc @@ -2,7 +2,7 @@ [id="proc-gw-team-access"] -= Providing team access to a resource += Provide team access to a resource [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-team-add-user.adoc b/downstream/modules/platform/proc-gw-team-add-user.adoc index dbabdd6975..0b97a2e5b7 100644 --- a/downstream/modules/platform/proc-gw-team-add-user.adoc +++ b/downstream/modules/platform/proc-gw-team-add-user.adoc @@ -2,7 +2,7 @@ [id="proc-gw-team-add-user"] -= Assigning users to a team += Assign users to a team [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-team-list-view.adoc b/downstream/modules/platform/proc-gw-team-list-view.adoc index e0e53d920a..7bbb65beb9 100644 --- a/downstream/modules/platform/proc-gw-team-list-view.adoc +++ b/downstream/modules/platform/proc-gw-team-list-view.adoc @@ -2,7 +2,7 @@ [id="proc-gw-team-list-view"] -= Teams list view += View the Teams list [role="_abstract"] The *Teams* page displays the existing teams for your installation. From here, you can search for a specific team, filter the list of teams by team name or organization, or change the sort order for the list. diff --git a/downstream/modules/platform/proc-gw-team-remove-user.adoc b/downstream/modules/platform/proc-gw-team-remove-user.adoc index 795ee886b1..c9710171b3 100644 --- a/downstream/modules/platform/proc-gw-team-remove-user.adoc +++ b/downstream/modules/platform/proc-gw-team-remove-user.adoc @@ -2,7 +2,7 @@ [id="proc-gw-team-remove-user"] -= Removing users from a team += Remove users from a team [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-troubleshoot-oidc-scope-mismatch.adoc b/downstream/modules/platform/proc-gw-troubleshoot-oidc-scope-mismatch.adoc index 19c3121db0..50aa1b536d 100644 --- a/downstream/modules/platform/proc-gw-troubleshoot-oidc-scope-mismatch.adoc +++ b/downstream/modules/platform/proc-gw-troubleshoot-oidc-scope-mismatch.adoc @@ -2,7 +2,7 @@ [id="troubleshoot-oidc-scope-mismatch"] -= Troubleshooting Generic OIDC scope mismatches += Troubleshoot Generic OIDC scope mismatches [role="_abstract"] Authentication fails when the Identity Provider (IdP) does not support the default scopes automatically appended by the system. diff --git a/downstream/modules/platform/proc-gw-update-callback-urls.adoc b/downstream/modules/platform/proc-gw-update-callback-urls.adoc index 7241fec40d..44c7646fab 100644 --- a/downstream/modules/platform/proc-gw-update-callback-urls.adoc +++ b/downstream/modules/platform/proc-gw-update-callback-urls.adoc @@ -2,7 +2,7 @@ [id="gw-update-callback-urls"] -= Updating callback URLs for OAuth and SSO providers += Update callback URLs for OAuth and SSO providers [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-user-access-resources.adoc b/downstream/modules/platform/proc-gw-user-access-resources.adoc index 8cf678c377..dd6d254939 100644 --- a/downstream/modules/platform/proc-gw-user-access-resources.adoc +++ b/downstream/modules/platform/proc-gw-user-access-resources.adoc @@ -2,7 +2,7 @@ [id="proc-gw-user-access-resources"] -= Providing direct user access to a resource += Provide direct user access to a resource [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-users-list-view.adoc b/downstream/modules/platform/proc-gw-users-list-view.adoc index 20807f35d2..753c911784 100644 --- a/downstream/modules/platform/proc-gw-users-list-view.adoc +++ b/downstream/modules/platform/proc-gw-users-list-view.adoc @@ -2,7 +2,7 @@ [id="proc-gw-users-list-view"] -= Users list view += View the Users list [role="_abstract"] diff --git a/downstream/modules/platform/proc-gw-using-jinja-syntax-auth-maps.adoc b/downstream/modules/platform/proc-gw-using-jinja-syntax-auth-maps.adoc index 8eb9c66a84..39740f7cba 100644 --- a/downstream/modules/platform/proc-gw-using-jinja-syntax-auth-maps.adoc +++ b/downstream/modules/platform/proc-gw-using-jinja-syntax-auth-maps.adoc @@ -2,7 +2,7 @@ [id="gw-using-jinja-syntax-auth-maps"] -= Using Jinja-like syntax in authenticator maps += Use Jinja-like syntax in authenticator maps [role="_abstract"] diff --git a/downstream/modules/platform/proc-ha-hub-installation.adoc b/downstream/modules/platform/proc-ha-hub-installation.adoc index 32e47e7840..e491fdd4c9 100644 --- a/downstream/modules/platform/proc-ha-hub-installation.adoc +++ b/downstream/modules/platform/proc-ha-hub-installation.adoc @@ -2,7 +2,7 @@ [id="ha-hub-installation"] -= Installing high availability {HubName} += Install high availability {HubName} [role="_abstract"] Configure inventory files to install a highly available {HubName} with clustered nodes and dedicated database hosts. This clustered setup uses load balancing to support enterprise-scale automation and ensures consistent system uptime. diff --git a/downstream/modules/platform/proc-hs-eda-setup.adoc b/downstream/modules/platform/proc-hs-eda-setup.adoc index 972e60a87a..b250cb92b1 100644 --- a/downstream/modules/platform/proc-hs-eda-setup.adoc +++ b/downstream/modules/platform/proc-hs-eda-setup.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="proc-hs-eda-setup"] -= Setting up horizontal scaling for {EDAcontroller} += Set up horizontal scaling for {EDAcontroller} [role="_abstract"] To scale up (add more nodes) or scale down (remove nodes), you must update the content of the inventory file to add or remove nodes and rerun the installation program. diff --git a/downstream/modules/platform/proc-hub-ingress-options.adoc b/downstream/modules/platform/proc-hub-ingress-options.adoc index a852556a23..4f2ddcc402 100644 --- a/downstream/modules/platform/proc-hub-ingress-options.adoc +++ b/downstream/modules/platform/proc-hub-ingress-options.adoc @@ -2,7 +2,7 @@ [id="proc-hub-ingress-options_{context}"] -= Configuring the ingress type for your {HubName} operator += Configure ingress options for {HubName} [role="_abstract"] diff --git a/downstream/modules/platform/proc-hub-route-options.adoc b/downstream/modules/platform/proc-hub-route-options.adoc index 067db0f8ab..981e61ced1 100644 --- a/downstream/modules/platform/proc-hub-route-options.adoc +++ b/downstream/modules/platform/proc-hub-route-options.adoc @@ -2,7 +2,7 @@ [id="proc-hub-route-options_{context}"] -= Configure your {HubName} operator route options += Configure {HubName} route options [role="_abstract"] diff --git a/downstream/modules/platform/proc-import-mesh-ca.adoc b/downstream/modules/platform/proc-import-mesh-ca.adoc index 2aa1b2069e..6ef12c8f8c 100644 --- a/downstream/modules/platform/proc-import-mesh-ca.adoc +++ b/downstream/modules/platform/proc-import-mesh-ca.adoc @@ -2,7 +2,7 @@ [id="importing-mesh-ca_{context}"] -= Importing a Certificate Authority (CA) certificate += Import a CA certificate [role="_abstract"] A Certificate Authority (CA) verifies and signs individual node certificates in an {AutomationMesh} environment. You can provide your own CA by specifying the path to the certificate and the private RSA key file in the `inventory` file of your {PlatformName} installer. diff --git a/downstream/modules/platform/proc-install-aap-operator.adoc b/downstream/modules/platform/proc-install-aap-operator.adoc index cf61c0a2f7..cc0d89fe8d 100644 --- a/downstream/modules/platform/proc-install-aap-operator.adoc +++ b/downstream/modules/platform/proc-install-aap-operator.adoc @@ -2,7 +2,7 @@ [id="proc-install-aap-operator_{context}"] -= Installing the {OperatorPlatformName} on {OCP} += Install the {OperatorPlatformName} on {OCP} [role="_abstract"] diff --git a/downstream/modules/platform/proc-install-cli-aap-operator.adoc b/downstream/modules/platform/proc-install-cli-aap-operator.adoc index e6d38f6009..6524b7bc79 100644 --- a/downstream/modules/platform/proc-install-cli-aap-operator.adoc +++ b/downstream/modules/platform/proc-install-cli-aap-operator.adoc @@ -5,7 +5,7 @@ [id="install-cli-aap-operator_{context}"] -= Installing the {OperatorPlatformNameShort} in a namespace += Install the {OperatorPlatformNameShort} in a namespace [role="_abstract"] diff --git a/downstream/modules/platform/proc-install-ha-hub-selinux.adoc b/downstream/modules/platform/proc-install-ha-hub-selinux.adoc index d93794f52a..82a69c4b7c 100644 --- a/downstream/modules/platform/proc-install-ha-hub-selinux.adoc +++ b/downstream/modules/platform/proc-install-ha-hub-selinux.adoc @@ -2,7 +2,7 @@ [id="proc-install-ha-hub-selinux"] -= Enabling a high availability (HA) deployment of {HubName} on SELinux += Enable a high availability (HA) deployment of {HubName} on SELinux [role="_abstract"] Enable a high availability (HA) deployment of {HubName} on SELinux by creating and mounting the required `/var/lib/pulp` directories on an external NFS export. This process ensures that the appropriate SELinux security contexts are correctly applied to the mount points, fulfilling the prerequisites for a successful {PlatformNameShort} installation in this specialized environment. diff --git a/downstream/modules/platform/proc-installing-containerized-aap.adoc b/downstream/modules/platform/proc-installing-containerized-aap.adoc index 10412d5fb8..c5c5074e40 100644 --- a/downstream/modules/platform/proc-installing-containerized-aap.adoc +++ b/downstream/modules/platform/proc-installing-containerized-aap.adoc @@ -2,7 +2,7 @@ [id="installing-containerized-aap"] -= Installing containerized {PlatformNameShort} += Install containerized {PlatformNameShort} [role="_abstract"] Run the `install` playbook to install containerized {PlatformNameShort} after preparing the {RHEL} host, downloading the installation program, and configuring the inventory file. diff --git a/downstream/modules/platform/proc-installing-the-aap-setup-bundle.adoc b/downstream/modules/platform/proc-installing-the-aap-setup-bundle.adoc index 590d5ddbcb..124dd1f23f 100644 --- a/downstream/modules/platform/proc-installing-the-aap-setup-bundle.adoc +++ b/downstream/modules/platform/proc-installing-the-aap-setup-bundle.adoc @@ -4,7 +4,7 @@ [id="installing-the-aap-setup-bundle_{context}"] -= Downloading and installing the {PlatformNameShort} setup bundle += Download and install the {PlatformNameShort} setup bundle [role="_abstract"] diff --git a/downstream/modules/platform/proc-modifying-the-run-schedule.adoc b/downstream/modules/platform/proc-modifying-the-run-schedule.adoc index a825a7b4c7..2f817a6081 100644 --- a/downstream/modules/platform/proc-modifying-the-run-schedule.adoc +++ b/downstream/modules/platform/proc-modifying-the-run-schedule.adoc @@ -2,7 +2,7 @@ [id="modifying-the-run-schedule_{context}"] -= Modifying the run schedule += Configure the `metrics-utility` to run at specific times [role="_abstract"] You can configure `metrics-utility` to run at specified times and intervals. Run frequency is expressed in cronjobs. For more information on the cron utility, see link:https://www.redhat.com/sysadmin/linux-cron-command[How to schedule jobs using the Linux `Cron` utility]. diff --git a/downstream/modules/platform/proc-obtaining-configuring-rpm-dependencies.adoc b/downstream/modules/platform/proc-obtaining-configuring-rpm-dependencies.adoc index be33368b4c..c3f48b81bb 100644 --- a/downstream/modules/platform/proc-obtaining-configuring-rpm-dependencies.adoc +++ b/downstream/modules/platform/proc-obtaining-configuring-rpm-dependencies.adoc @@ -2,7 +2,7 @@ [id="obtaining-and-configuring-rpm-dependencies"] -= Obtaining and configuring RPM source dependencies += Obtain and configure RPM source dependencies [role="_abstract"] The {PlatformNameShort} containerized setup bundle installation program does not include RPM source dependencies from the BaseOS and AppStream repositories. It relies on the host system's package manager to resolve these dependencies. diff --git a/downstream/modules/platform/proc-operator-access-aap.adoc b/downstream/modules/platform/proc-operator-access-aap.adoc index ebddd53918..b78121167a 100644 --- a/downstream/modules/platform/proc-operator-access-aap.adoc +++ b/downstream/modules/platform/proc-operator-access-aap.adoc @@ -2,7 +2,7 @@ [id="operator-access-aap_{context}"] -= Accessing {Gateway} through the {OCPShort} UI += Access {PlatformNameShort} through the UI [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-collect-diagnostic-data.adoc b/downstream/modules/platform/proc-operator-collect-diagnostic-data.adoc index c75d972f78..6533b271f2 100644 --- a/downstream/modules/platform/proc-operator-collect-diagnostic-data.adoc +++ b/downstream/modules/platform/proc-operator-collect-diagnostic-data.adoc @@ -2,7 +2,7 @@ [id="proc-operator-collect-diagnostic-data_{context}"] -= Collecting Diagnostic Data += Collect diagnostic data [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-config-csrf-gateway.adoc b/downstream/modules/platform/proc-operator-config-csrf-gateway.adoc index 81cc2c7119..b53ff2f4a2 100644 --- a/downstream/modules/platform/proc-operator-config-csrf-gateway.adoc +++ b/downstream/modules/platform/proc-operator-config-csrf-gateway.adoc @@ -2,7 +2,7 @@ [id="proc-operator-config-csrf-gateway_{context}"] -= Configuring your CSRF settings for your {Gateway} Operator ingress += Configure your CSRF settings [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-config-log-verbosity.adoc b/downstream/modules/platform/proc-operator-config-log-verbosity.adoc index 625f5a6f90..6a759b7493 100644 --- a/downstream/modules/platform/proc-operator-config-log-verbosity.adoc +++ b/downstream/modules/platform/proc-operator-config-log-verbosity.adoc @@ -2,7 +2,7 @@ [id="proc-operator-config-log-verbosity_{context}"] -= Configuring log verbosity += Configure log verbosity [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-crd-config-parameters-ui.adoc b/downstream/modules/platform/proc-operator-crd-config-parameters-ui.adoc index bc84c416fe..6ce5728175 100644 --- a/downstream/modules/platform/proc-operator-crd-config-parameters-ui.adoc +++ b/downstream/modules/platform/proc-operator-crd-config-parameters-ui.adoc @@ -2,7 +2,7 @@ [id="proc-operator-crd-config-parameters-ui_{context}"] -= Discovering custom resource configuration parameters through the {OCPShort} UI += View configuration parameters in the UI [role="_abstract"] You can discover the configuration parameters for your {OperatorPlatformNameShort} by viewing its Custom Resource (CR). The parameters are listed in the YAML schema. diff --git a/downstream/modules/platform/proc-operator-crd-config-parameters.adoc b/downstream/modules/platform/proc-operator-crd-config-parameters.adoc index aacd556372..f6d5343b87 100644 --- a/downstream/modules/platform/proc-operator-crd-config-parameters.adoc +++ b/downstream/modules/platform/proc-operator-crd-config-parameters.adoc @@ -2,7 +2,7 @@ [id="proc-operator-crd-config-parameters_{context}"] -= Discovering custom resource definition configuration parameters += View configuration parameters by using the CLI [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-create-controller-credential.adoc b/downstream/modules/platform/proc-operator-create-controller-credential.adoc index 78f0ffd7da..27122463c8 100644 --- a/downstream/modules/platform/proc-operator-create-controller-credential.adoc +++ b/downstream/modules/platform/proc-operator-create-controller-credential.adoc @@ -2,7 +2,7 @@ [id="proc-operator-create-controller-credential_{context}"] -= Creating an {ControllerName} credential custom resource += Create an {ControllerName} credential custom resource [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-create-controller-inventory.adoc b/downstream/modules/platform/proc-operator-create-controller-inventory.adoc index ec484a5f05..43c589831b 100644 --- a/downstream/modules/platform/proc-operator-create-controller-inventory.adoc +++ b/downstream/modules/platform/proc-operator-create-controller-inventory.adoc @@ -2,7 +2,7 @@ [id="proc-operator-create-controller-inventory_{context}"] -= Creating an {ControllerName} inventory custom resource += Create an {ControllerName} inventory custom resource [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-create-controller-project.adoc b/downstream/modules/platform/proc-operator-create-controller-project.adoc index d918a27c60..6f05cb6fdd 100644 --- a/downstream/modules/platform/proc-operator-create-controller-project.adoc +++ b/downstream/modules/platform/proc-operator-create-controller-project.adoc @@ -2,7 +2,7 @@ [id="proc-operator-create-controller-project_{context}"] -= Creating an {ControllerName} project custom resource += Create an {ControllerName} project custom resource [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-create-controller-schedule.adoc b/downstream/modules/platform/proc-operator-create-controller-schedule.adoc index d449ad4765..d94e99bdef 100644 --- a/downstream/modules/platform/proc-operator-create-controller-schedule.adoc +++ b/downstream/modules/platform/proc-operator-create-controller-schedule.adoc @@ -2,7 +2,7 @@ [id="proc-operator-create-controller-schedule_{context}"] -= Creating an {ControllerName} schedule custom resource += Create an {ControllerName} schedule custom resource [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-create-controller-workflow-template.adoc b/downstream/modules/platform/proc-operator-create-controller-workflow-template.adoc index 4845ab506e..449dde7e86 100644 --- a/downstream/modules/platform/proc-operator-create-controller-workflow-template.adoc +++ b/downstream/modules/platform/proc-operator-create-controller-workflow-template.adoc @@ -2,7 +2,7 @@ [id="proc-operator-create-controller-workflow-template_{context}"] -= Creating an {ControllerName} workflow template custom resource += Create an {ControllerName} workflow template custom resource [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-create-controller-workflow.adoc b/downstream/modules/platform/proc-operator-create-controller-workflow.adoc index e307b75238..243541f2f4 100644 --- a/downstream/modules/platform/proc-operator-create-controller-workflow.adoc +++ b/downstream/modules/platform/proc-operator-create-controller-workflow.adoc @@ -2,7 +2,7 @@ [id="proc-operator-create-controller-workflow_{context}"] -= Creating an {ControllerName} workflow custom resource += Create an {ControllerName} workflow custom resource [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-create_crs.adoc b/downstream/modules/platform/proc-operator-create_crs.adoc index 35714af881..bab166f18a 100644 --- a/downstream/modules/platform/proc-operator-create_crs.adoc +++ b/downstream/modules/platform/proc-operator-create_crs.adoc @@ -2,7 +2,7 @@ [id="operator-create-crs_{context}"] -= Creating {PlatformNameShort} custom resources += Create {PlatformNameShort} custom resources [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-debug-crashing-pods.adoc b/downstream/modules/platform/proc-operator-debug-crashing-pods.adoc index 9c0b21fdeb..6698e14311 100644 --- a/downstream/modules/platform/proc-operator-debug-crashing-pods.adoc +++ b/downstream/modules/platform/proc-operator-debug-crashing-pods.adoc @@ -2,7 +2,7 @@ [id="proc-operator-debug-crashing-pods_{context}"] -= Debugging crashing pods += Debug crashing pods [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-defining-nested-parameter.adoc b/downstream/modules/platform/proc-operator-defining-nested-parameter.adoc index 25d871b9f3..8db2043268 100644 --- a/downstream/modules/platform/proc-operator-defining-nested-parameter.adoc +++ b/downstream/modules/platform/proc-operator-defining-nested-parameter.adoc @@ -2,7 +2,7 @@ [id="proc-operator-defining-nest-parameter_{context}"] -= Defining a parameter on a nested component += Configure component parameters [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-deploy-central-config.adoc b/downstream/modules/platform/proc-operator-deploy-central-config.adoc index 457bbed59a..2687ec4d94 100644 --- a/downstream/modules/platform/proc-operator-deploy-central-config.adoc +++ b/downstream/modules/platform/proc-operator-deploy-central-config.adoc @@ -2,7 +2,7 @@ [id="operator-deploy-central-config_{context}"] -= Deploying the {Gateway} with existing {PlatformNameShort} components += Add components to an existing deployment [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-deploy-redis.adoc b/downstream/modules/platform/proc-operator-deploy-redis.adoc index dce457d22a..f1a6110656 100644 --- a/downstream/modules/platform/proc-operator-deploy-redis.adoc +++ b/downstream/modules/platform/proc-operator-deploy-redis.adoc @@ -2,7 +2,7 @@ [id="operator-deploy-redis"] -= Deploying Redis on {OperatorPlatformName} += Configure Redis [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-enable-https-redirect.adoc b/downstream/modules/platform/proc-operator-enable-https-redirect.adoc index 027689b7f6..e80ea0779d 100644 --- a/downstream/modules/platform/proc-operator-enable-https-redirect.adoc +++ b/downstream/modules/platform/proc-operator-enable-https-redirect.adoc @@ -2,7 +2,7 @@ [id="proc-operator-enable-https-redirect"] -= Enabling HTTPS redirect for single sign-on (SSO) for {Gateway} on {OCPShort} += Enable HTTPS redirect for single sign-on [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-external-db-controller.adoc b/downstream/modules/platform/proc-operator-external-db-controller.adoc index 78a354524f..8cac1c2a47 100644 --- a/downstream/modules/platform/proc-operator-external-db-controller.adoc +++ b/downstream/modules/platform/proc-operator-external-db-controller.adoc @@ -3,7 +3,7 @@ [id="proc-operator-external-db-controller"] -= Configuring an external database for {ControllerName} on {OperatorPlatformName} += Configure an external database for {ControllerName} on {OperatorPlatformName} [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-external-db-gateway.adoc b/downstream/modules/platform/proc-operator-external-db-gateway.adoc index a6e5381e00..bd7a3708f4 100644 --- a/downstream/modules/platform/proc-operator-external-db-gateway.adoc +++ b/downstream/modules/platform/proc-operator-external-db-gateway.adoc @@ -2,7 +2,7 @@ [id="proc-operator-external-db-gateway"] -= Configuring an external database for {Gateway} on {OperatorPlatformName} += Configure an external database for {Gateway} on {OperatorPlatformName} [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-external-db-hub.adoc b/downstream/modules/platform/proc-operator-external-db-hub.adoc index db4c179b16..e33df42d4d 100644 --- a/downstream/modules/platform/proc-operator-external-db-hub.adoc +++ b/downstream/modules/platform/proc-operator-external-db-hub.adoc @@ -3,7 +3,7 @@ [id="proc-operator-external-db-hub"] -= Configuring an external database for {HubName} on {OperatorPlatformName} += Configure an external database for {HubName} on {OperatorPlatformName} [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-inspect-k8s-resource.adoc b/downstream/modules/platform/proc-operator-inspect-k8s-resource.adoc index 53968a78d9..2443002848 100644 --- a/downstream/modules/platform/proc-operator-inspect-k8s-resource.adoc +++ b/downstream/modules/platform/proc-operator-inspect-k8s-resource.adoc @@ -2,7 +2,7 @@ [id="proc-operator-inspect-k8s-resource_{context}"] -= Inspecting a {OCPShort} resource += Inspect a {OCPShort} resource [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-link-components.adoc b/downstream/modules/platform/proc-operator-link-components.adoc index 9d215d06c2..02f3161139 100644 --- a/downstream/modules/platform/proc-operator-link-components.adoc +++ b/downstream/modules/platform/proc-operator-link-components.adoc @@ -2,7 +2,7 @@ [id="operator-link-components_{context}"] -= Linking your components to the {Gateway} += Deploy a new {PlatformNameShort} instance with components [role="_abstract"] After installing the {OperatorPlatformNameShort} in your namespace you can set up your *{PlatformNameShort}* instance. diff --git a/downstream/modules/platform/proc-operator-mesh-upgrading-receptors.adoc b/downstream/modules/platform/proc-operator-mesh-upgrading-receptors.adoc index ca42ae8295..e9fba09702 100644 --- a/downstream/modules/platform/proc-operator-mesh-upgrading-receptors.adoc +++ b/downstream/modules/platform/proc-operator-mesh-upgrading-receptors.adoc @@ -2,7 +2,7 @@ [id="proc-operator-mesh-upgrading-receptors"] -= Upgrading receptors += Upgrade receptors [role="_abstract"] A software update addresses any issues or bugs to provide a better experience of working with the technology. Anyone with administrative rights can update the receptor on an execution node. diff --git a/downstream/modules/platform/proc-operator-scaling-down-aap.adoc b/downstream/modules/platform/proc-operator-scaling-down-aap.adoc index 3deebcf4b3..6618a7d45e 100644 --- a/downstream/modules/platform/proc-operator-scaling-down-aap.adoc +++ b/downstream/modules/platform/proc-operator-scaling-down-aap.adoc @@ -2,7 +2,7 @@ [id="operator-scaling-down-aap"] -= Scaling down {OperatorPlatformName} deployments += Scale down your {OperatorPlatformNameShort} deployment [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-troubleshoot-ext-db.adoc b/downstream/modules/platform/proc-operator-troubleshoot-ext-db.adoc index 120eb69c29..d156f0f8ba 100644 --- a/downstream/modules/platform/proc-operator-troubleshoot-ext-db.adoc +++ b/downstream/modules/platform/proc-operator-troubleshoot-ext-db.adoc @@ -2,7 +2,7 @@ [id="aap-operator-troubleshoot-ext-db_{context}"] -= Troubleshooting an external database with an unexpected DataStyle set += Troubleshoot an external database [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-upgrade.adoc b/downstream/modules/platform/proc-operator-upgrade.adoc index 325fc19ab1..bccdf0d88d 100644 --- a/downstream/modules/platform/proc-operator-upgrade.adoc +++ b/downstream/modules/platform/proc-operator-upgrade.adoc @@ -2,7 +2,7 @@ [id="upgrading-operator_{context}"] -= Upgrading the {OperatorPlatformNameShort} += Upgrade the {OperatorPlatformNameShort} [role="_abstract"] diff --git a/downstream/modules/platform/proc-operator-viewing-events.adoc b/downstream/modules/platform/proc-operator-viewing-events.adoc index bb199a7ca5..62023f1068 100644 --- a/downstream/modules/platform/proc-operator-viewing-events.adoc +++ b/downstream/modules/platform/proc-operator-viewing-events.adoc @@ -2,7 +2,7 @@ [id="proc-operator-viewing-events_{context}"] -= Viewing events in the {OCPShort} += View events in the {OCPShort} [role="_abstract"] diff --git a/downstream/modules/platform/proc-pac-add-policy-to-inventory.adoc b/downstream/modules/platform/proc-pac-add-policy-to-inventory.adoc index 5cefbf982f..0858d11211 100644 --- a/downstream/modules/platform/proc-pac-add-policy-to-inventory.adoc +++ b/downstream/modules/platform/proc-pac-add-policy-to-inventory.adoc @@ -4,7 +4,7 @@ [id="pac-add-policy-to-inventory_{context}"] -= Associating a policy with an inventory += Associate a policy with an inventory [role="_abstract"] Learn how to associate a policy with an inventory diff --git a/downstream/modules/platform/proc-pac-add-policy-to-org.adoc b/downstream/modules/platform/proc-pac-add-policy-to-org.adoc index 0d88a829bd..cc0d2d8cc7 100644 --- a/downstream/modules/platform/proc-pac-add-policy-to-org.adoc +++ b/downstream/modules/platform/proc-pac-add-policy-to-org.adoc @@ -4,7 +4,7 @@ [id="pac-add-policy-to-org_{context}"] -= Associating a policy with an organization += Associate a policy with an organization [role="_abstract"] Learn how to associate a policy with an organization. diff --git a/downstream/modules/platform/proc-pac-add-policy-to-template.adoc b/downstream/modules/platform/proc-pac-add-policy-to-template.adoc index fd40d062c8..82d876cb75 100644 --- a/downstream/modules/platform/proc-pac-add-policy-to-template.adoc +++ b/downstream/modules/platform/proc-pac-add-policy-to-template.adoc @@ -4,7 +4,7 @@ [id="pac-add-policy-to-template_{context}"] -= Associating a policy with a job template += Associate a policy with a job template [role="_abstract"] Learn how to associate a policy with a job template. diff --git a/downstream/modules/platform/proc-perform-containerized-disconnected-installation.adoc b/downstream/modules/platform/proc-perform-containerized-disconnected-installation.adoc index 1c0f50b8e9..3cc3b71883 100644 --- a/downstream/modules/platform/proc-perform-containerized-disconnected-installation.adoc +++ b/downstream/modules/platform/proc-perform-containerized-disconnected-installation.adoc @@ -2,7 +2,7 @@ [id="perform-disconnected-installation"] -= Performing a disconnected installation += Perform a disconnected installation [role="_abstract"] A disconnected installation installs containerized {PlatformNameShort} without requiring network access to external registries. diff --git a/downstream/modules/platform/proc-postgresql-enable-mtls-authentication.adoc b/downstream/modules/platform/proc-postgresql-enable-mtls-authentication.adoc index c6ee44c292..da984ac2a8 100644 --- a/downstream/modules/platform/proc-postgresql-enable-mtls-authentication.adoc +++ b/downstream/modules/platform/proc-postgresql-enable-mtls-authentication.adoc @@ -2,7 +2,7 @@ [id="proc-enable-mtls-authentication_{context}"] -= Enabling mutual TLS (mTLS) authentication += Enable mutual TLS (mTLS) authentication [role="_abstract"] Enable mutual TLS authentication to secure PostgreSQL database connections with certificate-based verification. diff --git a/downstream/modules/platform/proc-postgresql-use-custom-certificates.adoc b/downstream/modules/platform/proc-postgresql-use-custom-certificates.adoc index 27b2373d65..65c5315422 100644 --- a/downstream/modules/platform/proc-postgresql-use-custom-certificates.adoc +++ b/downstream/modules/platform/proc-postgresql-use-custom-certificates.adoc @@ -2,7 +2,7 @@ [id="proc-use-custom-tls-certificates_{context}"] -= Using custom TLS certificates += Use custom TLS certificates [role="_abstract"] Configure the installer to use your custom TLS certificates and keys for all {PlatformNameShort} services instead of the default self-signed certificates. This is achieved by setting inventory variables (`aap_ca_cert_file` and `aap_ca_key_file`), and optionally specifying a custom Certificate Authority (CA) certificate using `custom_ca_cert` to ensure trust and security across the platform. diff --git a/downstream/modules/platform/proc-preparing-the-managed-nodes-for-containerized-installation.adoc b/downstream/modules/platform/proc-preparing-the-managed-nodes-for-containerized-installation.adoc index ef28ae503c..6215a7bef0 100644 --- a/downstream/modules/platform/proc-preparing-the-managed-nodes-for-containerized-installation.adoc +++ b/downstream/modules/platform/proc-preparing-the-managed-nodes-for-containerized-installation.adoc @@ -2,7 +2,7 @@ [id="preparing-the-managed-nodes-for-containerized-installation"] -= Preparing the managed nodes for containerized installation += Prepare the managed nodes for containerized installation [role="_abstract"] Managed nodes, also referred to as hosts, are the devices that {PlatformNameShort} manages. diff --git a/downstream/modules/platform/proc-preparing-the-rhel-host-for-containerized-installation.adoc b/downstream/modules/platform/proc-preparing-the-rhel-host-for-containerized-installation.adoc index 2c2fb5d503..8111f27b2d 100644 --- a/downstream/modules/platform/proc-preparing-the-rhel-host-for-containerized-installation.adoc +++ b/downstream/modules/platform/proc-preparing-the-rhel-host-for-containerized-installation.adoc @@ -2,7 +2,7 @@ [id="preparing-the-rhel-host-for-containerized-installation"] -= Preparing the {RHEL} host for containerized installation += Prepare the {RHEL} host for containerized installation [role="_abstract"] Containerized {PlatformNameShort} runs the component services as Podman based containers on top of a {RHEL} host. Prepare the {RHEL} host to ensure a successful installation. diff --git a/downstream/modules/platform/proc-projects-manage-playbooks-manually.adoc b/downstream/modules/platform/proc-projects-manage-playbooks-manually.adoc index 7615408ecc..e2029e9905 100644 --- a/downstream/modules/platform/proc-projects-manage-playbooks-manually.adoc +++ b/downstream/modules/platform/proc-projects-manage-playbooks-manually.adoc @@ -2,7 +2,7 @@ [id="proc-projects-manage-playbooks-manually"] -= Managing playbooks manually += Manage playbooks manually [role="_abstract"] Manage Ansible playbooks and directories directly on the {ControllerName} filesystem. diff --git a/downstream/modules/platform/proc-projects-using-collections-with-hub.adoc b/downstream/modules/platform/proc-projects-using-collections-with-hub.adoc index 6e2eee2d07..e5dd30dee0 100644 --- a/downstream/modules/platform/proc-projects-using-collections-with-hub.adoc +++ b/downstream/modules/platform/proc-projects-using-collections-with-hub.adoc @@ -2,7 +2,7 @@ [id="proc-projects-using-collections-with-hub"] -= Using collections with {HubName} += Use collections with {HubName} [role="_abstract"] Before {ControllerName} can use {HubName} as the default source for collections content, you must create an API token in the {HubName} UI. diff --git a/downstream/modules/platform/proc-provide-custom-ca-cert.adoc b/downstream/modules/platform/proc-provide-custom-ca-cert.adoc index 75a5c13aac..ce1e5c8c3f 100644 --- a/downstream/modules/platform/proc-provide-custom-ca-cert.adoc +++ b/downstream/modules/platform/proc-provide-custom-ca-cert.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="providing-a-custom-ca-certificate"] -= Providing a custom CA certificate += Provide a custom CA certificate [role="_abstract"] When you manually provide TLS certificates for {PlatformNameShort} services (such as `gateway_tls_cert`, `controller_tls_cert`, or `hub_tls_cert`), those certificates might be signed by a custom CA. diff --git a/downstream/modules/platform/proc-provide-custom-tls-certs-per-service.adoc b/downstream/modules/platform/proc-provide-custom-tls-certs-per-service.adoc index 3b58d3d3c4..35219097bb 100644 --- a/downstream/modules/platform/proc-provide-custom-tls-certs-per-service.adoc +++ b/downstream/modules/platform/proc-provide-custom-tls-certs-per-service.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="proc-provide-custom-tls-certs-per-service"] -= Providing custom TLS certificates for each service += Provide custom TLS certificates for each service [role="_abstract"] Use this method if your organization manages TLS certificates outside of {PlatformNameShort} and requires manual provisioning. diff --git a/downstream/modules/platform/proc-provision-ocp-storage-amazon-s3.adoc b/downstream/modules/platform/proc-provision-ocp-storage-amazon-s3.adoc index 1c0c13b209..86e7b48658 100644 --- a/downstream/modules/platform/proc-provision-ocp-storage-amazon-s3.adoc +++ b/downstream/modules/platform/proc-provision-ocp-storage-amazon-s3.adoc @@ -3,7 +3,7 @@ [id="provision-ocp-storage-amazon-s3_{context}"] -= Configuring object storage on Amazon S3 += Configure object storage on Amazon S3 [role="_abstract"] diff --git a/downstream/modules/platform/proc-provision-ocp-storage-azure-blob.adoc b/downstream/modules/platform/proc-provision-ocp-storage-azure-blob.adoc index 00cfe46af1..8dbf388bf3 100644 --- a/downstream/modules/platform/proc-provision-ocp-storage-azure-blob.adoc +++ b/downstream/modules/platform/proc-provision-ocp-storage-azure-blob.adoc @@ -2,7 +2,7 @@ [id="provision-ocp-storage-azure-blob_{context}"] -= Configuring object storage on Azure Blob += Configure object storage on Azure Blob [role="_abstract"] diff --git a/downstream/modules/platform/proc-provision-ocp-storage-with-readwritemany.adoc b/downstream/modules/platform/proc-provision-ocp-storage-with-readwritemany.adoc index 26d4f1a178..212cf42608 100644 --- a/downstream/modules/platform/proc-provision-ocp-storage-with-readwritemany.adoc +++ b/downstream/modules/platform/proc-provision-ocp-storage-with-readwritemany.adoc @@ -2,7 +2,7 @@ [id="proc-provision-ocp-storage-with-readwritemany_{context}"] -= Provisioning OCP storage with `ReadWriteMany` access mode += Provision OCP storage with `ReadWriteMany` access mode [role="_abstract"] diff --git a/downstream/modules/platform/proc-proxy-AWS-inventory-sync.adoc b/downstream/modules/platform/proc-proxy-AWS-inventory-sync.adoc index b4beb91b17..744b05707c 100644 --- a/downstream/modules/platform/proc-proxy-AWS-inventory-sync.adoc +++ b/downstream/modules/platform/proc-proxy-AWS-inventory-sync.adoc @@ -2,7 +2,7 @@ [id="proc-proxy-AWS-inventory-sync"] -= Enabling a configurable proxy environment for AWS inventory synchronization += Enable a configurable proxy environment for AWS inventory synchronization [role="_abstract"] To enable a configurable proxy environment for AWS inventory synchronization, you can manually edit the override configuration file or set the configuration in the platform UI: diff --git a/downstream/modules/platform/proc-pulling-the-secret.adoc b/downstream/modules/platform/proc-pulling-the-secret.adoc index 8050b749e7..67f6c21306 100644 --- a/downstream/modules/platform/proc-pulling-the-secret.adoc +++ b/downstream/modules/platform/proc-pulling-the-secret.adoc @@ -2,7 +2,7 @@ [id="proc-pulling-the-secret"] -= Pulling the secret for {OCPShort} deployments += Create a pull secret to run the default {ExecEnvShort} on remote nodes [role="_abstract"] If you are using the default {ExecEnvShort} provided with {ControllerName} to run on remote execution nodes, you must add a pull secret in {ControllerName} that has the credential for pulling the {ExecEnvShort} image. diff --git a/downstream/modules/platform/proc-reinstalling-containerized-aap.adoc b/downstream/modules/platform/proc-reinstalling-containerized-aap.adoc index ec7640f013..36294520a0 100644 --- a/downstream/modules/platform/proc-reinstalling-containerized-aap.adoc +++ b/downstream/modules/platform/proc-reinstalling-containerized-aap.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="reinstalling-containerized-aap"] -= Reinstalling containerized {PlatformNameShort} += Reinstall containerized {PlatformNameShort} [role="_abstract"] Reinstall a containerized deployment after uninstalling and preserving the database. diff --git a/downstream/modules/platform/proc-remove-EDA-2.4-db.adoc b/downstream/modules/platform/proc-remove-EDA-2.4-db.adoc index 50790267da..d6f42197a7 100644 --- a/downstream/modules/platform/proc-remove-EDA-2.4-db.adoc +++ b/downstream/modules/platform/proc-remove-EDA-2.4-db.adoc @@ -2,7 +2,7 @@ [id="proc-removing-eda-db_{context}"] -= Removing {EDAName} 2.4 database += Remove the 2.4 database for {EDAName} [role="_abstract"] {PlatformNameShort} 2.6 supports upgrades from {PlatformNameShort} 2.4 environments for all components, except for {EDAName}. diff --git a/downstream/modules/platform/proc-restore-aap-container.adoc b/downstream/modules/platform/proc-restore-aap-container.adoc index 83ac9dc9fc..61afc55c12 100644 --- a/downstream/modules/platform/proc-restore-aap-container.adoc +++ b/downstream/modules/platform/proc-restore-aap-container.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="proc-restore-aap-container"] -= Restoring containerized {PlatformNameShort} += Restore containerized {PlatformNameShort} [role="_abstract"] Restore your {ContainerBase} of {PlatformNameShort} from a backup, or to a different environment. diff --git a/downstream/modules/platform/proc-rpm-troubleshoot-generating-logs.adoc b/downstream/modules/platform/proc-rpm-troubleshoot-generating-logs.adoc index f96427bfb9..92b73cc22f 100644 --- a/downstream/modules/platform/proc-rpm-troubleshoot-generating-logs.adoc +++ b/downstream/modules/platform/proc-rpm-troubleshoot-generating-logs.adoc @@ -2,7 +2,7 @@ [id="rpm-troubleshoot-generating-logs"] -= Gathering {PlatformNameShort} logs += Gather {PlatformNameShort} logs [role="_abstract"] Gather configuration, diagnostic, and troubleshooting data from all nodes in your {PlatformNameShort} environment by running the setup script with the `-s` flag. This crucial procedure generates an sos report, which contains the detailed diagnostic information Red Hat Technical Support engineers require to analyze and resolve service requests efficiently. @@ -46,13 +46,19 @@ $ ./setup.sh -e 'case_number=0000000' -e 'clean=true' -e 'upload=true' -s [%header, cols="a,a,a"] [%autowidth] |=== -|Parameter |Description |Default value | +|Parameter |Description |Default value -`case_number`| Specifies the support case number that you want. | - | +|`case_number` +| Specifies the support case number that you want. +| - -`clean`| Obfuscates sensitive data that might be present on the `sos` report. | `false` | +|`clean` +| Obfuscates sensitive data that might be present on the `sos` report. +| `false` -`upload`| Automatically uploads the `sos` report data to Red Hat. | `false` | +|`upload` +| Automatically uploads the `sos` report data to Red Hat. +| `false` |=== .Additional resources diff --git a/downstream/modules/platform/proc-run-jobs-on-execution-nodes.adoc b/downstream/modules/platform/proc-run-jobs-on-execution-nodes.adoc index 3a09fbd790..f5ecc7b20c 100644 --- a/downstream/modules/platform/proc-run-jobs-on-execution-nodes.adoc +++ b/downstream/modules/platform/proc-run-jobs-on-execution-nodes.adoc @@ -2,7 +2,7 @@ [id="proc-run-jobs-on-execution-nodes"] -= Running jobs on execution nodes += Run jobs on execution nodes [role="_abstract"] You must specify where jobs run from, or they default to running in the control cluster. diff --git a/downstream/modules/platform/proc-running-setup-script-for-updates.adoc b/downstream/modules/platform/proc-running-setup-script-for-updates.adoc index 42d9c6ea39..51d288e861 100644 --- a/downstream/modules/platform/proc-running-setup-script-for-updates.adoc +++ b/downstream/modules/platform/proc-running-setup-script-for-updates.adoc @@ -2,7 +2,7 @@ [id="proc-running-setup-script-for-updates"] -= Running the {PlatformName} installer setup script += Run the installer setup script and verify platform accounts [role="_abstract"] Execute the {PlatformName} installer setup script after configuring your `inventory` file. This action initiates the installation or update process, applying all your custom settings to deploy the platform successfully. diff --git a/downstream/modules/platform/proc-running-setup-script.adoc b/downstream/modules/platform/proc-running-setup-script.adoc index c96d172865..6e1895c779 100644 --- a/downstream/modules/platform/proc-running-setup-script.adoc +++ b/downstream/modules/platform/proc-running-setup-script.adoc @@ -2,7 +2,7 @@ [id="proc-running-setup-script_{context}"] -= Running the {PlatformName} installer setup script += Run the setup script [role="_abstract"] Run the {Installer} setup script after updating the inventory file with all the required parameters to begin the installation and configuration of the platform. diff --git a/downstream/modules/platform/proc-scm-git-subversion.adoc b/downstream/modules/platform/proc-scm-git-subversion.adoc index 1f586483d6..fec48da470 100644 --- a/downstream/modules/platform/proc-scm-git-subversion.adoc +++ b/downstream/modules/platform/proc-scm-git-subversion.adoc @@ -2,7 +2,7 @@ [id="proc-scm-git-subversion"] -= SCM Types - Configuring playbooks to use Git and Subversion += Configure playbooks to use Git and Subversion SCM types [role="_abstract"] Configure {ControllerName} projects to synchronize Ansible playbooks directly from Git and Subversion. diff --git a/downstream/modules/platform/proc-scm-insights.adoc b/downstream/modules/platform/proc-scm-insights.adoc index 168b1c0de3..395ba96781 100644 --- a/downstream/modules/platform/proc-scm-insights.adoc +++ b/downstream/modules/platform/proc-scm-insights.adoc @@ -2,7 +2,7 @@ [id="proc-scm-insights"] -= SCM Type - Configuring playbooks to use {RHLightspeed} += Configure playbooks to use {RHLightspeed} [role="_abstract"] Configure your projects to retrieve Ansible playbooks directly from {RHLightspeed}. diff --git a/downstream/modules/platform/proc-scm-remote-archive.adoc b/downstream/modules/platform/proc-scm-remote-archive.adoc index 7ec74e4bb4..19bf545f07 100644 --- a/downstream/modules/platform/proc-scm-remote-archive.adoc +++ b/downstream/modules/platform/proc-scm-remote-archive.adoc @@ -2,7 +2,7 @@ [id="proc-scm-remote-archive"] -= SCM Type - Configuring playbooks to use a remote archive += Configure playbooks to use a remote archive [role="_abstract"] Playbooks that use a remote archive enable projects to be based on a build process that produces a versioned artifact, or release, containing all the requirements for that project in a single archive. diff --git a/downstream/modules/platform/proc-set-EDA-proxy.adoc b/downstream/modules/platform/proc-set-EDA-proxy.adoc index ceca8235d0..3105dcc4aa 100644 --- a/downstream/modules/platform/proc-set-EDA-proxy.adoc +++ b/downstream/modules/platform/proc-set-EDA-proxy.adoc @@ -2,7 +2,7 @@ [id="proc-set-EDA-proxy"] -= Configuring proxy settings on {EDAName} += Configure proxy settings for Event-Driven Ansible [role="_abstract"] For {EDAName}, there are no global settings to set a proxy. diff --git a/downstream/modules/platform/proc-set-domain-of-interest.adoc b/downstream/modules/platform/proc-set-domain-of-interest.adoc index 6a45df0b61..b2fa9f1483 100644 --- a/downstream/modules/platform/proc-set-domain-of-interest.adoc +++ b/downstream/modules/platform/proc-set-domain-of-interest.adoc @@ -4,7 +4,7 @@ [id="set-domain-of-interest_{context}"] -= Setting your domains of interest += Set your domains of interest [role="_abstract"] With domain filtering, you can customize the content displayed in the *Jobs* and *Templates* sub-sections of Automation Execution. Jobs and templates are linked to descriptive labels. When you select a label, you can filter out less-relevant resources, giving you easy access to the resources relevant to your area of interest. diff --git a/downstream/modules/platform/proc-set-registry-username-password.adoc b/downstream/modules/platform/proc-set-registry-username-password.adoc index 48f713eced..24c6b23077 100644 --- a/downstream/modules/platform/proc-set-registry-username-password.adoc +++ b/downstream/modules/platform/proc-set-registry-username-password.adoc @@ -2,7 +2,7 @@ [id="proc-set-registry-username-password"] -= Setting registry_username and registry_password += Create a registry service account [role="_abstract"] Create a new registry service account on the Red Hat Customer Portal to generate a named token and username. Use these credentials to set the `registry_username` and `registry_password` variables, which are essential for supporting online non-bundled installations in environments where credentials must be shared, such as deployment systems. diff --git a/downstream/modules/platform/proc-set-up-virtual-machines.adoc b/downstream/modules/platform/proc-set-up-virtual-machines.adoc index bf22f31ba9..8dcf2e7638 100644 --- a/downstream/modules/platform/proc-set-up-virtual-machines.adoc +++ b/downstream/modules/platform/proc-set-up-virtual-machines.adoc @@ -2,7 +2,7 @@ [id="proc-set-up-virtual-machines"] -= Setting up Virtual Machines for use in an {AutomationMesh} += Set up VMs for use in mesh [role="_abstract"] Prepare {RHEL} virtual machines by setting up SSH access and enabling repositories. diff --git a/downstream/modules/platform/proc-settings-troubleshooting.adoc b/downstream/modules/platform/proc-settings-troubleshooting.adoc index 03b6b39302..d8e6bba718 100644 --- a/downstream/modules/platform/proc-settings-troubleshooting.adoc +++ b/downstream/modules/platform/proc-settings-troubleshooting.adoc @@ -3,7 +3,7 @@ [id="proc-settings-troubleshooting"] //To be added to Donna's AAP/UI document for 2.5 -= Troubleshooting options += Access troubleshooting information in the UI [role="_abstract"] You can use the *Troubleshooting* page to enable or disable certain flags that aid in debugging issues within {PlatformNameShort}. diff --git a/downstream/modules/platform/proc-setup-ext-db-with-admin-creds.adoc b/downstream/modules/platform/proc-setup-ext-db-with-admin-creds.adoc index 6a87c3bed0..6656680d04 100644 --- a/downstream/modules/platform/proc-setup-ext-db-with-admin-creds.adoc +++ b/downstream/modules/platform/proc-setup-ext-db-with-admin-creds.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="setup-ext-db-with-admin-creds"] -= Setting up an external database with PostgreSQL admin credentials += Set up an external database with PostgreSQL admin credentials [role="_abstract"] If you have PostgreSQL admin credentials, you can supply them in the inventory file and the installation program creates the PostgreSQL users and databases for each component for you. diff --git a/downstream/modules/platform/proc-setup-ext-db-without-admin-creds.adoc b/downstream/modules/platform/proc-setup-ext-db-without-admin-creds.adoc index 6eef822ea3..7a87068cd2 100644 --- a/downstream/modules/platform/proc-setup-ext-db-without-admin-creds.adoc +++ b/downstream/modules/platform/proc-setup-ext-db-without-admin-creds.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="setup-ext-db-without-admin-creds"] -= Setting up an external database without PostgreSQL admin credentials += Set up an external database without PostgreSQL admin credentials [role="_abstract"] If you do not have PostgreSQL admin credentials, then PostgreSQL users and databases need to be created for each component ({Gateway}, {ControllerName}, {HubName}, and {EDAName}) before running the installation program. diff --git a/downstream/modules/platform/proc-setup-postgresql-ext-database.adoc b/downstream/modules/platform/proc-setup-postgresql-ext-database.adoc index 7419235d6b..a163bc5a4f 100644 --- a/downstream/modules/platform/proc-setup-postgresql-ext-database.adoc +++ b/downstream/modules/platform/proc-setup-postgresql-ext-database.adoc @@ -2,7 +2,7 @@ [id="proc-setup-postgresql-ext-database_{context}"] -= Setting up an external database += Set up an external database [role="_abstract"] diff --git a/downstream/modules/platform/proc-synchronizing-rpm-repositories-by-using-reposync.adoc b/downstream/modules/platform/proc-synchronizing-rpm-repositories-by-using-reposync.adoc index 96fe6977f7..0206f460b5 100644 --- a/downstream/modules/platform/proc-synchronizing-rpm-repositories-by-using-reposync.adoc +++ b/downstream/modules/platform/proc-synchronizing-rpm-repositories-by-using-reposync.adoc @@ -5,7 +5,7 @@ [id="proc-synchronizing-rpm-repositories-by-using-reposync_{context}"] -= Synchronizing RPM repositories using reposync += Synchronize the RPM repositories by using reposync [role="_abstract"] To perform a reposync you need a {RHEL} host that has access to the internet. diff --git a/downstream/modules/platform/proc-uninstalling-containerized-aap.adoc b/downstream/modules/platform/proc-uninstalling-containerized-aap.adoc index 6df5cc7c44..73acf3a8a9 100644 --- a/downstream/modules/platform/proc-uninstalling-containerized-aap.adoc +++ b/downstream/modules/platform/proc-uninstalling-containerized-aap.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="uninstalling-containerized-aap"] -= Uninstalling containerized {PlatformNameShort} += Uninstall containerized {PlatformNameShort} [role="_abstract"] Uninstall your {ContainerBase} of {PlatformNameShort}. diff --git a/downstream/modules/platform/proc-update-aap-container.adoc b/downstream/modules/platform/proc-update-aap-container.adoc index 8ed4e2dae6..86f88300c7 100644 --- a/downstream/modules/platform/proc-update-aap-container.adoc +++ b/downstream/modules/platform/proc-update-aap-container.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="updating-containerized-ansible-automation-platform"] -= Upgrading containerized {PlatformNameShort} += Upgrade your containerized deployment of {PlatformNameShort} [role="_abstract"] Perform an upgrade of containerized {PlatformNameShort}. diff --git a/downstream/modules/platform/proc-update-aap-operator-yaml-chatbot.adoc b/downstream/modules/platform/proc-update-aap-operator-yaml-chatbot.adoc index 6b226f73a2..8143be6e14 100644 --- a/downstream/modules/platform/proc-update-aap-operator-yaml-chatbot.adoc +++ b/downstream/modules/platform/proc-update-aap-operator-yaml-chatbot.adoc @@ -2,7 +2,7 @@ [id="proc-update-aap-operator-chatbot"] -= Updating the YAML file of the {PlatformNameShort} operator += Update the YAML file of the {PlatformNameShort} operator [role="_abstract"] diff --git a/downstream/modules/platform/proc-upgrade-controller-hub-eda-unified-services.adoc b/downstream/modules/platform/proc-upgrade-controller-hub-eda-unified-services.adoc index 957b7d3a22..29ce3f2352 100644 --- a/downstream/modules/platform/proc-upgrade-controller-hub-eda-unified-services.adoc +++ b/downstream/modules/platform/proc-upgrade-controller-hub-eda-unified-services.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="upgrade-controller-hub-eda-unified-ui-services_{context}"] -= Using Migration path for 2.4 services with 2.6 services += Use Migration path for 2.4 services with 2.6 services [role="_abstract"] If you installed {PlatformNameShort} {PlatformVers} to use {EDAName} in a supported scenario, you can upgrade your {PlatformNameShort} 2.4 {ControllerName} and {HubName} to {PlatformNameShort} {PlatformVers} by following this procedure. diff --git a/downstream/modules/platform/proc-upgrade-controller-hub-eda-unified-ui.adoc b/downstream/modules/platform/proc-upgrade-controller-hub-eda-unified-ui.adoc index a2fb9889a3..dd92b91389 100644 --- a/downstream/modules/platform/proc-upgrade-controller-hub-eda-unified-ui.adoc +++ b/downstream/modules/platform/proc-upgrade-controller-hub-eda-unified-ui.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="upgrade-controller-hub-eda-unified-ui_{context}"] -= Using migration path for 2.4 instances with managed databases += Use migration path for 2.4 instances with managed databases [role="_abstract"] Migrate {PlatformNameShort} 2.4 instances with managed databases to {PlatformVers} by upgrading {ControllerName} and {HubName} before enabling unified UI and {EDAName}. diff --git a/downstream/modules/platform/proc-use-controller-resource-operator.adoc b/downstream/modules/platform/proc-use-controller-resource-operator.adoc index 957227e451..8651b22053 100644 --- a/downstream/modules/platform/proc-use-controller-resource-operator.adoc +++ b/downstream/modules/platform/proc-use-controller-resource-operator.adoc @@ -2,7 +2,7 @@ [id="proc-use-controller-resource-operator_{context}"] -= Using {OperatorResourceShort} += Use {OperatorResourceShort} [role="_abstract"] diff --git a/downstream/modules/platform/proc-use-custom-ca-certs.adoc b/downstream/modules/platform/proc-use-custom-ca-certs.adoc index 60e3aeb8b0..26fc55362b 100644 --- a/downstream/modules/platform/proc-use-custom-ca-certs.adoc +++ b/downstream/modules/platform/proc-use-custom-ca-certs.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="use-custom-ca-certs"] -= Using a custom CA to generate all TLS certificates += Use a custom CA to generate all TLS certificates [role="_abstract"] Use this method when you want {PlatformNameShort} to generate all of the certificates, but you want them signed by a custom CA rather than the default self-signed certificates. diff --git a/downstream/modules/platform/proc-use-custom-signed-certificates.adoc b/downstream/modules/platform/proc-use-custom-signed-certificates.adoc index 61d9614ddb..a17b6d993a 100644 --- a/downstream/modules/platform/proc-use-custom-signed-certificates.adoc +++ b/downstream/modules/platform/proc-use-custom-signed-certificates.adoc @@ -2,7 +2,7 @@ [id="proc-use-custom-signed-certificates"] -= Using custom signed certificates in managed cloud and operator environments += Use custom signed certificates in managed cloud and operator environments [role="_abstract"] Execution nodes verify incoming connections by ensuring the x509 certificate was issued by a trusted Certificate Authority (CA). diff --git a/downstream/modules/platform/proc-verify-aap-installation.adoc b/downstream/modules/platform/proc-verify-aap-installation.adoc index 9682c1bbda..34ecb51221 100644 --- a/downstream/modules/platform/proc-verify-aap-installation.adoc +++ b/downstream/modules/platform/proc-verify-aap-installation.adoc @@ -2,7 +2,7 @@ [id="proc-verify-aap-installation_{context}"] -= Verifying installation of {PlatformNameShort} += Verify your installation of {PlatformNameShort} [role="_abstract"] Perform the verification step for your {PlatformName} deployment by successfully logging into the platform. A successful login confirms that the installation is complete, ensuring your environment is ready for operational use. diff --git a/downstream/modules/platform/proc-verify-user-migration.adoc b/downstream/modules/platform/proc-verify-user-migration.adoc index bdeb19b977..b79a2943c3 100644 --- a/downstream/modules/platform/proc-verify-user-migration.adoc +++ b/downstream/modules/platform/proc-verify-user-migration.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: PROCEDURE [id="verify-user-migration_{context}"] -= Verifying user migration += Verify user migration [role="_abstract"] During the upgrade to {PlatformNameShort} {PlatformVers}, controller user accounts are converted into platform user accounts. diff --git a/downstream/modules/platform/proc-viewing-operator-logs.adoc b/downstream/modules/platform/proc-viewing-operator-logs.adoc index 9fd3622501..3c8ffaa72b 100644 --- a/downstream/modules/platform/proc-viewing-operator-logs.adoc +++ b/downstream/modules/platform/proc-viewing-operator-logs.adoc @@ -2,7 +2,7 @@ [id="proc-viewing-operator-logs_{context}"] -= Viewing operator logs += View operator logs [role="_abstract"] diff --git a/downstream/modules/platform/ref-adding-execution-nodes.adoc b/downstream/modules/platform/ref-adding-execution-nodes.adoc index d976c8c8e3..c7e2573d7e 100644 --- a/downstream/modules/platform/ref-adding-execution-nodes.adoc +++ b/downstream/modules/platform/ref-adding-execution-nodes.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: REFERENCE [id="adding-execution-nodes"] -= Adding execution nodes += Add execution nodes [role="_abstract"] Containerized {PlatformNameShort} can deploy remote execution nodes. diff --git a/downstream/modules/platform/ref-assign-pods-to-nodes.adoc b/downstream/modules/platform/ref-assign-pods-to-nodes.adoc index fc220692e3..35d80d510f 100644 --- a/downstream/modules/platform/ref-assign-pods-to-nodes.adoc +++ b/downstream/modules/platform/ref-assign-pods-to-nodes.adoc @@ -2,7 +2,7 @@ [id="ref-assign-pods-to-nodes_{context}"] -= Assigning pods to specific nodes += Assign pods to specific nodes [role="_abstract"] You can constrain the {ControllerName} pods created by the operator to run on a certain subset of nodes. diff --git a/downstream/modules/platform/ref-automation-mesh-proxy.adoc b/downstream/modules/platform/ref-automation-mesh-proxy.adoc index 9ba5994b23..02ca056f2d 100644 --- a/downstream/modules/platform/ref-automation-mesh-proxy.adoc +++ b/downstream/modules/platform/ref-automation-mesh-proxy.adoc @@ -2,7 +2,7 @@ [id="ref-automation-mesh-proxy"] -= Configuring proxy settings for {AutomationMesh} += Configure proxy settings for automation mesh [role="_abstract"] You can route outbound communication from the receptor on an {AutomationMesh} node through a proxy server. diff --git a/downstream/modules/platform/ref-ccsp.adoc b/downstream/modules/platform/ref-ccsp.adoc index 1835b2b33b..3292b7e8d1 100644 --- a/downstream/modules/platform/ref-ccsp.adoc +++ b/downstream/modules/platform/ref-ccsp.adoc @@ -2,7 +2,7 @@ [id="ref-ccsp"] -= CCSP += Original Certified Cloud and Service Provider (CCSP) report [role="_abstract"] `CCSP` is the original report format. It does not include many of the customization of CCSPv2, and the intention is only to use it for the CCSP partner program. diff --git a/downstream/modules/platform/ref-configuring-inventory-file.adoc b/downstream/modules/platform/ref-configuring-inventory-file.adoc index 5abddc6565..62b397e8e9 100644 --- a/downstream/modules/platform/ref-configuring-inventory-file.adoc +++ b/downstream/modules/platform/ref-configuring-inventory-file.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: REFERENCE [id="configuring-inventory-file"] -= Configuring the inventory file += Configure the inventory file [role="_abstract"] You can control the installation of {PlatformNameShort} with inventory files. Inventory files define the host details, certificate details, and component-specific settings needed to customize the installation. diff --git a/downstream/modules/platform/ref-containerized-troubleshoot-config.adoc b/downstream/modules/platform/ref-containerized-troubleshoot-config.adoc index 1ce1fc919b..a130937ae3 100644 --- a/downstream/modules/platform/ref-containerized-troubleshoot-config.adoc +++ b/downstream/modules/platform/ref-containerized-troubleshoot-config.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: REFERENCE [id="troubleshooting-containerized-ansible-automation-platform-configuration"] -= Troubleshooting containerized {PlatformNameShort} configuration += Troubleshoot your containerized configuration [role="_abstract"] Use this information to troubleshoot your containerized {PlatformNameShort} configuration. diff --git a/downstream/modules/platform/ref-containerized-troubleshoot-diagnosing.adoc b/downstream/modules/platform/ref-containerized-troubleshoot-diagnosing.adoc index 214c9568a1..5e76857dc6 100644 --- a/downstream/modules/platform/ref-containerized-troubleshoot-diagnosing.adoc +++ b/downstream/modules/platform/ref-containerized-troubleshoot-diagnosing.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: REFERENCE [id="diagnosing-the-problem"] -= Diagnosing the problem += Diagnose the problem [role="_abstract"] For general container-based troubleshooting, you can inspect the container logs for any running service to help troubleshoot underlying issues. diff --git a/downstream/modules/platform/ref-containerized-troubleshoot-install.adoc b/downstream/modules/platform/ref-containerized-troubleshoot-install.adoc index 15a5ddc17c..0db1da124d 100644 --- a/downstream/modules/platform/ref-containerized-troubleshoot-install.adoc +++ b/downstream/modules/platform/ref-containerized-troubleshoot-install.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: REFERENCE [id="troubleshooting-containerized-ansible-automation-platform-installation"] -= Troubleshooting containerized {PlatformNameShort} installation += Troubleshoot your containerized installation [role="_abstract"] Use this information to troubleshoot your containerized installation of {PlatformNameShort}. diff --git a/downstream/modules/platform/ref-containerized-troubleshoot-ref.adoc b/downstream/modules/platform/ref-containerized-troubleshoot-ref.adoc index 5788624d4c..2d5a629c8a 100644 --- a/downstream/modules/platform/ref-containerized-troubleshoot-ref.adoc +++ b/downstream/modules/platform/ref-containerized-troubleshoot-ref.adoc @@ -2,7 +2,7 @@ [id="containerized-ansible-automation-platform-reference"] -= Containerized {PlatformNameShort} reference += Understand the architecture of your containerized deployment [role="_abstract"] Use this information to understand the architecture for your containerized {PlatformNameShort} deployment. diff --git a/downstream/modules/platform/ref-controller-access-azure-resources-in-playbook.adoc b/downstream/modules/platform/ref-controller-access-azure-resources-in-playbook.adoc index a456ea9073..e2a84466ed 100644 --- a/downstream/modules/platform/ref-controller-access-azure-resources-in-playbook.adoc +++ b/downstream/modules/platform/ref-controller-access-azure-resources-in-playbook.adoc @@ -2,7 +2,7 @@ [id="ref-controller-access-azure-resources-in-playbook"] -= Access {Azure} resource manager credentials in an ansible playbook += Access {Azure} Resource Manager credentials in an Ansible Playbook [role="_abstract"] You can get {Azure} credential parameters from a job runtime environment. diff --git a/downstream/modules/platform/ref-controller-access-network-creds-playbook.adoc b/downstream/modules/platform/ref-controller-access-network-creds-playbook.adoc index 51efdee585..cd329fcde0 100644 --- a/downstream/modules/platform/ref-controller-access-network-creds-playbook.adoc +++ b/downstream/modules/platform/ref-controller-access-network-creds-playbook.adoc @@ -2,7 +2,7 @@ [id="ref-controller-access-network-creds-playbook"] -= Access network credentials in an ansible playbook += Access network credentials in an Ansible Playbook [role="_abstract"] When using the *Controller Access Network Credentials* credential type, you can access the username and password parameters in your Ansible Playbook by using the following environment variables: diff --git a/downstream/modules/platform/ref-controller-additional-build-steps.adoc b/downstream/modules/platform/ref-controller-additional-build-steps.adoc index 5b3ea78f30..26e2725de0 100644 --- a/downstream/modules/platform/ref-controller-additional-build-steps.adoc +++ b/downstream/modules/platform/ref-controller-additional-build-steps.adoc @@ -2,7 +2,7 @@ [id="ref-controller-additional-build-steps"] -= additional_build_steps += Additional_build_steps [role="_abstract"] The build steps specify custom build commands for any build phase. diff --git a/downstream/modules/platform/ref-controller-api-config-settings.adoc b/downstream/modules/platform/ref-controller-api-config-settings.adoc index c32b252421..9b5f97b91e 100644 --- a/downstream/modules/platform/ref-controller-api-config-settings.adoc +++ b/downstream/modules/platform/ref-controller-api-config-settings.adoc @@ -2,7 +2,7 @@ [id="controller-api-config-settings"] -= Configuration settings += API configuration values [role="_abstract"] There are two named-URL-related configuration settings available under `/api/controller/v2/settings/named-url/: NAMED_URL_FORMATS` and `NAMED_URL_GRAPH_NODES`. diff --git a/downstream/modules/platform/ref-controller-applications-getting-started.adoc b/downstream/modules/platform/ref-controller-applications-getting-started.adoc index 71d2420d06..83825c1b86 100644 --- a/downstream/modules/platform/ref-controller-applications-getting-started.adoc +++ b/downstream/modules/platform/ref-controller-applications-getting-started.adoc @@ -2,7 +2,7 @@ [id="ref-controller-applications-getting-started"] -= Getting started with OAuth Applications += Get started with OAuth Applications [role="_abstract"] You can access the *OAuth Applications* page from the navigation panel by selecting {MenuAMAdminOauthApps}. From there you can view, create, sort and search for applications currently managed by {PlatformNameShort} and {ControllerName}. diff --git a/downstream/modules/platform/ref-controller-approval-nodes.adoc b/downstream/modules/platform/ref-controller-approval-nodes.adoc index 2b3df54da7..21aea87b29 100644 --- a/downstream/modules/platform/ref-controller-approval-nodes.adoc +++ b/downstream/modules/platform/ref-controller-approval-nodes.adoc @@ -2,7 +2,7 @@ [id="controller-approval-nodes"] -= Approval nodes += Configure nodes in workflow visualizer [role="_abstract"] Choosing an *Approval* node requires your intervention to advance a workflow. diff --git a/downstream/modules/platform/ref-controller-autoscaling.adoc b/downstream/modules/platform/ref-controller-autoscaling.adoc index 95079402a1..c9a286ab6c 100644 --- a/downstream/modules/platform/ref-controller-autoscaling.adoc +++ b/downstream/modules/platform/ref-controller-autoscaling.adoc @@ -2,7 +2,7 @@ [id="ref-controller-autoscaling"] -= Autoscaling += Autoscale [role="_abstract"] Use the "callback" feature to permit newly booting instances to request configuration for auto-scaling scenarios or provisioning integration. \ No newline at end of file diff --git a/downstream/modules/platform/ref-controller-backup-restore-clustered-environments.adoc b/downstream/modules/platform/ref-controller-backup-restore-clustered-environments.adoc index 01bdf512f3..fa2eefb381 100644 --- a/downstream/modules/platform/ref-controller-backup-restore-clustered-environments.adoc +++ b/downstream/modules/platform/ref-controller-backup-restore-clustered-environments.adoc @@ -2,7 +2,7 @@ [id="controller-backup-restore-clustered-environments"] -= Backup and restore clustered environments += Backup and restore in clustered environments [role="_abstract"] Learn how to back up and restore {ControllerName} in a clustered environment. diff --git a/downstream/modules/platform/ref-controller-backup-restore-considerations.adoc b/downstream/modules/platform/ref-controller-backup-restore-considerations.adoc index 7c0d6434c9..f4436eabe9 100644 --- a/downstream/modules/platform/ref-controller-backup-restore-considerations.adoc +++ b/downstream/modules/platform/ref-controller-backup-restore-considerations.adoc @@ -2,7 +2,7 @@ [id="controller-backup-restore-considerations"] -= Backup and restoration considerations += Considerations for backup and restore [role="_abstract"] Consider the following points when you backup and restore your system: diff --git a/downstream/modules/platform/ref-controller-capacity-planning.adoc b/downstream/modules/platform/ref-controller-capacity-planning.adoc index 4de87335f4..cfdeb31c15 100644 --- a/downstream/modules/platform/ref-controller-capacity-planning.adoc +++ b/downstream/modules/platform/ref-controller-capacity-planning.adoc @@ -2,7 +2,7 @@ [id="ref-controller-capacity-planning"] -= Capacity planning for deploying {ControllerName} += Capacity plan for node types and workload characteristics [role="_abstract"] Capacity planning for {ControllerName} is planning the scale and characteristics of your deployment so that it has the capacity to run the planned workload. Capacity planning includes the following phases: diff --git a/downstream/modules/platform/ref-controller-config-options.adoc b/downstream/modules/platform/ref-controller-config-options.adoc index 65ba6f82d9..ec8ca9ff6b 100644 --- a/downstream/modules/platform/ref-controller-config-options.adoc +++ b/downstream/modules/platform/ref-controller-config-options.adoc @@ -2,7 +2,7 @@ [id="ref-controller-config-options"] -= options += Options [role="_abstract"] A dictionary of keywords or options that can affect the runtime functionality {Builder}. diff --git a/downstream/modules/platform/ref-controller-config-version.adoc b/downstream/modules/platform/ref-controller-config-version.adoc index 6487952ed0..bb7c93aa6a 100644 --- a/downstream/modules/platform/ref-controller-config-version.adoc +++ b/downstream/modules/platform/ref-controller-config-version.adoc @@ -2,7 +2,7 @@ [id="ref-controller-config-version"] -= version += Version [role="_abstract"] An integer value that sets the schema version of the {ExecEnvShort} definition file. diff --git a/downstream/modules/platform/ref-controller-connection-security.adoc b/downstream/modules/platform/ref-controller-connection-security.adoc index e9ce5002ea..797510985d 100644 --- a/downstream/modules/platform/ref-controller-connection-security.adoc +++ b/downstream/modules/platform/ref-controller-connection-security.adoc @@ -2,7 +2,7 @@ [id="ref-controller-connection-security"] -= Connection security += Internal, external, and managed node connections [role="_abstract"] {ControllerNameStart} allows for connections to internal services, external access, and managed nodes. @@ -17,3 +17,31 @@ You must have 'local' user access for the following users: * receptor * nginx ==== + +== Internal services + +{ControllerNameStart} connects to the following services as part of internal operation: + +PostgreSQL database:: +The connection to the PostgreSQL database is done by password authentication over TCP, either through localhost or remotely (external database). +This connection can use PostgreSQL's built-in support for SSL/TLS, as natively configured by the {Installer} support. +SSL/TLS protocols are configured by the default OpenSSL configuration. + +A Redis key or value store:: +The connection to Redis is over a local UNIX socket, restricted to the awx service user. + +== External access + +{ControllerNameStart} is accessed using standard HTTP/HTTPS on standard ports, provided by Nginx. +A self-signed certificate or key is installed by default; you can provide a locally appropriate certificate and key. + +SSL/TLS algorithm support is configured in the `/etc/nginx/nginx.conf` configuration file. +An "intermediate" profile is used by default, that you can configure. +You must reapply changes after each update. + +== Managed nodes + +{ControllerNameStart} connects to managed machines and services as part of automation. +All connections to managed machines are done by standard secure mechanisms, such as SSH, WinRM, or SSL/TLS. + +Each of these inherits configuration from the system configuration for the feature in question, such as the system OpenSSL configuration. diff --git a/downstream/modules/platform/ref-controller-credential-galaxy-hub.adoc b/downstream/modules/platform/ref-controller-credential-galaxy-hub.adoc index 5d643e5db2..200d7d405a 100644 --- a/downstream/modules/platform/ref-controller-credential-galaxy-hub.adoc +++ b/downstream/modules/platform/ref-controller-credential-galaxy-hub.adoc @@ -2,7 +2,7 @@ [id="ref-controller-credential-galaxy-hub"] -= {Galaxy}/{HubName} API token credential type += {Galaxy} or {HubName} API token credential type [role="_abstract"] You can create a {Galaxy} or {PrivateHubName} API token credential in {ControllerName} to access collections published on {Galaxy} or an instance of {PrivateHubName}. diff --git a/downstream/modules/platform/ref-controller-credential-machine.adoc b/downstream/modules/platform/ref-controller-credential-machine.adoc index efc1b280d7..b2cd873bb8 100644 --- a/downstream/modules/platform/ref-controller-credential-machine.adoc +++ b/downstream/modules/platform/ref-controller-credential-machine.adoc @@ -50,12 +50,13 @@ For more information, see Centrify's link:https://docs.delinea.com/online-help/s ** *machinectl*: Enables you to manage containers through the `systemd` machine manager. ** *sesu*: Enables your remote/login user to run commands as another user through the CA Privileged Access Manager. -[NOTE] -==== -Custom `become` plugins are available from Ansible 2.8+. +//Removing this note at AAP-63419 as Ansible 2.8 is ancient +//[NOTE] +//==== +//Custom `become` plugins are available from Ansible 2.8+. //Commenting out as no downstream alternative [AAP-57435] //For more information, see link:https://docs.ansible.com/projects/ansible/latest/playbook_guide/playbooks_privilege_escalation.html[Understanding Privilege Escalation] and the list of link:https://docs.ansible.com/projects/ansible/latest/plugins/become.html#plugin-list[Become plugins] -==== +//==== * *Privilege Escalation Username*: You see this field only if you selected an option for privilege escalation. Enter the username to use with escalation privileges on the remote system. * *Privilege Escalation Password*: You see this field only if you selected an option for privilege escalation. diff --git a/downstream/modules/platform/ref-controller-data-collection-details.adoc b/downstream/modules/platform/ref-controller-data-collection-details.adoc index 282d64e2de..f327c383cf 100644 --- a/downstream/modules/platform/ref-controller-data-collection-details.adoc +++ b/downstream/modules/platform/ref-controller-data-collection-details.adoc @@ -2,7 +2,7 @@ [id="ref-controller-data-collection-details"] -= Details of data collection += Details about data collected for {Analytics} [role="_abstract"] Learn about the specific data that {ControllerName} collects and sends to Red Hat when you enable {Analytics}. diff --git a/downstream/modules/platform/ref-controller-database-settings.adoc b/downstream/modules/platform/ref-controller-database-settings.adoc index 4094dcaecc..fdaa0a7e90 100644 --- a/downstream/modules/platform/ref-controller-database-settings.adoc +++ b/downstream/modules/platform/ref-controller-database-settings.adoc @@ -2,7 +2,7 @@ [id="ref-controller-database-settings"] -= PostgreSQL database configuration and maintenance for {ControllerName} += Tune the PostgreSQL database for optimal performance [role="_abstract"] Improve the performance of {ControllerName}, by configuring the following configuration parameters in the database: diff --git a/downstream/modules/platform/ref-controller-images.adoc b/downstream/modules/platform/ref-controller-images.adoc index 7d3fa039ab..110bd4d38d 100644 --- a/downstream/modules/platform/ref-controller-images.adoc +++ b/downstream/modules/platform/ref-controller-images.adoc @@ -2,7 +2,7 @@ [id="ref-controller-images"] -= images += Images [role="_abstract"] This section describes the structure and valid keys for defining container images used by {ExecEnvShort}. diff --git a/downstream/modules/platform/ref-controller-instance-group-capacity.adoc b/downstream/modules/platform/ref-controller-instance-group-capacity.adoc index 01d28ffafa..29c70578d6 100644 --- a/downstream/modules/platform/ref-controller-instance-group-capacity.adoc +++ b/downstream/modules/platform/ref-controller-instance-group-capacity.adoc @@ -2,7 +2,7 @@ [id="controller-instance-group-capacity"] -= Instance group capacity limits += Capacity limits for instance groups [role="_abstract"] There is external business logic that can drive the need to limit the concurrency of jobs sent to an instance group, or the maximum number of forks to be consumed. diff --git a/downstream/modules/platform/ref-controller-instance-group-policies.adoc b/downstream/modules/platform/ref-controller-instance-group-policies.adoc index 3592ea89c9..0f58b2f66f 100644 --- a/downstream/modules/platform/ref-controller-instance-group-policies.adoc +++ b/downstream/modules/platform/ref-controller-instance-group-policies.adoc @@ -2,7 +2,7 @@ [id="controller-instance-group-policies"] -= Instance group policies += Define instance groups in the inventory file [role="_abstract"] You can configure {ControllerName} instances to automatically join instance groups when they come online by defining a policy. diff --git a/downstream/modules/platform/ref-controller-internal-cluster-routing.adoc b/downstream/modules/platform/ref-controller-internal-cluster-routing.adoc index e5eda0b470..818e5a2882 100644 --- a/downstream/modules/platform/ref-controller-internal-cluster-routing.adoc +++ b/downstream/modules/platform/ref-controller-internal-cluster-routing.adoc @@ -2,7 +2,7 @@ [id="ref-controller-internal-cluster-routing"] -= Internal Cluster Routing += VM installation settings for internal cluster routing [role="_abstract"] {ControllerNameStart} cluster hosts communicate across the network within the cluster. In the inventory file for the traditional VM installer, you can indicate several routes to the cluster nodes that are used in different ways: diff --git a/downstream/modules/platform/ref-controller-inv-variable-management.adoc b/downstream/modules/platform/ref-controller-inv-variable-management.adoc index 63e955ec45..b83ccf9521 100644 --- a/downstream/modules/platform/ref-controller-inv-variable-management.adoc +++ b/downstream/modules/platform/ref-controller-inv-variable-management.adoc @@ -2,7 +2,7 @@ [id="ref-controller-inv-variable-management"] -= Variable Management for Inventory += Variable management for inventory [role="_abstract"] Variables associated with hosts and groups in an inventory can be managed in several ways in {ControllerName}. diff --git a/downstream/modules/platform/ref-controller-inventory-plugins.adoc b/downstream/modules/platform/ref-controller-inventory-plugins.adoc index 124f77c243..8ddae8056c 100644 --- a/downstream/modules/platform/ref-controller-inventory-plugins.adoc +++ b/downstream/modules/platform/ref-controller-inventory-plugins.adoc @@ -2,7 +2,7 @@ [id="ref-controller-inventory-plugins"] -= Inventory Plugins += Generate dynamic data from external sources with inventory plugins [role="_abstract"] {ControllerNameStart} uses inventory plugins to dynamically generate inventory data from external sources. @@ -31,5 +31,6 @@ format. For more information about sources and their templates, see xref:controller-inventory-templates[Supported inventory plugin templates]. -`source_vars` that contain `plugin: foo.bar.baz` as a top-level key are replaced with the fully-qualified inventory plugin name at runtime based on the `InventorySource` source. -For example, if you select ec2 for the `InventorySource` then, at run time, plugin is set to `amazon.aws.aws_ec2`. +`source_vars` that contain `plugin: xxx.yyy.zzz` as a top-level key are replaced with the fully-qualified inventory plugin name at runtime based on the `InventorySource` source. + +For example, if you select `ec2` for the `InventorySource` then, at run time, the plugin is set to `amazon.aws.aws_ec2`. diff --git a/downstream/modules/platform/ref-controller-inventory-sources.adoc b/downstream/modules/platform/ref-controller-inventory-sources.adoc index 7c5774aea0..d98b03a503 100644 --- a/downstream/modules/platform/ref-controller-inventory-sources.adoc +++ b/downstream/modules/platform/ref-controller-inventory-sources.adoc @@ -14,7 +14,7 @@ Choose a source which matches the inventory type against which a host can be ent * xref:proc-controller-inv-source-vm-vcenter[VMware vCenter] * xref:proc-controller-inv-source-vm-esxi[VMware ESXi] * xref:proc-controller-inv-source-satellite[Red Hat Satellite 6] -* xref:proc-controller-inv-source-insights[{RHLightspeed}] +* xref:proc-controller-inv-source-rhlightspeed[{RHLightspeed}] * xref:proc-controller-inv-source-openstack[OpenStack] * xref:proc-controller-inv-source-rh-virt[Red Hat Virtualization] * xref:proc-controller-inv-source-aap[{PlatformName}] diff --git a/downstream/modules/platform/ref-controller-job-template-variables.adoc b/downstream/modules/platform/ref-controller-job-template-variables.adoc index 169fdc0bb2..e7d1ecdeaf 100644 --- a/downstream/modules/platform/ref-controller-job-template-variables.adoc +++ b/downstream/modules/platform/ref-controller-job-template-variables.adoc @@ -2,7 +2,7 @@ [id="controller-job-template-variables"] -= Variables in job templates += Set extra variables in job templates [role="_abstract"] Along with any extra variables set in the job template and survey, {ControllerName} automatically adds the following variables to the job environment. diff --git a/downstream/modules/platform/ref-controller-large-host-counts.adoc b/downstream/modules/platform/ref-controller-large-host-counts.adoc index 81302d33e8..b37d073050 100644 --- a/downstream/modules/platform/ref-controller-large-host-counts.adoc +++ b/downstream/modules/platform/ref-controller-large-host-counts.adoc @@ -2,7 +2,7 @@ [id="ref-controller-large-host-counts"] -= Larger Host Counts += Larger host counts [role="_abstract"] Set "forks" on a job template to larger values to increase parallelism of execution runs. diff --git a/downstream/modules/platform/ref-controller-log-aggregators.adoc b/downstream/modules/platform/ref-controller-log-aggregators.adoc index efe90ed5fe..69a3b224b3 100644 --- a/downstream/modules/platform/ref-controller-log-aggregators.adoc +++ b/downstream/modules/platform/ref-controller-log-aggregators.adoc @@ -2,7 +2,7 @@ [id="ref-controller-log-aggregators"] -= Logging aggregator services += Configure third-party services [role="_abstract"] The logging aggregator service works with the following monitoring and data analysis systems: diff --git a/downstream/modules/platform/ref-controller-log-files-containerized.adoc b/downstream/modules/platform/ref-controller-log-files-containerized.adoc index 7090dcb722..647d8afb35 100644 --- a/downstream/modules/platform/ref-controller-log-files-containerized.adoc +++ b/downstream/modules/platform/ref-controller-log-files-containerized.adoc @@ -2,7 +2,7 @@ [id="ref-controller-log-files-containerized"] -= Accessing {ControllerName} logs for containerized {PlatformNameShort} += Access {ControllerName} logs for containerized {PlatformNameShort} [role="_abstract"] Logs for containerized {PlatformNameShort} are not saved to specific files. The application logs are sent to the container `stdout` and handled by Podman with `journald`. diff --git a/downstream/modules/platform/ref-controller-log-files.adoc b/downstream/modules/platform/ref-controller-log-files.adoc index ec59134deb..29ffe2da48 100644 --- a/downstream/modules/platform/ref-controller-log-files.adoc +++ b/downstream/modules/platform/ref-controller-log-files.adoc @@ -2,7 +2,7 @@ [id="ref-controller-log-files"] -= Accessing {ControllerName} logs for RPM-based {PlatformNameShort} += Access {ControllerName} logs for RPM-based {PlatformNameShort} [role="_abstract"] {ControllerNameStart} logfiles can be accessed from two centralized locations: diff --git a/downstream/modules/platform/ref-controller-loggers.adoc b/downstream/modules/platform/ref-controller-loggers.adoc index c85e31affd..6b5982800d 100644 --- a/downstream/modules/platform/ref-controller-loggers.adoc +++ b/downstream/modules/platform/ref-controller-loggers.adoc @@ -2,7 +2,7 @@ [id="ref-controller-loggers"] -= Loggers += Configure logging components [role="_abstract"] {ControllerNameStart} provides several loggers that can be configured to deliver structured log data for analysis and monitoring. diff --git a/downstream/modules/platform/ref-controller-performance-troubleshooting.adoc b/downstream/modules/platform/ref-controller-performance-troubleshooting.adoc index 011ca12137..8e4b3aec49 100644 --- a/downstream/modules/platform/ref-controller-performance-troubleshooting.adoc +++ b/downstream/modules/platform/ref-controller-performance-troubleshooting.adoc @@ -2,7 +2,7 @@ [id="ref-controller-performance-troubleshooting"] -= Performance troubleshooting for {ControllerName} += Troubleshoot common performance issues [role="_abstract"] This provides guidance on troubleshooting common performance issues with {ControllerName}. diff --git a/downstream/modules/platform/ref-controller-policy-considerations.adoc b/downstream/modules/platform/ref-controller-policy-considerations.adoc index c3d979f66e..06058b2da9 100644 --- a/downstream/modules/platform/ref-controller-policy-considerations.adoc +++ b/downstream/modules/platform/ref-controller-policy-considerations.adoc @@ -2,7 +2,7 @@ [id="controller-policy-considerations"] -= Notable policy considerations += Configure instance groups from the API [role="_abstract"] Take the following policy considerations into account: diff --git a/downstream/modules/platform/ref-controller-proj-sign-prerequisites.adoc b/downstream/modules/platform/ref-controller-proj-sign-prerequisites.adoc index 1aeb35a423..239064e313 100644 --- a/downstream/modules/platform/ref-controller-proj-sign-prerequisites.adoc +++ b/downstream/modules/platform/ref-controller-proj-sign-prerequisites.adoc @@ -2,7 +2,7 @@ [id="ref-controller-proj-sign-prerequisites"] -= Controller project sign prerequisites += Sign content in automation projects [role="_abstract"] Prepare your {RHEL} systems by enabling the correct repositories and subscriptions needed to install components for project signing. diff --git a/downstream/modules/platform/ref-controller-reuse-external-database-fail.adoc b/downstream/modules/platform/ref-controller-reuse-external-database-fail.adoc index ba60356cdf..d829134262 100644 --- a/downstream/modules/platform/ref-controller-reuse-external-database-fail.adoc +++ b/downstream/modules/platform/ref-controller-reuse-external-database-fail.adoc @@ -2,7 +2,7 @@ [id="controller-reuse-external-database-fail"] -= Reusing an external database causes installations to fail += Prevent installation failures when reusing an external database [role="_abstract"] When reusing an external database for clustered installations, you must manually clear the database before performing subsequent installations. diff --git a/downstream/modules/platform/ref-controller-scm-inv-source-fields.adoc b/downstream/modules/platform/ref-controller-scm-inv-source-fields.adoc index 7516213459..baf04fd332 100644 --- a/downstream/modules/platform/ref-controller-scm-inv-source-fields.adoc +++ b/downstream/modules/platform/ref-controller-scm-inv-source-fields.adoc @@ -2,7 +2,7 @@ [id="ref-controller-scm-inv-source-fields"] -= Source control management inventory source fields += Inventory file fields for source control [role="_abstract"] You can use a source control management (SCM) system, such as Git, to manage your inventory files in {ControllerName}. diff --git a/downstream/modules/platform/ref-controller-settings-control-execution-nodes.adoc b/downstream/modules/platform/ref-controller-settings-control-execution-nodes.adoc index bc28ae3d5f..7d1234fa4f 100644 --- a/downstream/modules/platform/ref-controller-settings-control-execution-nodes.adoc +++ b/downstream/modules/platform/ref-controller-settings-control-execution-nodes.adoc @@ -2,7 +2,7 @@ [id="ref-controller-settings-control-execution-nodes"] -= Capacity settings for control and execution nodes += Capacity settings for each node type [role="_abstract"] Configure capacity settings for control and execution nodes to manage resource allocation effectively. diff --git a/downstream/modules/platform/ref-controller-settings-scheduling-jobs.adoc b/downstream/modules/platform/ref-controller-settings-scheduling-jobs.adoc index cd32953637..e5dbfbdb99 100644 --- a/downstream/modules/platform/ref-controller-settings-scheduling-jobs.adoc +++ b/downstream/modules/platform/ref-controller-settings-scheduling-jobs.adoc @@ -2,7 +2,7 @@ [id="ref-controller-settings-scheduling-jobs"] -= Settings for scheduling jobs += Adjust settings for scheduling jobs [role="_abstract"] The controller uses a task manager to schedule jobs onto instances. diff --git a/downstream/modules/platform/ref-controller-token-session-management.adoc b/downstream/modules/platform/ref-controller-token-session-management.adoc index e0f186e6f4..40d52310a8 100644 --- a/downstream/modules/platform/ref-controller-token-session-management.adoc +++ b/downstream/modules/platform/ref-controller-token-session-management.adoc @@ -2,7 +2,7 @@ [id="ref-controller-token-session-management"] -= Token and session management += Create, revoke, or clear tokens [role="_abstract"] {PlatformNameShort} supports the following commands for OAuth2 token management: diff --git a/downstream/modules/platform/ref-controller-troubleshoot-logging.adoc b/downstream/modules/platform/ref-controller-troubleshoot-logging.adoc index bb77a311d7..2e97e12f03 100644 --- a/downstream/modules/platform/ref-controller-troubleshoot-logging.adoc +++ b/downstream/modules/platform/ref-controller-troubleshoot-logging.adoc @@ -2,7 +2,7 @@ [id="ref-controller-troubleshoot-logging"] -= Troubleshooting logging += Troubleshoot logging [role="_abstract"] This section provides information to help troubleshoot logging issues in {ControllerName}. diff --git a/downstream/modules/platform/ref-controller-use-dynamic-inv-sources.adoc b/downstream/modules/platform/ref-controller-use-dynamic-inv-sources.adoc index bc1310c84b..37d2a618bb 100644 --- a/downstream/modules/platform/ref-controller-use-dynamic-inv-sources.adoc +++ b/downstream/modules/platform/ref-controller-use-dynamic-inv-sources.adoc @@ -2,7 +2,7 @@ [id="ref-controller-use-dynamic-inv-sources"] -= Use Dynamic Inventory Sources += Use dynamic inventory sources [role="_abstract"] Define an inventory synchronization process by using dynamic sources, such as a cloud provider or CMDB, to help ensure your infrastructure inventory in {ControllerName} stays consistently up-to-date. diff --git a/downstream/modules/platform/ref-controller-vmware-esxi.adoc b/downstream/modules/platform/ref-controller-vmware-esxi.adoc index fae0974bc7..8054668999 100644 --- a/downstream/modules/platform/ref-controller-vmware-esxi.adoc +++ b/downstream/modules/platform/ref-controller-vmware-esxi.adoc @@ -2,10 +2,10 @@ [id="ref-controller-vmware-esxi"] -= VMWare ESXI += VMWare ESXi [role="_abstract"] -This example inventory configuration file demonstrates how to use the `vmware.vmware.vms` inventory plugin to gather virtual machine information from a VMWare ESXI host. +This example inventory configuration file demonstrates how to use the `vmware.vmware.vms` inventory plugin to gather virtual machine information from a VMWare ESXi host. [literal, options="nowrap" subs="+attributes"] ---- diff --git a/downstream/modules/platform/ref-controller-vmware-vcenter.adoc b/downstream/modules/platform/ref-controller-vmware-vcenter.adoc index 09fb4a1ad4..6eda57092f 100644 --- a/downstream/modules/platform/ref-controller-vmware-vcenter.adoc +++ b/downstream/modules/platform/ref-controller-vmware-vcenter.adoc @@ -5,7 +5,7 @@ = VMware vCenter [role="_abstract"] -This section describes how to configure and use VMware vCenter as a platform for hosting {ControllerName} virtual machines (VMs). +Configure and use VMware vCenter as a platform for hosting {ControllerName} virtual machines (VMs). [literal, options="nowrap" subs="+attributes"] ---- diff --git a/downstream/modules/platform/ref-controller-web-service-tuning.adoc b/downstream/modules/platform/ref-controller-web-service-tuning.adoc index bcfbb22f76..db3d1aeaa5 100644 --- a/downstream/modules/platform/ref-controller-web-service-tuning.adoc +++ b/downstream/modules/platform/ref-controller-web-service-tuning.adoc @@ -2,7 +2,7 @@ [id="ref-controller-web-service-tuning"] -= Web server tuning += Tune the web server [role="_abstract"] The Control and Hybrid nodes each serve the UI and API of {ControllerName}. WSGI traffic is served by the uwsgi web server on a local socket. ASGI traffic is served by Daphne. NGINX listens on port 443 and proxies traffic as needed. diff --git a/downstream/modules/platform/ref-deduplication-hosts-metrics-utility.adoc b/downstream/modules/platform/ref-deduplication-hosts-metrics-utility.adoc index 047aaa7f8c..755227829c 100644 --- a/downstream/modules/platform/ref-deduplication-hosts-metrics-utility.adoc +++ b/downstream/modules/platform/ref-deduplication-hosts-metrics-utility.adoc @@ -2,7 +2,7 @@ [id="ref-deduplication-hosts-metrics-utility"] -= Deduplication of hosts for `metrics-utility` reports += How to deduplicate host data in reports [role="_abstract"] Deduplication changes how `metrics-utility` merges individual host records into countable managed nodes when building reports. Deduplication identifies identical hosts to ensure an accurate count of unique hosts. diff --git a/downstream/modules/platform/ref-eda-system-requirements.adoc b/downstream/modules/platform/ref-eda-system-requirements.adoc index a007befa04..b7a21bca31 100644 --- a/downstream/modules/platform/ref-eda-system-requirements.adoc +++ b/downstream/modules/platform/ref-eda-system-requirements.adoc @@ -2,7 +2,7 @@ [id="event-driven-ansible-system-requirements"] -= {EDAcontroller} system requirements += {EDAName} system requirements [role="_abstract"] The {EDAcontroller} is a single-node system capable of handling a variable number of long-running processes (such as rulebook activations) on-demand, depending on the number of CPU cores. diff --git a/downstream/modules/platform/ref-edge-manager-device-lifecycle.adoc b/downstream/modules/platform/ref-edge-manager-device-lifecycle.adoc index 0b9723f604..7511b8bd36 100644 --- a/downstream/modules/platform/ref-edge-manager-device-lifecycle.adoc +++ b/downstream/modules/platform/ref-edge-manager-device-lifecycle.adoc @@ -2,7 +2,7 @@ [id="edge-manager-device-lifecycle"] -= Use device lifecycle hooks += Run user-defined commands with device lifecycle hooks [role="_abstract"] diff --git a/downstream/modules/platform/ref-edge-manager-field-selectors.adoc b/downstream/modules/platform/ref-edge-manager-field-selectors.adoc index fd5161e13d..78665ca47a 100644 --- a/downstream/modules/platform/ref-edge-manager-field-selectors.adoc +++ b/downstream/modules/platform/ref-edge-manager-field-selectors.adoc @@ -2,7 +2,7 @@ [id="edge-manager-field-selectors"] -= Field selectors += Filter a list with field selectors [role="_abstract"] diff --git a/downstream/modules/platform/ref-editing-inventory-file.adoc b/downstream/modules/platform/ref-editing-inventory-file.adoc index 2a30f2e4b5..7fcd412be6 100644 --- a/downstream/modules/platform/ref-editing-inventory-file.adoc +++ b/downstream/modules/platform/ref-editing-inventory-file.adoc @@ -3,10 +3,10 @@ [id="ref-editing-installer-inventory-file_{context}"] -= Editing the {PlatformName} installer inventory file += Edit the inventory file [role="_abstract"] -You can use the {PlatformName} installer inventory file to specify your installation scenario. +You can use the {PlatformNameShort} installer inventory file to specify your installation scenario. == For an RPM installation diff --git a/downstream/modules/platform/ref-encrypting-plaintext-passwords.adoc b/downstream/modules/platform/ref-encrypting-plaintext-passwords.adoc index 4c3f1c4797..d4a310fcb5 100644 --- a/downstream/modules/platform/ref-encrypting-plaintext-passwords.adoc +++ b/downstream/modules/platform/ref-encrypting-plaintext-passwords.adoc @@ -2,7 +2,7 @@ [id="ref-encrypting-plaintext-passwords"] -= Encrypting plain text passwords in {ControllerName} configuration files += Encrypt plain text passwords in {ControllerName} configuration files [role="_abstract"] Plain text passwords in {ControllerName} configuration files pose a potential security risk. diff --git a/downstream/modules/platform/ref-fetching-a-monthly-report.adoc b/downstream/modules/platform/ref-fetching-a-monthly-report.adoc index 9025e7aff4..7334e54745 100644 --- a/downstream/modules/platform/ref-fetching-a-monthly-report.adoc +++ b/downstream/modules/platform/ref-fetching-a-monthly-report.adoc @@ -2,7 +2,7 @@ [id="ref-fetching-a-monthly-report"] -= Fetching a monthly report += Configure a monthly usage report [role="_abstract"] You can fetch a monthly report from {PlatformNameShort} to gather usage metrics and create a consumption-based billing report. To fetch a monthly report on {RHEL} or on {OCPShort}, use the following procedures: diff --git a/downstream/modules/platform/ref-filter-by-organization.adoc b/downstream/modules/platform/ref-filter-by-organization.adoc index eda84fef38..d3fcdd708f 100644 --- a/downstream/modules/platform/ref-filter-by-organization.adoc +++ b/downstream/modules/platform/ref-filter-by-organization.adoc @@ -2,7 +2,7 @@ [id="ref-filter-by-organization"] -= Filtering reports by organization += Filter reports by organization [role="_abstract"] When generating reports by using the metrics utility, you can filter the data by organization. diff --git a/downstream/modules/platform/ref-gw-request-token-after-expiration.adoc b/downstream/modules/platform/ref-gw-request-token-after-expiration.adoc index d763f7b0d9..436cb6f74f 100644 --- a/downstream/modules/platform/ref-gw-request-token-after-expiration.adoc +++ b/downstream/modules/platform/ref-gw-request-token-after-expiration.adoc @@ -2,7 +2,7 @@ [id="gw-request-token-after-expiration"] -= Requesting an access token after expiration += Request an access token after expiration [role="_abstract"] diff --git a/downstream/modules/platform/ref-ha-hub-reqs.adoc b/downstream/modules/platform/ref-ha-hub-reqs.adoc index 19118f7367..e57f7f08be 100644 --- a/downstream/modules/platform/ref-ha-hub-reqs.adoc +++ b/downstream/modules/platform/ref-ha-hub-reqs.adoc @@ -16,7 +16,7 @@ The {PlatformName} installer returns an error if `/var/lib/pulp` is not detected If you receive an error stating `/var/lib/pulp` is not detected in one of your nodes, ensure `/var/lib/pulp` is properly mounted in all servers and re-run the installation program. -== Installing firewalld for HA hub deployment +== Install firewalld for HA hub deployment If you intend to install a HA {HubName} using a network storage on the {HubName} nodes itself, you must first install and use `firewalld` to open the necessary ports as required by your shared storage system before running the {PlatformNameShort} installer. diff --git a/downstream/modules/platform/ref-ocp-additional-configs.adoc b/downstream/modules/platform/ref-ocp-additional-configs.adoc index b2f6105b63..0fc920b860 100644 --- a/downstream/modules/platform/ref-ocp-additional-configs.adoc +++ b/downstream/modules/platform/ref-ocp-additional-configs.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: REFERENCE [id="ocp-additional-configs_{context}"] -= Additional configurations += Add a collection download count to {HubName} [role="_abstract"] diff --git a/downstream/modules/platform/ref-operator-aap-faq.adoc b/downstream/modules/platform/ref-operator-aap-faq.adoc index 3c7709890b..ff527aa2dc 100644 --- a/downstream/modules/platform/ref-operator-aap-faq.adoc +++ b/downstream/modules/platform/ref-operator-aap-faq.adoc @@ -2,7 +2,7 @@ [id="operator-aap-troubleshooting_{context}"] -= Frequently asked questions on {Gateway} += Review {Gateway} FAQs [role="_abstract"] diff --git a/downstream/modules/platform/ref-operator-crd-customize.adoc b/downstream/modules/platform/ref-operator-crd-customize.adoc index 5c86fff461..22f310983b 100644 --- a/downstream/modules/platform/ref-operator-crd-customize.adoc +++ b/downstream/modules/platform/ref-operator-crd-customize.adoc @@ -2,7 +2,7 @@ [id="ref-operator-crd-customize_{context}"] -= Customizing your resource requirements += Customize your resource requirements [role="_abstract"] diff --git a/downstream/modules/platform/ref-pac-inputs-outputs.adoc b/downstream/modules/platform/ref-pac-inputs-outputs.adoc index be7ee2b6fa..6fcff3d3db 100644 --- a/downstream/modules/platform/ref-pac-inputs-outputs.adoc +++ b/downstream/modules/platform/ref-pac-inputs-outputs.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: REFERENCE [id="pac-inputs-outputs_{context}"] -= Policy enforcement inputs and outputs += Policy enforcement input and output options [role="_abstract"] Use the following inputs and outputs to craft policies for use in policy enforcement. diff --git a/downstream/modules/platform/ref-post-installation-tasks.adoc b/downstream/modules/platform/ref-post-installation-tasks.adoc index 7f241312d0..fe5ec5da0d 100644 --- a/downstream/modules/platform/ref-post-installation-tasks.adoc +++ b/downstream/modules/platform/ref-post-installation-tasks.adoc @@ -2,7 +2,7 @@ [id="completing-post-installation-tasks_{context}"] -= Completing post installation tasks += Complete post installation tasks [role="_abstract"] diff --git a/downstream/modules/platform/ref-projects-collections-support.adoc b/downstream/modules/platform/ref-projects-collections-support.adoc index 49cb9e17ff..bd65b18972 100644 --- a/downstream/modules/platform/ref-projects-collections-support.adoc +++ b/downstream/modules/platform/ref-projects-collections-support.adoc @@ -2,7 +2,7 @@ [id="ref-projects-collections-support"] -= Collections support += Configure collections from source management to run in a project [role="_abstract"] {ControllerNameStart} supports project-specific Ansible collections in job runs. diff --git a/downstream/modules/platform/ref-projects-galaxy-support.adoc b/downstream/modules/platform/ref-projects-galaxy-support.adoc index fef5dfc8e5..c60ec18384 100644 --- a/downstream/modules/platform/ref-projects-galaxy-support.adoc +++ b/downstream/modules/platform/ref-projects-galaxy-support.adoc @@ -2,7 +2,7 @@ [id="ref-projects-galaxy-support"] -= {Galaxy} support += Reuse prebuilt automation by referencing roles [role="_abstract"] At the end of a project update, {ControllerName} searches for the `requirements.yml` file in the `roles` directory, located at diff --git a/downstream/modules/platform/ref-projects-manage-playbooks-with-source-control.adoc b/downstream/modules/platform/ref-projects-manage-playbooks-with-source-control.adoc index c1b99d8ba2..8429624127 100644 --- a/downstream/modules/platform/ref-projects-manage-playbooks-with-source-control.adoc +++ b/downstream/modules/platform/ref-projects-manage-playbooks-with-source-control.adoc @@ -2,7 +2,7 @@ [id="ref-projects-manage-playbooks-with-source-control"] -= Managing playbooks using source control += Configure playbooks to use source control management (SCM) systems [role="_abstract"] Choose one of the following options when managing playbooks by using source control: diff --git a/downstream/modules/platform/ref-redis-config-enterprise-topology.adoc b/downstream/modules/platform/ref-redis-config-enterprise-topology.adoc index edfe0813f0..75c942c375 100644 --- a/downstream/modules/platform/ref-redis-config-enterprise-topology.adoc +++ b/downstream/modules/platform/ref-redis-config-enterprise-topology.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: REFERENCE [id="redis-config-enterprise-topology_{context}"] -= Configuring Redis += Configure Redis [role="_abstract"] {PlatformNameShort} offers a centralized Redis instance in both `standalone` and `clustered` topologies. diff --git a/downstream/modules/platform/ref-removing-instances.adoc b/downstream/modules/platform/ref-removing-instances.adoc index 7679db8185..709e7b66e2 100644 --- a/downstream/modules/platform/ref-removing-instances.adoc +++ b/downstream/modules/platform/ref-removing-instances.adoc @@ -2,7 +2,7 @@ [id="ref-removing-instances"] -= Removing Instances += Remove instances [role="_abstract"] From the *Instances* page, you can add, remove or run health checks on your nodes. diff --git a/downstream/modules/platform/ref-renewal-guidance.adoc b/downstream/modules/platform/ref-renewal-guidance.adoc index 55ad651024..7a4b90565a 100644 --- a/downstream/modules/platform/ref-renewal-guidance.adoc +++ b/downstream/modules/platform/ref-renewal-guidance.adoc @@ -2,7 +2,7 @@ [id="ref-renewal-guidance"] -= `RENEWAL_GUIDANCE` += Configure options in the `RENEWAL_GUIDANCE` report [role="_abstract"] The `RENEWAL_GUIDANCE` report provides historical usage from the HostMetric table, applying deduplication and showing real historical usage for renewal guidance purposes. diff --git a/downstream/modules/platform/ref-report-types.adoc b/downstream/modules/platform/ref-report-types.adoc index 84ddf3c27d..bd0b3c2705 100644 --- a/downstream/modules/platform/ref-report-types.adoc +++ b/downstream/modules/platform/ref-report-types.adoc @@ -2,7 +2,7 @@ [id="ref-report-types"] -= Report types += Configure options for the Certified Cloud and Service Provider report (CCSPv2) [role="_abstract"] Additional configurations for data gathering and report building based on a report type. Apply the environment variables to each report type based on your {PlatformNameShort} installation. diff --git a/downstream/modules/platform/ref-resource-management-pods-containers.adoc b/downstream/modules/platform/ref-resource-management-pods-containers.adoc index 3215e7a2f1..ebeb1564f3 100644 --- a/downstream/modules/platform/ref-resource-management-pods-containers.adoc +++ b/downstream/modules/platform/ref-resource-management-pods-containers.adoc @@ -2,13 +2,13 @@ [id="ref-resource-management-pods-containers_{context}"] -= Resource management for pods and containers += Manage resources for pods and containers [role="_abstract"] When you specify a pod, you can specify how much of each resource a container needs. The most common resources to specify are CPU and memory (RAM). -When you specify the resource request for containers in a Pod, the kubernetes-scheduler uses this information to allocate the node to place the Pod on. +When you specify the resource request for containers in a Pod, the Kubernetes-scheduler uses this information to allocate the node to place the Pod on. When you specify a resource limit for a container, the _kubelet_, or node agent, enforces those limits so that the running container is not permitted to use more of that resource than the limit you set. The kubelet also reserves at least the requested amount of that system resource specifically for that container to use. \ No newline at end of file diff --git a/downstream/modules/platform/ref-resource-types.adoc b/downstream/modules/platform/ref-resource-types.adoc index 85bfc5a7c9..6333953757 100644 --- a/downstream/modules/platform/ref-resource-types.adoc +++ b/downstream/modules/platform/ref-resource-types.adoc @@ -15,7 +15,7 @@ Compute resources are measurable quantities that can be requested, allocated, an They are distinct from API resources. API resources, such as pods and services, are objects that can be read and modified through the Kubernetes API server. -== Specifying resource requests and limits for pods and containers +== Specify resource requests and limits for pods and containers For each container, you can specify resource limits and requests, including the following: [options="nowrap" subs="+quotes,attributes"] diff --git a/downstream/modules/platform/ref-select-a-date-range-ccspv2.adoc b/downstream/modules/platform/ref-select-a-date-range-ccspv2.adoc index 0568662f08..46dc64473f 100644 --- a/downstream/modules/platform/ref-select-a-date-range-ccspv2.adoc +++ b/downstream/modules/platform/ref-select-a-date-range-ccspv2.adoc @@ -2,7 +2,7 @@ [id="ref-select-a-date-range-ccspv2"] -= Selecting a date range for your CCSPv2 report += Select a date range for your CCSPv2 report [role="_abstract"] The default behavior of the CCSPv2 report is to build a report for the previous month. The following examples describe how to override this default behavior to select a specific date range for your report: diff --git a/downstream/modules/platform/ref-select-a-date-range.adoc b/downstream/modules/platform/ref-select-a-date-range.adoc index 48bd7d4984..77a19fafa1 100644 --- a/downstream/modules/platform/ref-select-a-date-range.adoc +++ b/downstream/modules/platform/ref-select-a-date-range.adoc @@ -2,7 +2,7 @@ [id="ref-select-a-date-range"] -= Selecting a date range for your `RENEWAL_GUIDANCE` report += Select a date range for your `RENEWAL_GUIDANCE` report [role="_abstract"] The default behavior of the `RENEWAL_GUIDANCE` report is to build a report for the current date. The following examples describe how to override this default behavior to select a specific date range for your report: diff --git a/downstream/modules/platform/ref-select-report-date-range.adoc b/downstream/modules/platform/ref-select-report-date-range.adoc index d850824387..5cc7e43512 100644 --- a/downstream/modules/platform/ref-select-report-date-range.adoc +++ b/downstream/modules/platform/ref-select-report-date-range.adoc @@ -2,7 +2,7 @@ [id="ref-select-report-date-range"] -= Selecting a date range for your CCSP report += Select a date range for your CCSP report [role="_abstract"] By default, the CCSPv2 report generates data for the previous calendar month. You can override this behavior by specifying a different month when you run the `metrics-utility build_report` command. diff --git a/downstream/modules/platform/ref-show-ephemeral-use.adoc b/downstream/modules/platform/ref-show-ephemeral-use.adoc index 2be199f188..ff8bd24a1e 100644 --- a/downstream/modules/platform/ref-show-ephemeral-use.adoc +++ b/downstream/modules/platform/ref-show-ephemeral-use.adoc @@ -2,7 +2,7 @@ [id="ref-show-ephemeral-use"] -= Showing ephemeral usage += Generate reports to show ephemeral usage [role="_abstract"] The `metrics-utility` command-line tool can generate reports showing ephemeral usage of managed nodes. diff --git a/downstream/modules/platform/ref-supported-storage.adoc b/downstream/modules/platform/ref-supported-storage.adoc index 5a355f20e4..669c39baf2 100644 --- a/downstream/modules/platform/ref-supported-storage.adoc +++ b/downstream/modules/platform/ref-supported-storage.adoc @@ -2,7 +2,7 @@ [id="ref-supported-storage"] -= Supported storage += Specify where to store consumption-based reports [role="_abstract"] Supported storage is available for storing the raw data obtained by using the `metrics-utility gather_automation_controller_billing_data` command and storing the generated reports obtained by using the `metrics-utility build_report` command. diff --git a/downstream/modules/platform/ref-system-proxy-config.adoc b/downstream/modules/platform/ref-system-proxy-config.adoc index 5424231b07..13c5e33ab3 100644 --- a/downstream/modules/platform/ref-system-proxy-config.adoc +++ b/downstream/modules/platform/ref-system-proxy-config.adoc @@ -2,7 +2,7 @@ [id="ref-system-proxy-config"] -= System proxy configuration += Configure the system-level outbound proxy [role="_abstract"] An outbound proxy (egress proxy) is a server that acts as an intermediary for requests from clients seeking resources from other servers on the internet. diff --git a/downstream/modules/platform/ref-troubleshoot-ansible-mcp-server.adoc b/downstream/modules/platform/ref-troubleshoot-ansible-mcp-server.adoc index 08f71e4e07..7192891565 100644 --- a/downstream/modules/platform/ref-troubleshoot-ansible-mcp-server.adoc +++ b/downstream/modules/platform/ref-troubleshoot-ansible-mcp-server.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: REFERENCE [id="troubleshoot-ansible-mcp-server-errors"] -= Troubleshooting Ansible MCP server errors += Troubleshoot Ansible MCP server errors [role="_abstract"] diff --git a/downstream/modules/platform/ref-upgrade-2.4-to-2.6.adoc b/downstream/modules/platform/ref-upgrade-2.4-to-2.6.adoc index 30ffb3e09a..990cdb89fe 100644 --- a/downstream/modules/platform/ref-upgrade-2.4-to-2.6.adoc +++ b/downstream/modules/platform/ref-upgrade-2.4-to-2.6.adoc @@ -2,7 +2,7 @@ [id="ref-upgrade-2.4-to-2.6"] -= Upgrading from {PlatformNameShort} 2.4 to 2.6 += Upgrade from 2.4 to 2.6 [role="_abstract"] It is possible for customers to upgrade directly from the latest 2.4 version to {PlatformVers}. diff --git a/downstream/modules/platform/ref-upgrade-2.5-to-2.6.adoc b/downstream/modules/platform/ref-upgrade-2.5-to-2.6.adoc index 83dd4d16bd..f5c7cfdb88 100644 --- a/downstream/modules/platform/ref-upgrade-2.5-to-2.6.adoc +++ b/downstream/modules/platform/ref-upgrade-2.5-to-2.6.adoc @@ -2,7 +2,7 @@ [id="ref-upgrade-2.5-to-2.6"] -= Upgrades from {PlatformNameShort} 2.5 to {PlatformVers} += Upgrade from 2.5 to {PlatformVers} [role="_abstract"] When upgrading from {PlatformNameShort} 2.5 to {PlatformVers}, existing authenticators and their mappings in {Gateway} continue to function as they are, with no changes being imported. diff --git a/downstream/modules/platform/ref-upgrade-post-upgrade.adoc b/downstream/modules/platform/ref-upgrade-post-upgrade.adoc index 73885b43bc..1f0ebce430 100644 --- a/downstream/modules/platform/ref-upgrade-post-upgrade.adoc +++ b/downstream/modules/platform/ref-upgrade-post-upgrade.adoc @@ -2,7 +2,7 @@ [id="ref-upgrade-post-upgrade"] -= Post upgrade += Verify assigned permissions after upgrading [role="_abstract"] It is imperative that administrators verify the assigned permissions for all teams in the platform-wide authentication gateway immediately after the upgrade: diff --git a/downstream/modules/platform/ref-upgrade-scenarios-container.adoc b/downstream/modules/platform/ref-upgrade-scenarios-container.adoc index 81be50a1d7..faa8303754 100644 --- a/downstream/modules/platform/ref-upgrade-scenarios-container.adoc +++ b/downstream/modules/platform/ref-upgrade-scenarios-container.adoc @@ -2,7 +2,7 @@ [id="upgrade-scenarios-container"] -= Container-based upgrade scenarios += Supported container-based upgrade and migration scenarios [role="_abstract"] Find the supported upgrade paths for your container-based {PlatformNameShort} deployment. diff --git a/downstream/modules/platform/ref-upgrade-scenarios-openshift.adoc b/downstream/modules/platform/ref-upgrade-scenarios-openshift.adoc index 6d3ec5e97d..1455b362ad 100644 --- a/downstream/modules/platform/ref-upgrade-scenarios-openshift.adoc +++ b/downstream/modules/platform/ref-upgrade-scenarios-openshift.adoc @@ -2,7 +2,7 @@ [id="upgrade-scenarios-openshift"] -= {OCPShort} upgrade scenarios += Supported Operator-based upgrade and migration scenarios [role="_abstract"] Find the supported upgrade paths for {PlatformNameShort} deployments that use {OCPShort}. diff --git a/downstream/modules/platform/ref-upgrade-scenarios-rpm.adoc b/downstream/modules/platform/ref-upgrade-scenarios-rpm.adoc index 38935a37d1..de5329ceef 100644 --- a/downstream/modules/platform/ref-upgrade-scenarios-rpm.adoc +++ b/downstream/modules/platform/ref-upgrade-scenarios-rpm.adoc @@ -2,7 +2,7 @@ [id="upgrade-scenarios-rpm"] -= RPM-based upgrade scenarios += Supported RPM-based upgrade and migration scenarios [role="_abstract"] Find the supported upgrade paths for your RPM-based {PlatformNameShort} deployment. diff --git a/downstream/modules/platform/ref-using-custom-receptor-signing-keys.adoc b/downstream/modules/platform/ref-using-custom-receptor-signing-keys.adoc index 65c7acbf3d..056103b3f3 100644 --- a/downstream/modules/platform/ref-using-custom-receptor-signing-keys.adoc +++ b/downstream/modules/platform/ref-using-custom-receptor-signing-keys.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: REFERENCE [id="using-custom-receptor-signing-keys"] -= Using custom Receptor signing keys += Use custom Receptor signing keys [role="_abstract"] Receptor signing is enabled by default unless `receptor_disable_signing=true` is set, and an RSA key pair (public and private) is generated by the installation program. However, you can set custom RSA public and private keys by using the following variables: diff --git a/downstream/modules/platform/ref-work-with-permissions.adoc b/downstream/modules/platform/ref-work-with-permissions.adoc index 22d432e6ab..dfb502b285 100644 --- a/downstream/modules/platform/ref-work-with-permissions.adoc +++ b/downstream/modules/platform/ref-work-with-permissions.adoc @@ -2,7 +2,7 @@ [id="ref-work-with-permissions"] -= Work with permissions += Configure project permissions [role="_abstract"] The set of permissions assigned to a project (role-based access controls) that provide the ability to read, change, and administer projects, inventories, job templates, and other elements are privileges. diff --git a/downstream/modules/playbooks/proc-build-an-inventory.adoc b/downstream/modules/playbooks/proc-build-an-inventory.adoc index aae477cd0e..b06246f82c 100644 --- a/downstream/modules/playbooks/proc-build-an-inventory.adoc +++ b/downstream/modules/playbooks/proc-build-an-inventory.adoc @@ -2,7 +2,7 @@ [id="proc-build-an-inventory"] -= Building an inventory += Define which hosts to manage in an inventory file [role="_abstract"] Inventories organize managed nodes in centralized files that provide Ansible with system information and network locations. Using an inventory file, Ansible can manage a large number of hosts with a single command. diff --git a/downstream/modules/playbooks/proc-creating-a-playbook.adoc b/downstream/modules/playbooks/proc-creating-a-playbook.adoc index 9195a74947..1af2173ce5 100644 --- a/downstream/modules/playbooks/proc-creating-a-playbook.adoc +++ b/downstream/modules/playbooks/proc-creating-a-playbook.adoc @@ -2,7 +2,7 @@ [id="proc-creating-a-plaaybook"] -= Creating your first playbook += Create a simple playbook to connect to managed hosts [role="_abstract"] Learn how to create a playbook that pings your hosts and prints a “Hello world” message. diff --git a/downstream/modules/playbooks/proc-run-ansible-network-playbook.adoc b/downstream/modules/playbooks/proc-run-ansible-network-playbook.adoc index f45ccd6aed..4f40f67146 100644 --- a/downstream/modules/playbooks/proc-run-ansible-network-playbook.adoc +++ b/downstream/modules/playbooks/proc-run-ansible-network-playbook.adoc @@ -2,7 +2,7 @@ [id="proc-run-ansible-network-playbook"] -= Running a network Ansible Playbook += Run a network Ansible Playbook [role="_abstract"] If you want to run a particular command every day, you can save it in a playbook and run it with `ansible-playbook` instead of ansible. diff --git a/downstream/modules/playbooks/proc-starting-automation.adoc b/downstream/modules/playbooks/proc-starting-automation.adoc index 318c13a076..791f129783 100644 --- a/downstream/modules/playbooks/proc-starting-automation.adoc +++ b/downstream/modules/playbooks/proc-starting-automation.adoc @@ -2,7 +2,7 @@ [id="proc-starting-automation"] -= Starting automation with Ansible += Start automating with Ansible [role="_abstract"] Get started with Ansible by creating an automation project, building an inventory, and creating a `Hello World` playbook. diff --git a/downstream/modules/playbooks/ref-create-variables.adoc b/downstream/modules/playbooks/ref-create-variables.adoc index 13fa3d4fe0..88486242bd 100644 --- a/downstream/modules/playbooks/ref-create-variables.adoc +++ b/downstream/modules/playbooks/ref-create-variables.adoc @@ -2,7 +2,7 @@ [id="ref-create-variables"] -= Create variables += Create inventory file variables to set values for managed nodes [role="_abstract"] Variables set values for managed nodes, such as the IP address, FQDN, operating system, and SSH user, so you do not need to pass them when running Ansible commands. diff --git a/downstream/modules/security/con-automate-idps-rules.adoc b/downstream/modules/security/con-automate-idps-rules.adoc index bab6e3243d..0010653a6c 100644 --- a/downstream/modules/security/con-automate-idps-rules.adoc +++ b/downstream/modules/security/con-automate-idps-rules.adoc @@ -2,7 +2,7 @@ [id="con-automate-ids-rules_{context}"] -= Automating your IDPS rules with {PlatformNameShort} += Automate your IDPS rules with {PlatformNameShort} [role="_abstract"] To automate your IDPS, use the `ids_rule` role to create and change Snort rules. diff --git a/downstream/modules/security/con-patch-automation-with-aap.adoc b/downstream/modules/security/con-patch-automation-with-aap.adoc index 7e651a2852..0859daef52 100644 --- a/downstream/modules/security/con-patch-automation-with-aap.adoc +++ b/downstream/modules/security/con-patch-automation-with-aap.adoc @@ -2,7 +2,7 @@ [id="con-patch-automation-with-aap"] -= Patch automation with {PlatformNameShort} += Automate software patching [role="_abstract"] Software patching is a fundamental activity of security and IT operations teams everywhere. diff --git a/downstream/modules/security/proc-creating-firewall-rule.adoc b/downstream/modules/security/proc-creating-firewall-rule.adoc index 344bdcd9f4..808fcff1de 100644 --- a/downstream/modules/security/proc-creating-firewall-rule.adoc +++ b/downstream/modules/security/proc-creating-firewall-rule.adoc @@ -2,10 +2,10 @@ [id="proc-creating-firewall-rule_{context}"] -= Creating a new firewall rule += Create a new firewall rule [role="_abstract"] -Use the acl_manager role to create a new firewall rule for blocking a source IP address from accessing a destination IP address. +Use the `acl_manager` role to create a new firewall rule for blocking a source IP address from accessing a destination IP address. .Prerequisites @@ -35,7 +35,9 @@ Use the acl_manager role to create a new firewall rule for blocking a source IP ansible_network_os: checkpoint ---- -. Run the playbook ``$ ansible-navigator run --ee false ``. +. Run the playbook: ++ +`$ ansible-navigator run --ee false `. + image::security-create-rule.png[Playbook with new firewall rule] diff --git a/downstream/modules/security/proc-creating-idps-rule.adoc b/downstream/modules/security/proc-creating-idps-rule.adoc index 90f4ce73e3..07aba912b8 100644 --- a/downstream/modules/security/proc-creating-idps-rule.adoc +++ b/downstream/modules/security/proc-creating-idps-rule.adoc @@ -2,7 +2,7 @@ [id="proc-creating-ids-rule_{context}"] -= Creating a new IDPS rule += Create a new IDPS rule [role="_abstract"] Use the `ids_rule` role to manage your rules and signatures for IDPS. diff --git a/downstream/modules/security/proc-deleting-firewall-rule.adoc b/downstream/modules/security/proc-deleting-firewall-rule.adoc index b75e5401a8..d178b54ed6 100644 --- a/downstream/modules/security/proc-deleting-firewall-rule.adoc +++ b/downstream/modules/security/proc-deleting-firewall-rule.adoc @@ -2,7 +2,7 @@ [id="proc-deleting-rule_{context}"] -= Deleting a firewall rule += Delete a firewall rule [role="_abstract"] Use the acl_manager role to delete a security rule. @@ -34,7 +34,9 @@ Use the acl_manager role to delete a security rule. ansible_network_os: checkpoint ---- -. Run the playbook `$ ansible-navigator run --ee false `: +. Run the playbook: ++ +`$ ansible-navigator run --ee false `: + image::security-delete-rule.png[Playbook with deleted firewall rule] diff --git a/downstream/modules/security/proc-verifying-idps-install.adoc b/downstream/modules/security/proc-verifying-idps-install.adoc index 46b80d8c93..c2f58f83ad 100644 --- a/downstream/modules/security/proc-verifying-idps-install.adoc +++ b/downstream/modules/security/proc-verifying-idps-install.adoc @@ -2,7 +2,7 @@ [id="proc-verifying-ids-install_{context}"] -= Verifying your IDPS installation += Verify your IDPS installation [role="_abstract"] Use the following procedure to verify that Snort has been configured successfully: diff --git a/downstream/modules/security/ref-case-study-f5.adoc b/downstream/modules/security/ref-case-study-f5.adoc index e86842feb0..6f53b74440 100644 --- a/downstream/modules/security/ref-case-study-f5.adoc +++ b/downstream/modules/security/ref-case-study-f5.adoc @@ -2,7 +2,7 @@ [id="ref-case-study-f5"] -= Case Study with F5 += Case study with F5 example [role="_abstract"] diff --git a/downstream/modules/security/ref-drive-responses-from-logging-events.adoc b/downstream/modules/security/ref-drive-responses-from-logging-events.adoc index 64f442a8aa..8165d01f10 100644 --- a/downstream/modules/security/ref-drive-responses-from-logging-events.adoc +++ b/downstream/modules/security/ref-drive-responses-from-logging-events.adoc @@ -2,7 +2,7 @@ [id="ref-drive-responses-from-logging-events"] -= Driving responses from logging events += Drive responses from logging events [role="_abstract"] diff --git a/downstream/modules/security/ref-install-security-updates.adoc b/downstream/modules/security/ref-install-security-updates.adoc index 1aa8825a09..7c2b272f9b 100644 --- a/downstream/modules/security/ref-install-security-updates.adoc +++ b/downstream/modules/security/ref-install-security-updates.adoc @@ -2,7 +2,7 @@ [id="ref-install-security-updates"] -= Installing security updates only += Install security updates only [role="_abstract"] For organizations with a policy requiring that all RPMs including security errata be kept up to date, the following playbook might be used in a regularly scheduled job template. diff --git a/downstream/modules/security/ref-keep-up-to-date.adoc b/downstream/modules/security/ref-keep-up-to-date.adoc index c46486ded7..3832b5c772 100644 --- a/downstream/modules/security/ref-keep-up-to-date.adoc +++ b/downstream/modules/security/ref-keep-up-to-date.adoc @@ -2,7 +2,7 @@ [id="ref-keep-up-to-date"] -= Keeping everything up to date += Keep everything up to date [role="_abstract"] For some {RHEL} servers, such as a lab or other non-production systems, you might want to install all available patches on a regular cadence. diff --git a/downstream/modules/security/ref-specify-package-versions.adoc b/downstream/modules/security/ref-specify-package-versions.adoc index 0d7758123c..e912eceff0 100644 --- a/downstream/modules/security/ref-specify-package-versions.adoc +++ b/downstream/modules/security/ref-specify-package-versions.adoc @@ -2,7 +2,7 @@ [id="ref-specify-package-versions"] -= Specifying package versions += Specify package versions [role="_abstract"] For production systems, a well-established configuration management practice is to deploy only known, tested combinations of software to ensure that systems are configured correctly and perform as expected. diff --git a/downstream/modules/terraform-aap/con-terraform-migration-examples.adoc b/downstream/modules/terraform-aap/con-terraform-migration-examples.adoc index 217a48a1d1..a2b2206a40 100644 --- a/downstream/modules/terraform-aap/con-terraform-migration-examples.adoc +++ b/downstream/modules/terraform-aap/con-terraform-migration-examples.adoc @@ -8,7 +8,7 @@ These before and after examples help users understand how the modules can be configured in a real world environment. -== Example 1: Plan Only +== Migration examples: Plan Only * **Before (`cloud.terraform.terraform`):** ---- @@ -56,7 +56,7 @@ These before and after examples help users understand how the modules can be con value: "production" ---- -== Example 2: Plan and apply +== Migration examples: Plan and apply * **Before (`cloud.terraform.terraform`):** diff --git a/downstream/modules/terraform-aap/proc-cloud-terraform-building-execution-environment.adoc b/downstream/modules/terraform-aap/proc-cloud-terraform-building-execution-environment.adoc index 22ff6ab220..5ac14ddc97 100644 --- a/downstream/modules/terraform-aap/proc-cloud-terraform-building-execution-environment.adoc +++ b/downstream/modules/terraform-aap/proc-cloud-terraform-building-execution-environment.adoc @@ -2,7 +2,7 @@ [id="cloud-terraform-building-execution-environment"] -= Building an {ExecEnvShort} in {PlatformNameShort} += Build an {ExecEnvShort} in {PlatformNameShort} [role="_abstract"] diff --git a/downstream/modules/terraform-aap/proc-cloud-terraform-creating-credential.adoc b/downstream/modules/terraform-aap/proc-cloud-terraform-creating-credential.adoc index fc015c37db..909dd67b05 100644 --- a/downstream/modules/terraform-aap/proc-cloud-terraform-creating-credential.adoc +++ b/downstream/modules/terraform-aap/proc-cloud-terraform-creating-credential.adoc @@ -2,7 +2,7 @@ [id="cloud-terraform-creating-credential"] -= Creating a credential += Create a credential for using cloud.terraform [role="_abstract"] diff --git a/downstream/modules/terraform-aap/proc-cloud-terraform-creating-launching-job-template.adoc b/downstream/modules/terraform-aap/proc-cloud-terraform-creating-launching-job-template.adoc index e03e384328..23a583042a 100644 --- a/downstream/modules/terraform-aap/proc-cloud-terraform-creating-launching-job-template.adoc +++ b/downstream/modules/terraform-aap/proc-cloud-terraform-creating-launching-job-template.adoc @@ -2,7 +2,7 @@ [id="cloud-terraform-creating-launching-job-template"] -= Creating and launching a job template += Create and launch a job template [role="_abstract"] diff --git a/downstream/modules/terraform-aap/proc-terraform-configuring-config-version-module.adoc b/downstream/modules/terraform-aap/proc-terraform-configuring-config-version-module.adoc index c4323464de..3e8b7528bb 100644 --- a/downstream/modules/terraform-aap/proc-terraform-configuring-config-version-module.adoc +++ b/downstream/modules/terraform-aap/proc-terraform-configuring-config-version-module.adoc @@ -2,7 +2,7 @@ [id="configuring-config-version-module"] -= Configuring the `hashicorp.terraform.configuration_version` module += Configure the `hashicorp.terraform.configuration_version` module [role="_abstract"] diff --git a/downstream/modules/terraform-aap/proc-terraform-configuring-run-module.adoc b/downstream/modules/terraform-aap/proc-terraform-configuring-run-module.adoc index 63e17309e4..20263cd085 100644 --- a/downstream/modules/terraform-aap/proc-terraform-configuring-run-module.adoc +++ b/downstream/modules/terraform-aap/proc-terraform-configuring-run-module.adoc @@ -2,7 +2,7 @@ [id="configuring-run-module"] -= Configuring the `hashicorp.terraform.run` module += Configure the `hashicorp.terraform.run` module [role="_abstract"] diff --git a/downstream/modules/terraform-aap/proc-terraform-creating-credential.adoc b/downstream/modules/terraform-aap/proc-terraform-creating-credential.adoc index eecd77c086..a604d85a3b 100644 --- a/downstream/modules/terraform-aap/proc-terraform-creating-credential.adoc +++ b/downstream/modules/terraform-aap/proc-terraform-creating-credential.adoc @@ -2,7 +2,7 @@ [id="terraform-creating-credential"] -= Creating a credential += Create a credential [role="_abstract"] diff --git a/downstream/modules/terraform-aap/proc-terraform-creating-custom-credential-type.adoc b/downstream/modules/terraform-aap/proc-terraform-creating-custom-credential-type.adoc index 5b639d212b..69c89fa951 100644 --- a/downstream/modules/terraform-aap/proc-terraform-creating-custom-credential-type.adoc +++ b/downstream/modules/terraform-aap/proc-terraform-creating-custom-credential-type.adoc @@ -2,7 +2,7 @@ [id="creating-custom-credential-type"] -= Creating a custom credential type += Create a custom credential type [role="_abstract"] diff --git a/downstream/modules/terraform-aap/proc-terraform-migrating-from-community.adoc b/downstream/modules/terraform-aap/proc-terraform-migrating-from-community.adoc index 989fe7b79a..486430c0fa 100644 --- a/downstream/modules/terraform-aap/proc-terraform-migrating-from-community.adoc +++ b/downstream/modules/terraform-aap/proc-terraform-migrating-from-community.adoc @@ -2,10 +2,12 @@ [id="terraform-migrating-from-community"] -= Migrating from the community edition += Migrate from the {Terraform} community edition [role="_abstract"] +If you want to use {PlatformNameShort} with {TerraformEnterpriseShortName} (TFE) or {TerraformCloudShortName} and you are currently using {TerraformCommunityName} (TCE), you must migrate to TFE or {TerraformCloudShortName} and then update {PlatformNameShort} configurations to work with TFE or {TerraformCloudShortName}. + When you migrate from TCE to TFE or {TerraformCloudShortName}, you are not migrating the collection itself. Instead, you are adapting your existing TCE usage to work with TFE or {TerraformCloudShortName}. After you migrate, you must update the {PlatformNameShort} credentials, execution environment, and job templates. diff --git a/downstream/modules/terraform-aap/proc-terraform-provider-configuring-event-stream.adoc b/downstream/modules/terraform-aap/proc-terraform-provider-configuring-event-stream.adoc index 4be48e370a..cc9658d0fc 100644 --- a/downstream/modules/terraform-aap/proc-terraform-provider-configuring-event-stream.adoc +++ b/downstream/modules/terraform-aap/proc-terraform-provider-configuring-event-stream.adoc @@ -2,7 +2,7 @@ [id="terraform-provider-configuring-event-stream"] -= Configuring an event stream += Configure an event stream [role="_abstract"] diff --git a/downstream/modules/terraform-aap/proc-terraform-provider-configuring-tf-actions.adoc b/downstream/modules/terraform-aap/proc-terraform-provider-configuring-tf-actions.adoc index 8dfa48a767..6a6e872fb2 100644 --- a/downstream/modules/terraform-aap/proc-terraform-provider-configuring-tf-actions.adoc +++ b/downstream/modules/terraform-aap/proc-terraform-provider-configuring-tf-actions.adoc @@ -2,7 +2,7 @@ [id="terraform-provider-configuring-tf-actions"] -= Configuring TF Actions += Configure TF Actions [role="_abstract"] diff --git a/downstream/modules/terraform-aap/proc-terraform-provider-configuring.adoc b/downstream/modules/terraform-aap/proc-terraform-provider-configuring.adoc index c7e4365e8c..53e826a3a8 100644 --- a/downstream/modules/terraform-aap/proc-terraform-provider-configuring.adoc +++ b/downstream/modules/terraform-aap/proc-terraform-provider-configuring.adoc @@ -2,7 +2,7 @@ [id="terraform-provider-configuring"] -= Configuring the provider += Configure the provider [role="_abstract"] diff --git a/downstream/modules/terraform-aap/proc-terraform-provider-creating-applying-plan.adoc b/downstream/modules/terraform-aap/proc-terraform-provider-creating-applying-plan.adoc index 2999302cd3..cfb1538382 100644 --- a/downstream/modules/terraform-aap/proc-terraform-provider-creating-applying-plan.adoc +++ b/downstream/modules/terraform-aap/proc-terraform-provider-creating-applying-plan.adoc @@ -2,7 +2,7 @@ [id="terraform-provider-creating-applying-plan"] -= Creating and applying the plan += Create and apply the plan [role="_abstract"] diff --git a/downstream/modules/terraform-aap/proc-terraform-provider-using-tf-actions-direct-job.adoc b/downstream/modules/terraform-aap/proc-terraform-provider-using-tf-actions-direct-job.adoc index fdc4d1684f..d393b55d73 100644 --- a/downstream/modules/terraform-aap/proc-terraform-provider-using-tf-actions-direct-job.adoc +++ b/downstream/modules/terraform-aap/proc-terraform-provider-using-tf-actions-direct-job.adoc @@ -2,7 +2,7 @@ [id="terraform-provider-tf-actions-direct-job"] -= Using TF Actions as a direct job += Use TF Actions as a direct job [role="_abstract"] diff --git a/downstream/modules/troubleshooting-aap/proc-troubleshoot-must-gather.adoc b/downstream/modules/troubleshooting-aap/proc-troubleshoot-must-gather.adoc index 4ba4695731..c0a9e50cbc 100644 --- a/downstream/modules/troubleshooting-aap/proc-troubleshoot-must-gather.adoc +++ b/downstream/modules/troubleshooting-aap/proc-troubleshoot-must-gather.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="troubleshoot-must-gather"] -= Troubleshooting {PlatformNameShort} on {OCPShort} by using the must-gather command += Troubleshoot {PlatformNameShort} on {OCPShort} by using the must-gather command [role="_abstract"] The `oc adm must-gather` command line interface (CLI) command collects information from your {PlatformNameShort} installation deployed on {OCPShort}. It gathers information that is often needed for debugging issues, including resource definitions and service logs. diff --git a/downstream/modules/troubleshooting-aap/ref-troubleshoot-sosreport.adoc b/downstream/modules/troubleshooting-aap/ref-troubleshoot-sosreport.adoc index d059544f72..56c68ae936 100644 --- a/downstream/modules/troubleshooting-aap/ref-troubleshoot-sosreport.adoc +++ b/downstream/modules/troubleshooting-aap/ref-troubleshoot-sosreport.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: REFERENCE [id="troubleshoot-sosreport"] -= Troubleshooting {PlatformNameShort} on VM-based installations by generating an sos report += Troubleshoot {PlatformNameShort} on VM-based installations by generating an sos report [role="_abstract"] The `sos` utility collects configuration, diagnostic, and troubleshooting data from your {PlatformNameShort} on a {VMBase}. diff --git a/downstream/modules/vault-aap/proc-vault-configuring-kv1-secret-get-lookup.adoc b/downstream/modules/vault-aap/proc-vault-configuring-kv1-secret-get-lookup.adoc index 1c3615d182..03e5452326 100644 --- a/downstream/modules/vault-aap/proc-vault-configuring-kv1-secret-get-lookup.adoc +++ b/downstream/modules/vault-aap/proc-vault-configuring-kv1-secret-get-lookup.adoc @@ -2,7 +2,7 @@ [id="vault-configuring-kv1-secret-get-lookup"] -= Configuring the `hashicorp.vault.kv1_secret_get` lookup plugin += Configure the `hashicorp.vault.kv1_secret_get` lookup plugin [role="_abstract"] diff --git a/downstream/modules/vault-aap/proc-vault-configuring-kv1-secret-info.adoc b/downstream/modules/vault-aap/proc-vault-configuring-kv1-secret-info.adoc index 1583fb8fac..95930bf836 100644 --- a/downstream/modules/vault-aap/proc-vault-configuring-kv1-secret-info.adoc +++ b/downstream/modules/vault-aap/proc-vault-configuring-kv1-secret-info.adoc @@ -2,7 +2,7 @@ [id="vault-configuring-kv1-secret-info"] -= Configuring the `hashicorp.vault.kv1_secret_info` module += Configure the `hashicorp.vault.kv1_secret_info` module [role="_abstract"] diff --git a/downstream/modules/vault-aap/proc-vault-configuring-kv1-secret.adoc b/downstream/modules/vault-aap/proc-vault-configuring-kv1-secret.adoc index 758249f1a5..a66ddcf710 100644 --- a/downstream/modules/vault-aap/proc-vault-configuring-kv1-secret.adoc +++ b/downstream/modules/vault-aap/proc-vault-configuring-kv1-secret.adoc @@ -2,7 +2,7 @@ [id="vault-configuring-kv1-secret"] -= Configuring the `hashicorp.vault.kv1_secret` module += Configure the `hashicorp.vault.kv1_secret` module [role="_abstract"] diff --git a/downstream/modules/vault-aap/proc-vault-configuring-kv2-secret-get-lookup.adoc b/downstream/modules/vault-aap/proc-vault-configuring-kv2-secret-get-lookup.adoc index 487da99d66..dd5e4512d0 100644 --- a/downstream/modules/vault-aap/proc-vault-configuring-kv2-secret-get-lookup.adoc +++ b/downstream/modules/vault-aap/proc-vault-configuring-kv2-secret-get-lookup.adoc @@ -2,7 +2,7 @@ [id="vault-configuring-kv2-secret-get-lookup"] -= Configuring the `hashicorp.vault.kv2_secret_get` lookup plugin += Configure the `hashicorp.vault.kv2_secret_get` lookup plugin [role="_abstract"] diff --git a/downstream/modules/vault-aap/proc-vault-configuring-kv2-secret-info.adoc b/downstream/modules/vault-aap/proc-vault-configuring-kv2-secret-info.adoc index a566ced318..cefc3f1f24 100644 --- a/downstream/modules/vault-aap/proc-vault-configuring-kv2-secret-info.adoc +++ b/downstream/modules/vault-aap/proc-vault-configuring-kv2-secret-info.adoc @@ -2,7 +2,7 @@ [id="vault-configuring-kv2-secret-info"] -= Configuring the `hashicorp.vault.kv2_secret_info` module += Configure the `hashicorp.vault.kv2_secret_info` module [role="_abstract"] diff --git a/downstream/modules/vault-aap/proc-vault-configuring-kv2-secret.adoc b/downstream/modules/vault-aap/proc-vault-configuring-kv2-secret.adoc index 942737946a..21f74661cf 100644 --- a/downstream/modules/vault-aap/proc-vault-configuring-kv2-secret.adoc +++ b/downstream/modules/vault-aap/proc-vault-configuring-kv2-secret.adoc @@ -2,7 +2,7 @@ [id="vault-configuring-kv2-secret"] -= Configuring the `hashicorp.vault.kv2_secret` module += Configure the `hashicorp.vault.kv2_secret` module [role="_abstract"] diff --git a/downstream/modules/vault-aap/proc-vault-creating-credential-type.adoc b/downstream/modules/vault-aap/proc-vault-creating-credential-type.adoc index 39a21a9688..ed785fddcb 100644 --- a/downstream/modules/vault-aap/proc-vault-creating-credential-type.adoc +++ b/downstream/modules/vault-aap/proc-vault-creating-credential-type.adoc @@ -2,7 +2,7 @@ [id="vault-creating-credential-type"] -= Creating a custom credential type += Create a custom credential type [role="_abstract"] diff --git a/downstream/modules/vault-aap/proc-vault-creating-custom-credential.adoc b/downstream/modules/vault-aap/proc-vault-creating-custom-credential.adoc index 0d4773adb7..bfb7678b7c 100644 --- a/downstream/modules/vault-aap/proc-vault-creating-custom-credential.adoc +++ b/downstream/modules/vault-aap/proc-vault-creating-custom-credential.adoc @@ -2,7 +2,7 @@ [id="vault-creating-custom-credential"] -= Creating a custom credential += Create a custom credential [role="_abstract"] diff --git a/downstream/titles/develop-content-with-assistant/aap-common b/downstream/titles/develop-content-with-assistant/aap-common new file mode 120000 index 0000000000..472eeb4dac --- /dev/null +++ b/downstream/titles/develop-content-with-assistant/aap-common @@ -0,0 +1 @@ +../../aap-common \ No newline at end of file diff --git a/downstream/titles/develop-content-with-assistant/attributes b/downstream/titles/develop-content-with-assistant/attributes new file mode 120000 index 0000000000..a5caaa73a5 --- /dev/null +++ b/downstream/titles/develop-content-with-assistant/attributes @@ -0,0 +1 @@ +../../attributes \ No newline at end of file diff --git a/downstream/titles/develop-content-with-assistant/devtools b/downstream/titles/develop-content-with-assistant/devtools new file mode 120000 index 0000000000..dc79f7e1fa --- /dev/null +++ b/downstream/titles/develop-content-with-assistant/devtools @@ -0,0 +1 @@ +../../assemblies/devtools \ No newline at end of file diff --git a/downstream/titles/develop-content-with-assistant/docinfo.xml b/downstream/titles/develop-content-with-assistant/docinfo.xml new file mode 100644 index 0000000000..5d9cea70fb --- /dev/null +++ b/downstream/titles/develop-content-with-assistant/docinfo.xml @@ -0,0 +1,11 @@ +Using the AI assistant to develop Ansible automation content +Red Hat Ansible Automation Platform +2.6 +Configure and use the AI assistant through the Ansible VS Code extension to develop content. + + This guide describes how to install, configure, and use the MCP server-enabled AI assistant embedded in the Ansible {VSCode} extension . + + + Red Hat Customer Content Services + + \ No newline at end of file diff --git a/downstream/titles/develop-content-with-assistant/images b/downstream/titles/develop-content-with-assistant/images new file mode 120000 index 0000000000..5fa6987088 --- /dev/null +++ b/downstream/titles/develop-content-with-assistant/images @@ -0,0 +1 @@ +../../images \ No newline at end of file diff --git a/downstream/titles/develop-content-with-assistant/master.adoc b/downstream/titles/develop-content-with-assistant/master.adoc new file mode 100644 index 0000000000..541ad9ad26 --- /dev/null +++ b/downstream/titles/develop-content-with-assistant/master.adoc @@ -0,0 +1,32 @@ +:imagesdir: images +:numbered: +:toclevels: 4 +:experimental: + +include::attributes/attributes.adoc[] + +// Book Title += Using the AI assistant to develop Ansible automation content + +Thank you for your interest in {PlatformName}. {PlatformNameShort} is a commercial offering that helps teams manage complex multi-tier deployments by adding control, knowledge, and delegation to Ansible-powered environments. + +This guide describes how to install, configure, and use the MCP server-enabled AI assistant embedded in the Ansible {VSCode} extension to develop Ansible automation content. +This document has been updated to include information for the latest release of {PlatformNameShort}. + +include::{Boilerplate}[] + +include::devtools/assembly-mcp-vscode-ext-setup.adoc[leveloffset=+1] + +include::devtools/assembly-mcp-vscode-ext-configure.adoc[leveloffset=+1] + +include::devtools/assembly-mcp-vscode-ext-manage.adoc[leveloffset=+1] + +include::devtools/assembly-mcp-vscode-ext-scaffold.adoc[leveloffset=+1] + +include::devtools/assembly-mcp-vscode-ext-validate.adoc[leveloffset=+1] + +include::devtools/assembly-mcp-vscode-ext-create-ee.adoc[leveloffset=+1] + +include::devtools/assembly-mcp-vscode-ext-run.adoc[leveloffset=+1] + + diff --git a/downstream/titles/eda/eda-user-guide/master.adoc b/downstream/titles/eda/eda-user-guide/master.adoc index 66128718fe..aa1aa5fa6b 100644 --- a/downstream/titles/eda/eda-user-guide/master.adoc +++ b/downstream/titles/eda/eda-user-guide/master.adoc @@ -27,6 +27,10 @@ include::eda/assembly-eda-set-up-rhaap-credential.adoc[leveloffset=+1] //include::eda/assembly-eda-set-up-token.adoc[leveloffset=+1] include::eda/assembly-eda-rulebook-activations.adoc[leveloffset=+1] +include::eda/assembly-eda-manage-active-rulebook-activations.adoc[leveloffset=+1] + +include::eda/assembly-eda-reuse-rulebook-activation-configurations.adoc[leveloffset=+1] + include::eda/assembly-eda-rulebook-troubleshooting.adoc[leveloffset=+1] include::eda/assembly-eda-rule-audit.adoc[leveloffset=+1] diff --git a/downstream/titles/release-notes/async/aap-26-20251006.adoc b/downstream/titles/release-notes/async/aap-26-20251006.adoc index 7cb0ef5510..5f48450a5c 100644 --- a/downstream/titles/release-notes/async/aap-26-20251006.adoc +++ b/downstream/titles/release-notes/async/aap-26-20251006.adoc @@ -10,7 +10,8 @@ This release includes the following components and versions: |==== | Release Date | Component versions -| October 6, 2025 | +| October 6, 2025 +a| * Automation controller 4.7.1 * Automation hub 4.11.0 @@ -20,8 +21,6 @@ This release includes the following components and versions: * Receptor 1.5.7 * RPM-based installer Ansible Automation Platform (bundle) 2.6-1 * RPM-based installer Ansible Automation Platform (online) 2.6-1 -| - |==== CSV Versions in this release: diff --git a/downstream/titles/release-notes/async/aap-26-20251016.adoc b/downstream/titles/release-notes/async/aap-26-20251016.adoc index a1f58fee84..a87a1a7ee5 100644 --- a/downstream/titles/release-notes/async/aap-26-20251016.adoc +++ b/downstream/titles/release-notes/async/aap-26-20251016.adoc @@ -10,7 +10,8 @@ This release includes the following components and versions: |==== | Release Date | Component versions -| October 16, 2025 | +| October 16, 2025 +a| * Automation controller 4.7.2 * Automation hub 4.11.1 @@ -20,8 +21,6 @@ This release includes the following components and versions: * Receptor 1.5.7 * RPM-based installer Ansible Automation Platform (bundle) 2.6-1.1 * RPM-based installer Ansible Automation Platform (online) 2.6-1 -| - |==== CSV Versions in this release: diff --git a/downstream/titles/release-notes/async/aap-26-20251028.adoc b/downstream/titles/release-notes/async/aap-26-20251028.adoc index 676164bf6f..0f24b704c9 100644 --- a/downstream/titles/release-notes/async/aap-26-20251028.adoc +++ b/downstream/titles/release-notes/async/aap-26-20251028.adoc @@ -10,7 +10,8 @@ This release includes the following components and versions: |==== | Release Date | Component versions -| October 28, 2025 | +| October 28, 2025 +a| * {ControllerNameStart} 4.7.4 * {HubNameStart} 4.11.2 @@ -20,8 +21,6 @@ This release includes the following components and versions: * Receptor 1.6.0 * RPM-based installer {PlatformNameShort} (bundle) 2.6-2 * RPM-based installer {PlatformNameShort} (online) 2.6-2 -| - |==== CSV Versions in this release: diff --git a/downstream/titles/release-notes/async/aap-26-20251105.adoc b/downstream/titles/release-notes/async/aap-26-20251105.adoc index 97c682f39c..a2a9a01b73 100644 --- a/downstream/titles/release-notes/async/aap-26-20251105.adoc +++ b/downstream/titles/release-notes/async/aap-26-20251105.adoc @@ -10,7 +10,8 @@ This release includes the following components and versions: |==== | Release Date | Component versions -| November 5, 2025 | +| November 5, 2025 +a| * {ControllerNameStart} 4.7.4 * {HubNameStart} 4.11.2 @@ -20,8 +21,6 @@ This release includes the following components and versions: * Receptor 1.6.0 * RPM-based installer {PlatformNameShort} (bundle) 2.6-2 * RPM-based installer {PlatformNameShort} (online) 2.6-2 -| - |==== CSV Versions in this release: diff --git a/downstream/titles/release-notes/async/aap-26-20251119.adoc b/downstream/titles/release-notes/async/aap-26-20251119.adoc index 1fae59031c..13d4d1692a 100644 --- a/downstream/titles/release-notes/async/aap-26-20251119.adoc +++ b/downstream/titles/release-notes/async/aap-26-20251119.adoc @@ -10,7 +10,8 @@ This release includes the following components and versions: |==== | Release Date | Component versions -| November 19, 2025 | +| November 19, 2025 +a| * {ControllerNameStart} 4.7.5 * {HubNameStart} 4.11.3 @@ -20,8 +21,6 @@ This release includes the following components and versions: * Receptor 1.6.2 * RPM-based installer {PlatformNameShort} (bundle) 2.6-3 * RPM-based installer {PlatformNameShort} (online) 2.6-3 -| - |==== CSV Versions in this release: diff --git a/downstream/titles/release-notes/async/aap-26-20251210.adoc b/downstream/titles/release-notes/async/aap-26-20251210.adoc index d69be0650c..2f0e16db93 100644 --- a/downstream/titles/release-notes/async/aap-26-20251210.adoc +++ b/downstream/titles/release-notes/async/aap-26-20251210.adoc @@ -10,7 +10,8 @@ This release includes the following components and versions: |==== | Release Date | Component versions -| December 10, 2025 | +| December 10, 2025 +a| * {ControllerNameStart} 4.7.6 * {HubNameStart} 4.11.4 @@ -20,8 +21,6 @@ This release includes the following components and versions: * Receptor 1.6.2 * RPM-based installer {PlatformNameShort} (bundle) 2.6-3.1 * RPM-based installer {PlatformNameShort} (online) 2.6-3 -| - |==== CSV Versions in this release: diff --git a/downstream/titles/release-notes/async/aap-26-20260106.adoc b/downstream/titles/release-notes/async/aap-26-20260106.adoc index f5b2cb33cb..4b4299d4fe 100644 --- a/downstream/titles/release-notes/async/aap-26-20260106.adoc +++ b/downstream/titles/release-notes/async/aap-26-20260106.adoc @@ -10,7 +10,8 @@ This release includes the following components and versions: |==== | Release Date | Component versions -| January 6, 2026 | +| January 6, 2026 +a| * {ControllerNameStart} 4.7.6 * {HubNameStart} 4.11.4 @@ -20,8 +21,6 @@ This release includes the following components and versions: * Receptor 1.6.2 * RPM-based installer {PlatformNameShort} (bundle) 2.6-3.2 * RPM-based installer {PlatformNameShort} (online) 2.6-3 -| - |==== CSV Versions in this release: diff --git a/downstream/titles/self-service-config/master.adoc b/downstream/titles/self-service-config/master.adoc index 3c0f2fa1dd..862d940c1b 100644 --- a/downstream/titles/self-service-config/master.adoc +++ b/downstream/titles/self-service-config/master.adoc @@ -20,8 +20,7 @@ include::assemblies/devtools/ref-devspaces-aap-sync-config-ref.adoc[leveloffset= include::assemblies/devtools/ref-devspaces-aap-sync-examples.adoc[leveloffset=+1] -//[gmurray] Commenting out until content is ready to be published. See AAP-60016 for details -//include::assemblies/devtools/ref-devspaces-rbac-and-display-logic.adoc[leveloffset=+1] +include::assemblies/devtools/ref-devspaces-rbac-and-display-logic.adoc[leveloffset=+1] include::assemblies/devtools/ref-devspaces-aap-sync-troubleshooting.adoc[leveloffset=+1] diff --git a/downstream/titles/self-service-using/master.adoc b/downstream/titles/self-service-using/master.adoc index 0c0d35ccc5..499bba0839 100644 --- a/downstream/titles/self-service-using/master.adoc +++ b/downstream/titles/self-service-using/master.adoc @@ -29,7 +29,6 @@ include::devtools/assembly-self-service-rbac.adoc[leveloffset=+1] include::devtools/assembly-backstage-software-templates.adoc[leveloffset=+1] -//[gmurray] commenting out until ready for tect preview which is scheduled for Jan 25, 2026 -//include::devtools/assembly-self-service-create-ee-definitions.adoc[leveloffset=+1] +include::devtools/assembly-self-service-create-ee-definitions.adoc[leveloffset=+1] include::devtools/assembly-self-service-feedback.adoc[leveloffset=+1] \ No newline at end of file