From fdb3c146f5af89964b7f04c78bb71651164c398e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Fri, 18 Oct 2024 14:06:17 +0200 Subject: [PATCH 1/7] fix leftovers MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- assemblies/assembly-authenticating-with-github.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/assemblies/assembly-authenticating-with-github.adoc b/assemblies/assembly-authenticating-with-github.adoc index 70d1c5a361..4d30cd3d36 100644 --- 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: From f7272e5685e2e501273034e6a8be86d3f40b2570 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Fri, 18 Oct 2024 14:13:56 +0200 Subject: [PATCH 2/7] fix erroneous procedure MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- ...c-enabling-authentication-with-github.adoc | 21 +++++++++++++++++++ ...g-the-bulk-import-from-github-feature.adoc | 2 +- 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/modules/authentication/proc-enabling-authentication-with-github.adoc b/modules/authentication/proc-enabling-authentication-with-github.adoc index b4157bdec0..19ac6d73b3 100644 --- a/modules/authentication/proc-enabling-authentication-with-github.adoc +++ b/modules/authentication/proc-enabling-authentication-with-github.adoc @@ -159,6 +159,27 @@ auth: enterpriseInstanceUrl: ${GITHUB_HOST_DOMAIN} ---- +[TIP] +==== +To enable GitHub integration with another authentication provider you have already configured, omit the `auth` and `signInPage` sections from this procedure: + +.`app-config-rhdh.yaml` fragment with mandatory fields to enable integration with GitHub and use a different authentication provider +[source,yaml] +---- +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} +---- +==== + -- .Verification 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 index b2f05fd5bd..e76f86c0a0 100644 --- 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 From 5355f83bdc5ed5e37f4b68ac7409e72cdea7a6da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Fri, 18 Oct 2024 15:03:40 +0200 Subject: [PATCH 3/7] more fixup MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- .../procedure-importing-multiple-repositories-from-github.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc index b0c38724ff..ac241bfad5 100644 --- 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 From 59095620e9fd20a01e8b9acf291cb18fe9238e49 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Mon, 21 Oct 2024 12:21:31 +0200 Subject: [PATCH 4/7] Update modules/authentication/proc-enabling-authentication-with-github.adoc --- .../proc-enabling-authentication-with-github.adoc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/modules/authentication/proc-enabling-authentication-with-github.adoc b/modules/authentication/proc-enabling-authentication-with-github.adoc index 19ac6d73b3..53e3b42ccd 100644 --- a/modules/authentication/proc-enabling-authentication-with-github.adoc +++ b/modules/authentication/proc-enabling-authentication-with-github.adoc @@ -161,7 +161,10 @@ auth: [TIP] ==== -To enable GitHub integration with another authentication provider you have already configured, omit the `auth` and `signInPage` sections from this procedure: +To enable GitHub integration with another authentication provider you have already configured: + +* Add the GitHub provider to the existing `auth` section. +* Keep the `signInPage` section from your authentication provider. .`app-config-rhdh.yaml` fragment with mandatory fields to enable integration with GitHub and use a different authentication provider [source,yaml] From 11947c9d5776b805cebf4633ead81fdbdc836e63 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Mon, 21 Oct 2024 12:24:25 +0200 Subject: [PATCH 5/7] Update modules/authentication/proc-enabling-authentication-with-github.adoc --- .../proc-enabling-authentication-with-github.adoc | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/modules/authentication/proc-enabling-authentication-with-github.adoc b/modules/authentication/proc-enabling-authentication-with-github.adoc index 53e3b42ccd..87d3d1da54 100644 --- a/modules/authentication/proc-enabling-authentication-with-github.adoc +++ b/modules/authentication/proc-enabling-authentication-with-github.adoc @@ -169,6 +169,14 @@ To enable GitHub integration with another authentication provider you have alrea .`app-config-rhdh.yaml` fragment with mandatory fields to enable integration with GitHub and use a different authentication provider [source,yaml] ---- +auth: + environment: production + providers: + github: + production: + clientId: ${AUTH_GITHUB_CLIENT_ID} + clientSecret: ${AUTH_GITHUB_CLIENT_SECRET} + ____ integrations: github: - host: ${GITHUB_HOST_DOMAIN} @@ -180,6 +188,7 @@ integrations: webhookSecret: ${GITHUB_WEBHOOK_SECRET} privateKey: | ${GITHUB_PRIVATE_KEY_FILE} +signInPage: ____ ---- ==== From 841ed2c9bc2eb84afb5c71513cf6ea93a80cb5af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Mon, 21 Oct 2024 12:27:56 +0200 Subject: [PATCH 6/7] Update modules/authentication/proc-enabling-authentication-with-github.adoc --- .../proc-enabling-authentication-with-github.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/authentication/proc-enabling-authentication-with-github.adoc b/modules/authentication/proc-enabling-authentication-with-github.adoc index 87d3d1da54..2959aa943e 100644 --- a/modules/authentication/proc-enabling-authentication-with-github.adoc +++ b/modules/authentication/proc-enabling-authentication-with-github.adoc @@ -167,7 +167,7 @@ To enable GitHub integration with another authentication provider you have alrea * Keep the `signInPage` section from your authentication provider. .`app-config-rhdh.yaml` fragment with mandatory fields to enable integration with GitHub and use a different authentication provider -[source,yaml] +[source,yaml,subs="+quotes"] ---- auth: environment: production From 771561b4cbfb4f13cec62b25ff74863f5eb4d579 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 22 Oct 2024 09:35:04 +0200 Subject: [PATCH 7/7] Apply suggestions from code review Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> --- .../proc-enabling-authentication-with-github.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/authentication/proc-enabling-authentication-with-github.adoc b/modules/authentication/proc-enabling-authentication-with-github.adoc index 2959aa943e..df2911af57 100644 --- a/modules/authentication/proc-enabling-authentication-with-github.adoc +++ b/modules/authentication/proc-enabling-authentication-with-github.adoc @@ -161,12 +161,12 @@ auth: [TIP] ==== -To enable GitHub integration with another authentication provider you have already configured: +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. +* Keep the `signInPage` section from your authentication provider configuration. -.`app-config-rhdh.yaml` fragment with mandatory fields to enable integration with GitHub and use a different authentication provider +.`app-config-rhdh.yaml` fragment with mandatory fields to enable GitHub integration and use a different authentication provider [source,yaml,subs="+quotes"] ---- auth: