Skip to content

Commit 57e99d8

Browse files
jmagakjmagak
committed
deploy: 8e6a217 
1 parent a183009 commit 57e99d8

File tree

19 files changed

+1441
-1382
lines changed

19 files changed

+1441
-1382
lines changed

‎pr-661/admin-rhdh/index.html‎

Lines changed: 5 additions & 5 deletions
Large diffs are not rendered by default.

‎pr-661/authentication/index.html‎

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?xml version='1.0' encoding='UTF-8'?>
22
<!DOCTYPE html>
3-
<html xmlns="http://www.w3.org/1999/xhtml" class="chrometwo"><head><title>Authentication</title><link rel="stylesheet" type="text/css" href="Common_Content/css/default.css"/><meta name="generator" content="publican v4.3.2"/><meta name="description" content="As a Red Hat Developer Hub platform engineer, you can manage authentication of other users to meet the specific needs of your organization."/><link rel="next" href="#idm45576493475680" title="Preface"/><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/><script type="text/javascript" src="Common_Content/scripts/jquery-1.7.1.min.js"> </script><script type="text/javascript" src="Common_Content/scripts/utils.js"> </script><script type="text/javascript" src="Common_Content/scripts/highlight.js/highlight.pack.js"> </script></head><body><div id="chrometwo"><div id="main"><div xml:lang="en-US" class="book" id="idm45576498890000"><div class="titlepage"><div><div class="producttitle"><span class="productname">Red Hat Developer Hub</span> <span class="productnumber">1.3</span></div><div><h1 class="title">Authentication</h1></div><div><h2 class="subtitle">Configuring authentication to external services in Red Hat Developer Hub</h2></div><div><div xml:lang="en-US" class="authorgroup"><span class="orgname">Red Hat Customer Content Services</span></div></div><div><a href="#idm45576496171136">Legal Notice</a></div><div><div class="abstract"><p class="title"><strong>Abstract</strong></p><div class="para">
3+
<html xmlns="http://www.w3.org/1999/xhtml" class="chrometwo"><head><title>Authentication</title><link rel="stylesheet" type="text/css" href="Common_Content/css/default.css"/><meta name="generator" content="publican v4.3.2"/><meta name="description" content="As a Red Hat Developer Hub platform engineer, you can manage authentication of other users to meet the specific needs of your organization."/><link rel="next" href="#idm45894825619136" title="Preface"/><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/><script type="text/javascript" src="Common_Content/scripts/jquery-1.7.1.min.js"> </script><script type="text/javascript" src="Common_Content/scripts/utils.js"> </script><script type="text/javascript" src="Common_Content/scripts/highlight.js/highlight.pack.js"> </script></head><body><div id="chrometwo"><div id="main"><div xml:lang="en-US" class="book" id="idm45894824151072"><div class="titlepage"><div><div class="producttitle"><span class="productname">Red Hat Developer Hub</span> <span class="productnumber">1.3</span></div><div><h1 class="title">Authentication</h1></div><div><h2 class="subtitle">Configuring authentication to external services in Red Hat Developer Hub</h2></div><div><div xml:lang="en-US" class="authorgroup"><span class="orgname">Red Hat Customer Content Services</span></div></div><div><a href="#idm45894820388432">Legal Notice</a></div><div><div class="abstract"><p class="title"><strong>Abstract</strong></p><div class="para">
44
As a Red Hat Developer Hub platform engineer, you can manage authentication of other users to meet the specific needs of your organization.
5-
</div></div></div></div><hr/></div><div class="toc"><ul class="toc"><li><span class="preface"><a href="#idm45576493475680">Preface</a></span></li><li><span class="chapter"><a href="#authenticating-with-the-guest-user_title-authentication">1. Authenticating with the Guest user</a></span><ul><li><span class="section"><a href="#authenticating-with-the-guest-user-on-an-operator-based-installation_title-authentication">1.1. Authenticating with the Guest user on an Operator-based installation</a></span></li><li><span class="section"><a href="#authenticating-with-the-guest-user-on-a-helm-based-installation_title-authentication">1.2. Authenticating with the Guest user on a Helm-based installation</a></span></li></ul></li><li><span class="chapter"><a href="#assembly-authenticating-with-rhsso">2. Authenticating with Red Hat Single Sign-On (RHSSO)</a></span><ul><li><span class="section"><a href="#enabling-authentication-with-rhsso">2.1. Enabling authentication with Red Hat Single-Sign On (RHSSO)</a></span></li><li><span class="section"><a href="#provisioning-users-from-rhsso-to-the-software-catalog">2.2. Provisioning users from Red Hat Single-Sign On (RHSSO) to the software catalog</a></span></li><li><span class="section"><a href="#creating-a-custom-transformer-to-provision-users-from-rhsso-to-the-software-catalog">2.3. Creating a custom transformer to provision users from Red Hat Single-Sign On (RHSSO) to the software catalog</a></span></li></ul></li><li><span class="chapter"><a href="#assembly-auth-provider-github">3. Enabling the GitHub authentication provider</a></span><ul><li><span class="section"><a href="#enabling-authentication-with-github">3.1. Enabling authentication with GitHub</a></span></li><li><span class="section"><a href="#provisioning-users-from-github-to-the-software-catalog">3.2. Provisioning users from GitHub to the software catalog</a></span></li></ul></li><li><span class="chapter"><a href="#assembly-authenticating-with-microsoft-azure">4. Authentication with Microsoft Azure</a></span><ul><li><span class="section"><a href="#enabling-authentication-with-microsoft-azure">4.1. Enabling authentication with Microsoft Azure</a></span></li><li><span class="section"><a href="#provisioning-users-from-microsoft-azure-to-the-software-catalog">4.2. Provisioning users from Microsoft Azure to the software catalog</a></span></li></ul></li></ul></div><section class="preface" id="idm45576493475680"><div class="titlepage"><div><div><h1 class="title">Preface</h1></div></div></div><p>
5+
</div></div></div></div><hr/></div><div class="toc"><ul class="toc"><li><span class="preface"><a href="#idm45894825619136">Preface</a></span></li><li><span class="chapter"><a href="#authenticating-with-the-guest-user_title-authentication">1. Authenticating with the Guest user</a></span><ul><li><span class="section"><a href="#authenticating-with-the-guest-user-on-an-operator-based-installation_title-authentication">1.1. Authenticating with the Guest user on an Operator-based installation</a></span></li><li><span class="section"><a href="#authenticating-with-the-guest-user-on-a-helm-based-installation_title-authentication">1.2. Authenticating with the Guest user on a Helm-based installation</a></span></li></ul></li><li><span class="chapter"><a href="#assembly-authenticating-with-rhsso">2. Authenticating with Red Hat Single Sign-On (RHSSO)</a></span><ul><li><span class="section"><a href="#enabling-authentication-with-rhsso">2.1. Enabling authentication with Red Hat Single-Sign On (RHSSO)</a></span></li><li><span class="section"><a href="#provisioning-users-from-rhsso-to-the-software-catalog">2.2. Provisioning users from Red Hat Single-Sign On (RHSSO) to the software catalog</a></span></li><li><span class="section"><a href="#creating-a-custom-transformer-to-provision-users-from-rhsso-to-the-software-catalog">2.3. Creating a custom transformer to provision users from Red Hat Single-Sign On (RHSSO) to the software catalog</a></span></li></ul></li><li><span class="chapter"><a href="#authenticating-with-github">3. Authenticating with GitHub</a></span><ul><li><span class="section"><a href="#enabling-authentication-with-github">3.1. Enabling authentication with GitHub</a></span></li><li><span class="section"><a href="#provisioning-users-from-github-to-the-software-catalog">3.2. Provisioning users from GitHub to the software catalog</a></span></li></ul></li><li><span class="chapter"><a href="#assembly-authenticating-with-microsoft-azure">4. Authentication with Microsoft Azure</a></span><ul><li><span class="section"><a href="#enabling-authentication-with-microsoft-azure">4.1. Enabling authentication with Microsoft Azure</a></span></li><li><span class="section"><a href="#provisioning-users-from-microsoft-azure-to-the-software-catalog">4.2. Provisioning users from Microsoft Azure to the software catalog</a></span></li></ul></li></ul></div><section class="preface" id="idm45894825619136"><div class="titlepage"><div><div><h1 class="title">Preface</h1></div></div></div><p>
66
Depending on your organization’s security policies, you might require to identify and authorize users before giving them access to resources, such as Red Hat Developer Hub.
77
</p><p>
88
In Developer Hub, authentication and authorization are two separate processes:
@@ -391,7 +391,7 @@
391391
You can select a group, view the list, and access or review the information imported from RHSSO.
392392
</li><li class="listitem">
393393
You can log in with an RHSSO account.
394-
</li></ul></div></section></section><section class="chapter" id="assembly-auth-provider-github"><div class="titlepage"><div><div><h1 class="title">Chapter 3. Enabling the GitHub authentication provider</h1></div></div></div><p>
394+
</li></ul></div></section></section><section class="chapter" id="authenticating-with-github"><div class="titlepage"><div><div><h1 class="title">Chapter 3. Authenticating with GitHub</h1></div></div></div><p>
395395
To authenticate users with GitHub or GitHub Enterprise:
396396
</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
397397
<a class="link" href="#enabling-authentication-with-github" title="3.1. Enabling authentication with GitHub">Enable the GitHub authentication provider in Developer Hub</a>.
@@ -558,7 +558,35 @@
558558
github:
559559
production:
560560
enterpriseInstanceUrl: ${GITHUB_HOST_DOMAIN}</pre>
561-
</p></div></dd></dl></div></li></ol></div><div class="orderedlist"><p class="title"><strong>Verification</strong></p><ol class="orderedlist" type="1"><li class="listitem">
561+
</p></div></dd></dl></div><div class="admonition tip"><div class="admonition_header">Tip</div><div><p>
562+
To enable GitHub integration with a different authentication provider, complete the following configurations:
563+
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
564+
Add the GitHub provider to the existing <code class="literal">auth</code> section.
565+
</li><li class="listitem">
566+
Keep the <code class="literal">signInPage</code> section from your authentication provider configuration.
567+
</li></ul></div><div class="formalpara"><p class="title"><strong><code class="literal">app-config-rhdh.yaml</code> fragment with mandatory fields to enable GitHub integration and use a different authentication provider</strong></p><p>
568+
569+
<pre class="programlisting language-yaml">auth:
570+
environment: production
571+
providers:
572+
github:
573+
production:
574+
clientId: ${AUTH_GITHUB_CLIENT_ID}
575+
clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
576+
<span class="emphasis"><em>&lt;your_other_authentication_providers_configuration&gt;</em></span>
577+
integrations:
578+
github:
579+
- host: ${GITHUB_HOST_DOMAIN}
580+
apps:
581+
- appId: ${AUTH_GITHUB_APP_ID}
582+
clientId: ${AUTH_GITHUB_CLIENT_ID}
583+
clientSecret: ${GITHUB_CLIENT_SECRET}
584+
webhookUrl: ${GITHUB_WEBHOOK_URL}
585+
webhookSecret: ${GITHUB_WEBHOOK_SECRET}
586+
privateKey: |
587+
${GITHUB_PRIVATE_KEY_FILE}
588+
signInPage: <span class="emphasis"><em>&lt;your_main_authentication_provider&gt;</em></span></pre>
589+
</p></div></div></div></li></ol></div><div class="orderedlist"><p class="title"><strong>Verification</strong></p><ol class="orderedlist" type="1"><li class="listitem">
562590
Go to the Developer Hub login page.
563591
</li><li class="listitem">
564592
Your Developer Hub sign-in page displays <span class="strong strong"><strong>Sign in using GitHub</strong></span> and the Guest user sign-in is disabled.
@@ -922,7 +950,7 @@
922950
backend:start: {"class":"MicrosoftGraphOrgEntityProvider$1","level":"info","message":"Committed 1 msgraph users and 1 msgraph groups in 0.0 seconds.","plugin":"catalog","service":"backstage","taskId":"MicrosoftGraphOrgEntityProvider:default:refresh","taskInstanceId":"88a67ce1-c466-41a4-9760-825e16b946be","timestamp":"2024-06-26 12:23:42"}</pre>
923951
</p></div></li><li class="listitem">
924952
Log in with a Microsoft Azure account.
925-
</li></ol></div></section></section><div><div xml:lang="en-US" class="legalnotice" id="idm45576496171136"><h1 class="legalnotice">Legal Notice</h1><div class="para">
953+
</li></ol></div></section></section><div><div xml:lang="en-US" class="legalnotice" id="idm45894820388432"><h1 class="legalnotice">Legal Notice</h1><div class="para">
926954
Copyright <span class="trademark"/>© 2024 Red Hat, Inc.
927955
</div><div class="para">
928956
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at <a class="uri" href="http://creativecommons.org/licenses/by-sa/3.0/">http://creativecommons.org/licenses/by-sa/3.0/</a>. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

0 commit comments

Comments
 (0)