Skip to content

Commit e99d668

Browse files
committed
RHIDP-4248 Finish removing authentication sections from the Getting started guide
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
1 parent db995eb commit e99d668

File tree

4 files changed

+31
-372
lines changed

4 files changed

+31
-372
lines changed

assemblies/assembly-authenticating-with-github.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,9 @@ include::modules/authentication/proc-enabling-authentication-with-github.adoc[le
1111

1212
include::modules/authentication/proc-provisioning-users-from-github-to-the-software-catalog.adoc[leveloffset=+1]
1313

14+
15+
include::modules/authentication/proc-configuring-github-integration.adoc[leveloffset=+1]
16+
17+
18+
include::modules/authentication/proc-enabling-github-discovery.adoc[leveloffset=+1]
19+

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

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,10 @@ Optional: enter additional secrets. The additional secrets are not required for
6363
`GITHUB_ORG_URL`:: Enter `$GITHUB_HOST_DOMAIN/$GITHUB_ORGANIZATION`.
6464
`GITHUB_CLIENT_SECRET`:: Enter the saved **Client Secret**.
6565
`GITHUB_PRIVATE_KEY_FILE`:: Enter the saved **Private key**.
66+
`GITHUB_WEBHOOK_URL`:: Enter your {product-short} URL: `pass:c,a,q[{my-product-url}]`.
6667
`GITHUB_WEBHOOK_SECRET`:: Enter the saved *Webhook secret*.
6768

68-
. To set up the GitHub authentication provider in your {product-short} custom configuration, edit your custom {product-short} ConfigMap such as `app-config-rhdh`, and add the following lines to the `app-config-rhdh.yaml` content:
69+
. To set up the GitHub authentication provider and enable integration with the GitHub API in your {product-short} custom configuration, edit your custom {product-short} ConfigMap such as `app-config-rhdh`, and add the following lines to the `app-config-rhdh.yaml` content:
6970
+
7071
--
7172
.`app-config-rhdh.yaml` fragment with mandatory fields to enable authentication with GitHub
@@ -78,13 +79,24 @@ auth:
7879
production:
7980
clientId: ${AUTH_GITHUB_CLIENT_ID}
8081
clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
82+
integrations:
83+
github:
84+
- host: ${GITHUB_HOST_DOMAIN}
85+
apps:
86+
- appId: ${AUTH_GITHUB_APP_ID}
87+
clientId: ${AUTH_GITHUB_CLIENT_ID}
88+
clientSecret: ${GITHUB_CLIENT_SECRET}
89+
webhookUrl: ${GITHUB_WEBHOOK_URL}
90+
webhookSecret: ${GITHUB_WEBHOOK_SECRET}
91+
privateKey: |
92+
${GITHUB_PRIVATE_KEY_FILE}
8193
signInPage: github
8294
----
8395

8496
`environment: production`::
8597
Mark the environment as `production` to hide the Guest login in the {product-short} home page.
8698

87-
`clientId`, `clientSecret`::
99+
`clientId`, `clientSecret`, `host`, `appId`, `webhookUrl`, `webhookSecret`, `privateKey`::
88100
Use the {product-short} application information that you have created in GitHub and configured in OpenShift as secrets.
89101

90102
`sigInPage: github`::
@@ -107,6 +119,17 @@ auth:
107119
production:
108120
clientId: ${AUTH_GITHUB_CLIENT_ID}
109121
clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
122+
integrations:
123+
github:
124+
- host: ${GITHUB_HOST_DOMAIN}
125+
apps:
126+
- appId: ${AUTH_GITHUB_APP_ID}
127+
clientId: ${AUTH_GITHUB_CLIENT_ID}
128+
clientSecret: ${GITHUB_CLIENT_SECRET}
129+
webhookUrl: ${GITHUB_WEBHOOK_URL}
130+
webhookSecret: ${GITHUB_WEBHOOK_SECRET}
131+
privateKey: |
132+
${GITHUB_PRIVATE_KEY_FILE}
110133
signInPage: github
111134
dangerouslyAllowSignInWithoutUserInCatalog: true
112135
----

0 commit comments

Comments
 (0)