Merge branch 'release-1.3' into cherry-pick-637-to-release-1.3

themr0c · web-flow · commit 58e68febadd8 · 2024-11-05T14:02:03.000+01:00
diff --git a/artifacts/attributes.adoc b/artifacts/attributes.adoc
@@ -27,8 +27,8 @@
 :osd-brand-name: Red Hat OpenShift Dedicated
 :osd-short: OpenShift Dedicated
 // minimum and current latest supported versions
-:ocp-version-min: 4.12
-:ocp-version: 4.15
+:ocp-version-min: 4.14
+:ocp-version: 4.16
 // First mention of OpenShift CLI or `oc` in a module
 :openshift-cli: pass:quotes[OpenShift CLI (`oc`)]
 :rhsso-brand-name: Red Hat Single-Sign On
diff --git a/artifacts/snip-customer-support-info.adoc b/artifacts/snip-customer-support-info.adoc
@@ -5,4 +5,4 @@
 If you experience difficulty with a procedure described in this documentation, visit the http://access.redhat.com[Red Hat Customer Portal]. You can use the Red Hat Customer Portal for the following purposes:
 
 * To search or browse through the Red Hat Knowledgebase of technical support articles about Red Hat products. 
-* To create a https://access.redhat.com/support/cases/#/case/new/get-support?caseCreate=true[support case] for Red Hat Global Support Services (GSS). For support case creation, select *Red Hat Developer Hub* as the product and select the appropriate product version.
+* To create a https://access.redhat.com/support/cases/#/case/new/get-support?caseCreate=true[support case] for {company-name} Global Support Services (GSS). For support case creation, select *{product}* as the product and select the appropriate product version. For detailed information about supported platforms, see link:{release-notes-url}#con-release-notes-overview.adoc[Supported Platforms] and the link:https://access.redhat.com/support/policy/updates/developerhub[{product} Life Cycle].
diff --git a/assemblies/assembly-add-custom-app-file-openshift.adoc b/assemblies/assembly-add-custom-app-file-openshift.adoc
@@ -18,7 +18,7 @@ data:
 You can add the custom application configuration file to {ocp-short} in one of the following ways:
 
 * The {product} Operator
-* The {product} Helm chart.
+* The {product} Helm chart
 
 include::modules/getting-started/proc-add-custom-app-file-openshift-helm.adoc[leveloffset=+1]
 
diff --git a/assemblies/assembly-admin-templates.adoc b/assemblies/assembly-admin-templates.adoc
@@ -22,5 +22,4 @@ include::modules/templates/proc-adding-templates.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
-* link:{LinkGettingStartedGuide}[Configuring a GitHub App in {product-short}]
-* link:{LinkGettingStartedGuide}[Enabling the GitLab OAuth authentication provider]
+* link:{authentication-book-url}#assembly-auth-provider-github[Enabling the GitHub authentication provider]
diff --git a/assemblies/assembly-authenticating-with-github.adoc b/assemblies/assembly-authenticating-with-github.adoc
@@ -1,5 +1,5 @@
-[id="assembly-auth-provider-github"]
-= Enabling the GitHub authentication provider
+[id="authenticating-with-github"]
+= Authenticating with GitHub
 
 To authenticate users with GitHub or GitHub Enterprise:
 
diff --git a/modules/authentication/proc-creating-a-custom-transformer-to-provision-users-from-rhsso-to-the-software-catalog.adoc b/modules/authentication/proc-creating-a-custom-transformer-to-provision-users-from-rhsso-to-the-software-catalog.adoc
@@ -1,4 +1,4 @@
-[id="provisioning-users-from-rhsso-to-the-software-catalog"]
+[id="creating-a-custom-transformer-to-provision-users-from-rhsso-to-the-software-catalog"]
 = Creating a custom transformer to provision users from {rhsso-brand-name} ({rhsso}) to the software catalog
 
 To customize how {rhsso} users and groups are mapped to {product} entities, you can create a backend module that uses the `keycloakTransformerExtensionPoint` to provide custom user and group transformers for the Keycloak backend.
diff --git a/modules/authentication/proc-enabling-authentication-with-github.adoc b/modules/authentication/proc-enabling-authentication-with-github.adoc
@@ -159,6 +159,39 @@ auth:
         enterpriseInstanceUrl: ${GITHUB_HOST_DOMAIN}
 ----
 
+[TIP]
+====
+To enable GitHub integration with a different authentication provider, complete the following configurations:
+
+* Add the GitHub provider to the existing `auth` section.
+* Keep the `signInPage` section from your authentication provider configuration.
+
+.`app-config-rhdh.yaml` fragment with mandatory fields to enable GitHub integration and use a different authentication provider
+[source,yaml,subs="+quotes"]
+----
+auth:
+  environment: production
+  providers:
+    github:
+      production:
+        clientId: ${AUTH_GITHUB_CLIENT_ID}
+        clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
+    __<your_other_authentication_providers_configuration>__
+integrations:
+  github:
+    - host: ${GITHUB_HOST_DOMAIN}
+      apps:
+        - appId: ${AUTH_GITHUB_APP_ID}
+          clientId: ${AUTH_GITHUB_CLIENT_ID}
+          clientSecret: ${GITHUB_CLIENT_SECRET}
+          webhookUrl: ${GITHUB_WEBHOOK_URL}
+          webhookSecret: ${GITHUB_WEBHOOK_SECRET}
+          privateKey: |
+            ${GITHUB_PRIVATE_KEY_FILE}
+signInPage: __<your_main_authentication_provider>__
+----
+====
+
 --
 
 .Verification
diff --git a/modules/authorization/proc-mounting-the-policy-csv-file-using-the-operator.adoc b/modules/authorization/proc-mounting-the-policy-csv-file-using-the-operator.adoc
@@ -53,8 +53,8 @@ permission:
 .Example custom resource
 [source, yaml]
 ----
-apiVersion: v1
-kind: ConfigMap
+apiVersion: rhdh.redhat.com/v1alpha1
+kind: Backstage
 metadata:
   name: example
 spec:
diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc
@@ -3,7 +3,7 @@
 You can enable the Bulk Import feature for users and give them the necessary permissions to access it.
 
 .Prerequisites
-* You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub authentication and integration].
+* You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub integration].
 
 .Procedure
 
diff --git a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc
@@ -4,7 +4,6 @@
 In {product}, you can select your GitHub repositories and automate their onboarding to the {product-short} catalog.
 
 .Prerequisites
-* You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub authentication and integration].
 * You have xref:enabling-and-giving-access-to-the-bulk-import-feature[enabled the Bulk Import feature and gave access to it].
 
 .Procedure
diff --git a/modules/installation/proc-install-operator.adoc b/modules/installation/proc-install-operator.adoc
@@ -15,7 +15,7 @@ As an administrator, you can install the {product} Operator. Authorized users ca
 
 Containers are available for the following CPU architectures:
 
-* AMD64 and Intel 64 (x86_64)
+* AMD64 and Intel 64 (`x86_64`)
 
 .Prerequisites
 
diff --git a/modules/release-notes/con-release-notes-overview.adoc b/modules/release-notes/con-release-notes-overview.adoc
@@ -19,3 +19,22 @@ Benefits of {product} include:
 .Additional resources
 
 * link:{upgrading-book-url}[{upgrading-book-title}].
+
+== Supported Platforms
+
+{product} runs on {ocp-short} {ocp-version-min}-{ocp-version} on the following CPU architecture:
+
+* AMD64 and Intel 64 (`x86_64`)
+
+In addition to {ocp-short}, the following hosted environments are also supported:
+
+* {eks-brand-name}
+* {aks-brand-name}
+* {osd-short} on {gcp-brand-name}
+
+.Additional resources
+
+* link:https://docs.redhat.com/en/documentation/openshift_container_platform[OpenShift documentation]
+* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}#Install%20and%20Upgrade[{product} Installation guides]
+
+

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-[id="provisioning-users-from-rhsso-to-the-software-catalog"]`
	`1`	`+[id="creating-a-custom-transformer-to-provision-users-from-rhsso-to-the-software-catalog"]`
`2`	`2`	`= Creating a custom transformer to provision users from {rhsso-brand-name} ({rhsso}) to the software catalog`
`3`	`3`
`4`	`4`	To customize how {rhsso} users and groups are mapped to {product} entities, you can create a backend module that uses the `keycloakTransformerExtensionPoint` to provide custom user and group transformers for the Keycloak backend.