Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions artifacts/attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
:product: Red Hat Developer Hub
:product-short: Developer Hub
:product-very-short: RHDH
:product-version: 1.3
:product-bundle-version: 1.3.0
:product-chart-version: 1.3.0
:product-version: 1.4
:product-bundle-version: 1.4.0
:product-chart-version: 1.4.0
:product-backstage-version: 1.29.2
:rhdeveloper-name: Red Hat Developer
:rhel: Red Hat Enterprise Linux
Expand Down
12 changes: 6 additions & 6 deletions assemblies/assembly-audit-log.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ Audit logs are not forwarded to the internal log store by default because this d
* For a complete list of fields that a {product-short} audit log can include, see xref:ref-audit-log-fields.adoc_{context}[]
* For a list of scaffolder events that a {product-short} audit log can include, see xref:ref-audit-log-scaffolder-events.adoc_{context}[]

include::modules/getting-started/con-audit-log-config.adoc[leveloffset=+1]
include::modules/observe/con-audit-log-config.adoc[leveloffset=+1]

include::modules/getting-started/proc-audit-log-view.adoc[leveloffset=+1]
include::modules/observe/proc-audit-log-view.adoc[leveloffset=+1]

include::modules/getting-started/ref-audit-log-fields.adoc[leveloffset=+2]
include::modules/observe/ref-audit-log-fields.adoc[leveloffset=+2]

include::modules/getting-started/ref-audit-log-scaffolder-events.adoc[leveloffset=+2]
include::modules/observe/ref-audit-log-scaffolder-events.adoc[leveloffset=+2]

include::modules/getting-started/ref-audit-log-catalog-events.adoc[leveloffset=+2]
include::modules/observe/ref-audit-log-catalog-events.adoc[leveloffset=+2]

include::modules/getting-started/ref-audit-log-file-rotation-overview.adoc[leveloffset=+1]
include::modules/observe/ref-audit-log-file-rotation-overview.adoc[leveloffset=+1]
5 changes: 1 addition & 4 deletions assemblies/assembly-rhdh-integration-aks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,4 @@ This integration requires the deployment of {product-short} on {aks-short} using
* The Helm chart
* The {product} Operator
.Additional resources
* link:{authentication-book-url}#assembly-authenticating-with-microsoft-azure[Authenticating with {azure-brand-name}]
include::modules/admin/proc-rhdh-monitoring-logging-aks.adoc[leveloffset=+1]
//include::modules/admin/proc-rhdh-monitoring-logging-aks.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814
2 changes: 1 addition & 1 deletion assemblies/assembly-rhdh-integration-aws.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ The integration with {aws-short} requires the deployment of {product-short} in {
* The Helm chart
* The {product} Operator

include::modules/admin/proc-rhdh-monitoring-logging-aws.adoc[leveloffset=+1]
//include::modules/admin/proc-rhdh-monitoring-logging-aws.adoc[leveloffset=+1]// moving observe category related content to new titles: RHIDP-4814

10 changes: 4 additions & 6 deletions assemblies/assembly-rhdh-observability.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,13 @@
= Enabling observability for {product} on {ocp-short}
:context: assembly-rhdh-observability

toc::[]

// Metrics
In {ocp-short}, metrics are exposed through an HTTP service endpoint under the `/metrics` canonical name. You can create a `ServiceMonitor` custom resource (CR) to scrape metrics from a service endpoint in a user-defined project.

include::modules/observability/proc-admin-enabling-metrics-ocp-helm.adoc[leveloffset=+1]
include::modules/observability/proc-admin-enabling-metrics-ocp-operator.adoc[leveloffset=+1]
include::modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc[leveloffset=+1]
include::modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc[leveloffset=+1]


[role="_additional-resources"]
[id="additional-resources_{context}"]
== Additional resources
.Additional resources
* link:https://docs.openshift.com/container-platform/latest/observability/monitoring/managing-metrics.html[{ocp-short} - Managing metrics]
18 changes: 9 additions & 9 deletions assemblies/assembly-rhdh-telemetry.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,22 @@ With {product-very-short}, you can customize the telemetry data collection featu


// disabling telemetry
include::modules/admin/ref-disabling-telemetry.adoc[leveloffset=+1]
include::modules/observe/ref-disabling-telemetry.adoc[leveloffset=+1]

include::modules/admin/proc-disabling-telemetry-using-helm.adoc[leveloffset=+2]
include::modules/observe/proc-disabling-telemetry-using-operator.adoc[leveloffset=+2]

include::modules/admin/proc-disabling-telemetry-using-operator.adoc[leveloffset=+2]
include::modules/observe/proc-disabling-telemetry-using-helm.adoc[leveloffset=+2]

// enabling telemetry
include::modules/admin/ref-enabling-telemetry.adoc[leveloffset=+1]
include::modules/observe/ref-enabling-telemetry.adoc[leveloffset=+1]

include::modules/admin/proc-enabling-telemetry-using-helm.adoc[leveloffset=+2]
include::modules/observe/proc-enabling-telemetry-using-operator.adoc[leveloffset=+2]

include::modules/admin/proc-enabling-telemetry-using-operator.adoc[leveloffset=+2]
include::modules/observe/proc-enabling-telemetry-using-helm.adoc[leveloffset=+2]

// customizing telemetry segment source
include::modules/admin/ref-customizing-telemetry-segment.adoc[leveloffset=+1]
include::modules/observe/ref-customizing-telemetry-segment.adoc[leveloffset=+1]

include::modules/admin/proc-customizing-telemetry-segment-using-helm.adoc[leveloffset=+2]
include::modules/observe/proc-customizing-telemetry-segment-using-operator.adoc[leveloffset=+2]

include::modules/admin/proc-customizing-telemetry-segment-using-operator.adoc[leveloffset=+2]
include::modules/observe/proc-customizing-telemetry-segment-using-helm.adoc[leveloffset=+2]
6 changes: 3 additions & 3 deletions titles/admin-rhdh/title-admin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ include::modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kube
// include::modules/installation/proc-config-dynamic-plugins-rhdh-operator.adoc[leveloffset=+1]

//Telemetry data collection
include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1]
//include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814

// Observability
include::assemblies/assembly-rhdh-observability.adoc[leveloffset=+1]
//include::assemblies/assembly-rhdh-observability.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814

// Running RHDH behind a proxy
include::assemblies/assembly-running-rhdh-behind-a-proxy.adoc[leveloffset=+1]
Expand All @@ -35,7 +35,7 @@ include::assemblies/assembly-running-rhdh-behind-a-proxy.adoc[leveloffset=+1]
include::assemblies/assembly-rhdh-integration-aws.adoc[leveloffset=+1]

//aks integration
include::assemblies/assembly-rhdh-integration-aks.adoc[leveloffset=+1]
//include::assemblies/assembly-rhdh-integration-aks.adoc[leveloffset=+1] // Removing assembly since the all of the content does not exist in admin guide

// Managing templates
include::assemblies/assembly-admin-templates.adoc[leveloffset=+1]
Expand Down
1 change: 1 addition & 0 deletions titles/audit-log/artifacts
1 change: 1 addition & 0 deletions titles/audit-log/assemblies
11 changes: 11 additions & 0 deletions titles/audit-log/docinfo.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<title>{title}</title>
<productname>{product}</productname>
<productnumber>{product-version}</productnumber>
<subtitle>{subtitle}</subtitle>
<abstract>
<para>{abstract}</para>
</abstract>
<authorgroup>
<orgname>{company-name} Customer Content Services</orgname>
</authorgroup>
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
1 change: 1 addition & 0 deletions titles/audit-log/images
12 changes: 12 additions & 0 deletions titles/audit-log/master.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
include::artifacts/attributes.adoc[]
:context: title-audit-log
:doctype: book
:imagesdir: images
:title: Audit log
:subtitle: Tracking user activities, system events, and data changes with {product} audit logs
:abstract: As a {product} administrator, you can track user activities, system events, and data changes with {product-short} audit logs.

= {title}

// Audit logging
include::assemblies/assembly-audit-log.adoc[leveloffset=+1]
1 change: 1 addition & 0 deletions titles/audit-log/modules
2 changes: 1 addition & 1 deletion titles/getting-started-rhdh/title-getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ include::modules/getting-started/proc-enable-servicenow-custom-actions-plugin.ad
include::modules/getting-started/ref-supported-servicenow-custom-actions.adoc[leveloffset=+2]

// Audit logging
include::assemblies/assembly-audit-log.adoc[leveloffset=+1]
//include::assemblies/assembly-audit-log.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814
1 change: 1 addition & 0 deletions titles/monitoring-and-logging/artifacts
1 change: 1 addition & 0 deletions titles/monitoring-and-logging/assemblies
11 changes: 11 additions & 0 deletions titles/monitoring-and-logging/docinfo.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<title>{title}</title>
<productname>{product}</productname>
<productnumber>{product-version}</productnumber>
<subtitle>{subtitle}</subtitle>
<abstract>
<para>{abstract}</para>
</abstract>
<authorgroup>
<orgname>{company-name} Customer Content Services</orgname>
</authorgroup>
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
1 change: 1 addition & 0 deletions titles/monitoring-and-logging/images
19 changes: 19 additions & 0 deletions titles/monitoring-and-logging/master.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
include::artifacts/attributes.adoc[]
:context: title-monitoring-logging
:doctype: book
:imagesdir: images
:title: Monitoring and logging
:subtitle: Tracking performance and capturing insights with monitoring and logging tools in {product}
:abstract: As a {product} Operations or Project Manager, you can monitor performance and gather insights using {product}'s monitoring and logging tools.

= {title}

//metrics
include::assemblies/assembly-rhdh-observability.adoc[leveloffset=+1]

//AWS
include::modules/observe/proc-rhdh-monitoring-logging-aws.adoc[leveloffset=+1]

//AKS
include::modules/observe/proc-rhdh-monitoring-logging-aks.adoc[leveloffset=+1]

1 change: 1 addition & 0 deletions titles/monitoring-and-logging/modules
1 change: 1 addition & 0 deletions titles/telemetry/artifacts
1 change: 1 addition & 0 deletions titles/telemetry/assemblies
11 changes: 11 additions & 0 deletions titles/telemetry/docinfo.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<title>{title}</title>
<productname>{product}</productname>
<productnumber>{product-version}</productnumber>
<subtitle>{subtitle}</subtitle>
<abstract>
<para>{abstract}</para>
</abstract>
<authorgroup>
<orgname>{company-name} Customer Content Services</orgname>
</authorgroup>
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
1 change: 1 addition & 0 deletions titles/telemetry/images
12 changes: 12 additions & 0 deletions titles/telemetry/master.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
include::artifacts/attributes.adoc[]
:context: title-telemetry
:doctype: book
:imagesdir: images
:title: Telemetry data collection
:subtitle: Collecting and analyzing telemetry data to enhance {product} experience
:abstract: As a {product} administrator, you can collect and analyze telemetry data to enhance your {product} experience.

= {title}

//Telemetry data collection
include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1]
1 change: 1 addition & 0 deletions titles/telemetry/modules