Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the config in installation #888

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

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.

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

Version(s): 1.4

Add the relevant labels to the Pull Request.
Issue: https://issues.redhat.com/browse/RHIDP-5733

@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

"app-config-rhdh.yaml": |
app:
title: {product}
baseUrl: https://<rhdh_dns_name>
Copy link
Member

Choose a reason for hiding this comment

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

Consider rather using the my-product-url attribute.

options:
subject: legacy-default-config
secret: "${BACKEND_SECRET}"
baseUrl: https://<rhdh_dns_name>
Copy link
Member

Choose a reason for hiding this comment

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

Consider rather using the my-product-url attribute.

secret: "${BACKEND_SECRET}"
baseUrl: https://<rhdh_dns_name>
cors:
origin: https://<rhdh_dns_name>
Copy link
Member

Choose a reason for hiding this comment

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

Consider rather using the my-product-url attribute.

metadata:
name: {my-product-secrets}
stringData:
# TODO: See https://backstage.io/docs/auth/service-to-service-auth/#setup
Copy link
Member

Choose a reason for hiding this comment

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

You can't leave here a link to upsteam.

@@ -19,6 +19,48 @@ As a developer, you can deploy a {product} instance on {ocp-short} by using the
. From the *Developer* perspective on the {ocp-short} web console, click *+Add*.
. From the *Developer Catalog* panel, click *Operator Backed*.
. In the *Filter by keyword* box, enter _{product-short}_ and click the *{product}* card.
. Create a config map named `app-config-rhdh` containing the {product-short} configuration using the following template:
Copy link
Member

Choose a reason for hiding this comment

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

For consistency, consider that these steps should be exactly the same as the steps found in modules/configuring/proc-provisioning-your-custom-configuration.adoc.

BACKEND_SECRET: "xxx"
----
--

Copy link
Member

Choose a reason for hiding this comment

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

For consistency, consider that these steps should be exactly the same as the steps found in modules/configuring/proc-provisioning-your-custom-configuration.adoc.

GitHub Actions added 2 commits February 18, 2025 12:07

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@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
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.

None yet

4 participants