Skip to content

Commit 93c616e

Browse files
themr0cthemr0c
authored
Merge branch 'main' into RHIDP-3976
2 parents 0e110f8 + 0b7c758 commit 93c616e

File tree

53 files changed

+595
-72
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+595
-72
lines changed

‎artifacts/attributes.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
:product: Red Hat Developer Hub
1111
:product-short: Developer Hub
1212
:product-very-short: RHDH
13-
:product-version: 1.3
14-
:product-bundle-version: 1.3.0
15-
:product-chart-version: 1.3.0
13+
:product-version: 1.4
14+
:product-bundle-version: 1.4.0
15+
:product-chart-version: 1.4.0
1616
:product-backstage-version: 1.29.2
1717
:rhdeveloper-name: Red Hat Developer
1818
:rhel: Red Hat Enterprise Linux

‎assemblies/assembly-audit-log.adoc‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ Audit logs are not forwarded to the internal log store by default because this d
3333
* For a complete list of fields that a {product-short} audit log can include, see xref:ref-audit-log-fields.adoc_{context}[]
3434
* For a list of scaffolder events that a {product-short} audit log can include, see xref:ref-audit-log-scaffolder-events.adoc_{context}[]
3535

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

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

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

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

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

46-
include::modules/getting-started/ref-audit-log-file-rotation-overview.adoc[leveloffset=+1]
46+
include::modules/observe/ref-audit-log-file-rotation-overview.adoc[leveloffset=+1]

‎assemblies/assembly-customizing-the-quick-access-card-in-rhdh.adoc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
[id="customizing-the-quick-access-card-in-rhdh"]
4+
= Customizing the Quick access card in {product}
5+
6+
To access the Home page in {product}, the base URL must include the `/developer-hub` proxy. You can configure the Home page by passing the data into the `app-config.yaml` file as a proxy. You can provide data to the Home page from the following sources:
7+
8+
* JSON files hosted on GitHub or GitLab.
9+
* A dedicated service that provides the Home page data in JSON format using an API.
10+
11+
include::modules/getting-started/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc[leveloffset=+1]
12+
include::modules/getting-started/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc[leveloffset=+1]
13+
14+
15+

‎assemblies/assembly-customizing-the-rhdh-homepage.adoc‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
[id='proc-customize-rhdh-homepage_{context}']
2+
= Customizing the Home page in {product}
3+
4+
When using the `app-config`, you can do the following:
5+
6+
* Customize and extend the default Home page layout with additional cards that appear based on the plugins you have installed and enabled.
7+
* Change quick access links.
8+
* Add, reorganize, and remove the following available cards:
9+
+
10+
** Search bar
11+
** Quick access
12+
** Headline
13+
** Markdown
14+
** Placeholder
15+
** Catalog starred entities
16+
** Featured docs
17+
18+
include::modules/getting-started/proc-customizing-the-home-page-cards.adoc[leveloffset=+1]
19+
include::modules/getting-started/proc-defining-the-layout-of-the-product-home-page.adoc[leveloffset=+1]

‎assemblies/assembly-rhdh-integration-aks.adoc‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,4 @@ This integration requires the deployment of {product-short} on {aks-short} using
1313
* The Helm chart
1414
* The {product} Operator
1515
16-
.Additional resources
17-
* link:{authentication-book-url}#assembly-authenticating-with-microsoft-azure[Authenticating with {azure-brand-name}]
18-
19-
include::modules/admin/proc-rhdh-monitoring-logging-aks.adoc[leveloffset=+1]
16+
//include::modules/admin/proc-rhdh-monitoring-logging-aks.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814

‎assemblies/assembly-rhdh-integration-aws.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ The integration with {aws-short} requires the deployment of {product-short} in {
1212
* The Helm chart
1313
* The {product} Operator
1414
15-
include::modules/admin/proc-rhdh-monitoring-logging-aws.adoc[leveloffset=+1]
15+
//include::modules/admin/proc-rhdh-monitoring-logging-aws.adoc[leveloffset=+1]// moving observe category related content to new titles: RHIDP-4814
1616

‎assemblies/assembly-rhdh-observability.adoc‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,13 @@
33
= Enabling observability for {product} on {ocp-short}
44
:context: assembly-rhdh-observability
55

6-
toc::[]
7-
86
// Metrics
97
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.
108

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

1413
[role="_additional-resources"]
15-
[id="additional-resources_{context}"]
16-
== Additional resources
14+
.Additional resources
1715
* link:https://docs.openshift.com/container-platform/latest/observability/monitoring/managing-metrics.html[{ocp-short} - Managing metrics]

‎assemblies/assembly-rhdh-telemetry.adoc‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,22 @@ With {product-very-short}, you can customize the telemetry data collection featu
2020

2121

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

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

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

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

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

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

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

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

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

‎modules/authentication/proc-enabling-authentication-with-rhsso.adoc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ Save the value for the next step:
2323
* **Client ID**
2424
* **Client Secret**
2525

26+
.. Configure your {rhsso} realm for performance and security:
27+
... Navigate to the **Configure** > **Realm Settings**.
28+
... Set the **Access Token Lifespan** to a value greater than five minutes (preferably 10 or 15 minutes) to prevent performance issues from frequent refresh token requests for every API call.
29+
... Enable the **Revoke Refresh Token** option to improve security by enabling the refresh token rotation strategy.
30+
2631
.. To prepare for the verification steps, in the same realm, get the credential information for an existing user or link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#create-user_[create a user]. Save the user credential information for the verification steps.
2732

2833
. To add your {rhsso} credentials to your {product-short} secrets, edit your {product-short} secrets, such as `secrets-rhdh`, and add the following key/value pairs:
@@ -163,6 +168,18 @@ auth:
163168
----
164169
--
165170

171+
`auth.backstageTokenExpiration`::
172+
--
173+
To modify the {product-short} token expiration from its default value of one hour, note that this refers to the validity of short-term cryptographic tokens, not the session duration. The expiration value must be set between 10 minutes and 24 hours.
174+
175+
.`app-config-rhdh.yaml` fragment with optional `auth.backstageTokenExpiration` field
176+
[source,yaml,subs="+quotes"]
177+
----
178+
auth:
179+
backstageTokenExpiration: { minutes: _<user_defined_value>_ }
180+
----
181+
--
182+
166183
--
167184

168185
.Verification

0 commit comments

Comments
 (0)