Skip to content

Commit 342e40d

Browse files
pabel-rhgtrivedi88
authored andcommitted
RHIDP-4862 - Update Tech Radar to 1.0 (redhat-developer#708)
* Incorporated changes * incorporated kashish's comment * comments
1 parent 70f0ee4 commit 342e40d

File tree

4 files changed

+49
-48
lines changed

4 files changed

+49
-48
lines changed

artifacts/attributes.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,11 @@
3636
:rhsso-brand-name: Red Hat Single-Sign On
3737
:rhsso: RHSSO
3838

39+
// RHTAP information
40+
:rhtap-version: 1.2
41+
:rhtap-brand-name: Red Hat Trusted Application Pipeline
42+
:rhtap-very-short: RHTAP
43+
3944
// Partner Platforms
4045
:aws-brand-name: Amazon Web Services
4146
:aws-short: AWS

assemblies/assembly-about-rhdh.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,16 @@ endif::[]
88
ifdef::context[]
99
[id="about-rhdh_{context}"]
1010
endif::[]
11-
= About {product}
11+
= About {product} ({product-very-short})
1212

1313
:context: about-rhdh
1414

15-
{product} is a fully supported, open developer platform that reduces friction and frustration of developers while boosting productivity.
15+
{product} is all about making your development process smoother and more efficient. It unifies all the tools and resources your team needs into one platform, helping you collaborate better and get your applications from code to deployment faster.
1616

17-
This platform is driven by a centralized software catalog, providing efficiency to your microservices and infrastructure.
17+
== Why use {product}?
1818

19-
Use {product} to simplify decision-making through a selection of internally approved tools, programming languages, and developer resources within a self-managed portal.
19+
* *Boost developer productivity:* Say goodbye to common organizational hiccups. With clear guidelines and automated processes your team can focus on what they do best - writing great code.
2020

21+
* *Unified dashboard:* Access everything in one place - from Git repositories and CI/CD pipelines to issue tracking, monitoring, and documentation. With over 150 plugins, it’s all curated to fit your company’s best practices.
2122

2223
include::modules/about/con-benefits-of-rhdh.adoc[leveloffset=+1]
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:_mod-docs-content-type: CONCEPT
2+
3+
[id="elevate-your-development-with-secure-templates_{context}"]
4+
= Elevate your development with secure templates
5+
6+
If you have the {rhtap-brand-name} ({rhtap-very-short}) installed, {product} ({product-very-short}) becomes even more powerful. {rhtap-very-short} provides additional secure software templates that you can use right within {product-very-short}. These templates help you integrate advanced security measures into your development process seamlessly, without adding complexity.
7+
8+
* *Ready-to-use secure templates:* Jumpstart your projects with templates that incorporate industry-leading security practices. {rhtap-very-short} ensures that every line of code contributes to a fortress of security significantly enhancing early vulnerability detection and mitigation.
9+
10+
* *Seamless integration:* The secure templates from {rhtap-very-short} slide right into your existing workflows, so there’s no extra work for your team. By aligning with Supply-chain Levels for Software Artifacts (SLSA) Level 3 {rhtap-very-short}’s pioneering secure CI/CD framework upholds the highest standards in software development.
11+
12+
* *Focus on innovation:* With security built into your templates, {rhtap-very-short} helps you adopt a DevSecOps culture. This allows your developers to concentrate on building great features without getting bogged down by security setups.
13+
14+
{rhtap-very-short} integrates *Red Hat Trusted Artifact Signer (RHTAS)* for code integrity, *Red hat Trusted Profile Analyzer (RHTPA)* for automated SBOM creation, and *Red Hat Advanced Cluster Security (RHACS)* for proactive vulnerability scanning, to strengthen your security posture with advanced tools, offering a robust defense against security threats throughout the development lifecycle.
15+
16+
== Transform your development process
17+
By bringing everything together in one place, {product} helps your team work more effectively and deliver better software. And if you are looking to add an extra layer of security the secure templates from {rhtap-brand-name} are there to enhance your workflow throughout the software development lifecycle.
18+
Lines changed: 21 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
11
[id='proc-customize-rhdh-tech-radar-page_{context}']
22
= Customizing the Tech Radar page in {product}
33

4-
In {product}, the Tech Radar page is provided by the `tech-radar` dynamic plugin, which is disabled by default. For information about enabling dynamic plugins in {product} see link:{LinkPluginsGuide}[Configuring plugins in {product}].
5-
6-
In {product}, you can configure Learning Paths by passing the data into the `app-config.yaml` file as a proxy. The base Tech Radar URL must include the `/developer-hub/tech-radar` proxy.
7-
8-
[NOTE]
9-
====
10-
Due to the use of overlapping `pathRewrites` for both the `tech-radar` and `homepage` quick access proxies, you must create the `tech-radar` configuration (`^api/proxy/developer-hub/tech-radar`) before you create the `homepage` configuration (`^/api/proxy/developer-hub`).
11-
12-
For more information about customizing the Home page in {product}, see xref:proc-customize-rhdh-homepage_rhdh-getting-started[Customizing the Home page in {product}].
13-
====
4+
In {product}, the Tech Radar page is provided by the `tech-radar` and `tech-radar-backend` dynamic plugins, which are disabled by default.
5+
For information about enabling dynamic plugins in {product} see link:{LinkPluginsGuide}[Configuring plugins in {product}].
146

157
You can provide data to the Tech Radar page from the following sources:
168

@@ -21,33 +13,22 @@ You can provide data to the Tech Radar page from the following sources:
2113

2214
.Prerequisites
2315

24-
You have installed {product} by using either the Operator or Helm chart.
25-
For more information, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp[{installing-on-ocp-book-title}].
16+
* You have installed {product} by using either the Operator or Helm chart. For more information, see link:{installing-on-ocp-book-url}[{installing-on-ocp-book-title}].
17+
* You have specified the data sources for the Tech Radar plugin in the `integrations` section of the `app-config.yaml` file. For example, to configure GitHub as an authentication provider, see link:{authentication-book-url}#authenticating-with-github[Authenticating with GitHub].
2618

2719
.Procedure
2820

2921
To access the data from the JSON files, complete the following step:
3022

31-
* Add the following code to the `app-config.yaml` file:
23+
. Enable the `./dynamic-plugins/dist/backstage-community-plugin-tech-radar` and `/dynamic-plugins/dist/backstage-community-plugin-tech-radar-backend-dynamic` plugins.
24+
. Add the following code to the `app-config.yaml` file:
3225
+
3326
[source,yaml]
3427
----
35-
proxy:
36-
endpoints:
37-
# Other Proxies
38-
# customize developer hub instance
39-
'/developer-hub':
40-
target: <DOMAIN_URL> # i.e https://raw.githubusercontent.com/
41-
pathRewrite:
42-
'^/api/proxy/developer-hub/tech-radar': <path to json file> # i.e /janus-idp/backstage-showcase/main/packages/app/public/tech-radar/data-default.json
43-
'^/api/proxy/developer-hub': <path to json file> # i.e /janus-idp/backstage-showcase/main/packages/app/public/homepage/data.json
44-
changeOrigin: true
45-
secure: true
46-
47-
# Change to "false" in case of using self hosted cluster with a self-signed certificate
48-
headers:
49-
<HEADER_KEY>: <HEADER_VALUE> # optional and can be passed as needed i.e Authorization can be passed for private GitHub repo and PRIVATE-TOKEN can be passed for private GitLab repo
28+
techRadar:
29+
url: ${TECH_RADAR_DATA_URL} <1>
5030
----
31+
<1> `TECH_RADAR_DATA_URL` is the URL from which the JSON data is loaded.
5132

5233
== Using a dedicated service to provide data to the Tech Radar page
5334

@@ -66,24 +47,20 @@ For more information, see xref:{installing-on-ocp-book-url}#assembly-install-rhd
6647

6748
To use a separate service to provide the Tech Radar data, complete the following steps:
6849

69-
. Add the following code to the `app-config-rhdh.yaml` file:
50+
. Add the dedicated service as an allowed host by adding the following code to the `app-config.yaml` file:
7051
+
7152
[source,yaml]
7253
----
73-
proxy:
74-
endpoints:
75-
# Other Proxies
76-
'/developer-hub/tech-radar':
77-
target: ${TECHRADAR_DATA_URL}
78-
changeOrigin: true
79-
# Change to "false" in case of using self hosted cluster with a self-signed certificate
80-
secure: true
54+
backend:
55+
reading:
56+
allow:
57+
- host: 'hostname'
8158
----
82-
where the `TECHRADAR_DATA_URL` is defined as `pass:c[http://<SERVICE_NAME>/tech-radar]`, for example, `pass:c[http://rhdh-customization-provider/tech-radar]`.
83-
+
84-
[NOTE]
85-
====
86-
You can define the `TECHRADAR_DATA_URL` by adding it to `rhdh-secrets` or by directly replacing it with its value in your custom ConfigMap.
87-
====
59+
. Add the following to the `app-config.yaml` file:
8860
+
89-
. Delete the {product-short} pod to ensure that the new configurations are loaded correctly.
61+
[source,yaml]
62+
----
63+
techRadar:
64+
url: ${TECH_RADAR_DATA_URL} <1>
65+
----
66+
<1> `TECH_RADAR_DATA_URL` is the URL from which the JSON data is loaded.

0 commit comments

Comments
 (0)