Skip to content

Commit 609a715

Browse files
openshift-cherrypick-robotthemr0chmanwani-rh
authored
[release-1.3] RHIDP-1925 Fix GitHub integration procedure (#666)
* fix leftovers Signed-off-by: Fabrice Flore-Thébault <[email protected]> * fix erroneous procedure Signed-off-by: Fabrice Flore-Thébault <[email protected]> * more fixup Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Update modules/authentication/proc-enabling-authentication-with-github.adoc * Update modules/authentication/proc-enabling-authentication-with-github.adoc * Update modules/authentication/proc-enabling-authentication-with-github.adoc * Apply suggestions from code review Co-authored-by: Heena Manwani <[email protected]> --------- Signed-off-by: Fabrice Flore-Thébault <[email protected]> Co-authored-by: Fabrice Flore-Thébault <[email protected]> Co-authored-by: Heena Manwani <[email protected]>
1 parent 714ac80 commit 609a715

File tree

4 files changed

+36
-4
lines changed

4 files changed

+36
-4
lines changed

assemblies/assembly-authenticating-with-github.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
[id="assembly-auth-provider-github"]
2-
= Enabling the GitHub authentication provider
1+
[id="authenticating-with-github"]
2+
= Authenticating with GitHub
33

44
To authenticate users with GitHub or GitHub Enterprise:
55

modules/authentication/proc-enabling-authentication-with-github.adoc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,39 @@ auth:
159159
enterpriseInstanceUrl: ${GITHUB_HOST_DOMAIN}
160160
----
161161

162+
[TIP]
163+
====
164+
To enable GitHub integration with a different authentication provider, complete the following configurations:
165+
166+
* Add the GitHub provider to the existing `auth` section.
167+
* Keep the `signInPage` section from your authentication provider configuration.
168+
169+
.`app-config-rhdh.yaml` fragment with mandatory fields to enable GitHub integration and use a different authentication provider
170+
[source,yaml,subs="+quotes"]
171+
----
172+
auth:
173+
environment: production
174+
providers:
175+
github:
176+
production:
177+
clientId: ${AUTH_GITHUB_CLIENT_ID}
178+
clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
179+
__<your_other_authentication_providers_configuration>__
180+
integrations:
181+
github:
182+
- host: ${GITHUB_HOST_DOMAIN}
183+
apps:
184+
- appId: ${AUTH_GITHUB_APP_ID}
185+
clientId: ${AUTH_GITHUB_CLIENT_ID}
186+
clientSecret: ${GITHUB_CLIENT_SECRET}
187+
webhookUrl: ${GITHUB_WEBHOOK_URL}
188+
webhookSecret: ${GITHUB_WEBHOOK_SECRET}
189+
privateKey: |
190+
${GITHUB_PRIVATE_KEY_FILE}
191+
signInPage: __<your_main_authentication_provider>__
192+
----
193+
====
194+
162195
--
163196

164197
.Verification

modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
You can enable the Bulk Import feature for users and give them the necessary permissions to access it.
44

55
.Prerequisites
6-
* You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub authentication and integration].
6+
* You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub integration].
77

88
.Procedure
99

modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
In {product}, you can select your GitHub repositories and automate their onboarding to the {product-short} catalog.
55

66
.Prerequisites
7-
* You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub authentication and integration].
87
* You have xref:enabling-and-giving-access-to-the-bulk-import-feature[enabled the Bulk Import feature and gave access to it].
98

109
.Procedure

0 commit comments

Comments
 (0)