|
1 | 1 | <?xml version='1.0' encoding='UTF-8'?> |
2 | 2 | <!DOCTYPE html> |
3 | | -<html xmlns="http://www.w3.org/1999/xhtml" class="chrometwo"><head><title>Administration guide for Red Hat Developer Hub</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="Red Hat Developer Hub is an enterprise-grade platform for building developer portals. As an administrative user, you can manage roles and permissions of other users and configure Developer Hub to meet the specific needs of your organization."/><link rel="next" href="#idm45506177400352" 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="idm45506172500416"><div class="titlepage"><div><div class="producttitle"><span class="productname">Red Hat Developer Hub</span> <span class="productnumber">1.4</span></div><div><h1 class="title">Administration guide for Red Hat Developer Hub</h1></div><div><h2 class="subtitle"/></div><div><div xml:lang="en-US" class="authorgroup"><span class="orgname">Red Hat Customer Content Services</span></div></div><div><a href="#idm45506173205120">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>Administration guide for Red Hat Developer Hub</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="Red Hat Developer Hub is an enterprise-grade platform for building developer portals. As an administrative user, you can manage roles and permissions of other users and configure Developer Hub to meet the specific needs of your organization."/><link rel="next" href="#idm44920260411696" 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="idm44920260349168"><div class="titlepage"><div><div class="producttitle"><span class="productname">Red Hat Developer Hub</span> <span class="productnumber">1.4</span></div><div><h1 class="title">Administration guide for Red Hat Developer Hub</h1></div><div><h2 class="subtitle"/></div><div><div xml:lang="en-US" class="authorgroup"><span class="orgname">Red Hat Customer Content Services</span></div></div><div><a href="#idm44920256216416">Legal Notice</a></div><div><div class="abstract"><p class="title"><strong>Abstract</strong></p><div class="para"> |
4 | 4 | Red Hat Developer Hub is an enterprise-grade platform for building developer portals. As an administrative user, you can manage roles and permissions of other users and configure Developer Hub 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="#idm45506177400352">Preface</a></span></li><li><span class="preface"><a href="#snip-customer-support-info_admin-rhdh">Red Hat Developer Hub support</a></span></li><li><span class="chapter"><a href="#assembly-add-custom-app-file-openshift_admin-rhdh">1. Adding a custom application configuration file to Red Hat OpenShift Container Platform</a></span><ul><li><span class="section"><a href="#proc-add-custom-app-file-openshift-helm_admin-rhdh">1.1. Adding a custom application configuration file to OpenShift Container Platform using the Helm chart</a></span></li><li><span class="section"><a href="#proc-add-custom-app-config-file-ocp-operator_admin-rhdh">1.2. Adding a custom application configuration file to OpenShift Container Platform using the Operator</a></span></li></ul></li><li><span class="chapter"><a href="#assembly-configuring-external-postgresql-databases">2. Configuring external PostgreSQL databases</a></span><ul><li><span class="section"><a href="#proc-configuring-postgresql-instance-using-operator_admin-rhdh">2.1. Configuring an external PostgreSQL instance using the Operator</a></span></li><li><span class="section"><a href="#proc-configuring-postgresql-instance-using-helm_admin-rhdh">2.2. Configuring an external PostgreSQL instance using the Helm Chart</a></span></li><li><span class="section"><a href="#proc-migrating-databases-to-an-external-server_admin-rhdh">2.3. Migrating local databases to an external database server using the Operator</a></span></li></ul></li><li><span class="chapter"><a href="#proc-configuring-an-rhdh-instance-with-tls-in-kubernetes_admin-rhdh">3. Configuring an RHDH instance with a TLS connection in Kubernetes</a></span></li><li><span class="chapter"><a href="#assembly-running-rhdh-behind-a-proxy">4. Running the RHDH application behind a corporate proxy</a></span><ul><li><span class="section"><a href="#understanding-no-proxy">4.1. Understanding the <code class="literal">NO_PROXY</code> exclusion rules</a></span></li><li><span class="section"><a href="#proc-configuring-proxy-in-helm-deployment_admin-rhdh">4.2. Configuring proxy information in Helm deployment</a></span></li><li><span class="section"><a href="#proc-configuring-proxy-in-operator-deployment_admin-rhdh">4.3. Configuring proxy information in Operator deployment</a></span></li></ul></li><li><span class="chapter"><a href="#assembly-rhdh-integration-aws">5. Red Hat Developer Hub integration with Amazon Web Services (AWS)</a></span></li><li><span class="chapter"><a href="#assembly-admin-templates">6. Managing templates</a></span><ul><li><span class="section"><a href="#proc-creating-templates_assembly-admin-templates">6.1. Creating a template by using the Template Editor</a></span></li><li><span class="section"><a href="#ref-creating-templates_assembly-admin-templates">6.2. Creating a template as a YAML file</a></span></li><li><span class="section"><a href="#proc-adding-templates_assembly-admin-templates">6.3. Importing an existing template to Red Hat Developer Hub</a></span></li></ul></li><li><span class="chapter"><a href="#assembly-techdocs-plugin_assembly-admin-templates">7. Configuring the TechDocs plugin in Red Hat Developer Hub</a></span><ul><li><span class="section"><a href="#con-techdocs-configure-storage_assembly-admin-templates">7.1. Configuring storage for TechDocs files</a></span><ul><li><span class="section"><a href="#proc-techdocs-using-odf-storage_assembly-admin-templates">7.1.1. Using OpenShift Data Foundation for file storage</a></span></li><li><span class="section"><a href="#proc-techdocs-configure-odf-helm_assembly-admin-templates">7.1.2. Making object storage accessible to containers by using the Helm chart</a></span></li><li><span class="section"><a href="#proc-techdocs-configure-odf-operator_assembly-admin-templates">7.1.3. Making object storage accessible to containers by using the Operator</a></span></li></ul></li><li><span class="section"><a href="#con-techdocs-config-cicd_assembly-admin-templates">7.2. Configuring CI/CD to generate and publish TechDocs sites</a></span><ul><li><span class="section"><a href="#proc-techdocs-config-cicd-prep-repo_assembly-admin-templates">7.2.1. Preparing your repository for CI</a></span></li><li><span class="section"><a href="#proc-techdocs-generate-site_assembly-admin-templates">7.2.2. Generating the TechDocs site</a></span></li><li><span class="section"><a href="#proc-techdocs-publish-site_assembly-admin-templates">7.2.3. Publishing the TechDocs site</a></span></li></ul></li></ul></li><li><span class="chapter"><a href="#proc-rhdh-deployment-config_assembly-admin-templates">8. Configuring Red Hat Developer Hub deployment</a></span></li></ul></div><section class="preface" id="idm45506177400352"><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="#idm44920260411696">Preface</a></span></li><li><span class="preface"><a href="#snip-customer-support-info_admin-rhdh">Red Hat Developer Hub support</a></span></li><li><span class="chapter"><a href="#assembly-add-custom-app-file-openshift_admin-rhdh">1. Adding a custom application configuration file to Red Hat OpenShift Container Platform</a></span><ul><li><span class="section"><a href="#proc-add-custom-app-file-openshift-helm_admin-rhdh">1.1. Adding a custom application configuration file to OpenShift Container Platform using the Helm chart</a></span></li><li><span class="section"><a href="#proc-add-custom-app-config-file-ocp-operator_admin-rhdh">1.2. Adding a custom application configuration file to OpenShift Container Platform using the Operator</a></span></li></ul></li><li><span class="chapter"><a href="#assembly-configuring-external-postgresql-databases">2. Configuring external PostgreSQL databases</a></span><ul><li><span class="section"><a href="#proc-configuring-postgresql-instance-using-operator_admin-rhdh">2.1. Configuring an external PostgreSQL instance using the Operator</a></span></li><li><span class="section"><a href="#proc-configuring-postgresql-instance-using-helm_admin-rhdh">2.2. Configuring an external PostgreSQL instance using the Helm Chart</a></span></li><li><span class="section"><a href="#proc-migrating-databases-to-an-external-server_admin-rhdh">2.3. Migrating local databases to an external database server using the Operator</a></span></li></ul></li><li><span class="chapter"><a href="#proc-configuring-an-rhdh-instance-with-tls-in-kubernetes_admin-rhdh">3. Configuring an RHDH instance with a TLS connection in Kubernetes</a></span></li><li><span class="chapter"><a href="#assembly-running-rhdh-behind-a-proxy">4. Running the RHDH application behind a corporate proxy</a></span><ul><li><span class="section"><a href="#understanding-no-proxy">4.1. Understanding the <code class="literal">NO_PROXY</code> exclusion rules</a></span></li><li><span class="section"><a href="#proc-configuring-proxy-in-helm-deployment_admin-rhdh">4.2. Configuring proxy information in Helm deployment</a></span></li><li><span class="section"><a href="#proc-configuring-proxy-in-operator-deployment_admin-rhdh">4.3. Configuring proxy information in Operator deployment</a></span></li></ul></li><li><span class="chapter"><a href="#assembly-rhdh-integration-aws">5. Red Hat Developer Hub integration with Amazon Web Services (AWS)</a></span></li><li><span class="chapter"><a href="#assembly-admin-templates">6. Managing templates</a></span><ul><li><span class="section"><a href="#proc-creating-templates_assembly-admin-templates">6.1. Creating a template by using the Template Editor</a></span></li><li><span class="section"><a href="#ref-creating-templates_assembly-admin-templates">6.2. Creating a template as a YAML file</a></span></li><li><span class="section"><a href="#proc-adding-templates_assembly-admin-templates">6.3. Importing an existing template to Red Hat Developer Hub</a></span></li></ul></li><li><span class="chapter"><a href="#assembly-techdocs-plugin_assembly-admin-templates">7. Configuring the TechDocs plugin in Red Hat Developer Hub</a></span><ul><li><span class="section"><a href="#con-techdocs-configure-storage_assembly-admin-templates">7.1. Configuring storage for TechDocs files</a></span><ul><li><span class="section"><a href="#proc-techdocs-using-odf-storage_assembly-admin-templates">7.1.1. Using OpenShift Data Foundation for file storage</a></span></li><li><span class="section"><a href="#proc-techdocs-configure-odf-helm_assembly-admin-templates">7.1.2. Making object storage accessible to containers by using the Helm chart</a></span></li><li><span class="section"><a href="#proc-techdocs-configure-odf-operator_assembly-admin-templates">7.1.3. Making object storage accessible to containers by using the Operator</a></span></li></ul></li><li><span class="section"><a href="#con-techdocs-config-cicd_assembly-admin-templates">7.2. Configuring CI/CD to generate and publish TechDocs sites</a></span><ul><li><span class="section"><a href="#proc-techdocs-config-cicd-prep-repo_assembly-admin-templates">7.2.1. Preparing your repository for CI</a></span></li><li><span class="section"><a href="#proc-techdocs-generate-site_assembly-admin-templates">7.2.2. Generating the TechDocs site</a></span></li><li><span class="section"><a href="#proc-techdocs-publish-site_assembly-admin-templates">7.2.3. Publishing the TechDocs site</a></span></li></ul></li></ul></li><li><span class="chapter"><a href="#proc-rhdh-deployment-config_assembly-admin-templates">8. Configuring Red Hat Developer Hub deployment</a></span></li></ul></div><section class="preface" id="idm44920260411696"><div class="titlepage"><div><div><h1 class="title">Preface</h1></div></div></div><p> |
6 | 6 | Red Hat Developer Hub is an enterprise-grade, open developer platform that you can use to build developer portals. This platform contains a supported and opinionated framework that helps reduce the friction and frustration of developers while boosting their productivity. |
7 | 7 | </p></section><section class="preface" id="snip-customer-support-info_admin-rhdh"><div class="titlepage"><div><div><h1 class="title">Red Hat Developer Hub support</h1></div></div></div><p> |
8 | 8 | If you experience difficulty with a procedure described in this documentation, visit the <a class="link" href="http://access.redhat.com">Red Hat Customer Portal</a>. You can use the Red Hat Customer Portal for the following purposes: |
|
1304 | 1304 | image: quay.io/my-org/my-sidecar:latest</pre> |
1305 | 1305 | </p></div></dd></dl></div><div class="itemizedlist _additional-resources"><p class="title"><strong>Additional resources</strong></p><ul class="itemizedlist _additional-resources" type="disc"><li class="listitem"> |
1306 | 1306 | To learn more about merging, see <a class="link" href="https://github.com/kubernetes/community/blob/master/contributors/devel/sig-api-machinery/strategic-merge-patch.md#basic-patch-format">Strategic Merge Patch</a>. |
1307 | | - </li></ul></div></section><div><div xml:lang="en-US" class="legalnotice" id="idm45506173205120"><h1 class="legalnotice">Legal Notice</h1><div class="para"> |
| 1307 | + </li></ul></div></section><div><div xml:lang="en-US" class="legalnotice" id="idm44920256216416"><h1 class="legalnotice">Legal Notice</h1><div class="para"> |
1308 | 1308 | Copyright <span class="trademark"/>© 2024 Red Hat, Inc. |
1309 | 1309 | </div><div class="para"> |
1310 | 1310 | 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