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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions modules/installation/proc-install-rhdh-ocp-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

+
--
[source,yaml,subs="attributes+"]
----
apiVersion: v1
kind: ConfigMap
metadata:
name: app-config-rhdh
data:
"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.

backend:
auth:
externalAccess:
- type: legacy
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.

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.

----
--

. Create a secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value:
+
--
[source,yaml,subs="+attributes,+quotes"]
----
apiVersion: v1
kind: Secret
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.

BACKEND_SECRET: "xxx"
----
--

. Click *Create*.
. xref:{configuring-book-url}#using-the-operator-to-run-rhdh-with-your-custom-configuration[Add your {product-custom-resource-type} custom resource content].
. On the *Create Backstage* page, click *Create*
Expand Down
42 changes: 42 additions & 0 deletions modules/installation/proc-install-rhdh-osd-gcp-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,48 @@ You can install {product-short} on {osd-short} on {gcp-short} using the {product
. In the *Filter by keyword* box, enter {product-short} and click the *{product} Operator* card.
. On the *{product} Operator* page, click *Install*.
. In the {ocp-short} console, navigate to *Installed Operators* and select *{product} Operator*.
. Create a secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value:
+
--
[source,yaml,subs="attributes+"]
----
apiVersion: v1
kind: ConfigMap
metadata:
name: app-config-rhdh
data:
"app-config-rhdh.yaml": |
app:
title: {product}
baseUrl: https://<rhdh_dns_name>
backend:
auth:
externalAccess:
- type: legacy
options:
subject: legacy-default-config
secret: "${BACKEND_SECRET}"
baseUrl: https://<rhdh_dns_name>
cors:
origin: https://<rhdh_dns_name>
----
--

. Create a secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value:
+
--
[source,yaml,subs="+attributes,+quotes"]
----
apiVersion: v1
kind: Secret
metadata:
name: {my-product-secrets}
stringData:
# TODO: See https://backstage.io/docs/auth/service-to-service-auth/#setup
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.

. From the {product-short} Operator page, click *Create New Instance* and specify the name and namespace where you want to deploy {product-short}.
. Configure the required settings such as Git integration, secret management, and user permissions.
. Review the configuration, select deployment options, and click *Create*.
Expand Down