Skip to content

Commit 6dd9bc4

Browse files
openshift-cherrypick-robothmanwani-rh
openshift-cherrypick-robot
and
hmanwani-rh
authored
[release-1.3] RHIDP-3389: Install and Run RHDH on OSD on GCP (#534)
Co-authored-by: Heena Manwani <hmanwani@redhat.com>
1 parent ed69be0 commit 6dd9bc4

File tree

10 files changed

+127
-0
lines changed

10 files changed

+127
-0
lines changed

‎artifacts/attributes.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@
4343
:aks-short: AKS
4444
:gke-brand-name: Google Kubernetes Engine
4545
:gke-short: GKE
46+
:gcp-brand-name: Google Cloud Platform
47+
:gcp-short: GCP
4648

4749
// Release Notes
4850
:rn-product-title: Release notes for Red Hat Developer Hub

‎assemblies/assembly-install-rhdh-osd-gcp.adoc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[id="assembly-install-rhdh-osd-gcp"]
2+
= Installing {product} on {osd-short} on {gcp-brand-name}
3+
:context: assembly-install-rhdh-osd-gcp
4+
5+
You can install {product-short} on {osd-short} on {gcp-brand-name} ({gcp-short}) using one of the following methods:
6+
7+
* The {product} Operator
8+
* The {product} Helm chart
9+
10+
// Operator procedure
11+
include::modules/installation/proc-install-rhdh-osd-gcp-operator.adoc[leveloffset=+1]
12+
13+
// Helm procedure
14+
include::modules/installation/proc-install-rhdh-osd-gcp-helm.adoc[leveloffset=+1]
15+

‎modules/installation/proc-install-rhdh-osd-gcp-helm.adoc‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
// Module included in the following assemblies:
2+
// assembly-install-rhdh-osd-gcp.adoc
3+
4+
[id="proc-install-rhdh-osd-gcp-helm_{context}"]
5+
= Installing {product} on {osd-short} on {gcp-short} using the Helm Chart
6+
7+
You can install {product-short} on {osd-short} on {gcp-short} using the {product} Helm Chart.
8+
9+
.Prerequisites
10+
* You have a valid {gcp-short} account.
11+
* 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.
12+
* You have installed Helm 3 or the latest.
13+
14+
.Procedure
15+
. From the *Developer* perspective on the {product-short} web console, click *+Add*.
16+
. From the *Developer Catalog* panel, click *Helm Chart*.
17+
. In the *Filter by keyword* box, enter {product-short} and click the *{product}* card.
18+
. From the {product} page, click *Create*.
19+
. From your cluster, copy the {ocp-short} router host (for example: `apps.<clusterName>.com`).
20+
. Select the radio button to configure the {product-short} instance with either the form view or YAML view. The *Form view* is selected by default.
21+
+
22+
--
23+
.. Using *Form view*
24+
... To configure the instance with the Form view, go to *Root Schema → global → Enable service authentication within Backstage instance* and paste your {ocp-short} router host into the field on the form.
25+
26+
.. Using *YAML view*
27+
... To configure the instance with the YAML view, paste your {ocp-short} router hostname in the `global.clusterRouterBase` parameter value as shown in the following example:
28+
+
29+
[source,yaml]
30+
----
31+
global:
32+
auth:
33+
backend:
34+
enabled: true
35+
clusterRouterBase: apps.<clusterName>.com
36+
# other {product} Helm Chart configurations
37+
----
38+
--
39+
40+
. Edit the other values if needed, then click *Create* and wait for the database and {product-short} to start.
41+
42+
.Verification
43+
44+
* To access the the {product-short}, click the *Open URL* icon.
45+
46+
.Additional resources
47+
* link:{LinkAdminGuide}[{Administration guide for {product}}]

‎modules/installation/proc-install-rhdh-osd-gcp-operator.adoc‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
// Module included in the following assemblies:
2+
// assembly-install-rhdh-osd-gcp.adoc
3+
4+
[id="proc-install-rhdh-osd-gcp-operator_{context}"]
5+
= Installing {product} on {osd-short} on {gcp-short} using the Operator
6+
7+
You can install {product-short} on {osd-short} on {gcp-short} using the {product} Operator.
8+
9+
.Prerequisites
10+
* You have a valid {gcp-short} account.
11+
* 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.
12+
* You have administrator access to {osd-short} cluster and {gcp-short} project.
13+
14+
.Procedure
15+
16+
. In the *Administrator* perspective of the {ocp-short} web console, click *Operators > OperatorHub*.
17+
. In the *Filter by keyword* box, enter {product-short} and click the *{product} Operator* card.
18+
. On the *{product} Operator* page, click *Install*.
19+
. In the {ocp-short} console, navigate to *Installed Operators* and select *{product} Operator*.
20+
. From the {product-short} Operator page, click *Create New Instance* and specify the name and namespace where you want to deploy {product-short}.
21+
. Configure the required settings such as Git integration, secret management, and user permissions.
22+
. Review the configuration, select deployment options, and click *Create*.
23+
24+
.Verification
25+
26+
* To access the {product-short}, navigate to the {product-short} URL provided in the {ocp-short} web console.
27+
28+
.Additional resources
29+
* link:{LinkAdminGuide}[{Administration guide for {product}}]

‎titles/install-rhdh-osd-gcp/artifacts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../artifacts

‎titles/install-rhdh-osd-gcp/assemblies‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../assemblies

‎titles/install-rhdh-osd-gcp/docinfo.xml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<title>Installing {product} on {osd-short} on {gcp-brand-name}</title>
2+
<productname>{product}</productname>
3+
<productnumber>{product-version}</productnumber>
4+
<subtitle>
5+
</subtitle>
6+
<abstract>
7+
<para>{product} is an enterprise-grade platform for building developer portals. Administrative users can configure roles, permissions, and other settings to enable other authorized users to deploy a {product-short} instance on {osd-brand-name} on {gcp-brand-name} ({gcp-short}) using either the Operator or Helm chart.</para>
8+
</abstract>
9+
<authorgroup>
10+
<orgname>{company-name} Customer Content Services</orgname>
11+
</authorgroup>
12+
<xi:include href="Common_Content/Legal_Notice.xml"
13+
xmlns:xi="http://www.w3.org/2001/XInclude" />

‎titles/install-rhdh-osd-gcp/images‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../images

‎titles/install-rhdh-osd-gcp/master.adoc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[id="title-install-rhdh-osd-gcp"]
2+
include::artifacts/attributes.adoc[]
3+
= Installing {product} on {osd-short} on {gcp-brand-name}
4+
:context: title-install-rhdh-osd-gcp
5+
:doctype: book
6+
:imagesdir: images
7+
8+
You can install {product-short} on {osd-short} on {gcp-brand-name} ({gcp-short}) using one of the following methods:
9+
10+
* The {product} Operator
11+
* The {product} Helm chart
12+
13+
// Operator procedure
14+
include::modules/installation/proc-install-rhdh-osd-gcp-operator.adoc[leveloffset=+1]
15+
16+
// Helm procedure
17+
include::modules/installation/proc-install-rhdh-osd-gcp-helm.adoc[leveloffset=+1]

‎titles/install-rhdh-osd-gcp/modules‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../modules

0 commit comments

Comments
 (0)