From 987c6796b0b225248eacfcfa5e765cac257bb5d9 Mon Sep 17 00:00:00 2001 From: Ed Mc Whinney Date: Wed, 16 Apr 2025 15:27:25 +0100 Subject: [PATCH 1/3] May service account updates Update Configuring Automation Execution doc to reflect service account changes to subscription management https://issues.redhat.com/browse/AAP-42976 --- .../platform/assembly-controller-login.adoc | 4 ++-- .../proc-controller-configure-analytics.adoc | 14 ++++++-------- .../proc-controller-find-subscription.adoc | 15 +++++++++++++++ .../platform/proc-controller-logging-in.adoc | 6 +++--- 4 files changed, 26 insertions(+), 13 deletions(-) create mode 100644 downstream/modules/platform/proc-controller-find-subscription.adoc diff --git a/downstream/assemblies/platform/assembly-controller-login.adoc b/downstream/assemblies/platform/assembly-controller-login.adoc index d94f57e31d..eeaba484cf 100644 --- a/downstream/assemblies/platform/assembly-controller-login.adoc +++ b/downstream/assemblies/platform/assembly-controller-login.adoc @@ -6,9 +6,9 @@ ifdef::controller-GS[] After you install {ControllerName}, you must log in to the Dashboard. endif::controller-GS[] ifdef::controller-UG[] -= Logging into {ControllerName} after installation += Logging into {PlatformNameShort} after installation -After you install {ControllerName}, you must log in. +After you install {PlatformNameShort}, you must log in. endif::controller-UG[] include::platform/proc-controller-logging-in.adoc[leveloffset=+1] diff --git a/downstream/modules/platform/proc-controller-configure-analytics.adoc b/downstream/modules/platform/proc-controller-configure-analytics.adoc index 2f63f1ba52..1270a8089c 100644 --- a/downstream/modules/platform/proc-controller-configure-analytics.adoc +++ b/downstream/modules/platform/proc-controller-configure-analytics.adoc @@ -7,19 +7,19 @@ When you imported your license for the first time, you were automatically opted .Prerequisites * A service account created with the Analytics Administrator viewer role in console.redhat.com. -For more information see, link:https://docs.redhat.com/en/documentation/red_hat_hybrid_cloud_console/1-latest/html/creating_and_managing_service_accounts/proc-ciam-svc-acct-overview-creating-service-acct#proc-ciam-svc-acct-create-creating-service-acct[Creating a service account]. +For more information, see link:https://docs.redhat.com/en/documentation/red_hat_hybrid_cloud_console/1-latest/html/creating_and_managing_service_accounts/proc-ciam-svc-acct-overview-creating-service-acct#proc-ciam-svc-acct-create-creating-service-acct[Creating a service account]. .Procedure . From the navigation panel, select {MenuSetSubscription}. -The *Subscription* page is displayed. +The *Subscription Settings* page is displayed. . If you have not already set up a subscription, do so now, and ensure that on the next page you have selected *{Analytics}* to use analytics data to enhance future releases of {PlatformNameShort} and to give the Red Hat Insights service to subscribers. -+ -image::automation_analytics.png[Automation analytics page] +//+ +//image::automation_analytics.png[Automation analytics page] . From the navigation panel, select {MenuSetSystem}. . Click btn:[Edit]. -. Toggle the *Gather data for {Analytics}* switch and enter your Red Hat customer credentials. -. You can also configure the following options: +//. Toggle the *Gather data for {Analytics}* switch and enter your Red Hat customer credentials. +. Configure the following options: + * *Red Hat Customer Name*: Enter the client ID you received when you created your service account. * *Red Hat Customer Password*: Enter the client secret you received when you created your service account.. @@ -31,5 +31,3 @@ image::automation_analytics.png[Automation analytics page] . Click btn:[Save]. //This field has been removed. //* *Last gathered entries from the data collection service of {Analytics}*: TBD - - diff --git a/downstream/modules/platform/proc-controller-find-subscription.adoc b/downstream/modules/platform/proc-controller-find-subscription.adoc new file mode 100644 index 0000000000..6fc22215bd --- /dev/null +++ b/downstream/modules/platform/proc-controller-find-subscription.adoc @@ -0,0 +1,15 @@ +[id="controller-find-subscription"] + += Finding your subscription + +Find your subscription after installation. + +.Procedure + +. From the navigation panel, select {MenuSetSubscription}. +The *Subscription Settings* page is displayed. +. Select the *Username / password* option. +. Enter the following details: +** *Red Hat Username*: Enter the client ID you received when you created your service account. +** *Red Hat Password*: Enter the client secret you received when you created your service account. +. Click btn:[Next]. \ No newline at end of file diff --git a/downstream/modules/platform/proc-controller-logging-in.adoc b/downstream/modules/platform/proc-controller-logging-in.adoc index 81045371cc..f93f081f1d 100644 --- a/downstream/modules/platform/proc-controller-logging-in.adoc +++ b/downstream/modules/platform/proc-controller-logging-in.adoc @@ -2,12 +2,12 @@ .Procedure -. With the login information provided after your installation completed, open a web browser and log in to the {ControllerName} by navigating to its server URL at: \https:/// +. With the login information provided after your installation completed, open a web browser and log in to the {PlatformNameShort} by navigating to its server URL at: \https:/// . Use the credentials specified during the installation process to login: * The default username is *admin*. * The password for *admin* is the value specified. -. Click the btn:[More Actions] icon *{MoreActionsIcon}* next to the desired user. +. Click the btn:[More Actions] icon *{MoreActionsIcon}* next to the required user. . Click btn:[Edit]. -. Edit the required details and click btn:[Save]. \ No newline at end of file +. Edit the required details and click btn:[Save]. From 4845f82427655b6a7dc28a9f5b4bc6d4909dbe0e Mon Sep 17 00:00:00 2001 From: Ed Mc Whinney Date: Tue, 22 Apr 2025 11:43:02 +0100 Subject: [PATCH 2/3] Further service account edits --- .../assemblies/platform/assembly-controller-login.adoc | 1 + .../platform/proc-controller-configure-analytics.adoc | 7 +------ .../platform/proc-controller-find-subscription.adoc | 2 +- 3 files changed, 3 insertions(+), 7 deletions(-) diff --git a/downstream/assemblies/platform/assembly-controller-login.adoc b/downstream/assemblies/platform/assembly-controller-login.adoc index eeaba484cf..ce8db684aa 100644 --- a/downstream/assemblies/platform/assembly-controller-login.adoc +++ b/downstream/assemblies/platform/assembly-controller-login.adoc @@ -12,3 +12,4 @@ After you install {PlatformNameShort}, you must log in. endif::controller-UG[] include::platform/proc-controller-logging-in.adoc[leveloffset=+1] +include::platform/proc-controller-find-subscription.adoc[leveloffset=+1] diff --git a/downstream/modules/platform/proc-controller-configure-analytics.adoc b/downstream/modules/platform/proc-controller-configure-analytics.adoc index 1270a8089c..399fad19a9 100644 --- a/downstream/modules/platform/proc-controller-configure-analytics.adoc +++ b/downstream/modules/platform/proc-controller-configure-analytics.adoc @@ -10,11 +10,6 @@ When you imported your license for the first time, you were automatically opted For more information, see link:https://docs.redhat.com/en/documentation/red_hat_hybrid_cloud_console/1-latest/html/creating_and_managing_service_accounts/proc-ciam-svc-acct-overview-creating-service-acct#proc-ciam-svc-acct-create-creating-service-acct[Creating a service account]. .Procedure -. From the navigation panel, select {MenuSetSubscription}. -The *Subscription Settings* page is displayed. -. If you have not already set up a subscription, do so now, and ensure that on the next page you have selected *{Analytics}* to use analytics data to enhance future releases of {PlatformNameShort} and to give the Red Hat Insights service to subscribers. -//+ -//image::automation_analytics.png[Automation analytics page] . From the navigation panel, select {MenuSetSystem}. . Click btn:[Edit]. @@ -25,7 +20,7 @@ The *Subscription Settings* page is displayed. * *Red Hat Customer Password*: Enter the client secret you received when you created your service account.. * *Red Hat or Satellite Username*: This username is used to send data to {Analytics}. * *Red Hat or Satellite password*: This password is used to send data to {Analytics}. -* *Last gather date for Automation Analytics*: Set the date and time +* *Last gather date for Automation Analytics*: Set the date and time. * *Automation Analytics Gather Interval*: Interval (in seconds) between data gathering. + . Click btn:[Save]. diff --git a/downstream/modules/platform/proc-controller-find-subscription.adoc b/downstream/modules/platform/proc-controller-find-subscription.adoc index 6fc22215bd..027b802b7f 100644 --- a/downstream/modules/platform/proc-controller-find-subscription.adoc +++ b/downstream/modules/platform/proc-controller-find-subscription.adoc @@ -12,4 +12,4 @@ The *Subscription Settings* page is displayed. . Enter the following details: ** *Red Hat Username*: Enter the client ID you received when you created your service account. ** *Red Hat Password*: Enter the client secret you received when you created your service account. -. Click btn:[Next]. \ No newline at end of file +. Click btn:[Next]. From 70f3415533794e6d78c2774ee473b1277fecfd75 Mon Sep 17 00:00:00 2001 From: Ed Mc Whinney Date: Wed, 7 May 2025 12:18:15 +0100 Subject: [PATCH 3/3] Adding latest service account changes per UI --- .../proc-controller-configure-analytics.adoc | 17 +++++++---------- .../proc-controller-find-subscription.adoc | 7 ++++--- 2 files changed, 11 insertions(+), 13 deletions(-) diff --git a/downstream/modules/platform/proc-controller-configure-analytics.adoc b/downstream/modules/platform/proc-controller-configure-analytics.adoc index 399fad19a9..ed6706798e 100644 --- a/downstream/modules/platform/proc-controller-configure-analytics.adoc +++ b/downstream/modules/platform/proc-controller-configure-analytics.adoc @@ -11,18 +11,15 @@ For more information, see link:https://docs.redhat.com/en/documentation/red_hat_ .Procedure -. From the navigation panel, select {MenuSetSystem}. +. From the navigation panel, select menu:{MenuAEAdminSettings}[System]. . Click btn:[Edit]. -//. Toggle the *Gather data for {Analytics}* switch and enter your Red Hat customer credentials. -. Configure the following options: +. Toggle the *Gather data for {Analytics}* switch and enter your Red Hat customer credentials: + -* *Red Hat Customer Name*: Enter the client ID you received when you created your service account. -* *Red Hat Customer Password*: Enter the client secret you received when you created your service account.. -* *Red Hat or Satellite Username*: This username is used to send data to {Analytics}. -* *Red Hat or Satellite password*: This password is used to send data to {Analytics}. -* *Last gather date for Automation Analytics*: Set the date and time. +* *Red Hat Client ID for Analytics*: Enter the client ID you received when you created your service account to send data to {Analytics}. +* *Red Hat Client Secret for Analytics*: Enter the client secret you received when you created your service account to send data to {Analytics}. +* *Red Hat Client ID for Subscriptions*: Enter the client ID you received when you created your service account to retrieve subscription and content information. +* *Red Hat Client Secret for Subscriptions*: Enter the client secret you received when you created your service account to retrieve subscription and content information. +* *Last gathered entries from the data collection service of Automation Analytics*: * *Automation Analytics Gather Interval*: Interval (in seconds) between data gathering. + . Click btn:[Save]. -//This field has been removed. -//* *Last gathered entries from the data collection service of {Analytics}*: TBD diff --git a/downstream/modules/platform/proc-controller-find-subscription.adoc b/downstream/modules/platform/proc-controller-find-subscription.adoc index 027b802b7f..b82e1247fb 100644 --- a/downstream/modules/platform/proc-controller-find-subscription.adoc +++ b/downstream/modules/platform/proc-controller-find-subscription.adoc @@ -8,8 +8,9 @@ Find your subscription after installation. . From the navigation panel, select {MenuSetSubscription}. The *Subscription Settings* page is displayed. -. Select the *Username / password* option. +. Click btn:[Edit subscription]. +. Select the *Service Account / Red Hat Satellite* option. . Enter the following details: -** *Red Hat Username*: Enter the client ID you received when you created your service account. -** *Red Hat Password*: Enter the client secret you received when you created your service account. +** *Client ID / Satellite username*: Enter the client ID you received when you created your service account. +** *Client secret / Satellite password*: Enter the client secret you received when you created your service account. . Click btn:[Next].