You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: remove attribute for the RHTAP 1.3 version (which is not used in the docs) (redhat-developer#1223)
* chore: no-op change to test updated bot token
Signed-off-by: rhdh-bot service account <[email protected]>
* remove rhtap version which we don't actually reference anywhere in the docs
Signed-off-by: Nick Boldt <[email protected]>
---------
Signed-off-by: rhdh-bot service account <[email protected]>
Signed-off-by: Nick Boldt <[email protected]>
Co-authored-by: rhdh-bot service account <[email protected]>
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
Copy file name to clipboardExpand all lines: modules/about/con-integrations-in-rhdh.adoc
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,17 +12,17 @@
12
12
* Access to advanced OpenShift capabilities such as service mesh, serverless functions, GitOps, and distributed tracing.
13
13
* Pipelines and GitOps plugins for streamlined cloud-native workflows.
14
14
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.
17
17
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:
19
19
20
20
* Code scanning
21
21
* Image building
22
22
* Vulnerability detection
23
23
* Deployment
24
24
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.
26
26
27
27
== Extending Backstage with {product}
28
28
{product} which is a fully supported, enterprise-grade productized version of upstream Backstage extends the upstream project by adding:
Copy file name to clipboardExpand all lines: modules/customizing-templates/proc-creating-templates.adoc
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
[id="proc-creating-templates_{context}"]
7
7
= Creating a Software Template by using the Template Editor
8
8
9
-
You can create a Software Template by using the Template Editor.
9
+
Use the {product} Template Editor to create a Software Template.
10
10
11
11
Alternately, you can use the Template Editor to do any of the following actions:
12
12
@@ -20,8 +20,8 @@ Alternately, you can use the Template Editor to do any of the following actions:
20
20
21
21
To create a Software Template by using the Template Editor templates, complete the following steps:
22
22
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*.
* *Load Template Directory*: Use to load an existing `templates.yaml` file
38
38
** In your local file manager, navigate to the folder where your `templates.yaml` file is stored and click *Select*.
39
39
* *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*.
41
41
.. On the *Template Editor* page, select the `templates.yaml` file.
42
42
.. (Optional) You can preview and test your template specifications.
43
43
... On the *Fill in some steps* tab, enter text into the required fields and click *Next*.
44
44
... On the *Repository Location* tab, enter text into the required fields and click *Review*.
45
45
... 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>>.
46
46
... 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].
48
48
49
49
.Verification
50
50
51
51
. Click the *Catalog* tab in the navigation panel.
52
52
. In the *Kind* drop-down menu, select *Template*.
53
53
. 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].
Copy file name to clipboardExpand all lines: modules/installation/proc-deploy-rhdh-instance-eks.adoc
+15-5Lines changed: 15 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,12 +8,12 @@
8
8
.Prerequisites
9
9
10
10
* 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.
13
13
* 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`.
17
17
18
18
.Procedure
19
19
@@ -158,3 +158,13 @@ In the previous template, replace ` <rhdh_dns_name>` with your {product-short} d
158
158
.Verification
159
159
160
160
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]
* 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]
Copy file name to clipboardExpand all lines: modules/installation/proc-deploy-rhdh-instance-gke.adoc
+17-4Lines changed: 17 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,10 @@ You can deploy your {product-short} instance in {gke-short} using the Operator.
4
4
5
5
.Prerequisites
6
6
* 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`.
10
9
* 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).
12
11
* You have configured the DNS records for your domain name to point to the IP address that has been reserved.
13
12
+
14
13
[NOTE]
@@ -191,5 +190,19 @@ spec:
191
190
192
191
// Wait until the DNS name is responsive, indicating that your {product-short} instance is ready for use.
* link:https://cloud.google.com/vpc/docs/reserve-static-external-ip-address#reserve_new_static[Reserving a new static external IP address]
199
+
194
200
.Additional information
195
201
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].
Copy file name to clipboardExpand all lines: modules/installation/proc-enable-signin.adoc
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,7 +63,6 @@ The {product} supports the following authentication providers:
63
63
.Prerequisites
64
64
65
65
* 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].
67
66
68
67
.Procedure
69
68
@@ -87,3 +86,8 @@ auth:
87
86
`signInPage: oidc`
88
87
89
88
. 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]
Copy file name to clipboardExpand all lines: modules/installation/proc-install-operator.adoc
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Containers are available for the following CPU architectures:
14
14
.Prerequisites
15
15
16
16
* 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.
18
18
* You have installed {ocp-brand-name} 4.17 or later.
19
19
20
20
.Procedure
@@ -81,5 +81,6 @@ If you selected an *Automatic* approval strategy, the upgrade status should reso
81
81
[role="_additional-resources"]
82
82
.Additional resources
83
83
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]
85
85
* 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]
Copy file name to clipboardExpand all lines: modules/installation/proc-install-rhdh-helm-airgapped-full.adoc
+10-4Lines changed: 10 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,11 @@ If your network has access to the registry through a bastion host, you can use t
9
9
** You have access to the registry.redhat.io.
10
10
** You have access to the charts.openshift.io Helm chart repository.
11
11
** 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.
13
13
** You have an account in https://developers.redhat.com/[{rhdeveloper-name}] portal.
14
14
* 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.
17
17
** You have installed {ocp-brand-name} {ocp-version-min} or later.
18
18
** You have installed the {openshift-cli} on your workstation.
19
19
@@ -146,4 +146,10 @@ where:
146
146
`<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`.
147
147
148
148
`<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]
Copy file name to clipboardExpand all lines: modules/installation/proc-install-rhdh-helm-airgapped-partial.adoc
+14-8Lines changed: 14 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,10 +8,10 @@ If your network has access to the `registry.redhat.io` registry and the `charts.
8
8
* You have installed {ocp-brand-name} {ocp-version-min} or later.
9
9
* You have access to the `charts.openshift.io` Helm chart repository.
10
10
* 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.
13
13
* 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.
15
15
* You have an account in https://developers.redhat.com/[{rhdeveloper-name}] portal.
16
16
17
17
.Procedure
@@ -33,11 +33,11 @@ kind: ImageSetConfiguration
33
33
mirror:
34
34
helm:
35
35
repositories:
36
-
- name: _<repository_name>_ (1)
37
-
url: _<repository_url>_ (2)
36
+
- name: _<repository_name>_ # <1>
37
+
url: _<repository_url>_ # <2>
38
38
charts:
39
-
- name: _<chart_name>_ (3)
40
-
version: "_<rhdh_version>_" (4)
39
+
- name: _<chart_name>_ # <3>
40
+
version: "_<rhdh_version>_" # <4>
41
41
----
42
42
<1> The name of the repository containing the Helm chart that you want to mirror, for example, `openshift-charts`.
43
43
<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:
122
122
`<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`.
123
123
124
124
`<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