ansible · g-murray · May 6, 2025 · May 6, 2025
diff --git a/downstream/assemblies/devtools/assembly-self-service-about.adoc b/downstream/assemblies/devtools/assembly-self-service-about.adoc
@@ -0,0 +1,33 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2025-05-05
+
+ifdef::context[:parent-context-of-self-service-about: {context}]
+
+:_mod-docs-content-type: ASSEMBLY
+
+ifndef::context[]
+[id="self-service-about"]
+endif::[]
+ifdef::context[]
+[id="self-service-about_{context}"]
+endif::[]
+
+= About {SelfService}
+
+:context: self-service-about
+
+{SelfService} connects with {PlatformName} using an OAuth application for authentication.
+For the {SelfServiceShort} release, the following restrictions apply:
+
+* Users can only use one {PlatformNameShort} instance.
+* Users can only use one {PlatformNameShort} Organization.
+
+[NOTE]
+====
+{SelfService} uses a {RHDH} image.
+You can use this image to run only {SelfService}.
+====
+
+ifdef::parent-context-of-self-service-about[:context: {parent-context-of-self-service-about}]
+ifndef::parent-context-of-self-service-about[:!context:]
+
diff --git a/downstream/assemblies/devtools/assembly-self-service-accessing-deployment.adoc b/downstream/assemblies/devtools/assembly-self-service-accessing-deployment.adoc
@@ -0,0 +1,24 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2025-05-05
+
+ifdef::context[:parent-context-of-self-service-accessing-deployment: {context}]
+
+:_mod-docs-content-type: ASSEMBLY
+
+ifndef::context[]
+[id="self-service-accessing-deployment"]
+endif::[]
+ifdef::context[]
+[id="self-service-accessing-deployment_{context}"]
+endif::[]
+
+= Accessing the {SelfServiceShort} deployment
+
+:context: self-service-accessing-deployment
+
+include::devtools/proc-self-service-add-deployment-url-oauth-app.adoc[leveloffset=+1]
+include::devtools/proc-self-service-sign-in.adoc[leveloffset=+1]
+
+ifdef::parent-context-of-self-service-accessing-deployment[:context: {parent-context-of-self-service-accessing-deployment}]
+ifndef::parent-context-of-self-service-accessing-deployment[:!context:]
+
diff --git a/downstream/assemblies/devtools/assembly-self-service-create-ocp-registry.adoc b/downstream/assemblies/devtools/assembly-self-service-create-ocp-registry.adoc
@@ -0,0 +1,23 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2025-05-05
+
+ifdef::context[:parent-context-of-self-service-create-ocp-registry: {context}]
+
+:_mod-docs-content-type: ASSEMBLY
+
+ifndef::context[]
+[id="self-service-create-ocp-registry"]
+endif::[]
+ifdef::context[]
+[id="self-service-create-ocp-registry_{context}"]
+endif::[]
+
+= Creating a plug-in registry in OpenShift
+
+:context: self-service-create-ocp-registry
+
+include::devtools/proc-self-service-download-tar.adoc[leveloffset=+1]
+
+ifdef::parent-context-of-self-service-create-ocp-registry[:context: {parent-context-of-self-service-create-ocp-registry}]
+ifndef::parent-context-of-self-service-create-ocp-registry[:!context:]
+
diff --git a/downstream/assemblies/devtools/assembly-self-service-create-ocp-secrets.adoc b/downstream/assemblies/devtools/assembly-self-service-create-ocp-secrets.adoc
@@ -0,0 +1,27 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2025-05-05
+
+ifdef::context[:parent-context-of-self-service-create-ocp-secrets: {context}]
+
+:_mod-docs-content-type: ASSEMBLY
+
+ifndef::context[]
+[id="self-service-create-ocp-secrets"]
+endif::[]
+ifdef::context[]
+[id="self-service-create-ocp-secrets_{context}"]
+endif::[]
+
+= Creating secrets in OpenShift for your environment variables
+
+:context: self-service-create-ocp-secrets
+
+Before installing the chart, you must create a set of secrets in your OpenShift project.
+The {SelfServiceShort} Helm chart fetches environment variables from OpenShift secrets. 
+
+include::devtools/proc-self-service-create-ocp-auth-secrets.adoc[leveloffset=+1]
+include::devtools/proc-self-service-create-scm-secrets.adoc[leveloffset=+1]
+
+ifdef::parent-context-of-self-service-create-ocp-secrets[:context: {parent-context-of-self-service-create-ocp-secrets}]
+ifndef::parent-context-of-self-service-create-ocp-secrets[:!context:]
+
diff --git a/downstream/assemblies/devtools/assembly-self-service-generate-scm-tokens.adoc b/downstream/assemblies/devtools/assembly-self-service-generate-scm-tokens.adoc
@@ -0,0 +1,24 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2025-05-05
+
+ifdef::context[:parent-context-of-self-service-generate-scm-tokens: {context}]
+
+:_mod-docs-content-type: ASSEMBLY
+
+ifndef::context[]
+[id="self-service-generate-scm-tokens"]
+endif::[]
+ifdef::context[]
+[id="self-service-generate-scm-tokens_{context}"]
+endif::[]
+
+= Generating GitHub and Gitlab personal access tokens
+
+:context: self-service-generate-scm-tokens
+
+include::devtools/proc-self-service-create-gh-pat.adoc[leveloffset=+1]
+include::devtools/proc-self-service-create-gl-pat.adoc[leveloffset=+1]
+
+ifdef::parent-context-of-self-service-generate-scm-tokens[:context: {parent-context-of-self-service-generate-scm-tokens}]
+ifndef::parent-context-of-self-service-generate-scm-tokens[:!context:]
+
diff --git a/downstream/assemblies/devtools/assembly-self-service-helm-install.adoc b/downstream/assemblies/devtools/assembly-self-service-helm-install.adoc
@@ -0,0 +1,25 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2025-05-05
+
+ifdef::context[:parent-context-of-self-service-helm-install: {context}]
+
+:_mod-docs-content-type: ASSEMBLY
+
+ifndef::context[]
+[id="self-service-helm-install"]
+endif::[]
+ifdef::context[]
+[id="self-service-helm-install_{context}"]
+endif::[]
+
+= Installing the {SelfServiceShort} Helm chart
+
+:context: self-service-helm-install
+
+include::devtools/proc-self-service-install-helm-from-catalog.adoc[leveloffset=+1]
+include::devtools/proc-self-service-install-verify.adoc[leveloffset=+1]
+// include::devtools/zzz[leveloffset=+1]
+
+ifdef::parent-context-of-self-service-helm-install[:context: {parent-context-of-self-service-helm-install}]
+ifndef::parent-context-of-self-service-helm-install[:!context:]
+
diff --git a/downstream/assemblies/devtools/assembly-self-service-installation-overview.adoc b/downstream/assemblies/devtools/assembly-self-service-installation-overview.adoc
@@ -0,0 +1,30 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2025-05-05
+
+ifdef::context[:parent-context-of-self-service-installation-overview: {context}]
+
+:_mod-docs-content-type: ASSEMBLY
+
+ifndef::context[]
+[id="self-service-installation-overview"]
+endif::[]
+ifdef::context[]
+[id="self-service-installation-overview_{context}"]
+endif::[]
+
+= Installation overview
+
+:context: self-service-installation-overview
+
+You can deploy {SelfServiceShort} from a Helm chart on OpenShift.
+
+Helm is a tool that simplifies deployment of applications on {OCP} clusters.
+Helm uses a packaging format called Helm charts.
+A Helm chart is a package of files that define how an application is deployed and managed on OpenShift.
+The Helm chart for {SelfServiceShort} is available in the OpenShift Helm catalog.
+
+include::devtools/con-installation-prereqs.adoc[leveloffset=+1]
+
+ifdef::parent-context-of-self-service-installation-overview[:context: {parent-context-of-self-service-installation-overview}]
+ifndef::parent-context-of-self-service-installation-overview[:!context:]
+
diff --git a/downstream/assemblies/devtools/assembly-self-service-preinstall-config.adoc b/downstream/assemblies/devtools/assembly-self-service-preinstall-config.adoc
@@ -0,0 +1,29 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2025-05-05
+
+ifdef::context[:parent-context-of-self-service-preinstall-config: {context}]
+
+:_mod-docs-content-type: ASSEMBLY
+
+ifndef::context[]
+[id="self-service-preinstall-config"]
+endif::[]
+ifdef::context[]
+[id="self-service-preinstall-config_{context}"]
+endif::[]
+
+= Pre-installation configuration
+
+:context: self-service-preinstall-config
+
+include::devtools/proc-self-service-create-oauth-app.adoc[leveloffset=+1]
+include::devtools/proc-self-service-generate-oauth-token.adoc[leveloffset=+1]
+include::assembly-self-service-generate-scm-tokens.adoc[leveloffset=+1]
+include::devtools/proc-self-service-ocp-project-setup.adoc[leveloffset=+1]
+include::assembly-self-service-create-ocp-registry.adoc[leveloffset=+1]
+include::assembly-self-service-create-ocp-secrets.adoc[leveloffset=+1]
+// include::devtools/zzz[leveloffset=+1]
+
+ifdef::parent-context-of-self-service-preinstall-config[:context: {parent-context-of-self-service-preinstall-config}]
+ifndef::parent-context-of-self-service-preinstall-config[:!context:]
+
diff --git a/downstream/assemblies/devtools/assembly-self-service-rbac.adoc b/downstream/assemblies/devtools/assembly-self-service-rbac.adoc
@@ -1,5 +1,5 @@
 ifdef::context[:parent-context: {context}]
-[id="self-service-rbac{context}"]
+[id="self-service-rbac_{context}"]
 
 = Working with RBAC
 

diff --git a/...am/assemblies/devtools/assembly-self-service-scm-credentials-private-repos.adoc b/...am/assemblies/devtools/assembly-self-service-scm-credentials-private-repos.adoc
@@ -9,7 +9,7 @@ ifndef::context[]
 [id="self-service-using-scm-credentials-private-repos"]
 endif::[]
 ifdef::context[]
-[id="self-service-using-scm-credentials-private-repos{context}"]
+[id="self-service-using-scm-credentials-private-repos_{context}"]
 endif::[]
 
 = Configuring source control credentials for private repositories

diff --git a/downstream/assemblies/devtools/assembly-self-service-telemetry-capture.adoc b/downstream/assemblies/devtools/assembly-self-service-telemetry-capture.adoc
@@ -0,0 +1,36 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2025-05-05
+
+ifdef::context[:parent-context-of-self-service-telemetry: {context}]
+
+:_mod-docs-content-type: ASSEMBLY
+
+ifndef::context[]
+[id="self-service-telemetry"]
+endif::[]
+ifdef::context[]
+[id="self-service-telemetry_{context}"]
+endif::[]
+
+= Telemetry capturing
+
+:context: self-service-telemetry
+
+The telemetry data collection feature helps in collecting and analyzing the telemetry data to improve your experience with self-service technical preview. This feature is enabled by default.
+
+Red Hat collects and analyses the following data:
+
+* Events of page visits and clicks on links or buttons.
+* System-related information, for example, locale, timezone, user agent including browser and OS details.
+* Page-related information, for example, title, category, extension name, URL, path, referrer, and search parameters.
+* Anonymized IP addresses, recorded as 0.0.0.0.
+* Anonymized username hashes, which are unique identifiers used solely to identify the number of unique users of the RHDH application.
+* Feedback and sentiment provided in the feedback form.
+
+// With Red Hat Developer Hub, you can disable or customize the telemetry data collection feature. 
+// For more information, refer to the Telemetry data collection guide in the Red Hat Developer Hub documentation.
+// include::devtools/zzz[leveloffset=+1]
+
+ifdef::parent-context-of-self-service-telemetry[:context: {parent-context-of-self-service-telemetry}]
+ifndef::parent-context-of-self-service-telemetry[:!context:]
+
diff --git a/downstream/assemblies/devtools/assembly-self-service-using-repo-setup.adoc b/downstream/assemblies/devtools/assembly-self-service-using-repo-setup.adoc
@@ -9,7 +9,7 @@ ifndef::context[]
 [id="self-service-using-repo-setup"]
 endif::[]
 ifdef::context[]
-[id="self-service-using-repo-setup{context}"]
+[id="self-service-using-repo-setup_{context}"]
 endif::[]
 
 = Setting up repositories for collections

diff --git a/downstream/assemblies/devtools/assembly-self-service-view-deployment.adoc b/downstream/assemblies/devtools/assembly-self-service-view-deployment.adoc
@@ -0,0 +1,27 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2025-05-05
+
+ifdef::context[:parent-context-of-self-service-view-deployment: {context}]
+
+:_mod-docs-content-type: ASSEMBLY
+
+ifndef::context[]
+[id="self-service-view-deployment"]
+endif::[]
+ifdef::context[]
+[id="self-service-view-deployment_{context}"]
+endif::[]
+
+= Inspecting the deployment on OpenShift
+
+:context: self-service-view-deployment
+
+You can inspect the deployment logs and ConfigMap on the OpenShift UI to verify that the deployment conforms with the settings in your Helm chart.
+
+include::devtools/proc-self-service-view-deployment-logs.adoc[leveloffset=+1]
+include::devtools/proc-self-service-view-configmap.adoc[leveloffset=+1]
+// include::devtools/zzz[leveloffset=+1]
+
+ifdef::parent-context-of-self-service-view-deployment[:context: {parent-context-of-self-service-view-deployment}]
+ifndef::parent-context-of-self-service-view-deployment[:!context:]
+
diff --git a/downstream/assemblies/devtools/assembly-self-service-working-templates.adoc b/downstream/assemblies/devtools/assembly-self-service-working-templates.adoc
@@ -9,7 +9,7 @@ ifndef::context[]
 [id="self-service-working-templates"]
 endif::[]
 ifdef::context[]
-[id="self-service-working-templates{context}"]
+[id="self-service-working-templates_{context}"]
 endif::[]
 
 = Working with templates

diff --git a/downstream/images/rhaap-sign-in-page.png b/downstream/images/rhaap-sign-in-page.png
diff --git a/downstream/images/self-service-create-oauth-app.png b/downstream/images/self-service-create-oauth-app.png
diff --git a/downstream/images/self-service-plugin-registry.png b/downstream/images/self-service-plugin-registry.png
diff --git a/downstream/images/self-service-pod-env-variables.png b/downstream/images/self-service-pod-env-variables.png
diff --git a/downstream/images/self-service-sign-in-page.png b/downstream/images/self-service-sign-in-page.png
diff --git a/downstream/images/self-service-templates-view.png b/downstream/images/self-service-templates-view.png
diff --git a/downstream/images/self-service-verify-helm-install.png b/downstream/images/self-service-verify-helm-install.png
diff --git a/downstream/images/self-service-view-deployment-logs.png b/downstream/images/self-service-view-deployment-logs.png
diff --git a/downstream/images/self-service-view-install-messages.png b/downstream/images/self-service-view-install-messages.png
diff --git a/downstream/modules/devtools/con-installation-prereqs.adoc b/downstream/modules/devtools/con-installation-prereqs.adoc
@@ -0,0 +1,16 @@
+:_mod-docs-content-type: CONCEPT
+
+[id="self-service-installation-prereqs_{context}"]
+= Prerequisites
+
+* A valid subscription to {PlatformName}.
+* An {PlatformNameShort} instance with the appropriate permissions to create an OAuth application.
+* An {OCPShort} instance (Version 4.12 or newer) with the appropriate permissions within your project to create an application.
+* You have installed the OpenShift CLI (`oc`).
+See the
+link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/cli_tools/openshift-cli-oc#cli-getting-started[Getting started with the OpenShift CLI]
+chapter of the _Understanding OpenShift Container Platform_ guide.
+* You have installed Helm 3.10 or newer.
+See the link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/building_applications/working-with-helm-charts#installing-helm[Installing Helm]
+chapter of the _OpenShift Container Platform Building applications_ guide.
+
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
@@ -0,0 +1,19 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="self-service-add-deployment-url-oauth-app_{context}"]
+= Adding the deployment URL to the OAuth Application
+
+When you set up your OAuth application in {PlatformNameShort} before deploying {SelfServiceShort},
+you added placeholder text for the `Redirect URL` value.
+
+You must update this value using the URL from the deployed application so that you can run automation on {SelfServiceShort} from {SelfServiceShort}.
+
+
+. Open the URL for the deployment from the OpenShift console to display the sign-in page for {SelfServiceShort}.
+. Copy the URL.
+. To determine the  Redirect URL value, append /api/auth/rhaap/handler/frame to the end of the deployment URL.
++
+For example, if the URL for the deployment is `\https://my-aap-self-service-technical-preview-backstage-myproject.mycluster.com`, 
+then the `Redirect URL` value is `\https://my-aap-self-service-technical-preview-backstage-myproject.mycluster.com/api/auth/rhaap/handler/frame`.
+. In a browser, open your instance of {PlatformNameShort}.
+
diff --git a/downstream/modules/devtools/proc-self-service-create-gh-pat.adoc b/downstream/modules/devtools/proc-self-service-create-gh-pat.adoc
@@ -0,0 +1,18 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2025-05-05
+:_mod-docs-content-type: PROCEDURE
+
+[id="self-service-create-gh-pat_{context}"]
+= Creating a Personal access token (PAT) on GitHub
+
+. In a browser, log in to GitHub and navigate to the
+link:https://github.com/settings/tokens[Personal access tokens]
+page.
+. Click *Generate new token(classic)*.
+. In the *Select scopes:* section, enable the following:
+** repo 
+** read:org 
+** workflow (as needed)
+. Click *Generate token*. 
+. Save the Personal access token.
+
diff --git a/downstream/modules/devtools/proc-self-service-create-gl-pat.adoc b/downstream/modules/devtools/proc-self-service-create-gl-pat.adoc
@@ -0,0 +1,19 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2025-05-05
+:_mod-docs-content-type: PROCEDURE
+
+[id="self-service-create-gl-pat_{context}"]
+= Creating a Personal access token (PAT) on Gitlab
+
+
+. In a browser, log in to Gitlab and navigate to the
+link:https://gitlab.com/-/user_settings/personal_access_tokens[Personal access tokens]
+page.
+. Click *Add new token*.
+. Provide a name and expiration date for the token.
+. In the *Scopes:* section, select the following:
+** read_repository
+** api
+. Click *Create personal access token*.
+. Save the Personal access token.
+