diff --git a/downstream/assemblies/platform/assembly-gateway-licensing.adoc b/downstream/assemblies/platform/assembly-gateway-licensing.adoc index 40ae1003db..ba5e965498 100644 --- a/downstream/assemblies/platform/assembly-gateway-licensing.adoc +++ b/downstream/assemblies/platform/assembly-gateway-licensing.adoc @@ -11,13 +11,19 @@ Ansible is an open source software project and is licensed under the GNU General You must have valid subscriptions attached before installing {PlatformNameShort}. -For more information, see xref:proc-attaching-subscriptions[Attaching Subscriptions]. +For more information, see link:{BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html-single/installing_on_openshift_container_platform/index#proc-attaching-subscriptions[Attaching Subscriptions]. include::platform/ref-controller-trial-evaluation.adoc[leveloffset=+1] + include::platform/ref-controller-licenses.adoc[leveloffset=+1] + include::platform/ref-controller-node-counting.adoc[leveloffset=+1] + include::platform/ref-controller-subscription-types.adoc[leveloffset=+1] + include::platform/proc-attaching-subscriptions.adoc[leveloffset=+1] + include::assembly-aap-manifest-files.adoc[leveloffset=+1] + include::assembly-aap-activate.adoc[leveloffset=+1] \ No newline at end of file diff --git a/downstream/assemblies/platform/assembly-install-aap-operator.adoc b/downstream/assemblies/platform/assembly-install-aap-operator.adoc index ce7861c8e7..d228c32deb 100644 --- a/downstream/assemblies/platform/assembly-install-aap-operator.adoc +++ b/downstream/assemblies/platform/assembly-install-aap-operator.adoc @@ -35,7 +35,7 @@ You cannot deploy {PlatformNameShort} in the default namespace on your OpenShift ==== -.Prerequisites +== Prerequisites * You have installed the {PlatformName} catalog in OperatorHub. * You have created a `StorageClass` object for your platform and a persistent volume claim (PVC) with `ReadWriteMany` access mode. See link:https://docs.openshift.com/container-platform/{OCPLatest}/storage/dynamic-provisioning.html[Dynamic provisioning] for details. * To run {OCP} clusters on Amazon Web Services (AWS) with `ReadWriteMany` access mode, you must add NFS or other storage. diff --git a/downstream/assemblies/platform/assembly-installing-aap-operator-cli.adoc b/downstream/assemblies/platform/assembly-installing-aap-operator-cli.adoc index 4dff4ee9eb..47e385d26d 100644 --- a/downstream/assemblies/platform/assembly-installing-aap-operator-cli.adoc +++ b/downstream/assemblies/platform/assembly-installing-aap-operator-cli.adoc @@ -25,14 +25,16 @@ You can use the {OCPShort} CLI to fetch the web address and the password of the To login to the {Gateway}, you need the web address and the password. include::platform/proc-cli-get-controller-address.adoc[leveloffset=+1] + include::platform/proc-cli-get-controller-pwd.adoc[leveloffset=+1] + include::platform/proc-cli-get-controller-pwd-decode.adoc[leveloffset=+1] [role="_additional-resources"] == Additional resources -* For more information on running operators on OpenShift Container Platform, navigate to the link:{BaseURL}/openshift_container_platform/[OpenShift Container Platform product documentation] and click the _Operators - Working with Operators in OpenShift Container Platform_ guide. +* link:{BaseURL}/openshift_container_platform/[OpenShift Container Platform product documentation] ifdef::parent-context[:context: {parent-context}] ifndef::parent-context[:!context:] diff --git a/downstream/assemblies/platform/assembly-installing-controller-operator.adoc b/downstream/assemblies/platform/assembly-installing-controller-operator.adoc index d347086c4e..067ab7d3dc 100644 --- a/downstream/assemblies/platform/assembly-installing-controller-operator.adoc +++ b/downstream/assemblies/platform/assembly-installing-controller-operator.adoc @@ -22,7 +22,7 @@ You can use these instructions to configure the {ControllerName} operator on {OC [NOTE] ==== -When an instance of {ControllerName} is removed, the associated PVCs are not automatically deleted. This can cause issues during migration if the new deployment has the same name as the previous one. Therefore, it is recommended that you manually remove old PVCs before deploying a new {ControllerName} instance in the same namespace. See xref:proc-find-delete-PVCs_{context}[Finding and deleting PVCs] for more information. +When an instance of {ControllerName} is removed, the associated PVCs are not automatically deleted. This can cause issues during migration if the new deployment has the same name as the previous one. Therefore, it is recommended that you manually remove old PVCs before deploying a new {ControllerName} instance in the same namespace. See link:{BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html-single/installing_on_openshift_container_platform/index#proc-find-delete-PVCs_installing-controller-operator[Finding and deleting PVCs] for more information. ==== @@ -34,19 +34,6 @@ When an instance of {ControllerName} is removed, the associated PVCs are not aut * For {ControllerName}, a default StorageClass must be configured on the cluster for the operator to dynamically create needed PVCs. This is not necessary if an external PostgreSQL database is configured. * For Hub a StorageClass that supports ReadWriteMany must be available on the cluster to dynamically created the PVC needed for the content, redis and api pods. If it is not the default StorageClass on the cluster, you can specify it when creating your AutomationHub object. -//Not relevant for 2.5 EA, commenting out section [gmurray] -//== Installing the {ControllerName} operator -//Use this procedure to install the {ControllerName} operator. - -//.Procedure - -//. Navigate to menu:Operators[Installed Operators], then click on the *Ansible Automation Platform* operator. -//. Locate the *Automation controller* tab, then click btn:[Create instance]. - -//You can proceed with configuring the instance using either the Form View or YAML view. - - -//include::platform/proc-creating-controller-form-view.adoc[leveloffset=+2] include::platform/proc-configuring-controller-image-pull-policy.adoc[leveloffset=+2] include::platform/proc-configuring-controller-ldap-security.adoc[leveloffset=+2] @@ -62,7 +49,7 @@ include::platform/proc-find-delete-PVCs.adoc[leveloffset=+1] [role="_additional-resources"] == Additional resources -* For more information on running operators on OpenShift Container Platform, navigate to the link:{BaseURL}/openshift_container_platform/[OpenShift Container Platform product documentation] and click the _Operators - Working with Operators in OpenShift Container Platform_ guide. +* link:{BaseURL}/openshift_container_platform/[OpenShift Container Platform product documentation] ifdef::parent-context[:context: {parent-context}] ifndef::parent-context[:!context:] diff --git a/downstream/assemblies/platform/assembly-installing-hub-operator.adoc b/downstream/assemblies/platform/assembly-installing-hub-operator.adoc index 748a92d671..1b9e980ef0 100644 --- a/downstream/assemblies/platform/assembly-installing-hub-operator.adoc +++ b/downstream/assemblies/platform/assembly-installing-hub-operator.adoc @@ -67,7 +67,7 @@ include::platform/proc-aap-add-allowed-registries.adoc[leveloffset=+1] [role="_additional-resources"] == Additional resources -* For more information on running operators on OpenShift Container Platform, navigate to the link:{BaseURL}/openshift_container_platform/[OpenShift Container Platform product documentation] and click the _Operators - Working with Operators in OpenShift Container Platform_ guide. +* link:{BaseURL}/openshift_container_platform/[OpenShift Container Platform product documentation] ifdef::parent-context[:context: {parent-context}] ifndef::parent-context[:!context:] diff --git a/downstream/modules/platform/con-aap-migrate-SAML-users.adoc b/downstream/modules/platform/con-aap-migrate-SAML-users.adoc index c3a2af910d..11cc0bf04e 100644 --- a/downstream/modules/platform/con-aap-migrate-SAML-users.adoc +++ b/downstream/modules/platform/con-aap-migrate-SAML-users.adoc @@ -40,4 +40,4 @@ Once you set up the auto migrate functionality, you should be able to login with [role="_additional-resources"] .Additional resources -Refer to link:https://interact.redhat.com/share/baxthgXBQZ3kSRKPLn5L[{PlatformNameShort} 2.4 to 2.5. Linking accounts post upgrade, and Setting up SAML authentication] for a demonstration of the post upgrade steps. +link:https://interact.redhat.com/share/baxthgXBQZ3kSRKPLn5L[{PlatformNameShort} 2.4 to 2.5. Linking accounts post upgrade, and Setting up SAML authentication] \ No newline at end of file diff --git a/downstream/modules/platform/con-aap-migrate-normal-users.adoc b/downstream/modules/platform/con-aap-migrate-normal-users.adoc index 8edb8295d0..3af7888cb5 100644 --- a/downstream/modules/platform/con-aap-migrate-normal-users.adoc +++ b/downstream/modules/platform/con-aap-migrate-normal-users.adoc @@ -14,4 +14,4 @@ When you upgrade from {PlatformNameShort} 2.4 to 2.5, your existing user account == Additional resources -* See link:{URLCentralAuth}/gw-managing-access#proc-controller-creating-a-user[Creating a user] for more information on user types. +* link:{URLCentralAuth}/gw-managing-access#proc-controller-creating-a-user[Creating a user] diff --git a/downstream/modules/platform/con-operator-upgrade-overview.adoc b/downstream/modules/platform/con-operator-upgrade-overview.adoc index 2b6b61efda..e98a64c0f0 100644 --- a/downstream/modules/platform/con-operator-upgrade-overview.adoc +++ b/downstream/modules/platform/con-operator-upgrade-overview.adoc @@ -3,6 +3,7 @@ [id="operator-upgrade-overview"] = Overview + You can use this document for help with upgrading {PlatformNameShort} 2.4 to 2.5 on {OCP}. This document applies to upgrades of {PlatformNameShort} 2.5 to later versions of 2.5. 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 067a0fe7f2..4069a11a8c 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 @@ -16,5 +16,5 @@ In addition, {ODFShort} provides a `ReadWriteMany` or S3-compliant implementatio [role="_additional-resources"] .Additional resources -* link:https://docs.openshift.com/container-platform/{OCPLatest}/storage/persistent_storage/persistent-storage-nfs.html[Persistent storage using NFS] in the {OCPShort} _Storage_ guide -* IBM's link:https://www.ibm.com/support/pages/how-do-i-create-storage-class-nfs-dynamic-storage-provisioning-openshift-environment[How do I create a storage class for NFS dynamic storage provisioning in an OpenShift environment?] +* link:https://docs.openshift.com/container-platform/{OCPLatest}/storage/persistent_storage/persistent-storage-nfs.html[Persistent storage using NFS] +* link:https://www.ibm.com/support/pages/how-do-i-create-storage-class-nfs-dynamic-storage-provisioning-openshift-environment[How do I create a storage class for NFS dynamic storage provisioning in an OpenShift environment?] diff --git a/downstream/modules/platform/proc-aap-add-merge-subscriptions.adoc b/downstream/modules/platform/proc-aap-add-merge-subscriptions.adoc index a8a5d91f90..efc667ab51 100644 --- a/downstream/modules/platform/proc-aap-add-merge-subscriptions.adoc +++ b/downstream/modules/platform/proc-aap-add-merge-subscriptions.adoc @@ -16,4 +16,4 @@ Once an allocation is created, you can add the subscriptions you need for {Platf [role="_additional-resources"] .Next steps -* xref:proc-aap-generate-manifest-file[Download the manifest file] from Red Hat Subscription Management. \ No newline at end of file +* link:{BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html-single/installing_on_openshift_container_platform/index#proc-aap-generate-manifest-file[Download the manifest file]. \ No newline at end of file diff --git a/downstream/modules/platform/proc-aap-create-subscription-allocation.adoc b/downstream/modules/platform/proc-aap-create-subscription-allocation.adoc index 9f16daf957..cedd231a3b 100644 --- a/downstream/modules/platform/proc-aap-create-subscription-allocation.adoc +++ b/downstream/modules/platform/proc-aap-create-subscription-allocation.adoc @@ -15,4 +15,4 @@ Creating a new subscription allocation allows you to set aside subscriptions and [role="_additional-resources"] .Next steps -* xref:proc-add-merge-subscriptions[Add the subscriptions] needed for {PlatformNameShort} to run properly. \ No newline at end of file +* link:{BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html-single/installing_on_openshift_container_platform/index#proc-add-merge-subscriptions[Add the subscriptions]. \ No newline at end of file diff --git a/downstream/modules/platform/proc-aap-generate-manifest-file.adoc b/downstream/modules/platform/proc-aap-generate-manifest-file.adoc index a4ea815ac7..7871ffdb7f 100644 --- a/downstream/modules/platform/proc-aap-generate-manifest-file.adoc +++ b/downstream/modules/platform/proc-aap-generate-manifest-file.adoc @@ -17,4 +17,4 @@ This downloads a file _manifest__.zip_ to your default do [role="_additional-resources"] .Next steps -* link:{URLCentralAuth}/assembly-gateway-licensing#proc-aap-activate-with-manifest[Upload the manifest file] to activate {PlatformName}. +* link:{URLCentralAuth}/assembly-gateway-licensing#proc-aap-activate-with-manifest[Upload the manifest file]. diff --git a/downstream/modules/platform/proc-access-hub-operator-ui.adoc b/downstream/modules/platform/proc-access-hub-operator-ui.adoc index 2b59ae50b8..8708414e34 100644 --- a/downstream/modules/platform/proc-access-hub-operator-ui.adoc +++ b/downstream/modules/platform/proc-access-hub-operator-ui.adoc @@ -11,6 +11,7 @@ You can access the {HubName} through the {Gateway} or through the following proc . Navigate to menu:Networking[Routes]. . Under *Location*, click on the URL for your {HubName} instance. +.Verification The {HubName} user interface launches where you can sign in with the administrator credentials specified during the operator configuration process. [NOTE] diff --git a/downstream/modules/platform/proc-account-linking.adoc b/downstream/modules/platform/proc-account-linking.adoc index 010384d2b5..3eae70e984 100644 --- a/downstream/modules/platform/proc-account-linking.adoc +++ b/downstream/modules/platform/proc-account-linking.adoc @@ -13,12 +13,13 @@ The first time you log in to {PlatformNameShort} 2.5, the platform searches thro To address this problem, use the account linking procedure to authenticate from any of your existing component accounts and still be recognized by the platform. Linking accounts associates existing component accounts with the same user profile. +If you have completed the upgrade process and have a legacy {PlatformNameShort} subscription, follow the account linking procedure below to migrate your account to {PlatformNameShort} 2.5. + .Prerequisites * You have completed the upgrade process and have a legacy {PlatformNameShort} account and credentials. .Procedure -If you have completed the upgrade process and have a legacy {PlatformNameShort} subscription, follow the account linking procedure below to migrate your account to {PlatformNameShort} 2.5. . Navigate to the login page for {PlatformNameShort}. . In the login modal, select either *I have an {ControllerName} account* or *I have an {HubName} account* based on the credentials you have. @@ -32,13 +33,13 @@ If you are logging in using OIDC credentials, see link:https://access.redhat.com . If you have successfully linked your account, the next screen shows your username with a green checkmark beside it. If you have other legacy accounts that you want to link, enter those account credentials and click btn:[Link] to link them to your centralized {Gateway} account. . Click btn:[Submit] to complete linking your legacy accounts. . After your accounts are linked, depending on your authentication method, you might be prompted to create a new username and password. These credentials will replace your legacy credentials for each component account. - -You can also link your legacy account manually by taking the following steps: - +* You can also link your legacy account manually by taking the following steps: . Select your user icon at the top right of your screen, and select *User details*. . Select the btn:[More Actions] icon *{MoreActionsIcon}* > *Link user accounts*. . Enter the credentials for the account that you want to link. +.Troubleshooting + If you encounter an error message telling you that your account could not be authenticated, contact your platform administrator. [NOTE] @@ -46,7 +47,7 @@ If you encounter an error message telling you that your account could not be aut If you log into {PlatformNameShort} for the first time and are prompted to change your username, this is an indication that another user has already logged into {PlatformNameShort} with the same username. To proceed with account migration, follow the prompts to change your username. {PlatformNameShort} uses your password to authenticate which account or accounts belong to you. ==== -.A diagram of the account linking flow +*A diagram of the account linking flow* image:account-linking-flow.png[Account linking flow] After you have migrated your user account, you can manage your account from the *Access Management* menu. See link:{URLCentralAuth}/gw-managing-access[Managing access with role based access control]. diff --git a/downstream/modules/platform/proc-add-controller-access-token.adoc b/downstream/modules/platform/proc-add-controller-access-token.adoc index a7d6fd7880..a92c21ff8a 100644 --- a/downstream/modules/platform/proc-add-controller-access-token.adoc +++ b/downstream/modules/platform/proc-add-controller-access-token.adoc @@ -6,13 +6,15 @@ To connect {OperatorResourceShort} with {Gateway} you must create a Kubernetes secret with the connection information for your {ControllerName} instance. +Use the following procedure to create an OAuth2 token for your user in the {Gateway} UI. + [NOTE] ==== You can only create OAuth 2 Tokens for your own user through the API or UI, which means you can only configure or view tokens from your own user profile. ==== .Procedure -To create an OAuth2 token for your user in the {Gateway} UI: + . Log in to {OCP}. . In the navigation panel, select menu:Access Management[Users]. @@ -20,9 +22,10 @@ To create an OAuth2 token for your user in the {Gateway} UI: . Select menu:Tokens[Automation Execution] . Click btn:[Create Token]. . You can leave *Applications* empty. Add a description and select *Read* or *Write* for the *Scope*. - ++ [NOTE] ==== Make sure you provide a valid user when creating tokens. Otherwise, you get an error message that you tried to issue the command without either specifying a user, or supplying a username that does not exist. -==== \ No newline at end of file +==== ++ \ No newline at end of file diff --git a/downstream/modules/platform/proc-add-operator-execution-nodes.adoc b/downstream/modules/platform/proc-add-operator-execution-nodes.adoc index ae2c7673cb..881adbadfd 100644 --- a/downstream/modules/platform/proc-add-operator-execution-nodes.adoc +++ b/downstream/modules/platform/proc-add-operator-execution-nodes.adoc @@ -53,4 +53,4 @@ watch podman ps ---- .Additional resources -* For more information about managing instance groups see the link:{BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html-single/using_automation_execution/index#controller-instance-groups[Managing Instance Groups] section of the Automation Controller User Guide. +* link:{BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html-single/using_automation_execution/index#controller-instance-groups[Managing Instance Groups] \ No newline at end of file diff --git a/downstream/modules/platform/proc-attaching-subscriptions.adoc b/downstream/modules/platform/proc-attaching-subscriptions.adoc index da973fde1e..a49989b8c0 100644 --- a/downstream/modules/platform/proc-attaching-subscriptions.adoc +++ b/downstream/modules/platform/proc-attaching-subscriptions.adoc @@ -34,21 +34,6 @@ $ sudo subscription-manager list --available --all | grep "Ansible Automation Pl Do not use MCT4022 as a `pool_id` for your subscription because it can cause {PlatformNameShort} subscription attachment to fail. ==== + -.Example -An example output of the `*subsciption-manager list*` command. Obtain the `pool_id` as seen in the `Pool ID:` section: -+ ------ -Subscription Name: Red Hat Ansible Automation, Premium (5000 Managed Nodes) - Provides: Red Hat Ansible Engine - Red Hat Ansible Automation Platform - SKU: MCT3695 - Contract: ```` - Pool ID: - Provides Management: No - Available: 4999 - Suggested: 1 ------ -+ . Attach the subscription: + ----- diff --git a/downstream/modules/platform/proc-cli-get-controller-address.adoc b/downstream/modules/platform/proc-cli-get-controller-address.adoc index f67078d18f..5182058794 100644 --- a/downstream/modules/platform/proc-cli-get-controller-address.adoc +++ b/downstream/modules/platform/proc-cli-get-controller-address.adoc @@ -12,11 +12,12 @@ The route inherits the name that you assigned to the {Gateway} object in the YAM .Procedure * Use the following command to fetch the routes: - ++ [subs="+quotes"] ----- oc get routes -n ____ ----- ++ .Verification 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 76d5b007ae..7061b1654e 100644 --- a/downstream/modules/platform/proc-configuring-controller-image-pull-policy.adoc +++ b/downstream/modules/platform/proc-configuring-controller-image-pull-policy.adoc @@ -3,6 +3,7 @@ [id="proc-configuring-controller-image-pull-policy_{context}"] = Configuring your controller image pull policy + Use this procedure to configure the image pull policy on your {ControllerName}. .Procedure diff --git a/downstream/modules/platform/proc-controller-ingress-options.adoc b/downstream/modules/platform/proc-controller-ingress-options.adoc index 9a18e87006..c2a200759d 100644 --- a/downstream/modules/platform/proc-controller-ingress-options.adoc +++ b/downstream/modules/platform/proc-controller-ingress-options.adoc @@ -19,12 +19,12 @@ The {OperatorPlatformNameShort} installation form allows you to further configur . Under *Ingress annotations*, enter any annotations to add to the ingress. . Under *Ingress TLS secret*, click the drop-down menu and select a secret from the list. +.Verification + After you have configured your {ControllerName} operator, click btn:[Create] at the bottom of the form view. {OCP} creates the pods. This may take a few minutes. You can view the progress by navigating to menu:Workloads[Pods] and locating the newly created instance. -.Verification - Verify that the following operator pods provided by the {PlatformNameShort} Operator installation from {ControllerName} are running: [cols="a,a,a,a"] |=== diff --git a/downstream/modules/platform/proc-create-a-connection-secret.adoc b/downstream/modules/platform/proc-create-a-connection-secret.adoc index 66fefa318e..7b164a456b 100644 --- a/downstream/modules/platform/proc-create-a-connection-secret.adoc +++ b/downstream/modules/platform/proc-create-a-connection-secret.adoc @@ -3,6 +3,7 @@ [id="proc-create-connection-secret_{context}"] = Creating a {ControllerName} connection secret for {OperatorResourceShort} + To make your connection information available to the {OperatorResourceShort}, create a k8s secret with the token and host value. .Procedure diff --git a/downstream/modules/platform/proc-create-an-ansiblejob.adoc b/downstream/modules/platform/proc-create-an-ansiblejob.adoc index bf4c4b2447..cdb866a4a0 100644 --- a/downstream/modules/platform/proc-create-an-ansiblejob.adoc +++ b/downstream/modules/platform/proc-create-an-ansiblejob.adoc @@ -3,6 +3,7 @@ [id="proc-create-an-ansiblejob_{context}"] = Creating an AnsibleJob custom resource + An AnsibleJob custom resource launches a job in the {ControllerName} instance specified in the Kubernetes secret ({ControllerName} host URL, token). You can launch an automation job on {ControllerName} by creating an AnsibleJob resource. diff --git a/downstream/modules/platform/proc-hub-ingress-options.adoc b/downstream/modules/platform/proc-hub-ingress-options.adoc index 15f71ed1ed..eaf7542d1a 100644 --- a/downstream/modules/platform/proc-hub-ingress-options.adoc +++ b/downstream/modules/platform/proc-hub-ingress-options.adoc @@ -19,12 +19,12 @@ The {OperatorPlatformNameShort} installation form allows you to further configur . Under *Ingress annotations*, enter any annotations to add to the ingress. . Under *Ingress TLS secret*, click the drop-down menu and select a secret from the list. +.Verification + After you have configured your {HubName} operator, click btn:[Create] at the bottom of the form view. {OCP} creates the pods. This may take a few minutes. You can view the progress by navigating to menu:Workloads[Pods] and locating the newly created instance. -.Verification - Verify that the following operator pods provided by the {PlatformNameShort} Operator installation from {HubName} are running: [cols="a,a,a"] |=== diff --git a/downstream/modules/platform/proc-install-aap-operator.adoc b/downstream/modules/platform/proc-install-aap-operator.adoc index b8e4b97731..248237aaa2 100644 --- a/downstream/modules/platform/proc-install-aap-operator.adoc +++ b/downstream/modules/platform/proc-install-aap-operator.adoc @@ -7,7 +7,6 @@ . Navigate to menu:Operators[OperatorHub]. . Search for {PlatformNameShort} and click btn:[Install]. . Select an *Update Channel*: -+ * *stable-2.x*: installs a namespace-scoped operator, which limits deployments of {HubName} and {ControllerName} instances to the namespace the operator is installed in, this is suitable for most cases. The stable-2.x channel does not require administrator privileges and utilizes fewer resources because it only monitors a single namespace. * *stable-2.x-cluster-scoped*: installs the {OperatorPlatformNameShort} in a single namespace that manages {PlatformNameShort} custom resources and deployments in all namespaces. @@ -15,10 +14,10 @@ The {OperatorPlatformNameShort} requires administrator privileges for all namesp . Select *Installation Mode*, *Installed Namespace*, and *Approval Strategy*. . Click btn:[Install]. -The installation process begins. When installation finishes, a modal appears notifying you that the {OperatorPlatformNameShort} is installed in the specified namespace. - .Verification +The installation process begins. When installation finishes, a modal appears notifying you that the {OperatorPlatformNameShort} is installed in the specified namespace. + * Click btn:[View Operator] to view your newly installed {OperatorPlatformNameShort} and verify the following operator custom resources are present: [cols="a,a,a,a"] diff --git a/downstream/modules/platform/proc-operator-access-aap.adoc b/downstream/modules/platform/proc-operator-access-aap.adoc index abe57a75a5..41c0cd1a38 100644 --- a/downstream/modules/platform/proc-operator-access-aap.adoc +++ b/downstream/modules/platform/proc-operator-access-aap.adoc @@ -3,6 +3,7 @@ [id="operator-access-aap_{context}"] = Accessing the {Gateway} + You should use the *{PlatformNameShort}* instance as your default. This instance links the {ControllerName}, {HubName}, and {EDAName} deployments to a single interface. @@ -23,12 +24,14 @@ To access your *{PlatformNameShort}* instance: .. Click btn:[Subscription manifest] or btn:[Username/password]. .. Upload your manifest or enter your username and password. .. Select your subscription from the *Subscription* list. -.. Click btn:[Next]. + -This redirects you to the *Analytics* page. +.. Click btn:[Next]. This redirects you to the *Analytics* page. . Click btn:[Next]. . Select the *I agree to the terms of the license agreement* checkbox. . Click btn:[Next]. +.Verification You now have access to the {Gateway} user interface. + +.Troubleshooting If you cannot access the {PlatformNameShort} see link:{BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html-single/installing_on_openshift_container_platform/index#operator-aap-troubleshooting_configure-aap-operator[Frequently asked questions on {Gateway}] for help with troubleshooting and debugging. diff --git a/downstream/modules/platform/proc-operator-config-csrf-gateway.adoc b/downstream/modules/platform/proc-operator-config-csrf-gateway.adoc index 35038a8a0d..af69b57896 100644 --- a/downstream/modules/platform/proc-operator-config-csrf-gateway.adoc +++ b/downstream/modules/platform/proc-operator-config-csrf-gateway.adoc @@ -26,14 +26,12 @@ spec: value: - https://my-aap-domain.com ---- - ++ . After you have configured your {Gateway}, click btn:[Create] at the bottom of the form view (Or btn:[Save] in the case of editing existing instances). -{OCP} creates the pods. This may take a few minutes. You can view the progress by navigating to menu:Workloads[Pods] and locating the newly created instance. - .Verification -Verify that the following operator pods provided by the {OperatorPlatformName} installation from {Gateway} are running: +{OCP} creates the pods. This may take a few minutes. You can view the progress by navigating to menu:Workloads[Pods] and locating the newly created instance. Verify that the following operator pods provided by the {OperatorPlatformName} installation from {Gateway} are running: [cols="a,a,a,a,a"] |=== diff --git a/downstream/modules/platform/proc-operator-create-controller-inventory.adoc b/downstream/modules/platform/proc-operator-create-controller-inventory.adoc index f2838f4e82..e64f902fc3 100644 --- a/downstream/modules/platform/proc-operator-create-controller-inventory.adoc +++ b/downstream/modules/platform/proc-operator-create-controller-inventory.adoc @@ -11,7 +11,7 @@ For more information see the link:{BaseURL}/red_hat_ansible_automation_platform/ .Procedure * Create an inventory on {ControllerName} by creating an inventory custom resource: - ++ ---- metadata: name: inventory-new @@ -34,4 +34,4 @@ spec: string: "string_value" number: 2 ---- - ++ diff --git a/downstream/modules/platform/proc-operator-create-controller-project.adoc b/downstream/modules/platform/proc-operator-create-controller-project.adoc index 9aad8d91d0..ccf8fcdb92 100644 --- a/downstream/modules/platform/proc-operator-create-controller-project.adoc +++ b/downstream/modules/platform/proc-operator-create-controller-project.adoc @@ -9,7 +9,7 @@ A Project is a logical collection of Ansible playbooks, represented in {Controll .Procedure * Create a project on {ControllerName} by creating an {ControllerName} project custom resource: - ++ ---- apiVersion: tower.ansible.com/v1alpha1 kind: AnsibleProject @@ -24,4 +24,5 @@ spec: description: demoProject connection_secret: controller-access runner_pull_policy: IfNotPresent ----- \ No newline at end of file +---- ++ \ No newline at end of file diff --git a/downstream/modules/platform/proc-operator-create-controller-schedule.adoc b/downstream/modules/platform/proc-operator-create-controller-schedule.adoc index a199fd0e73..bfc24386a1 100644 --- a/downstream/modules/platform/proc-operator-create-controller-schedule.adoc +++ b/downstream/modules/platform/proc-operator-create-controller-schedule.adoc @@ -7,7 +7,7 @@ .Procedure * Create a schedule on {ControllerName} by creating an {ControllerName} schedule custom resource: - ++ ---- apiVersion: tower.ansible.com/v1alpha1 kind: AnsibleSchedule @@ -19,4 +19,5 @@ spec: name: "Demo Schedule" rrule: "DTSTART:20210101T000000Z RRULE:FREQ=DAILY;INTERVAL=1;COUNT=1" unified_job_template: "Demo Job Template" ----- \ No newline at end of file +---- ++ \ No newline at end of file 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 d3ee5af167..ea3cd042ed 100644 --- a/downstream/modules/platform/proc-operator-create-controller-workflow-template.adoc +++ b/downstream/modules/platform/proc-operator-create-controller-workflow-template.adoc @@ -10,7 +10,7 @@ For more information see the link:{BaseURL}/red_hat_ansible_automation_platform/ .Procedure * Create a workflow template on {ControllerName} by creating a workflow template custom resource: - ++ ---- apiVersion: tower.ansible.com/v1alpha1 kind: WorkflowTemplate @@ -38,3 +38,4 @@ spec: name: Default type: job_template ---- ++ \ No newline at end of file diff --git a/downstream/modules/platform/proc-operator-create-controller-workflow.adoc b/downstream/modules/platform/proc-operator-create-controller-workflow.adoc index c8423f8b96..1a790e2495 100644 --- a/downstream/modules/platform/proc-operator-create-controller-workflow.adoc +++ b/downstream/modules/platform/proc-operator-create-controller-workflow.adoc @@ -10,7 +10,7 @@ For more information see the link:{BaseURL}/red_hat_ansible_automation_platform/ .Procedure * Create a workflow on {ControllerName} by creating a workflow custom resource: - ++ ---- apiVersion: tower.ansible.com/v1alpha1 kind: AnsibleWorkflow @@ -21,4 +21,5 @@ spec: workflow_template_name: Demo Job Template connection_secret: controller-access runner_pull_policy: IfNotPresent ----- \ No newline at end of file +---- ++ \ No newline at end of file diff --git a/downstream/modules/platform/proc-operator-create_crs.adoc b/downstream/modules/platform/proc-operator-create_crs.adoc index 33b59c16ef..c83f9c5a23 100644 --- a/downstream/modules/platform/proc-operator-create_crs.adoc +++ b/downstream/modules/platform/proc-operator-create_crs.adoc @@ -6,12 +6,12 @@ After upgrading to the latest version of {OperatorPlatformNameShort} on {OCPShort}, you can create an {PlatformNameShort} custom resource (CR) that specifies the names of your existing deployments, in the same namespace. -.Procedure -This example outlines the steps to deploy a new {EDAName} setup after upgrading to the latest version, with existing {ControllerName} and {HubName} deployments already in place. - +The following example outlines the steps to deploy a new {EDAName} setup after upgrading to the latest version, with existing {ControllerName} and {HubName} deployments already in place. The link:{BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html-single/installing_on_openshift_container_platform/index#appendix-operator-crs_performance-considerations[Appendix] contains more examples of {PlatformNameShort} CRs for different deployments. +.Procedure + . Log in to {OCP}. . Navigate to menu:Operators[Installed Operators]. . Select your {OperatorPlatformNameShort} deployment. @@ -42,7 +42,7 @@ spec: disabled: false ---- . Click btn:[Create]. - ++ [NOTE] ==== You can override the operator’s default image for {ControllerName}, {HubName}, or platform-resource app images by specifying the preferred image on the YAML spec. @@ -50,6 +50,7 @@ This enables upgrading a specific deployment, like a controller, without updatin The recommended approach however, is to upgrade the operator and use the default image values. ==== ++ .Verification Navigate to your {OperatorPlatformNameShort} deployment and click btn:[All instances] to verify whether all instances have deployed correctly. diff --git a/downstream/modules/platform/proc-operator-deploy-central-config.adoc b/downstream/modules/platform/proc-operator-deploy-central-config.adoc index ab988a31ae..fdc4d31f1e 100644 --- a/downstream/modules/platform/proc-operator-deploy-central-config.adoc +++ b/downstream/modules/platform/proc-operator-deploy-central-config.adoc @@ -3,6 +3,7 @@ [id="operator-deploy-central-config_{context}"] = Deploying the {Gateway} with existing {PlatformNameShort} components + You can link any components of the {PlatformNameShort}, that you have already installed to a new *{PlatformNameShort}* instance. The following procedure simulates a scenario where you have {ControllerName} as an existing component and want to add {HubName} and {EDAName}. @@ -15,7 +16,6 @@ The following procedure simulates a scenario where you have {ControllerName} as . Click btn:[Details] and on the *{PlatformNameShort}* tile click btn:[Create instance]. . From the *Create {PlatformNameShort}* page enter a name for your instance in the *Name* field. * When deploying an {PlatformNameShort} instance, ensure that `auto_update` is set to the default value of `false` on your existing {ControllerName} instance in order for the integration to work. - . Click btn:[YAML view] and copy in the following: + ---- @@ -59,7 +59,7 @@ spec: ---- .. For new components, if you do not specify a name, a default name is generated. . Click btn:[Create]. -. To access your new instance, see xref:operator-access-aap_{context}[Accessing the {Gateway}]. +. To access your new instance, see link:{BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html-single/installing_on_openshift_container_platform/index#operator-access-aap_install-aap-gateway[Accessing the {Gateway}]. [NOTE] ==== diff --git a/downstream/modules/platform/proc-operator-deploy-redis.adoc b/downstream/modules/platform/proc-operator-deploy-redis.adoc index a9593395da..4a38dc3b72 100644 --- a/downstream/modules/platform/proc-operator-deploy-redis.adoc +++ b/downstream/modules/platform/proc-operator-deploy-redis.adoc @@ -26,6 +26,8 @@ For more information about Redis, refer to Caching and queueing system in the _P . For the *Redis Mode* list, select *Cluster*. . Configure the rest of your instance as necessary, then click btn:[Create]. +.Verification + Your instance deploys with a cluster Redis with 6 Redis replicas as default. [NOTE] diff --git a/downstream/modules/platform/proc-operator-external-db-controller.adoc b/downstream/modules/platform/proc-operator-external-db-controller.adoc index 7c36f791c6..a386db3774 100644 --- a/downstream/modules/platform/proc-operator-external-db-controller.adoc +++ b/downstream/modules/platform/proc-operator-external-db-controller.adoc @@ -20,7 +20,7 @@ The same external database (PostgreSQL instance) can be used for both {HubName}, The following section outlines the steps to configure an external database for your {ControllerName} on a {OperatorPlatformNameShort}. .Prerequisite -The external database must be a PostgreSQL database that is the version supported by the current release of {PlatformNameShort}. +The external database must be a PostgreSQL database that is the version supported by the current release of {PlatformNameShort}. The external postgres instance credentials and connection information must be stored in a secret, which is then set on the {ControllerName} spec. [NOTE] ==== @@ -29,8 +29,6 @@ The external database must be a PostgreSQL database that is the version supporte .Procedure -The external postgres instance credentials and connection information must be stored in a secret, which is then set on the {ControllerName} spec. - . Create a `postgres_configuration_secret` YAML file, following the template below: + ---- diff --git a/downstream/modules/platform/proc-operator-external-db-gateway.adoc b/downstream/modules/platform/proc-operator-external-db-gateway.adoc index 2d3dc5425f..0d75ae9014 100644 --- a/downstream/modules/platform/proc-operator-external-db-gateway.adoc +++ b/downstream/modules/platform/proc-operator-external-db-gateway.adoc @@ -40,7 +40,7 @@ The same external database (PostgreSQL instance) can be used for both {HubName}, The following section outlines the steps to configure an external database for your {Gateway} on a {OperatorPlatformNameShort}. .Prerequisite -The external database must be a PostgreSQL database that is the version supported by the current release of {PlatformNameShort}. +The external database must be a PostgreSQL database that is the version supported by the current release of {PlatformNameShort}. The external postgres instance credentials and connection information must be stored in a secret, which is then set on the {Gateway} spec. [NOTE] ==== @@ -49,8 +49,6 @@ The external database must be a PostgreSQL database that is the version supporte .Procedure -The external postgres instance credentials and connection information must be stored in a secret, which is then set on the {Gateway} spec. - . Create a `postgres_configuration_secret` YAML file, following the template below: + ---- @@ -85,7 +83,7 @@ $ oc create -f external-postgres-configuration-secret.yml The following example is for a {Gateway} deployment. To configure an external database for all components, use the _aap-configuring-external-db-all-default-components.yml_ example in the link:{BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html-single/installing_on_openshift_container_platform/index#operator-crs[14.1. Custom resources] section. ==== - ++ . When creating your `AnsibleAutomationPlatform` custom resource object, specify the secret on your spec, following the example below: + ---- diff --git a/downstream/modules/platform/proc-operator-external-db-hub.adoc b/downstream/modules/platform/proc-operator-external-db-hub.adoc index bc1c4ffe5b..73f58776ed 100644 --- a/downstream/modules/platform/proc-operator-external-db-hub.adoc +++ b/downstream/modules/platform/proc-operator-external-db-hub.adoc @@ -21,6 +21,7 @@ The following section outlines the steps to configure an external database for y .Prerequisite The external database must be a PostgreSQL database that is the version supported by the current release of {PlatformNameShort}. +The external postgres instance credentials and connection information will need to be stored in a secret, which will then be set on the {HubName} spec. [NOTE] ==== @@ -29,8 +30,6 @@ The external database must be a PostgreSQL database that is the version supporte .Procedure -The external postgres instance credentials and connection information will need to be stored in a secret, which will then be set on the {HubName} spec. - . Create a `postgres_configuration_secret` YAML file, following the template below: + ---- diff --git a/downstream/modules/platform/proc-operator-scaling-down-aap.adoc b/downstream/modules/platform/proc-operator-scaling-down-aap.adoc index 60d658c159..1c7bbb4b8c 100644 --- a/downstream/modules/platform/proc-operator-scaling-down-aap.adoc +++ b/downstream/modules/platform/proc-operator-scaling-down-aap.adoc @@ -23,5 +23,7 @@ idle_aap: true + . Click btn:[Save]. +.Next steps + Setting the `idle_aap` value to `true` scales down all active deployments. Setting the value to `false` scales the deployments back up. diff --git a/downstream/modules/platform/proc-operator-upgrade.adoc b/downstream/modules/platform/proc-operator-upgrade.adoc index 0c47b9edf7..a35488a104 100644 --- a/downstream/modules/platform/proc-operator-upgrade.adoc +++ b/downstream/modules/platform/proc-operator-upgrade.adoc @@ -29,7 +29,9 @@ Upgrading from {EDAName} 2.4 is not supported. If you are using {EDAName} 2.4 in . Change the channel from stable-2.4 to stable-2.5. An InstallPlan is created for the user. . Click btn:[Preview InstallPlan]. . Click btn:[Approve]. -. Create a Custom Resource (CR) using the {PlatformNameShort} UI. -The {ControllerName} and {HubName} UIs remain until all SSO configuration is supported in the {Gateway} UI. +. Create a Custom Resource (CR) using the {PlatformNameShort} UI. The {ControllerName} and {HubName} UIs remain until all SSO configuration is supported in the {Gateway} UI. -For more information on configuring your updated {OperatorPlatformNameShort}, see link:{BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html-single/installing_on_openshift_container_platform/index#configure-aap-operator_operator-platform-doc[Configuring the {OperatorPlatformName} on {OCP}]. +[role="_additional-resources"] +.Additional resources + +* link:{BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html-single/installing_on_openshift_container_platform/index#configure-aap-operator_operator-platform-doc[Configuring the {OperatorPlatformName} on {OCP}] 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 d5f336713d..c95fd5cce5 100644 --- a/downstream/modules/platform/proc-provision-ocp-storage-amazon-s3.adoc +++ b/downstream/modules/platform/proc-provision-ocp-storage-amazon-s3.adoc @@ -43,7 +43,7 @@ spec: + . If you are applying this secret to an existing instance, restart the API pods for the change to take effect. `` is the name of your hub instance. - ++ [source,bash] ---- $ oc -n $HUB_NAMESPACE delete pod -l app.kubernetes.io/name=-api 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 4964d35cd4..1ac9e39df4 100644 --- a/downstream/modules/platform/proc-provision-ocp-storage-azure-blob.adoc +++ b/downstream/modules/platform/proc-provision-ocp-storage-azure-blob.adoc @@ -40,10 +40,10 @@ EOF spec: object_storage_azure_secret: test-azure ---- - ++ . If you are applying this secret to an existing instance, restart the API pods for the change to take effect. `` is the name of your hub instance. - ++ [source,bash] ---- $ oc -n $HUB_NAMESPACE delete pod -l app.kubernetes.io/name=-api diff --git a/downstream/modules/platform/proc-verify-network-connectivity.adoc b/downstream/modules/platform/proc-verify-network-connectivity.adoc index 1754005442..235623aea9 100644 --- a/downstream/modules/platform/proc-verify-network-connectivity.adoc +++ b/downstream/modules/platform/proc-verify-network-connectivity.adoc @@ -43,13 +43,15 @@ oc get pods ----- oc rsh dbchecker ----- -. After the shell session opens in the pod, verify that the new project can connect to your old project cluster: +.Verification + +After the shell session opens in the pod, verify that the new project can connect to your old project cluster: + ----- pg_isready -h -p -U AutomationContoller ----- + -.Example +For example: ----- : - accepting connections ----- diff --git a/downstream/modules/platform/ref-controller-trial-evaluation.adoc b/downstream/modules/platform/ref-controller-trial-evaluation.adoc index 84c5de1077..85e3cef90a 100644 --- a/downstream/modules/platform/ref-controller-trial-evaluation.adoc +++ b/downstream/modules/platform/ref-controller-trial-evaluation.adoc @@ -3,6 +3,7 @@ [id="ref-controller-trial-evaluation"] = Trial and evaluation + A license is required to run {PlatformNameShort}. You can start by using a free trial license. * Trial licenses for {PlatformNameShort} are available at the link:https://www.redhat.com/en/products/trials?products=ansible[Red Hat product trial center]. diff --git a/downstream/modules/platform/ref-operator-ocp-version.adoc b/downstream/modules/platform/ref-operator-ocp-version.adoc index cb1e8b4472..c7a8e579b4 100644 --- a/downstream/modules/platform/ref-operator-ocp-version.adoc +++ b/downstream/modules/platform/ref-operator-ocp-version.adoc @@ -10,4 +10,4 @@ The {OperatorPlatformNameShort} to install {PlatformNameShort} {PlatformVers} is [role="_additional-resources"] .Additional resources -* See the link:https://access.redhat.com/support/policy/updates/ansible-automation-platform[Red Hat Ansible Automation Platform Life Cycle] for the most current compatibility details. +* link:https://access.redhat.com/support/policy/updates/ansible-automation-platform[Red Hat Ansible Automation Platform Life Cycle]. diff --git a/downstream/titles/aap-operator-installation/my_module_files.txt b/downstream/titles/aap-operator-installation/my_module_files.txt new file mode 100644 index 0000000000..e69de29bb2