Use backstage-operator to install backstage #61

masayag · 2024-02-11T13:31:48Z

The PR changes the installation method of Janus-IDP from helm-based to an operator-based.
The configuration for backstage is split between several configmaps according to the sections in app-config.

masayag · 2024-02-11T13:32:53Z

@jianrongzhang89 can you have a look and see if this is the correct way to go?
Specifically, I'm trying to figure out if using the operator, there is also community catalog operator and if there is a need to explicitly create the Backstage kind (as in this sample https://github.com/janus-idp/operator/blob/72962ea8d6f37226142d7609e9087c486624a622/config/samples/_v1alpha1_backstage.yaml#L2)

charts/orchestrator/templates/rhdh-operator.yaml

jianrongzhang89 · 2024-02-12T20:50:41Z

@jianrongzhang89 can you have a look and see if this is the correct way to go? Specifically, I'm trying to figure out if using the operator, there is also community catalog operator and if there is a need to explicitly create the Backstage kind (as in this sample https://github.com/janus-idp/operator/blob/72962ea8d6f37226142d7609e9087c486624a622/config/samples/_v1alpha1_backstage.yaml#L2)

When the RHDH operator is released, it will be a certified Red Hat operator. It will NOT be released as an community operator.

jianrongzhang89 · 2024-02-13T14:55:13Z

@masayag I tried to install the chart based on the instruction but got error:
helm install orchestrator orchestrator
--set "backstage.upstream.backstage.appConfig.integrations.github[0].host"=github.com
--set "backstage.upstream.backstage.appConfig.integrations.github[0].token"=$GITHUB_TOKEN

Error: INSTALLATION FAILED: no SonataFlowPlatform with the name "sonataflow-platform" found

masayag · 2024-02-13T17:31:53Z

@masayag I tried to install the chart based on the instruction but got error: helm install orchestrator orchestrator --set "backstage.upstream.backstage.appConfig.integrations.github[0].host"=github.com --set "backstage.upstream.backstage.appConfig.integrations.github[0].token"=$GITHUB_TOKEN

Error: INSTALLATION FAILED: no SonataFlowPlatform with the name "sonataflow-platform" found

@jianrongzhang89 just to make sure I'm reproducing the same setup, did you create the DB before?

jianrongzhang89 · 2024-02-14T13:20:34Z

@masayag I tried to install the chart based on the instruction but got error: helm install orchestrator orchestrator --set "backstage.upstream.backstage.appConfig.integrations.github[0].host"=github.com --set "backstage.upstream.backstage.appConfig.integrations.github[0].token"=$GITHUB_TOKEN
Error: INSTALLATION FAILED: no SonataFlowPlatform with the name "sonataflow-platform" found

@jianrongzhang89 just to make sure I'm reproducing the same setup, did you create the DB before?

Yes the DB was created. Did you test the PR on a fresh cluster?

masayag · 2024-02-14T13:37:38Z

@masayag I tried to install the chart based on the instruction but got error: helm install orchestrator orchestrator --set "backstage.upstream.backstage.appConfig.integrations.github[0].host"=github.com --set "backstage.upstream.backstage.appConfig.integrations.github[0].token"=$GITHUB_TOKEN
Error: INSTALLATION FAILED: no SonataFlowPlatform with the name "sonataflow-platform" found

@jianrongzhang89 just to make sure I'm reproducing the same setup, did you create the DB before?

Yes the DB was created. Did you test the PR on a fresh cluster?

not on a fresh cluster. but made sure to clean the resources. I'll try on a fresh one.

jianrongzhang89 · 2024-02-14T15:09:50Z

@masayag I tried to install the chart based on the instruction but got error: helm install orchestrator orchestrator --set "backstage.upstream.backstage.appConfig.integrations.github[0].host"=github.com --set "backstage.upstream.backstage.appConfig.integrations.github[0].token"=$GITHUB_TOKEN
Error: INSTALLATION FAILED: no SonataFlowPlatform with the name "sonataflow-platform" found

@jianrongzhang89 just to make sure I'm reproducing the same setup, did you create the DB before?

Yes the DB was created. Did you test the PR on a fresh cluster?

not on a fresh cluster. but made sure to clean the resources. I'll try on a fresh one.

If you test on an existing cluster, make sure you remove all related CRDs before rerun your test. Note that when an operator is undeployed, the CRDs remain in the cluster by default.

jianrongzhang89 · 2024-02-14T16:08:04Z

@jianrongzhang89 can you have a look and see if this is the correct way to go? Specifically, I'm trying to figure out if using the operator, there is also community catalog operator and if there is a need to explicitly create the Backstage kind (as in this sample https://github.com/janus-idp/operator/blob/72962ea8d6f37226142d7609e9087c486624a622/config/samples/_v1alpha1_backstage.yaml#L2)

Yes, you will need to create a RHDH Backstage custom resource (after the operator is deployed) in order to deploy Backstage.

masayag · 2024-02-15T20:21:24Z

@jianrongzhang89 can you have a look and see if this is the correct way to go? Specifically, I'm trying to figure out if using the operator, there is also community catalog operator and if there is a need to explicitly create the Backstage kind (as in this sample https://github.com/janus-idp/operator/blob/72962ea8d6f37226142d7609e9087c486624a622/config/samples/_v1alpha1_backstage.yaml#L2)

Yes, you will need to create a RHDH Backstage custom resource (after the operator is deployed) in order to deploy Backstage.

With the updated version of the chart I'm able to get the backstage instance to start, but it fails to load the orchestrator and the notification plugins. I'll check this earliest next week.

However, one thing I could bypass is the environment set always to production, no matter what type of method I tried to override it.

pkliczewski

/lgtm

dmartinol · 2024-02-20T10:06:19Z

charts/orchestrator/templates/rhdh-operator.yaml

+metadata:
+  name: rhdh-operator
+  namespace: {{ .Values.rhdhOperator.subscription.namespace }}
+spec:


If you want to simplify the template and the documentation and, at the same time, provide more flexibility so that new sub-fields can be added if needed, you can just have a single structured JSON object representing the full configuration and then install it as:

spec: {{ toYaml .Values.subscription.spec | indent 2 }}

Then you can provide a default in your values.yaml with a sample data. (in the above example should be under rhdhOperator.subscription.spec, of course you can name it as you prefer

I'm going to leave this one as is for now since the other operators follow the same method. We can re-work this in the future to have the same way to configure all of the components.

charts/orchestrator/templates/rhdh-operator.yaml

dmartinol

lgtm, will approve after a quick validation on my cluster

dmartinol

validated locally: ~~apart from the notifications which are broken (as expected, IIUC)~~, all looks good.

openshift-ci · 2024-02-20T11:59:57Z

New changes are detected. LGTM label has been removed.

Signed-off-by: Moti Asayag <masayag@redhat.com>

masayag added the WIP label Feb 11, 2024

masayag requested a review from jianrongzhang89 February 11, 2024 13:32

masayag force-pushed the rhdh-operator branch 2 times, most recently from f7f64e4 to b67dfa0 Compare February 12, 2024 09:16

jianrongzhang89 reviewed Feb 12, 2024

View reviewed changes

charts/orchestrator/templates/rhdh-operator.yaml Outdated Show resolved Hide resolved

masayag force-pushed the rhdh-operator branch from b67dfa0 to f3f3d70 Compare February 12, 2024 22:00

masayag force-pushed the rhdh-operator branch from f3f3d70 to e8634f6 Compare February 13, 2024 20:21

masayag force-pushed the rhdh-operator branch 10 times, most recently from def42bf to 6f63f86 Compare February 15, 2024 19:47

masayag force-pushed the rhdh-operator branch 4 times, most recently from 8d7b0dd to 47e3979 Compare February 18, 2024 19:03

masayag force-pushed the rhdh-operator branch 6 times, most recently from abe9656 to 55d8f74 Compare February 19, 2024 20:27

masayag removed the WIP label Feb 19, 2024

masayag force-pushed the rhdh-operator branch 4 times, most recently from 59f322a to 00cc8ef Compare February 20, 2024 09:24

masayag requested review from pkliczewski, rgolangh and dmartinol February 20, 2024 09:24

masayag changed the title ~~Use rhdh-operator to install backstage~~ Use backstage-operator to install backstage Feb 20, 2024

pkliczewski reviewed Feb 20, 2024

View reviewed changes

openshift-ci bot assigned pkliczewski Feb 20, 2024

openshift-ci bot added the lgtm label Feb 20, 2024

dmartinol reviewed Feb 20, 2024

View reviewed changes

charts/orchestrator/templates/rhdh-operator.yaml Show resolved Hide resolved

dmartinol reviewed Feb 20, 2024

View reviewed changes

charts/orchestrator/templates/rhdh-operator.yaml Outdated Show resolved Hide resolved

dmartinol reviewed Feb 20, 2024

View reviewed changes

dmartinol approved these changes Feb 20, 2024

View reviewed changes

masayag force-pushed the rhdh-operator branch from 00cc8ef to 3a2628b Compare February 20, 2024 11:59

openshift-ci bot removed the lgtm label Feb 20, 2024

Use rhdh-operator to install backstage

6e3f5e0

Signed-off-by: Moti Asayag <masayag@redhat.com>

masayag force-pushed the rhdh-operator branch from 3a2628b to 6e3f5e0 Compare February 20, 2024 12:04

masayag merged commit 0771364 into parodos-dev:main Feb 20, 2024
1 check passed

masayag deleted the rhdh-operator branch April 7, 2024 09:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use backstage-operator to install backstage #61

Use backstage-operator to install backstage #61

masayag commented Feb 11, 2024 •

edited

Loading

masayag commented Feb 11, 2024 •

edited

Loading

jianrongzhang89 commented Feb 12, 2024

jianrongzhang89 commented Feb 13, 2024

masayag commented Feb 13, 2024

jianrongzhang89 commented Feb 14, 2024

masayag commented Feb 14, 2024

jianrongzhang89 commented Feb 14, 2024

jianrongzhang89 commented Feb 14, 2024

masayag commented Feb 15, 2024

pkliczewski left a comment

dmartinol Feb 20, 2024

masayag Feb 20, 2024

dmartinol left a comment

dmartinol left a comment •

edited

Loading

openshift-ci bot commented Feb 20, 2024

Use backstage-operator to install backstage #61

Use backstage-operator to install backstage #61

Conversation

masayag commented Feb 11, 2024 • edited Loading

masayag commented Feb 11, 2024 • edited Loading

jianrongzhang89 commented Feb 12, 2024

jianrongzhang89 commented Feb 13, 2024

masayag commented Feb 13, 2024

jianrongzhang89 commented Feb 14, 2024

masayag commented Feb 14, 2024

jianrongzhang89 commented Feb 14, 2024

jianrongzhang89 commented Feb 14, 2024

masayag commented Feb 15, 2024

pkliczewski left a comment

Choose a reason for hiding this comment

dmartinol Feb 20, 2024

Choose a reason for hiding this comment

masayag Feb 20, 2024

Choose a reason for hiding this comment

dmartinol left a comment

Choose a reason for hiding this comment

dmartinol left a comment • edited Loading

Choose a reason for hiding this comment

openshift-ci bot commented Feb 20, 2024

masayag commented Feb 11, 2024 •

edited

Loading

masayag commented Feb 11, 2024 •

edited

Loading

dmartinol left a comment •

edited

Loading