Skip to content

Commit 95012f2

Browse files
themr0cthemr0c
committed
deploy: 472dc52 
1 parent e077d0c commit 95012f2

File tree

36 files changed

+4134
-3474
lines changed

36 files changed

+4134
-3474
lines changed

‎release-1.8/about/index.html‎

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

‎release-1.8/adoption-insights/index.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version='1.0' encoding='UTF-8'?>
22
<!DOCTYPE html>
3-
<html xmlns="http://www.w3.org/1999/xhtml" class="chrometwo"><head><title>Adoption Insights in 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="As a platform engineer, you can configure Adoption Insights in Red Hat Developer Hub (RHDH) to visualize key metrics and trends to get information about the usage of RHDH in your organization."/><link rel="next" href="#assembly-adoption-insights" title="1. Adoption Insights"/><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"><section xml:lang="en-US" class="article" id="idm45371154420624"><div class="titlepage"><div><div class="producttitle"><span class="productname">Red Hat Developer Hub</span> <span class="productnumber">1.8</span></div><div><h1 class="title">Adoption Insights in Red Hat Developer Hub</h1></div><div><h3 class="subtitle"><em>Delivering detailed analytics on adoption and engagement within your internal developer portal</em></h3></div><div><div xml:lang="en-US" class="authorgroup"><span class="orgname">Red Hat Customer Content Services</span></div></div><div><a href="#idm45371137260896">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>Adoption Insights in 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="As a platform engineer, you can configure Adoption Insights in Red Hat Developer Hub (RHDH) to visualize key metrics and trends to get information about the usage of RHDH in your organization."/><link rel="next" href="#assembly-adoption-insights" title="1. Adoption Insights"/><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"><section xml:lang="en-US" class="article" id="idm45898528587040"><div class="titlepage"><div><div class="producttitle"><span class="productname">Red Hat Developer Hub</span> <span class="productnumber">1.8</span></div><div><h1 class="title">Adoption Insights in Red Hat Developer Hub</h1></div><div><h3 class="subtitle"><em>Delivering detailed analytics on adoption and engagement within your internal developer portal</em></h3></div><div><div xml:lang="en-US" class="authorgroup"><span class="orgname">Red Hat Customer Content Services</span></div></div><div><a href="#idm45898516550608">Legal Notice</a></div><div><div class="abstract"><p class="title"><strong>Abstract</strong></p><div class="para">
44
As a platform engineer, you can configure Adoption Insights in Red Hat Developer Hub (RHDH) to visualize key metrics and trends to get information about the usage of RHDH in your organization.
55
</div></div></div></div><hr/></div><div class="toc"><ul class="toc"><li><span class="section"><a href="#assembly-adoption-insights">1. Adoption Insights</a></span><ul><li><span class="section"><a href="#proc-configure-adoption-insights_title-adoption-insights">1.1. Configuring the Adoption Insights plugin in Red Hat Developer Hub</a></span></li><li><span class="section"><a href="#proc-customize-adoption-insights_title-adoption-insights">1.2. Customizing the Adoption Insights plugin in Red Hat Developer Hub</a></span></li><li><span class="section"><a href="#proc-using-adoption-insights_title-adoption-insights">1.3. Using Adoption Insights in Red Hat Developer Hub</a></span></li><li><span class="section"><a href="#proc-viewing-adoption-insights-card_title-adoption-insights">1.4. Viewing the Adoption Insights card</a></span></li><li><span class="section"><a href="#proc-modify-number-of-displayed-records_title-adoption-insights">1.5. Modifying the number of displayed records</a></span></li><li><span class="section"><a href="#proc-filter-records-to-display-spec_title-adoption-insights">1.6. Filtering records to display specific catalog entities in Top catalog entities</a></span></li><li><span class="section"><a href="#proc-viewing-searches_title-adoption-insights">1.7. Viewing Searches</a></span></li></ul></li></ul></div><section class="section" id="assembly-adoption-insights"><div class="titlepage"><div><div><h2 class="title">1. Adoption Insights</h2></div></div></div><p>
66
The Red Hat Developer Hub instance includes the Adoption Insights plugin preinstalled and enabled by default.
@@ -27,9 +27,9 @@
2727
</li></ul></div><div class="informalfigure"><div class="mediaobject"><img src="images/rhdh-plugins-reference/adoption-insights.jpg" alt="adoption insights"/></div></div><section class="section" id="proc-configure-adoption-insights_title-adoption-insights"><div class="titlepage"><div><div><h3 class="title">1.1. Configuring the Adoption Insights plugin in Red Hat Developer Hub</h3></div></div></div><p>
2828
The Adoption Insights plugin is preinstalled and enabled on a Developer Hub instance by default. You can disable or enable the Adoption Insights plugin and change other parameters, by configuring the <code class="literal">app-config</code> ConfigMap, which is created by the Red Hat Developer Hub Helm chart or Operator.
2929
</p><div class="admonition important"><div class="admonition_header">Important</div><div><p>
30-
If you used the Developer Preview of the Adoption Insights plugin and configured the feature manually, you must remove those earlier configuration changes as they are no longer required.
30+
If you previously used the Developer Preview of the Adoption Insights plugin and enabled the plugin manually, you must remove those earlier plugins as they are no longer required, and Adoption Insights is enabled by default.
3131
</p><p>
32-
In your dynamic plugins ConfigMap, for example: <code class="literal">dynamic-plugins-rhdh.yaml</code>, update the <code class="literal">package-disabled</code> value of the plugin to <code class="literal">false</code> as shown in the following example:
32+
In your dynamic plugins ConfigMap, for example: <code class="literal">dynamic-plugins-rhdh.yaml</code>, remove the references to <code class="literal">red-hat-developer-hub-backstage-plugin-adoption-insights</code>, <code class="literal">red-hat-developer-hub-backstage-plugin-adoption-insights-backend</code>, and <code class="literal">red-hat-developer-hub-backstage-plugin-analytics-module-adoption-insights</code>. Additionally update the <code class="literal">package.disabled</code> value of the <code class="literal">backstage-community-plugin-analytics-provider-segment</code> plugin to <code class="literal">false</code> as shown in the following example:
3333
</p><div class="formalpara"><p class="title"><strong><code class="literal">dynamic-plugins.yaml</code> fragment</strong></p><p>
3434

3535
<pre class="programlisting language-yaml">plugins:
@@ -39,7 +39,7 @@
3939
You can customize the Adoption Insights plugin to suit your needs by disabling or re-enabling it, and adjusting other settings as needed.
4040
</p><div class="itemizedlist"><p class="title"><strong>Procedure</strong></p><ul class="itemizedlist" type="disc"><li class="listitem"><p class="simpara">
4141
To customize <code class="literal">maxBufferSize</code>, <code class="literal">flushInterval</code>, <code class="literal">debug</code>, and <code class="literal">licensedUsers</code> in the Adoption Insights plugin, in your Red Hat Developer Hub <code class="literal">app-config.yaml</code> file, update the relevant settings as shown in the following code:
42-
</p><pre class="programlisting language-terminal">app:
42+
</p><pre class="programlisting language-yaml">app:
4343
analytics:
4444
adoptionInsights:
4545
maxBufferSize: _&lt;maximum_buffer_size&gt;_ <span id="CO1-1"/><span class="callout">1</span>
@@ -187,8 +187,8 @@
187187
Displays the total for the period in the card title
188188
</li><li class="listitem">
189189
Clarifies the average number each hour/day/week/month depending on the time period chosen
190-
</li></ul></div></section></section><div><div xml:lang="en-US" class="legalnotice" id="idm45371137260896"><h1 class="legalnotice">Legal Notice</h1><div class="para">
191-
Copyright <span class="trademark"/>© 2025 Red Hat, Inc.
190+
</li></ul></div></section></section><div><div xml:lang="en-US" class="legalnotice" id="idm45898516550608"><h1 class="legalnotice">Legal Notice</h1><div class="para">
191+
Copyright <span class="trademark"/>© 2026 Red Hat, Inc.
192192
</div><div class="para">
193193
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.
194194
</div><div class="para">

‎release-1.8/audit-log/index.html‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version='1.0' encoding='UTF-8'?>
22
<!DOCTYPE html>
3-
<html xmlns="http://www.w3.org/1999/xhtml" class="chrometwo"><head><title>Audit logs in 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="As a Red Hat Developer Hub (RHDH) administrator, you can track user activities, system events, and data changes with Developer Hub audit logs."/><link rel="next" href="#assembly-audit-log" title="1. Audit logs in Red Hat Developer Hub"/><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"><section xml:lang="en-US" class="article" id="idm46326254547744"><div class="titlepage"><div><div class="producttitle"><span class="productname">Red Hat Developer Hub</span> <span class="productnumber">1.8</span></div><div><h1 class="title">Audit logs in Red Hat Developer Hub</h1></div><div><h3 class="subtitle"><em>Tracking user activities, system events, and data changes with Red Hat Developer Hub audit logs</em></h3></div><div><div xml:lang="en-US" class="authorgroup"><span class="orgname">Red Hat Customer Content Services</span></div></div><div><a href="#idm46326254821904">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>Audit logs in 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="As a Red Hat Developer Hub (RHDH) administrator, you can track user activities, system events, and data changes with Developer Hub audit logs."/><link rel="next" href="#assembly-audit-log" title="1. Audit logs in Red Hat Developer Hub"/><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"><section xml:lang="en-US" class="article" id="idm46680292852208"><div class="titlepage"><div><div class="producttitle"><span class="productname">Red Hat Developer Hub</span> <span class="productnumber">1.8</span></div><div><h1 class="title">Audit logs in Red Hat Developer Hub</h1></div><div><h3 class="subtitle"><em>Tracking user activities, system events, and data changes with Red Hat Developer Hub audit logs</em></h3></div><div><div xml:lang="en-US" class="authorgroup"><span class="orgname">Red Hat Customer Content Services</span></div></div><div><a href="#idm46680293022688">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 (RHDH) administrator, you can track user activities, system events, and data changes with Developer Hub audit logs.
55
</div></div></div></div><hr/></div><div class="toc"><ul class="toc"><li><span class="section"><a href="#assembly-audit-log">1. Audit logs in Red Hat Developer Hub</a></span><ul><li><span class="section"><a href="#con-audit-log-config_assembly-audit-log">1.1. Configuring audit logs for Developer Hub on OpenShift Container Platform</a></span></li><li><span class="section"><a href="#proc-forward-audit-log-splunk_assembly-audit-log">1.2. Forwarding Red Hat Developer Hub audit logs to Splunk</a></span></li><li><span class="section"><a href="#proc-audit-log-view_assembly-audit-log">1.3. Viewing audit logs in Developer Hub</a></span></li></ul></li></ul></div><section class="section" id="assembly-audit-log"><div class="titlepage"><div><div><h2 class="title">1. Audit logs in Red Hat Developer Hub</h2></div></div></div><p>
66
Audit logs are a chronological set of records documenting the user activities, system events, and data changes that affect your Red Hat Developer Hub users, administrators, or components. Administrators can view Developer Hub audit logs in the OpenShift Container Platform web console to monitor scaffolder events, changes to the RBAC system, and changes to the Catalog database. Audit logs include the following information:
@@ -54,25 +54,25 @@
5454
Install the OpenShift Logging Operator in the <code class="literal">openshift-logging</code> namespace and switch to the namespace:
5555
</p><div class="formalpara"><p class="title"><strong>Example command to switch to a namespace</strong></p><p>
5656

57-
<pre class="programlisting language-bash">oc project openshift-logging</pre>
57+
<pre class="programlisting language-bash">$ oc project openshift-logging</pre>
5858
</p></div></li><li class="listitem"><p class="simpara">
5959
Create a <code class="literal">serviceAccount</code> named <code class="literal">log-collector</code> and bind the <code class="literal">collect-application-logs</code> role to the <code class="literal">serviceAccount</code> :
6060
</p><div class="formalpara"><p class="title"><strong>Example command to create a <code class="literal">serviceAccount</code></strong></p><p>
6161

62-
<pre class="programlisting language-bash">oc create sa log-collector</pre>
62+
<pre class="programlisting language-bash">$ oc create sa log-collector</pre>
6363
</p></div><div class="formalpara"><p class="title"><strong>Example command to bind a role to a <code class="literal">serviceAccount</code></strong></p><p>
6464

65-
<pre class="programlisting language-bash">oc create clusterrolebinding log-collector --clusterrole=collect-application-logs --serviceaccount=openshift-logging:log-collector</pre>
65+
<pre class="programlisting language-bash">$ oc create clusterrolebinding log-collector --clusterrole=collect-application-logs --serviceaccount=openshift-logging:log-collector</pre>
6666
</p></div></li><li class="listitem">
6767
Generate a <code class="literal">hecToken</code> in your Splunk instance.
6868
</li><li class="listitem"><p class="simpara">
6969
Create a key/value secret in the <code class="literal">openshift-logging</code> namespace and verify the secret:
7070
</p><div class="formalpara"><p class="title"><strong>Example command to create a key/value secret with <code class="literal">hecToken</code></strong></p><p>
7171

72-
<pre class="programlisting language-bash">oc -n openshift-logging create secret generic splunk-secret --from-literal=hecToken=&lt;HEC_Token&gt;</pre>
72+
<pre class="programlisting language-bash">$ oc -n openshift-logging create secret generic splunk-secret --from-literal=hecToken=&lt;HEC_Token&gt;</pre>
7373
</p></div><div class="formalpara"><p class="title"><strong>Example command to verify a secret</strong></p><p>
7474

75-
<pre class="programlisting language-bash">oc -n openshift-logging get secret/splunk-secret -o yaml</pre>
75+
<pre class="programlisting language-bash">$ oc -n openshift-logging get secret/splunk-secret -o yaml</pre>
7676
</p></div></li><li class="listitem"><p class="simpara">
7777
Create a basic `ClusterLogForwarder`resource YAML file as follows:
7878
</p><div class="formalpara"><p class="title"><strong>Example `ClusterLogForwarder`resource YAML file</strong></p><p>
@@ -154,7 +154,7 @@
154154
Run the following command to apply the <code class="literal">ClusterLogForwarder</code> configuration:
155155
</p><div class="formalpara"><p class="title"><strong>Example command to apply <code class="literal">ClusterLogForwarder</code> configuration</strong></p><p>
156156

157-
<pre class="programlisting language-bash">oc apply -f &lt;ClusterLogForwarder-configuration.yaml&gt;</pre>
157+
<pre class="programlisting language-bash">$ oc apply -f &lt;ClusterLogForwarder-configuration.yaml&gt;</pre>
158158
</p></div></li><li class="listitem"><p class="simpara">
159159
Optional: To reduce the risk of log loss, configure your <code class="literal">ClusterLogForwarder</code> pods using the following options:
160160
</p><div class="orderedlist"><ol class="orderedlist" type="a"><li class="listitem"><p class="simpara">
@@ -202,8 +202,8 @@
202202
From the <span class="strong strong"><strong>Logs</strong></span> view, enter <code class="literal">isAuditEvent</code> into the <span class="strong strong"><strong>Search</strong></span> field to filter audit logs from other log types. You can use the arrows to browse the logs containing the <code class="literal">isAuditEvent</code> field.
203203
</li></ol></div><div class="itemizedlist _additional-resources"><p class="title"><strong>Additional resources</strong></p><ul class="itemizedlist _additional-resources" type="disc"><li class="listitem">
204204
<a class="link" href="https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/observability/logging/cluster-logging.html">About Logging in Red Hat OpenShift Container Platform</a>
205-
</li></ul></div></section></section><div><div xml:lang="en-US" class="legalnotice" id="idm46326254821904"><h1 class="legalnotice">Legal Notice</h1><div class="para">
206-
Copyright <span class="trademark"/>© 2025 Red Hat, Inc.
205+
</li></ul></div></section></section><div><div xml:lang="en-US" class="legalnotice" id="idm46680293022688"><h1 class="legalnotice">Legal Notice</h1><div class="para">
206+
Copyright <span class="trademark"/>© 2026 Red Hat, Inc.
207207
</div><div class="para">
208208
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.
209209
</div><div class="para">

0 commit comments

Comments
 (0)