diff --git a/modules/installation/proc-deploy-rhdh-instance-eks.adoc b/modules/installation/proc-deploy-rhdh-instance-eks.adoc index 25a272fad6..ce6a3d4d82 100644 --- a/modules/installation/proc-deploy-rhdh-instance-eks.adoc +++ b/modules/installation/proc-deploy-rhdh-instance-eks.adoc @@ -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. +* 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 @@ -158,3 +158,13 @@ In the previous template, replace ` ` 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 + +* 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] diff --git a/modules/installation/proc-deploy-rhdh-instance-gke.adoc b/modules/installation/proc-deploy-rhdh-instance-gke.adoc index c3439bd13c..62013cab5d 100644 --- a/modules/installation/proc-deploy-rhdh-instance-gke.adoc +++ b/modules/installation/proc-deploy-rhdh-instance-gke.adoc @@ -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] @@ -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] \ No newline at end of file diff --git a/modules/installation/proc-enable-signin.adoc b/modules/installation/proc-enable-signin.adoc index 60a61bca36..b81f6445cd 100644 --- a/modules/installation/proc-enable-signin.adoc +++ b/modules/installation/proc-enable-signin.adoc @@ -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 @@ -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] \ No newline at end of file diff --git a/modules/installation/proc-install-operator.adoc b/modules/installation/proc-install-operator.adoc index 6af2071eab..adaa931a5b 100644 --- a/modules/installation/proc-install-operator.adoc +++ b/modules/installation/proc-install-operator.adoc @@ -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 @@ -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] diff --git a/modules/installation/proc-install-rhdh-helm-airgapped-full.adoc b/modules/installation/proc-install-rhdh-helm-airgapped-full.adoc index 5ad3a6b9b5..22f83771a8 100644 --- a/modules/installation/proc-install-rhdh-helm-airgapped-full.adoc +++ b/modules/installation/proc-install-rhdh-helm-airgapped-full.adoc @@ -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]. @@ -146,4 +146,9 @@ where: `` :: Specifies the name of the archive file containing the resources that you want to mirror, for example, `redhat-developer-hub-1.4.1.tgz`. `` :: Specifies the namespace that you want to deploy the Helm chart to, for example, `{my-product-namespace}`. --- \ No newline at end of file +-- + +[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] \ No newline at end of file diff --git a/modules/installation/proc-install-rhdh-helm-airgapped-partial.adoc b/modules/installation/proc-install-rhdh-helm-airgapped-partial.adoc index f6d75e2634..64cf21cbba 100644 --- a/modules/installation/proc-install-rhdh-helm-airgapped-partial.adoc +++ b/modules/installation/proc-install-rhdh-helm-airgapped-partial.adoc @@ -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 @@ -122,4 +122,11 @@ where: `` :: Specifies the name of the archive file containing the resources that you want to mirror, for example, `redhat-developer-hub-1.4.1.tgz`. `` :: Specifies the namespace that you want to deploy the Helm chart to, for example, `{my-product-namespace}`. --- \ No newline at end of file +-- + +[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] \ No newline at end of file diff --git a/modules/installation/proc-install-rhdh-ocp-helm-cli.adoc b/modules/installation/proc-install-rhdh-ocp-helm-cli.adoc index 3588eb2909..e8760d2ed9 100644 --- a/modules/installation/proc-install-rhdh-ocp-helm-cli.adoc +++ b/modules/installation/proc-install-rhdh-ocp-helm-cli.adoc @@ -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 @@ -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] \ No newline at end of file + +* 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}] \ No newline at end of file diff --git a/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc b/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc index 5bf3c684dc..cf6f6bff88 100644 --- a/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc +++ b/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc @@ -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 @@ -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}] \ No newline at end of file diff --git a/modules/installation/proc-install-rhdh-ocp-operator.adoc b/modules/installation/proc-install-rhdh-ocp-operator.adoc index 54f6bd196e..fa81a0d528 100644 --- a/modules/installation/proc-install-rhdh-ocp-operator.adoc +++ b/modules/installation/proc-install-rhdh-ocp-operator.adoc @@ -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 @@ -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] + diff --git a/modules/installation/proc-install-rhdh-operator-airgapped-full.adoc b/modules/installation/proc-install-rhdh-operator-airgapped-full.adoc index aacb27585d..8e5000a5ba 100644 --- a/modules/installation/proc-install-rhdh-operator-airgapped-full.adoc +++ b/modules/installation/proc-install-rhdh-operator-airgapped-full.adoc @@ -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: @@ -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] \ No newline at end of file diff --git a/modules/installation/proc-install-rhdh-operator-airgapped-partial.adoc b/modules/installation/proc-install-rhdh-operator-airgapped-partial.adoc index 725af137f8..78754ccbde 100644 --- a/modules/installation/proc-install-rhdh-operator-airgapped-partial.adoc +++ b/modules/installation/proc-install-rhdh-operator-airgapped-partial.adoc @@ -14,14 +14,14 @@ You can use a helper script that mirrors the necessary images and provides the n When connected to a {ocp-short} cluster, the helper script detects it and automatically exposes the cluster registry. If connected to a Kubernetes cluster, you can manually specify the target registry to mirror the images. .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 an active `skopeo` session with administrative access to the target mirror registry. For more information, see link:https://github.com/containers/skopeo#authenticating-to-a-registry[Authenticating to a registry]. -* 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 an active `skopeo` session with administrative access to the target mirror registry. +* You have installed the `opm` CLI tool. * If you are using an {ocp-short} cluster, you have the following prerequisites: ** (Optional) You have installed the `oc-mirror` {ocp-short} CLI plugin if you want to use it to mirror images. * If you are using a supported Kubernetes cluster, you have the following prerequisites: @@ -69,4 +69,12 @@ 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_amazon_elastic_kubernetes_service/proc-rhdh-deploy-eks-operator_title-install-rhdh-eks[Installing {product-short} on {eks-short} with the Operator] ** 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] \ No newline at end of file +** 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://github.com/containers/skopeo#authenticating-to-a-registry[Authenticating to a registry] +* 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] \ No newline at end of file diff --git a/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc b/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc index df951f9169..d09bb6cddf 100644 --- a/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc +++ b/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc @@ -8,7 +8,7 @@ You can install {product-short} on {osd-short} on {gcp-short} using the {product .Prerequisites * You have a valid {gcp-short} account. -* Your {osd-short} cluster is running on {gcp-short}. For more information, see link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html/installing_accessing_and_deleting_openshift_dedicated_clusters/osd-creating-a-cluster-on-gcp[Creating a cluster on GCP] in {osd-brand-name} documentation. +* Your {osd-short} cluster is running on {gcp-short}. * You have installed Helm 3 or the latest. .Procedure @@ -43,6 +43,9 @@ global: * To access the the {product-short}, click the *Open URL* icon. +[role="_additional-resources"] .Additional resources + * link:{configuring-book-url}[{configuring-book-title}] * link:{customizing-book-url}[{customizing-book-title}] +* link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html/installing_accessing_and_deleting_openshift_dedicated_clusters/osd-creating-a-cluster-on-gcp[Creating a cluster on {gcp-short} in {osd-brand-name} documentation] diff --git a/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc b/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc index 995d878094..07c2c66c5e 100644 --- a/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc +++ b/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc @@ -8,7 +8,7 @@ You can install {product-short} on {osd-short} on {gcp-short} using the {product .Prerequisites * You have a valid {gcp-short} account. -* Your {osd-short} cluster is running on {gcp-short}. For more information, see link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html/installing_accessing_and_deleting_openshift_dedicated_clusters/osd-creating-a-cluster-on-gcp[Creating a cluster on GCP] in {osd-brand-name} documentation. +* Your {osd-short} cluster is running on {gcp-short}. * You have administrator access to {osd-short} cluster and {gcp-short} project. .Procedure @@ -25,6 +25,9 @@ You can install {product-short} on {osd-short} on {gcp-short} using the {product * To access the {product-short}, navigate to the {product-short} URL provided in the {ocp-short} web console. +[role="_additional-resources"] .Additional resources + * link:{configuring-book-url}[{configuring-book-title}] * link:{customizing-book-url}[{customizing-book-title}] +* link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html/installing_accessing_and_deleting_openshift_dedicated_clusters/osd-creating-a-cluster-on-gcp[Creating a cluster on {gcp-short} in {osd-brand-name} documentation] diff --git a/modules/installation/proc-rhdh-deploy-aks-helm.adoc b/modules/installation/proc-rhdh-deploy-aks-helm.adoc index 7118e0a636..aef9e287e7 100644 --- a/modules/installation/proc-rhdh-deploy-aks-helm.adoc +++ b/modules/installation/proc-rhdh-deploy-aks-helm.adoc @@ -9,8 +9,8 @@ You can deploy your {product-short} application on {aks-name} ({aks-short}) to a .Prerequisites * You have a {azure-brand-name} account with active subscription. -* You have installed the https://learn.microsoft.com/en-us/cli/azure/install-azure-cli[Azure CLI]. -* You have installed the link:https://kubernetes.io/docs/reference/kubectl/[`kubectl` CLI]. +* You have installed the Azure CLI. +* You have installed the `kubectl` CLI. * You are logged into your cluster using `kubectl`, and have `developer` or `admin` permissions. * You have installed Helm 3 or the latest. @@ -213,3 +213,9 @@ helm upgrade $DEPLOYMENT_NAME -i https://github.com/openshift-helm-charts/charts ---- helm -n $NAMESPACE delete $DEPLOYMENT_NAME ---- + +[role="_additional-resources"] +.Additional resources + +* link:https://learn.microsoft.com/en-us/cli/azure/install-azure-cli[Installing Azure CLI] +* link:https://kubernetes.io/docs/reference/kubectl/[Installing kubectl CLI] \ No newline at end of file diff --git a/modules/installation/proc-rhdh-deploy-eks-helm.adoc b/modules/installation/proc-rhdh-deploy-eks-helm.adoc index c6aff3342e..ff502aaa72 100644 --- a/modules/installation/proc-rhdh-deploy-eks-helm.adoc +++ b/modules/installation/proc-rhdh-deploy-eks-helm.adoc @@ -8,13 +8,13 @@ When you install the {product-short} Helm chart in {eks-name} ({eks-short}), it .Prerequisites -* You have an {eks-short} cluster with AWS 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 Amazon {product-short}] 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 an {eks-short} cluster with AWS Application Load Balancer (ALB) add-on installed. +* 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 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 installed Helm 3 or the latest. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/helm.html[Using Helm with Amazon {eks-short}]. +* 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`. +* You have installed Helm 3 or the latest. .Procedure @@ -125,3 +125,13 @@ For the latest chart version, see https://github.com/openshift-helm-charts/chart Wait until the DNS name is responsive, indicating that your {product-short} instance is ready for use. +[role="_additional-resources"] +.Additional resources + +* link:https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html[Application load balancing on Amazon {product-short}] +* 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] +* link: https://docs.aws.amazon.com/eks/latest/userguide/helm.html[Using Helm with Amazon {eks-short}] diff --git a/modules/installation/proc-rhdh-deploy-eks-operator.adoc b/modules/installation/proc-rhdh-deploy-eks-operator.adoc index 22671c3d97..197253af14 100644 --- a/modules/installation/proc-rhdh-deploy-eks-operator.adoc +++ b/modules/installation/proc-rhdh-deploy-eks-operator.adoc @@ -9,10 +9,10 @@ You can install the {product-short} Operator on {eks-short} using the https://ol .Prerequisites -* 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`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]. -* You have installed the Operator Lifecycle Manager (OLM). For more information about installation and troubleshooting, see https://olm.operatorframework.io/docs/getting-started/[OLM QuickStart] or https://operatorhub.io/how-to-install-an-operator#How-do-I-get-Operator-Lifecycle-Manager?[How do I get Operator Lifecycle Manager?] +* You have set the context to the {eks-short} cluster in your current `kubeconfig`. +* You have installed `kubectl`. +* You have subscribed to `registry.redhat.io`. +* You have installed the Operator Lifecycle Manager (OLM). .Procedure @@ -190,3 +190,12 @@ kubectl -n rhdh-operator edit configmap backstage-default-config .. Save and exit. + Wait for a few minutes until the changes are automatically applied to the operator pods. + +[role="_additional-resources"] +.Additional resources + +* 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] +* link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication] +* link:https://olm.operatorframework.io/docs/getting-started/[OLM QuickStart] +* link:https://operatorhub.io/how-to-install-an-operator#How-do-I-get-Operator-Lifecycle-Manager?[How do I get Operator Lifecycle Manager?] \ No newline at end of file diff --git a/modules/installation/proc-rhdh-deploy-gke-helm.adoc b/modules/installation/proc-rhdh-deploy-gke-helm.adoc index 55f56d4207..73fb7030c8 100644 --- a/modules/installation/proc-rhdh-deploy-gke-helm.adoc +++ b/modules/installation/proc-rhdh-deploy-gke-helm.adoc @@ -4,15 +4,15 @@ When you install the {product-short} Helm chart in {gke-brand-name} ({gke-short}), it orchestrates the deployment of a {product-short} instance, which provides a robust developer platform within the {gke-short} ecosystem. .Prerequisites -* 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 installed the Google Cloud CLI. For more information, see https://cloud.google.com/sdk/docs/install[Install the gcloud CLI]. -* You have logged in to your Google account and created a https://cloud.google.com/kubernetes-engine/docs/how-to/creating-an-autopilot-cluster[GKE Autopilot] or https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-zonal-cluster[GKE Standard] cluster. +* You have subscribed to `registry.redhat.io`. +* You have installed `kubectl`. +* You have installed the Google Cloud CLI. +* You have logged in to your Google account and created a {gke-short} Autopilot or {gke-short} Standard cluster. * 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 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 configured the DNS records for your domain name to point to the IP address that has been reserved. +* You have configured the DNS records for your domain name to point to the IP address that has been reserved. + [NOTE] ==== @@ -165,4 +165,13 @@ helm -n upgrade -f values.yaml openshift-hel [source,terminal,subs="attributes+"] ---- helm -n delete ----- \ No newline at end of file +---- + +[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/sdk/docs/install[Installing Google Cloud CLI] +* link:https://cloud.google.com/kubernetes-engine/docs/how-to/creating-an-autopilot-cluster[Creating {gke-short} Autopilot] +* link:https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-zonal-cluster[Creating {gke-short} Standard cluster] \ No newline at end of file diff --git a/modules/installation/proc-rhdh-deploy-gke-operator.adoc b/modules/installation/proc-rhdh-deploy-gke-operator.adoc index b55021b404..b4919e6d3c 100644 --- a/modules/installation/proc-rhdh-deploy-gke-operator.adoc +++ b/modules/installation/proc-rhdh-deploy-gke-operator.adoc @@ -6,15 +6,11 @@ You can install the {product-short} Operator on {gke-short} using the https://ol For information about the OLM, see link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)] documentation. .Prerequisites -* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]. - -* You have installed the Operator Lifecycle Manager (OLM). For more information about installation and troubleshooting, see https://operatorhub.io/how-to-install-an-operator#How-do-I-get-Operator-Lifecycle-Manager?[How do I get Operator Lifecycle Manager?] - -* You have installed `kubectl`. For more information, see https://kubernetes.io/docs/tasks/tools/#kubectl[Install kubetl]. - -* You have installed the Google Cloud CLI. For more information, see https://cloud.google.com/sdk/docs/install[Install the gcloud CLI]. - -* You have logged in to your Google account and created a https://cloud.google.com/kubernetes-engine/docs/how-to/creating-an-autopilot-cluster[GKE Autopilot] or https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-zonal-cluster[GKE Standard] cluster. +* You have subscribed to `registry.redhat.io`. +* You have installed the Operator Lifecycle Manager (OLM). +* You have installed `kubectl`. +* You have installed the Google Cloud CLI. +* You have logged in to your Google account and created a {gke-short} Autopilot or {gke-short} Standard cluster. .Procedure . Connect to your GKE cluster using the following command: @@ -207,4 +203,14 @@ kubectl -n rhdh-operator edit configmap backstage-default-config .. Save and exit. + -Wait until the changes are automatically applied to the Operator pods. \ No newline at end of file +Wait until the changes are automatically applied to the Operator pods. + +[role="_additional-resources"] +.Additional resources + +* link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication] +* link:https://operatorhub.io/how-to-install-an-operator#How-do-I-get-Operator-Lifecycle-Manager?[How do I get Operator Lifecycle Manager?] +* link:https://kubernetes.io/docs/tasks/tools/#kubectl[Installing kubetl] +* link:https://cloud.google.com/sdk/docs/install[Installing the gcloud CLI] +* link:https://cloud.google.com/kubernetes-engine/docs/how-to/creating-an-autopilot-cluster[Creating {gke-short} Autopilot] +* link:https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-zonal-cluster[Creating {gke-short} Standard cluster] \ No newline at end of file