Skip to content

Conversation

jmagak
Copy link
Member

@jmagak jmagak commented Jan 28, 2025

OCP: https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html-single/insta[…]g_red_hat_developer_hub_on_openshift_container_platform/index misses the steps to first create custom configs between step 1 and 2

OSD: https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html-single/insta[…]per_hub_on_openshift_dedicated_on_google_cloud_platform/index does not explain that you need a custom config.

This PR addresses the missing configuration steps and improves clarity for installing Red Hat Developer Hub on OpenShift environments.

The changes:

  • Added instructions for setting the required baseUrl in installation modules for:

OpenShift Container Platform (OCP) Operator-based installs

OpenShift Dedicated (OSD) using both Operator and Helm methods

  • Included references to Provisioning your custom Red Hat Developer Hub configuration for consistent reuse

  • Ensured all install flows now call out the need for app-config.yaml and BACKEND_SECRET as prerequisites

  • Updated notes and examples to reflect the correct ConfigMap and Secret structure expected by RHDH

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Version(s): 1.5, 1.6, 1.7, main

RHDHBUGS-314

Previews:
OCP
1. Installing Red Hat Developer Hub on OpenShift Container Platform with the Operator
1.1. Installing the Red Hat Developer Hub Operator
1.2. Deploying Red Hat Developer Hub on OpenShift Container Platform with the Operator
2. Installing Red Hat Developer Hub on OpenShift Container Platform with the Helm chart
2.1. Deploying Developer Hub from the OpenShift Container Platform web console with the Helm Chart
2.2. Deploying Developer Hub on OpenShift Container Platform with the Helm CLI

GCP
1. Installing Red Hat Developer Hub on OpenShift Dedicated on GCP using the Operator
2. Installing Red Hat Developer Hub on OpenShift Dedicated on GCP using the Helm Chart

@rhdh-bot
Copy link
Collaborator

rhdh-bot commented Jan 28, 2025

@jmagak jmagak requested a review from kadel January 28, 2025 16:50
@linfraze
Copy link
Member

linfraze commented Jan 28, 2025

@kadel @jmagak Are these new steps different from this prerequisite: You have provisioned your custom config maps and secrets in your project listed in 1.2. Deploying Red Hat Developer Hub on OpenShift Container Platform with the Operator?

I like the clarity and simplicity of adding these steps directly in the procedure, but want to ensure that we aren't duplicating or causing confusion with that existing prerequisite. TBH, that prereq is a little confusing and hard-to-follow (to the point that I can't even tell if it's related to these steps or a completely different task).

@themr0c
Copy link
Member

themr0c commented Jan 31, 2025

That's a lot of content duplication :/.

@jmagak
Copy link
Member Author

jmagak commented Jan 31, 2025

@kadel @jmagak Are these new steps different from this prerequisite: You have provisioned your custom config maps and secrets in your project listed in 1.2. Deploying Red Hat Developer Hub on OpenShift Container Platform with the Operator?

Thanks for bringing this up @linfraze. I agree that the prerequisite could be clearer. I am refining or rewording the section to avoid duplication and confusion. Feel free to share any thoughts on how we can align the section. @themr0c

@jmagak jmagak force-pushed the RHIDP-5733-info-about-custom-config-in-the-Installation-guides branch from 44910fc to 86a4998 Compare February 18, 2025 11:07
@jmagak jmagak force-pushed the RHIDP-5733-info-about-custom-config-in-the-Installation-guides branch from 86a4998 to a949fe6 Compare February 28, 2025 13:52
@jmagak jmagak force-pushed the RHIDP-5733-info-about-custom-config-in-the-Installation-guides branch from a949fe6 to 2a0f464 Compare March 6, 2025 14:16
@jmagak jmagak changed the title Update the config in installation RHIDP-5733: Info about custom config in the Installation guides Jun 2, 2025
@jmagak jmagak force-pushed the RHIDP-5733-info-about-custom-config-in-the-Installation-guides branch from 591394e to 7842d96 Compare July 24, 2025 13:36
@jmagak jmagak force-pushed the RHIDP-5733-info-about-custom-config-in-the-Installation-guides branch from 7842d96 to 032e3dd Compare August 1, 2025 12:24
@jmagak jmagak force-pushed the RHIDP-5733-info-about-custom-config-in-the-Installation-guides branch from cb0fe56 to 6e00f3f Compare August 5, 2025 11:44
@jmagak jmagak added Technical review done ⛅ Any procedure has been succesfully tested Ready to merge 💂 and removed Technical review needed 🔩 Test all the procedures do-no-merge/review-in-progress 👀 labels Aug 6, 2025
@pabel-rh pabel-rh merged commit c8c5cd3 into redhat-developer:main Aug 6, 2025
3 checks passed
@pabel-rh
Copy link
Member

pabel-rh commented Aug 6, 2025

/cherry-pick release-1.7

@pabel-rh
Copy link
Member

pabel-rh commented Aug 6, 2025

/cherry-pick release-1.6

@pabel-rh
Copy link
Member

pabel-rh commented Aug 6, 2025

/cherry-pick release-1.5

@openshift-cherrypick-robot
Copy link
Contributor

@pabel-rh: new pull request created: #1294

In response to this:

/cherry-pick release-1.7

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot
Copy link
Contributor

@pabel-rh: new pull request created: #1295

In response to this:

/cherry-pick release-1.6

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot
Copy link
Contributor

@pabel-rh: #888 failed to apply on top of branch "release-1.5":

Applying: Update the config in installation
Applying: Update the config in installation
Applying: Update the config in installation
Using index info to reconstruct a base tree...
M	modules/installation/proc-install-operator.adoc
M	titles/install-rhdh-aks/master.adoc
M	titles/install-rhdh-eks/master.adoc
M	titles/install-rhdh-gke/master.adoc
M	titles/install-rhdh-ocp/master.adoc
M	titles/install-rhdh-osd-gcp/master.adoc
Falling back to patching base and 3-way merge...
Auto-merging titles/install-rhdh-osd-gcp/master.adoc
Auto-merging titles/install-rhdh-ocp/master.adoc
Auto-merging titles/install-rhdh-gke/master.adoc
Auto-merging titles/install-rhdh-eks/master.adoc
Auto-merging titles/install-rhdh-aks/master.adoc
Auto-merging modules/installation/proc-install-operator.adoc
CONFLICT (content): Merge conflict in modules/installation/proc-install-operator.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0003 Update the config in installation

In response to this:

/cherry-pick release-1.5

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants