Skip to content

Commit 0c28654

Browse files
jmagakopenshift-cherrypick-robot
jmagak
authored and
openshift-cherrypick-robot
committed
Updates supported platforms
1 parent 69d5ec8 commit 0c28654

File tree

3 files changed

+157
-0
lines changed

3 files changed

+157
-0
lines changed

‎artifacts/attributes.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,9 @@
8888
:authorization-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authorization/index
8989
:authorization-book-title: Authorization
9090

91+
:installing-on-osd-on-gcp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/index
92+
:installing-on-osd-on-gcp-book-title: Installing {product} on {gcp-brand-name} on {gcp-brand-name}
93+
9194
:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index
9295
:installing-on-ocp-book-title: Installing {product} on {ocp-short}
9396

‎assemblies/assembly-about-rhdh.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,4 @@ Use {product} to simplify decision-making through a selection of internally appr
2020

2121

2222
include::modules/about/con-benefits-of-rhdh.adoc[leveloffset=+1]
23+
include::modules/about/proc-supported-platforms.adoc[leveloffset=+1]

‎modules/about/proc-supported-platforms.adoc‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
:_newdoc-version: 2.18.3
2+
:_template-generated: 2024-11-08
3+
4+
:_mod-docs-content-type: CONCEPT
5+
6+
[id="supported-platforms_{context}"]
7+
= Supported platforms
8+
9+
{product} runs on {ocp-short} {ocp-version-min}-{ocp-version} on supported architectures and providers, such as:
10+
11+
* link:{installing-on-ocp-book-url}[{ocp-brand-name} {ocp-version-min}-{ocp-version}]
12+
* link:{installing-on-eks-book-url}[{eks-brand-name}]
13+
* link:{installing-on-aks-book-url}[{aks-brand-name}]
14+
* link:{installing-on-osd-on-gcp-book-url}[{gcp-brand-name}]
15+
16+
== {ocp-brand-name}
17+
18+
As a developer, you can deploy a {product} instance on {ocp-short} by using the *Developer Catalog* in the {ocp-brand-name} web console.
19+
20+
.Prerequisites
21+
* You have installed the {product} Operator.
22+
* You have added a custom configuration file to {ocp-short}.
23+
24+
link:{installing-on-ocp-book-url}#proc-install-rhdh-ocp-operator_assembly-install-rhdh-ocp-operator[Procedure for Deploying {product} on {ocp-short} with the Operator]
25+
26+
27+
=== Deploying the {product-short} from the {ocp-short} web console with the Helm Chart
28+
29+
.Prerequisites
30+
* You have logged into your {ocp-short} account.
31+
* An administrator should have configured the appropriate roles and permissions within your project to create an application.
32+
* You have created a project in {ocp-short}.
33+
34+
link:{installing-on-ocp-book-url}#proc-install-rhdh-ocp-helm-gui_assembly-install-rhdh-ocp-helm[Procedure for Deploying {product-short} from the {ocp-short} web console with the Helm Chart]
35+
36+
=== Deploying the {product-short} on {ocp-short} with the Helm CLI
37+
38+
.Prerequisites
39+
* You have installed the {openshift-cli} on your workstation.
40+
* Ensure you are logged into your {ocp-short} account.
41+
* An administrator should have configured the appropriate roles and permissions within your project to create an application.
42+
* You have created a project in {ocp-short}.
43+
* You have installed the Helm CLI tool.
44+
45+
link:{installing-on-ocp-book-url}#proc-install-rhdh-ocp-helm-cli_assembly-install-rhdh-ocp-helm[Procedure for Deploying {product-short} on {ocp-short} using the Helm CLI]
46+
47+
== {eks-brand-name}
48+
49+
=== Installing the {product-short} on {eks-short} with the Operator
50+
51+
You can install the {product} Operator with or without the Operator Lifecycle Manager (OLM) framework.
52+
53+
==== Installing the {product-short} on {eks-short} with the OLM framework
54+
55+
You can install the {product} Operator with the Operator Lifecycle Manager (OLM) framework. As a developer, you can then deploy the {product-short} instance in {eks-short}.
56+
57+
.Prerequisites
58+
* You have set the context to the {eks-short} cluster in your current `kubeconfig`.
59+
* You have installed `kubectl`.
60+
* You have subscribed to `registry.redhat.io`.
61+
* You have installed the Operator Lifecycle Manager (OLM).
62+
63+
link:{installing-on-eks-book-url}#installing-the-developer-hub-operator-with-the-olm-framework[Procedure for Installing the {product} Operator with the Operator Lifecycle Manager (OLM) framework]
64+
65+
==== Installing the {product-short} Operator without the OLM framework
66+
67+
.Prerequisites
68+
* You have installed the following commands:
69+
** `git`
70+
** `make`
71+
** `sed`
72+
73+
link:{installing-on-eks-book-url:}#installing-the-developer-hub-operator-without-the-olm-framework[Procedure for Installing the {product-short} Operator without the OLM framework]
74+
75+
==== Deploying the {product-short} on {eks-short} with the Operator
76+
77+
.Prerequisites
78+
79+
* A cluster administrator has installed the {product} Operator.
80+
* You have installed an {eks-short} cluster with {aws-short} Application Load Balancer (ALB) add-on.
81+
* 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.
82+
* You have an entry in the {aws-short} Certificate Manager (ACM) for your preferred domain name. Keep record of your Certificate ARN.
83+
* You have subscribed to `registry.redhat.io`.
84+
* You have set the context to the {eks-short} cluster in your current `kubeconfig`.
85+
* You have installed `kubectl`.
86+
87+
link:{installing-on-eks-book-url:}#proc-deploy-rhdh-instance-eks.adoc_title-install-rhdh-eks[Procedure for Deploying the {product-short} on {eks-short} with the Operator]
88+
89+
=== Installing the {product-short} on {eks-short} with the Helm chart
90+
91+
.Prerequisites
92+
* You have an EKS cluster with AWS Application Load Balancer (ALB) add-on.
93+
* 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.
94+
* You have an entry in the AWS Certificate Manager (ACM) for your preferred domain name. Ensure you keep a record of your Certificate ARN.
95+
* You have subscribed to `registry.redhat.io`.
96+
* You have set the context to the {eks-short} cluster in your current `kubeconfig`.
97+
* You have installed `kubectl`.
98+
* You have installed Helm 3 or the latest.
99+
100+
link:{installing-on-eks-book-url:}#proc-rhdh-deploy-eks-helm_title-install-rhdh-eks[Procedure for Installing {product-short} on {eks-short} with the Helm chart]
101+
102+
== {aks-brand-name}
103+
104+
You can deploy a {product-short} application on {aks-name} ({aks-short}) using either the Operator or Helm chart.
105+
106+
=== Deploying the {product-short} on {aks-short} with the Operator
107+
108+
.Procedure
109+
. Have a {product} Operator manifest file, named `rhdh-operator-<VERSION>.yaml`, and modify the default configuration of `db-statefulset.yaml` and `deployment.yaml`.
110+
. Apply the modified Operator manifest to your Kubernetes cluster.
111+
. Have an `ImagePull Secret` named `rhdh-pull-secret` using your Red Hat credentials to access images from the protected `registry.redhat.io`.
112+
. Create an Ingress manifest file, named `rhdh-ingress.yaml`, specifying your {product-short} service name.
113+
. Deploy the created Ingress.
114+
. Create a ConfigMap named `app-config-rhdh` containing the {product-short} configuration.
115+
. Create a Secret named `secrets-rhdh` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string value.
116+
. Create a Custom Resource (CR) manifest file named `rhdh.yaml` and include the previously created `rhdh-pull-secret`.
117+
. Apply the Custom Resource (CR) manifest to your namespace.
118+
. Access the deployed {product-short} using the URL: `https://<app_address>`, where <app_address> is the Ingress address obtained earlier.
119+
120+
=== Deploying the {product-short} on {aks-name} ({aks-short}) with the Helm chart
121+
122+
You can access a comprehensive solution for building, testing, and deploying applications.
123+
124+
.Prerequisites
125+
* You have a {azure-brand-name} account with active subscription.
126+
* You have installed the https://learn.microsoft.com/en-us/cli/azure/install-azure-cli[Azure CLI].
127+
* You have installed the link:https://kubernetes.io/docs/reference/kubectl/[`kubectl` CLI].
128+
* You have logged into your cluster using `kubectl`, and have `developer` or `admin` permissions.
129+
* You have installed Helm 3 or the latest.
130+
131+
link:{installing-on-aks-book-url}#proc-rhdh-deploy-aks-helm_title-install-rhdh-aks[Procedure for Deploying {product-short} with the Helm Chart]
132+
133+
== {gcp-brand-name} ({gcp-short})
134+
135+
You can install {product-short} on {osd-short} on {gcp-brand-name} ({gcp-short}) using either the {product} Operator or the {product} Helm chart.
136+
137+
=== Installing the {product-short} on {osd-short} on {gcp-short} using the {product} Operator
138+
139+
.Prerequisites
140+
* You have a valid {gcp-short} account.
141+
* Ensure your {osd-short} cluster is running on {gcp-short}.
142+
* You have administrator access to {osd-short} cluster and {gcp-short} project.
143+
144+
link:{installing-on-osd-on-gcp-book-url}#proc-install-rhdh-osd-gcp-operator_title-install-rhdh-osd-gcp[Procedure for Installing the {product-short} on {osd-short} on {gcp-short} using the Operator]
145+
146+
=== Installing the {product-short} on {osd-short} on {gcp-short} using the {product} Helm Chart
147+
148+
.Prerequisites
149+
* You have a valid {gcp-short} account.
150+
* Ensure your {osd-short} cluster is running on {gcp-short}.
151+
* You have installed Helm 3 or the latest.
152+
153+
link:{installing-on-osd-on-gcp-book-url}#proc-install-rhdh-osd-gcp-helm_title-install-rhdh-osd-gcp[Procedure for Installing the {product-short} on {osd-short} on {gcp-short} using the Helm Chart]

0 commit comments

Comments
 (0)