Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions modules/installation/proc-deploy-rhdh-instance-eks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
.Prerequisites

* A cluster administrator has installed the {product} Operator.
* 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].
* 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.
* You have installed an {eks-short} cluster with {aws-short} Application Load Balancer (ALB) add-on.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’m not sure I understand the reason for this change. We’re removing references to additional resources, but I feel the Additional resources section should include only RHDH links, and any other resources could be added alongside the relevant introductory statement. Could you please clarify?

* 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.
* 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.
* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
* 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].
* You have installed `kubectl`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html[Installing or updating kubectl].
* You have subscribed to `registry.redhat.io`.
* You have set the context to the {eks-short} cluster in your current `kubeconfig`.
* You have installed `kubectl`.

.Procedure

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

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

[role="_additional-resources"]
.Additional resources
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don’t think these reference links, including the external ones, are best placed here. It might be better to add them back to the Prerequisites section with clear introductory statements, similar to how it’s done in the OCP documentation.
image


* link:https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html[Application load balancing on {eks-brand-name}]
* link:https://docs.aws.amazon.com/eks/latest/userguide/aws-load-balancer-controller.html[Installing the AWS Load Balancer Controller add-on]
* link:https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring.html[Configuring Amazon Route 53 as your DNS service documentation]
* link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]
* link:https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html[Creating or updating a kubeconfig file for an Amazon {eks-short} cluster]
* link:https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html[Installing or updating kubectl]
14 changes: 10 additions & 4 deletions modules/installation/proc-deploy-rhdh-instance-gke.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,10 @@ You can deploy your {product-short} instance in {gke-short} using the Operator.

.Prerequisites
* A cluster administrator has installed the {product} Operator.
* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
* You have installed `kubectl`. For more information, see https://kubernetes.io/docs/tasks/tools/#kubectl[Install kubetl].

* You have subscribed to `registry.redhat.io`.
* You have installed `kubectl`.
* You have configured a domain name for your {product-short} instance.
* 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]
* You have reserved a static external Premium IPv4 Global IP address that is not attached to any virtual machine (VM).
* You have configured the DNS records for your domain name to point to the IP address that has been reserved.
+
[NOTE]
Expand Down Expand Up @@ -193,3 +192,10 @@ spec:

.Additional information
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].

[role="_additional-resources"]
.Additional resources

* link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]
* link:https://kubernetes.io/docs/tasks/tools/#kubectl[Installing kubetl]
* link:https://cloud.google.com/vpc/docs/reserve-static-external-ip-address#reserve_new_static[Reserving a new static external IP address]
6 changes: 5 additions & 1 deletion modules/installation/proc-enable-signin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ The {product} supports the following authentication providers:
.Prerequisites

* You have installed the {product-short}.
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].

.Procedure

Expand All @@ -87,3 +86,8 @@ auth:
`signInPage: oidc`

. Start your {product-short} application and sign in.

[role="_additional-resources"]
.Additional resources

* xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart]
3 changes: 2 additions & 1 deletion modules/installation/proc-install-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Containers are available for the following CPU architectures:
.Prerequisites

* You are logged in as an administrator on the {ocp-short} web console.
* 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].
* You have configured the appropriate roles and permissions within your project to create or access an application.
* You have installed {ocp-brand-name} 4.17 or later.

.Procedure
Expand Down Expand Up @@ -83,3 +83,4 @@ If you selected an *Automatic* approval strategy, the upgrade status should reso

* xref:proc-install-rhdh-ocp-operator_{context}[Deploying {product} on {ocp-short} with the Operator]
* 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]
* 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]
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ If your network has access to the registry through a bastion host, you can use t
** You have access to the registry.redhat.io.
** You have access to the charts.openshift.io Helm chart repository.
** You have installed the {openshift-cli} on your workstation.
** 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].
** You have installed the oc-mirror {openshift-cli} plugin.
** You have an account in https://developers.redhat.com/[{rhdeveloper-name}] portal.
* You have set up your intermediary host.
** 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].
Expand Down Expand Up @@ -146,4 +146,9 @@ where:
`<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`.

`<your_namespace>` :: Specifies the namespace that you want to deploy the Helm chart to, for example, `{my-product-namespace}`.
--
--

[role="_additional-resources"]
.Additional resources

* 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]
15 changes: 11 additions & 4 deletions modules/installation/proc-install-rhdh-helm-airgapped-partial.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ If your network has access to the `registry.redhat.io` registry and the `charts.
* You have installed {ocp-brand-name} {ocp-version-min} or later.
* You have access to the `charts.openshift.io` Helm chart repository.
* You have access to the `registry.redhat.io`.
* 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].
* 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].
* You have access to a mirror registry that can be reached from the disconnected cluster, for example, the {ocp-short} image registry.
* You are logged in to your target mirror registry and have permissions to push images to it.
* You have installed the {openshift-cli} on your workstation.
* 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].
* You have installed the oc-mirror {openshift-cli} plugin.
* You have an account in https://developers.redhat.com/[{rhdeveloper-name}] portal.

.Procedure
Expand Down Expand Up @@ -122,4 +122,11 @@ where:
`<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`.

`<your_namespace>` :: Specifies the namespace that you want to deploy the Helm chart to, for example, `{my-product-namespace}`.
--
--

[role="_additional-resources"]
.Additional resources

* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/registry/index#securing-exposing-registry[Exposing the registry]
* 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]
* 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]
10 changes: 7 additions & 3 deletions modules/installation/proc-install-rhdh-ocp-helm-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ You can use the Helm CLI to install {product} on {ocp-brand-name}.
.Prerequisites
* You have installed the {openshift-cli} on your workstation.
* You are logged in to your {ocp-short} account.
* 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].
* 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].
* A user with the {ocp-short} admin role has configured the appropriate roles and permissions within your project to create an application.
* You have created a project in {ocp-short}.
* You have installed the Helm CLI tool.

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

[role="_additional-resources"]
.Additional resources
* link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html-single/building_applications/index#installing-helm[Installing Helm]

* link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html-single/building_applications/index#installing-helm[Installing Helm]
* 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]
* 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}]
10 changes: 8 additions & 2 deletions modules/installation/proc-install-rhdh-ocp-helm-gui.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ The {product} Helm chart is available in the Helm catalog on {osd-short} and {oc
.Prerequisites

* You are logged in to your {ocp-short} account.
* 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].
* 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].
* A user with the {ocp-short} `admin` role has configured the appropriate roles and permissions within your project to create an application.
* You have created a project in {ocp-short}.

.Procedure

Expand Down Expand Up @@ -76,3 +76,9 @@ Backend failed to start up Error: Missing required config value at 'backend.data

To resolve the error, verify the configuration files.
====

[role="_additional-resources"]
.Additional resources

* 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]
* 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}]
13 changes: 9 additions & 4 deletions modules/installation/proc-install-rhdh-ocp-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ As a developer, you can deploy a {product} instance on {ocp-short} by using the

.Prerequisites

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

.Procedure

Expand All @@ -36,4 +36,9 @@ image::rhdh/operator-install-1.png[]
[role="_additional-resources"]
[id="additional-resources_proc-install-rhdh-ocp-operator"]
.Additional resources
* 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]

* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[Building applications overview]
* xref:proc-install-operator_{context}[Installing the {product} Operator]
* xref:{configuring-book-url}#provisioning-your-custom-configuration[Provisioning your custom config maps and secrets in your `_<{my-product-namespace}>_` project]
* xref:{configuring-book-url}#using-the-operator-to-run-rhdh-with-your-custom-configuration[Authoring your {product-custom-resource-type} custom resource]

Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ If your network has access to the registry through a bastion host, you can use t

.Prerequisites

* You have installed Podman 5.3 or later. For more information, see link:https://podman.io/docs/installation[Podman Installation Instructions].
* You have installed Podman 5.3 or later.
* You have installed Skopeo 1.17 or later.
* You have installed `yq` 4.44 or later.
* You have installed the GNU `sed` command line text editor.
* You have installed `umoci` CLI tool.
* 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].
* 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].
* You have an active `oc registry`, `podman`, or `skopeo` session to the `registry.redhat.io` {company-name} Ecosystem Catalog.
* You have installed the `opm` CLI tool.

.Procedure
. Download the mirroring script to disk by running the following command:
Expand Down Expand Up @@ -82,3 +82,10 @@ kubectl -n rhdh-operator get pods
** 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]
** 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]
** 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]

[role="_additional-resources"]
.Additional resources

* link:https://podman.io/docs/installation[Podman Installation Instructions]
* link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]
* 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]
Loading