Skip to content

Commit

Permalink
deploy: 2bcae96
Browse files Browse the repository at this point in the history
  • Loading branch information
@jmagak
jmagak committed Feb 6, 2025
1 parent 190e642 commit 81f7403
Show file tree
Hide file tree
Showing 24 changed files with 1,762 additions and 1,589 deletions.
66 changes: 34 additions & 32 deletions pr-914/about/index.html
View file

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions pr-914/audit-log/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" class="chrometwo"><head><title>Audit log</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 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="idm45781527696080"><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">Audit log</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="#idm45781506718320">Legal Notice</a></div><div><div class="abstract"><p class="title"><strong>Abstract</strong></p><div class="para">
<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 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="idm45560245760112"><div class="titlepage"><div><div class="producttitle"><span class="productname">Red Hat Developer Hub</span> <span class="productnumber">1.5</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="#idm45560222440880">Legal Notice</a></div><div><div class="abstract"><p class="title"><strong>Abstract</strong></p><div class="para">
As a Red Hat Developer Hub administrator, you can track user activities, system events, and data changes with Developer Hub audit logs.
</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></li><li><span class="section"><a href="#con-audit-log-config_assembly-audit-log">2. Configuring audit logs for Developer Hub on OpenShift Container Platform</a></span><ul><li><span class="section"><a href="#proc-forward-audit-log-splunk_assembly-audit-log">2.1. Forwarding Red Hat Developer Hub audit logs to Splunk</a></span></li></ul></li><li><span class="section"><a href="#proc-audit-log-view_assembly-audit-log">3. Viewing audit logs in Developer Hub</a></span><ul><li><span class="section"><a href="#ref-audit-log-fields.adoc_assembly-audit-log">3.1. Audit log fields</a></span></li><li><span class="section"><a href="#ref-audit-log-scaffolder-events.adoc_assembly-audit-log">3.2. Scaffolder events</a></span></li><li><span class="section"><a href="#ref-audit-log-catalog-events.adoc_assembly-audit-log">3.3. Catalog events</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>
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:
Expand Down Expand Up @@ -33,11 +33,11 @@
</li></ul></div></section><section class="section" id="con-audit-log-config_assembly-audit-log"><div class="titlepage"><div><div><h2 class="title">2. Configuring audit logs for Developer Hub on OpenShift Container Platform</h2></div></div></div><p>
Use the OpenShift Container Platform web console to configure the following OpenShift Container Platform logging components to use audit logging for Developer Hub:
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">Logging deployment</span></dt><dd>
Configure the logging environment, including both the CPU and memory limits for each logging component. For more information, see <a class="link" href="https://docs.openshift.com/container-platform/4.15/observability/logging/config/cluster-logging-memory.html">Red Hat OpenShift Container Platform - Configuring your Logging deployment</a>.
Configure the logging environment, including both the CPU and memory limits for each logging component. For more information, see <a class="link" href="https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html-single/logging/index#cluster-logging-memory">Red Hat OpenShift Container Platform - Configuring your Logging deployment</a>.
</dd><dt><span class="term">Logging collector</span></dt><dd>
Configure the <code class="literal">spec.collection</code> stanza in the <code class="literal">ClusterLogging</code> custom resource (CR) to use a supported modification to the log collector and collect logs from <code class="literal">STDOUT</code>. For more information, see <a class="link" href="https://docs.openshift.com/container-platform/4.15/observability/logging/log_collection_forwarding/cluster-logging-collector.html">Red Hat OpenShift Container Platform - Configuring the logging collector</a>.
Configure the <code class="literal">spec.collection</code> stanza in the <code class="literal">ClusterLogging</code> custom resource (CR) to use a supported modification to the log collector and collect logs from <code class="literal">STDOUT</code>. For more information, see <a class="link" href="https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html-single/logging/index#cluster-logging-collector">Red Hat OpenShift Container Platform - Configuring the logging collector</a>.
</dd><dt><span class="term">Log forwarding</span></dt><dd>
Send logs to specific endpoints inside and outside your OpenShift Container Platform cluster by specifying a combination of outputs and pipelines in a <code class="literal">ClusterLogForwarder</code> CR. For more information, see <a class="link" href="https://docs.openshift.com/container-platform/4.15/observability/logging/log_collection_forwarding/cluster-logging-enabling-json-logging.html">Red Hat OpenShift Container Platform - Enabling JSON log forwarding</a> and <a class="link" href="https://docs.openshift.com/container-platform/4.15/observability/logging/log_collection_forwarding/configuring-log-forwarding.html">Red Hat OpenShift Container Platform - Configuring log forwarding</a>.
Send logs to specific endpoints inside and outside your OpenShift Container Platform cluster by specifying a combination of outputs and pipelines in a <code class="literal">ClusterLogForwarder</code> CR. For more information, see <a class="link" href="https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html-single/logging/index#cluster-logging-json-log-forwarding_cluster-logging-enabling-json-logging">Red Hat OpenShift Container Platform - Enabling JSON log forwarding</a> and <a class="link" href="https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html-single/logging/index#configuring-log-forwarding">Red Hat OpenShift Container Platform - Configuring log forwarding</a>.
</dd></dl></div><section class="section" id="proc-forward-audit-log-splunk_assembly-audit-log"><div class="titlepage"><div><div><h3 class="title">2.1. Forwarding Red Hat Developer Hub audit logs to Splunk</h3></div></div></div><p>
You can use the Red Hat OpenShift Logging (OpenShift Logging) Operator and a <code class="literal">ClusterLogForwarder</code> instance to capture the streamed audit logs from a Developer Hub instance and forward them to the HTTPS endpoint associated with your Splunk instance.
</p><div class="itemizedlist"><p class="title"><strong>Prerequisites</strong></p><ul class="itemizedlist" type="disc"><li class="listitem">
Expand Down Expand Up @@ -99,7 +99,7 @@
type: application
application:
includes:
- namespace: my-developer-hub-namespace
- namespace: my-rhdh-project
containerLimit:
maxRecordsPerSecond: 100</pre>
</p></div><p class="simpara">
Expand Down Expand Up @@ -308,7 +308,7 @@
Tracks <code class="literal">GET</code> requests to the <code class="literal">/locations/:id</code> endpoint, which returns a location matching the specified location ID
</dd><dt><span class="term"><code class="literal">QueriedCatalogEntityFetch</code></span></dt><dd>
Tracks <code class="literal">GET</code> requests to the <code class="literal">/entities/by-query</code> endpoint, which returns a list of entities matching the specified query
</dd></dl></div></section></section><div><div xml:lang="en-US" class="legalnotice" id="idm45781506718320"><h1 class="legalnotice">Legal Notice</h1><div class="para">
</dd></dl></div></section></section><div><div xml:lang="en-US" class="legalnotice" id="idm45560222440880"><h1 class="legalnotice">Legal Notice</h1><div class="para">
Copyright <span class="trademark"/>© 2025 Red Hat, Inc.
</div><div class="para">
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.
Expand Down
Loading

0 comments on commit 81f7403

Please sign in to comment.