Skip to content

Commit 54ee6c3

Browse files
author
GitHub Actions
committed
Move links in Prerequisites to Additional resources
1 parent c7d1764 commit 54ee6c3

18 files changed

+173
-64
lines changed

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 installed an {eks-short} cluster with {aws-short} Application Load Balancer (ALB) 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.
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: 10 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]
@@ -193,3 +192,10 @@ spec:
193192

194193
.Additional information
195194
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].
195+
196+
[role="_additional-resources"]
197+
.Additional resources
198+
199+
* link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]
200+
* link:https://kubernetes.io/docs/tasks/tools/#kubectl[Installing kubetl]
201+
* 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: 2 additions & 1 deletion
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
@@ -83,3 +83,4 @@ If you selected an *Automatic* approval strategy, the upgrade status should reso
8383

8484
* xref:proc-install-rhdh-ocp-operator_{context}[Deploying {product} on {ocp-short} with the 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-helm-airgapped-full.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ 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.
1515
** 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].
@@ -146,4 +146,9 @@ 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]

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

Lines changed: 11 additions & 4 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
@@ -122,4 +122,11 @@ 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+
130+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/registry/index#securing-exposing-registry[Exposing the registry]
131+
* 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]
132+
* 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]

modules/installation/proc-install-rhdh-ocp-helm-cli.adoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ You can use the Helm CLI to install {product} on {ocp-brand-name}.
99
.Prerequisites
1010
* You have installed the {openshift-cli} on your workstation.
1111
* You are logged in to your {ocp-short} account.
12-
* A user with the {ocp-short} admin role has configured the appropriate roles and permissions within your project to create an application. For more information about {ocp-short} roles, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/authentication_and_authorization/index#authorization-overview_using-rbac[Using RBAC to define and apply permissions].
13-
* You have created a project in {ocp-short}. For more information about creating a project in {ocp-short}, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[{ocp-brand-name} documentation].
12+
* A user with the {ocp-short} admin role has configured the appropriate roles and permissions within your project to create an application.
13+
* You have created a project in {ocp-short}.
1414
* You have installed the Helm CLI tool.
1515

1616
.Procedure
@@ -49,5 +49,9 @@ echo "https://redhat-developer-hub-$NAMESPACE.$CLUSTER_ROUTER_BASE"
4949
.Verification
5050
* Open the running {product-short} instance URL in your browser to use {product-short}.
5151

52+
[role="_additional-resources"]
5253
.Additional resources
53-
* link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html-single/building_applications/index#installing-helm[Installing Helm]
54+
55+
* link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html-single/building_applications/index#installing-helm[Installing Helm]
56+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/authentication_and_authorization/index#authorization-overview_using-rbac[Using RBAC to define and apply permissions]
57+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[Creating a project in {ocp-short}]

modules/installation/proc-install-rhdh-ocp-helm-gui.adoc

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ The {product} Helm chart is available in the Helm catalog on {osd-short} and {oc
1818
.Prerequisites
1919

2020
* You are logged in to your {ocp-short} account.
21-
* A user with the {ocp-short} `admin` role has configured the appropriate roles and permissions within your project to create an application. For more information about {ocp-short} roles, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/authentication_and_authorization/index#authorization-overview_using-rbac[Using RBAC to define and apply permissions].
22-
* You have created a project in {ocp-short}. For more information about creating a project in {ocp-short}, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[{ocp-brand-name} documentation].
21+
* A user with the {ocp-short} `admin` role has configured the appropriate roles and permissions within your project to create an application.
22+
* You have created a project in {ocp-short}.
2323

2424
.Procedure
2525

@@ -76,3 +76,9 @@ Backend failed to start up Error: Missing required config value at 'backend.data
7676
7777
To resolve the error, verify the configuration files.
7878
====
79+
80+
[role="_additional-resources"]
81+
.Additional resources
82+
83+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/authentication_and_authorization/index#authorization-overview_using-rbac[Using RBAC to define and apply permissions]
84+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[Creating a project in {ocp-short}]

modules/installation/proc-install-rhdh-ocp-operator.adoc

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ As a developer, you can deploy a {product} instance on {ocp-short} by using the
88

99
.Prerequisites
1010

11-
* xref:proc-install-operator_{context}[An {ocp-short} administrator has installed the {product} Operator].
12-
* xref:{configuring-book-url}#provisioning-your-custom-configuration[You have provisioned your custom config maps and secrets in your `_<{my-product-namespace}>_` project].
13-
* xref:{configuring-book-url}#using-the-operator-to-run-rhdh-with-your-custom-configuration[You have authored your {product-custom-resource-type} custom resource].
11+
* An {ocp-short} administrator has installed the {product} Operator.
12+
* You have provisioned your custom config maps and secrets in your `_<{my-product-namespace}>_` project.
13+
* You have authored your {product-custom-resource-type} custom resource.
1414

1515
.Procedure
1616

@@ -36,4 +36,9 @@ image::rhdh/operator-install-1.png[]
3636
[role="_additional-resources"]
3737
[id="additional-resources_proc-install-rhdh-ocp-operator"]
3838
.Additional resources
39-
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[{ocp-short} - Building applications overview]
39+
40+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[Building applications overview]
41+
* xref:proc-install-operator_{context}[Installing the {product} Operator]
42+
* xref:{configuring-book-url}#provisioning-your-custom-configuration[Provisioning your custom config maps and secrets in your `_<{my-product-namespace}>_` project]
43+
* xref:{configuring-book-url}#using-the-operator-to-run-rhdh-with-your-custom-configuration[Authoring your {product-custom-resource-type} custom resource]
44+

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

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ If your network has access to the registry through a bastion host, you can use t
88

99
.Prerequisites
1010

11-
* You have installed Podman 5.3 or later. For more information, see link:https://podman.io/docs/installation[Podman Installation Instructions].
11+
* You have installed Podman 5.3 or later.
1212
* You have installed Skopeo 1.17 or later.
1313
* You have installed `yq` 4.44 or later.
1414
* You have installed the GNU `sed` command line text editor.
1515
* You have installed `umoci` CLI tool.
16-
* You have an active `oc registry`, `podman`, or `skopeo` session to the `registry.redhat.io` {company-name} Ecosystem Catalog. For more information, see link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
17-
* You have installed the `opm` CLI tool. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/cli_tools/opm-cli#olm-about-opm_cli-opm-install[Installing the opm CLI].
16+
* You have an active `oc registry`, `podman`, or `skopeo` session to the `registry.redhat.io` {company-name} Ecosystem Catalog.
17+
* You have installed the `opm` CLI tool.
1818
1919
.Procedure
2020
. Download the mirroring script to disk by running the following command:
@@ -82,3 +82,10 @@ kubectl -n rhdh-operator get pods
8282
** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/proc-rhdh-deploy-aks-operator_title-install-rhdh-aks[Installing {product-short} on {aks-short} with the Operator]
8383
** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/proc-install-rhdh-osd-gcp-operator_title-install-rhdh-osd-gcp[Installing {product-short} on {gcp-short} with the Operator]
8484
** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_google_kubernetes_engine/proc-rhdh-deploy-gke-operator.adoc_title-install-rhdh-gke#proc-deploy-rhdh-instance-gke.adoc_title-install-rhdh-gke[Deploying {product-short} on {gke-short} with the Operator]
85+
86+
[role="_additional-resources"]
87+
.Additional resources
88+
89+
* link:https://podman.io/docs/installation[Podman Installation Instructions]
90+
* link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]
91+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/cli_tools/opm-cli#olm-about-opm_cli-opm-install[Installing the opm CLI]

0 commit comments

Comments
 (0)