Skip to content

Commit 0454cf2

Browse files
gtrivedi88GitHub Actions
authored andcommitted
Renamed RHTAP to RHADS (redhat-developer#1233)
RHIDP-7599: Update Template editor (redhat-developer#1218) * Added content * Incorporated Lindsey's comments and Jai's comments from test day * Added Jai's and Shiran's suggestion Move links in Prerequisites to Additional resources Move links in Prerequisites to Additional resources Move links in Prerequisites to Additional resources Move links in Prerequisites to Additional resources Move links in Prerequisites to Additional resources
1 parent 5da9619 commit 0454cf2

22 files changed

+208
-87
lines changed

artifacts/attributes.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@
5252
:rhbk: RHBK
5353
:keycloak-version: 26.0
5454

55-
// RHTAP information
56-
:rhtap-brand-name: Red Hat Trusted Application Pipeline
57-
:rhtap-very-short: RHTAP
55+
// RHADS information
56+
:rhads-brand-name: Red Hat Advanced Developer Suite - secure supply chain
57+
:rhads-very-short: RHADS - ssc
5858

5959
// TAS information
6060
:rhtas-brand-name: Red Hat Trusted Artifact Signer

modules/about/con-integrations-in-rhdh.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@
1212
* Access to advanced OpenShift capabilities such as service mesh, serverless functions, GitOps, and distributed tracing.
1313
* Pipelines and GitOps plugins for streamlined cloud-native workflows.
1414

15-
== Integration with {rhtap-brand-name}
16-
{rhtap-brand-name} ({rhtap-very-short}) enhances {product} by providing secure CI/CD capabilities that integrate security measures into every stage of the development process.
15+
== Integration with {rhads-brand-name}
16+
{rhads-brand-name} ({rhads-very-short}) enhances {product} by providing secure CI/CD capabilities that integrate security measures into every stage of the development process.
1717

18-
While {product} focuses on the inner loop (code, build, and test), {rhtap-very-short} manages the outer loop, automating:
18+
While {product} focuses on the inner loop (code, build, and test), {rhads-very-short} manages the outer loop, automating:
1919

2020
* Code scanning
2121
* Image building
2222
* Vulnerability detection
2323
* Deployment
2424

25-
{rhtap-very-short} includes tools like {rhtas-brand-name} ({rhtas-very-short}) for code integrity, {rhtpa-brand-name} ({rhtpa-very-short}) for automated Software build of Materials (SBOM) creation, and {rhacs-brand-name} ({rhacs-very-short}) for vulnerability scanning.
25+
{rhads-very-short} includes tools like {rhtas-brand-name} ({rhtas-very-short}) for code integrity, {rhtpa-brand-name} ({rhtpa-very-short}) for automated Software build of Materials (SBOM) creation, and {rhacs-brand-name} ({rhacs-very-short}) for vulnerability scanning.
2626

2727
== Extending Backstage with {product}
2828
{product} which is a fully supported, enterprise-grade productized version of upstream Backstage extends the upstream project by adding:

modules/customizing-templates/proc-creating-templates.adoc

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="proc-creating-templates_{context}"]
77
= Creating a Software Template by using the Template Editor
88

9-
You can create a Software Template by using the Template Editor.
9+
Use the {product} Template Editor to create a Software Template.
1010

1111
Alternately, you can use the Template Editor to do any of the following actions:
1212

@@ -20,8 +20,8 @@ Alternately, you can use the Template Editor to do any of the following actions:
2020

2121
To create a Software Template by using the Template Editor templates, complete the following steps:
2222

23-
. In your {product} navigation menu, click *Catalog > Self-service*.
24-
. Click the overview menu and select *Manage Templates*.
23+
. In your {product} navigation menu, click *Catalog > Self-service*. Alternatively, to go to *Self-service* page, in your header menu, click the (+) icon.
24+
. Click the Kebab menu and select *Manage Templates*.
2525
+
2626
image::rhdh/template-editor.png[Template Editor]
2727
+
@@ -37,17 +37,20 @@ image::rhdh/template-editor.png[Template Editor]
3737
* *Load Template Directory*: Use to load an existing `templates.yaml` file
3838
** In your local file manager, navigate to the folder where your `templates.yaml` file is stored and click *Select*.
3939
* *Create New Template*: Use to create a `templates.yaml` file
40-
** In your local file manager, navigate to the folder where you want the Template Editor to create a `templates.yaml` file and click *Select*.
40+
.. In your local file manager, navigate to the folder where you want the Template Editor to create a `templates.yaml` file and click *Select*.
4141
.. On the *Template Editor* page, select the `templates.yaml` file.
4242
.. (Optional) You can preview and test your template specifications.
4343
... On the *Fill in some steps* tab, enter text into the required fields and click *Next*.
4444
... On the *Repository Location* tab, enter text into the required fields and click *Review*.
4545
... Modify the YAML definition for the parameters of your template. For more information about these parameters, see <<Creating a Software Template as a YAML file>>.
4646
... Review the information for accuracy, then click *Create*.
47-
.. When the Software Template is created, xref:proc-adding-templates_{context}[import your Software Template in your {product-very-short} instance].
47+
.. After the Software Template is created, xref:proc-adding-templates_{context}[import your Software Template in your {product-very-short} instance].
4848

4949
.Verification
5050

5151
. Click the *Catalog* tab in the navigation panel.
5252
. In the *Kind* drop-down menu, select *Template*.
5353
. Confirm that your template is shown in the list of existing templates.
54+
55+
.Next step
56+
* xref:proc-adding-templates_{context}[Import your Software Template in your {product-very-short} instance].

modules/installation/proc-deploy-rhdh-instance-eks.adoc

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
.Prerequisites
99

1010
* A cluster administrator has installed the {product} Operator.
11-
* You have an {eks-short} cluster with {aws-short} Application Load Balancer (ALB) add-on installed. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html[Application load balancing on {eks-brand-name}] and https://docs.aws.amazon.com/eks/latest/userguide/aws-load-balancer-controller.html[Installing the AWS Load Balancer Controller add-on].
12-
* You have configured a domain name for your {product-short} instance. The domain name can be a hosted zone entry on Route 53 or managed outside of AWS. For more information, see https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring.html[Configuring Amazon Route 53 as your DNS service] documentation.
11+
* You have an {eks-short} cluster with {aws-short} Application Load Balancer (ALB) add-on installed.
12+
* You have configured a domain name for your {product-short} instance. The domain name can be a hosted zone entry on Route 53 or managed outside of AWS.
1313
* You have an entry in the {aws-short} Certificate Manager (ACM) for your preferred domain name. Make sure to keep a record of your Certificate ARN.
14-
* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
15-
* You have set the context to the {eks-short} cluster in your current `kubeconfig`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html[Creating or updating a kubeconfig file for an Amazon {eks-short} cluster].
16-
* You have installed `kubectl`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html[Installing or updating kubectl].
14+
* You have subscribed to `registry.redhat.io`.
15+
* You have set the context to the {eks-short} cluster in your current `kubeconfig`.
16+
* You have installed `kubectl`.
1717

1818
.Procedure
1919

@@ -158,3 +158,13 @@ In the previous template, replace ` <rhdh_dns_name>` with your {product-short} d
158158
.Verification
159159

160160
Wait until the DNS name is responsive, indicating that your {product-short} instance is ready for use.
161+
162+
[role="_additional-resources"]
163+
.Additional resources
164+
165+
* link:https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html[Application load balancing on {eks-brand-name}]
166+
* link:https://docs.aws.amazon.com/eks/latest/userguide/aws-load-balancer-controller.html[Installing the AWS Load Balancer Controller add-on]
167+
* link:https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring.html[Configuring Amazon Route 53 as your DNS service documentation]
168+
* link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]
169+
* link:https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html[Creating or updating a kubeconfig file for an Amazon {eks-short} cluster]
170+
* link:https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html[Installing or updating kubectl]

modules/installation/proc-deploy-rhdh-instance-gke.adoc

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,10 @@ You can deploy your {product-short} instance in {gke-short} using the Operator.
44

55
.Prerequisites
66
* A cluster administrator has installed the {product} Operator.
7-
* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
8-
* You have installed `kubectl`. For more information, see https://kubernetes.io/docs/tasks/tools/#kubectl[Install kubetl].
9-
7+
* You have subscribed to `registry.redhat.io`.
8+
* You have installed `kubectl`.
109
* You have configured a domain name for your {product-short} instance.
11-
* You have reserved a static external Premium IPv4 Global IP address that is not attached to any virtual machine (VM). For more information see https://cloud.google.com/vpc/docs/reserve-static-external-ip-address#reserve_new_static[Reserve a new static external IP address]
10+
* You have reserved a static external Premium IPv4 Global IP address that is not attached to any virtual machine (VM).
1211
* You have configured the DNS records for your domain name to point to the IP address that has been reserved.
1312
+
1413
[NOTE]
@@ -191,5 +190,19 @@ spec:
191190

192191
// Wait until the DNS name is responsive, indicating that your {product-short} instance is ready for use.
193192

193+
[role="_additional-resources"]
194+
.Additional resources
195+
196+
* link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]
197+
* link:https://kubernetes.io/docs/tasks/tools/#kubectl[Installing `kubetl]`
198+
* link:https://cloud.google.com/vpc/docs/reserve-static-external-ip-address#reserve_new_static[Reserving a new static external IP address]
199+
194200
.Additional information
195201
For more information on setting up {gke-short} using Ingress with TLS, see https://github.com/GoogleCloudPlatform/gke-networking-recipes/tree/main/ingress/single-cluster/ingress-https[Secure GKE Ingress].
202+
203+
[role="_additional-resources"]
204+
.Additional resources
205+
206+
* link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]
207+
* link:https://kubernetes.io/docs/tasks/tools/#kubectl[Installing kubetl]
208+
* link:https://cloud.google.com/vpc/docs/reserve-static-external-ip-address#reserve_new_static[Reserving a new static external IP address]

modules/installation/proc-enable-signin.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@ The {product} supports the following authentication providers:
6363
.Prerequisites
6464

6565
* You have installed the {product-short}.
66-
For more information about installation, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart].
6766

6867
.Procedure
6968

@@ -87,3 +86,8 @@ auth:
8786
`signInPage: oidc`
8887

8988
. Start your {product-short} application and sign in.
89+
90+
[role="_additional-resources"]
91+
.Additional resources
92+
93+
* xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart]

modules/installation/proc-install-operator.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Containers are available for the following CPU architectures:
1414
.Prerequisites
1515

1616
* You are logged in as an administrator on the {ocp-short} web console.
17-
* You have configured the appropriate roles and permissions within your project to create or access an application. For more information, see the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[{ocp-brand-name} documentation on Building applications].
17+
* You have configured the appropriate roles and permissions within your project to create or access an application.
1818
* You have installed {ocp-brand-name} 4.17 or later.
1919
2020
.Procedure
@@ -81,5 +81,6 @@ If you selected an *Automatic* approval strategy, the upgrade status should reso
8181
[role="_additional-resources"]
8282
.Additional resources
8383

84-
* xref:proc-install-rhdh-ocp-operator_{context}[Deploying {product} on {ocp-short} with the Operator]
84+
* xref:proc-install-rhdh-ocp-operator_{context}[Deploying {product} on {ocp-short} with Operator]
8585
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub by using the web console]
86+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[{ocp-brand-name} documentation on Building applications]

modules/installation/proc-install-rhdh-airgapped-partial-k8s-helm.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ In a partially disconnected environment, the cluster cannot access external regi
55

66
.Prerequisites
77

8-
* You have set up your workstation.
8+
* You have set up your workstation
99
** You have installed Skopeo 1.17 or later
1010
** You have installed Yq 4.4 or later
1111
** You have installed Helm 3.13 or later

modules/installation/proc-install-rhdh-helm-airgapped-full.adoc

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ If your network has access to the registry through a bastion host, you can use t
99
** You have access to the registry.redhat.io.
1010
** You have access to the charts.openshift.io Helm chart repository.
1111
** You have installed the {openshift-cli} on your workstation.
12-
** You have installed the oc-mirror {openshift-cli} plugin, for more information see https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[Installing the oc-mirror OpenShift CLI plugin].
12+
** You have installed the oc-mirror {openshift-cli} plugin.
1313
** You have an account in https://developers.redhat.com/[{rhdeveloper-name}] portal.
1414
* You have set up your intermediary host.
15-
** Your host has access to the disconnected cluster and to the target mirror registry, for example, the {ocp-brand-name} image registry. For more information about exposing the {ocp-short} image registry, see https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/registry/index#securing-exposing-registry[Exposing the registry].
16-
** You have installed the oc-mirror {openshift-cli} plugin, for more information see https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[Installing the oc-mirror OpenShift CLI plugin].
15+
** Your host has access to the disconnected cluster and to the target mirror registry, for example, the {ocp-brand-name} image registry.
16+
** You have installed the oc-mirror {openshift-cli} plugin.
1717
** You have installed {ocp-brand-name} {ocp-version-min} or later.
1818
** You have installed the {openshift-cli} on your workstation.
1919

@@ -146,4 +146,10 @@ where:
146146
`<archive_file>` :: Specifies the name of the archive file containing the resources that you want to mirror, for example, `redhat-developer-hub-1.4.1.tgz`.
147147

148148
`<your_namespace>` :: Specifies the namespace that you want to deploy the Helm chart to, for example, `{my-product-namespace}`.
149-
--
149+
--
150+
151+
[role="_additional-resources"]
152+
.Additional resources
153+
154+
* link:https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[Installing the oc-mirror OpenShift CLI plugin]
155+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/registry/index#securing-exposing-registry[Exposing the {ocp-short} image registry]

modules/installation/proc-install-rhdh-helm-airgapped-partial.adoc

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ If your network has access to the `registry.redhat.io` registry and the `charts.
88
* You have installed {ocp-brand-name} {ocp-version-min} or later.
99
* You have access to the `charts.openshift.io` Helm chart repository.
1010
* You have access to the `registry.redhat.io`.
11-
* You have access to a mirror registry that can be reached from the disconnected cluster, for example, the {ocp-short} image registry. For more information about exposing the {ocp-short} image registry, see https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/registry/index#securing-exposing-registry[Exposing the registry].
12-
* You are logged in to your target mirror registry and have permissions to push images to it. For more information, see link:https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-adding-registry-pull-secret_installing-mirroring-disconnected[Configuring credentials that allow images to be mirrored].
11+
* You have access to a mirror registry that can be reached from the disconnected cluster, for example, the {ocp-short} image registry.
12+
* You are logged in to your target mirror registry and have permissions to push images to it.
1313
* You have installed the {openshift-cli} on your workstation.
14-
* You have installed the oc-mirror {openshift-cli} plugin, for more information see https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[Installing the oc-mirror OpenShift CLI plugin].
14+
* You have installed the oc-mirror {openshift-cli} plugin.
1515
* You have an account in https://developers.redhat.com/[{rhdeveloper-name}] portal.
1616

1717
.Procedure
@@ -33,11 +33,11 @@ kind: ImageSetConfiguration
3333
mirror:
3434
helm:
3535
repositories:
36-
- name: _<repository_name>_ (1)
37-
url: _<repository_url>_ (2)
36+
- name: _<repository_name>_ # <1>
37+
url: _<repository_url>_ # <2>
3838
charts:
39-
- name: _<chart_name>_ (3)
40-
version: "_<rhdh_version>_" (4)
39+
- name: _<chart_name>_ # <3>
40+
version: "_<rhdh_version>_" # <4>
4141
----
4242
<1> The name of the repository containing the Helm chart that you want to mirror, for example, `openshift-charts`.
4343
<2> The URL for the repository containing the Helm chart that you want to mirror, for example, `https://charts.openshift.io`.
@@ -122,4 +122,10 @@ where:
122122
`<archive_file>` :: Specifies the name of the archive file containing the resources that you want to mirror, for example, `redhat-developer-hub-1.4.1.tgz`.
123123

124124
`<your_namespace>` :: Specifies the namespace that you want to deploy the Helm chart to, for example, `{my-product-namespace}`.
125-
--
125+
--
126+
+
127+
[role="_additional-resources"]
128+
.Additional resources
129+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/registry/index#securing-exposing-registry[Exposing the {ocp-short} image registry]
130+
* link:https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-adding-registry-pull-secret_installing-mirroring-disconnected[Configuring credentials that allow images to be mirrored]
131+
* link:https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[Installing the oc-mirror OpenShift CLI plugin]

0 commit comments

Comments
 (0)