Skip to content
This repository was archived by the owner on Jun 12, 2025. It is now read-only.

[1.5] Cleanup CRD fields in v1alpha2 of Release Candidate related fields #450

Draft
jordigilh wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

[1.5] Cleanup CRD fields in v1alpha2 of Release Candidate related fields #450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
96a2cd6
Normalized to source variable name
jordigilh Dec 19, 2024
3eedd98
Removed isReleaseCandidate
jordigilh Dec 19, 2024
f40d2c8
Remove rhdh/sonataflowPlatform image field used specifically for RC
jordigilh Dec 20, 2024
f438bad
Remove RC fields to allow customize dataIndexImage and jobServiceImag…
jordigilh Dec 20, 2024
6c49567
Removed get-cluster-version helper
jordigilh Dec 20, 2024
d15e518
Moved rhdhOperator.subscription.targetNamespace to rhdhOperator.targe…
jordigilh Dec 20, 2024
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
14 changes: 6 additions & 8 deletions bundle/manifests/orchestrator-operator.clusterserviceversion.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ metadata:
"rhdhOperator": {
"enableGuestProvider": false,
"enabled": true,
"isReleaseCandidate": false,
"secretRef": {
"argocd": {
"password": "ARGOCD_PASSWORD",
Expand Down Expand Up @@ -85,9 +84,9 @@ metadata:
"name": "rhdh",
"namespace": "rhdh-operator",
"source": "redhat-operators",
"startingCSV": "",
"targetNamespace": "rhdh-operator"
}
"startingCSV": ""
},
"targetNamespace": "rhdh-operator"
},
"rhdhPlugins": {
"notificationsEmail": {
Expand All @@ -114,18 +113,17 @@ metadata:
"installPlanApproval": "Automatic",
"name": "serverless-operator",
"namespace": "openshift-serverless",
"sourceName": "redhat-operators"
"source": "redhat-operators"
}
},
"sonataFlowOperator": {
"enabled": true,
"isReleaseCandidate": false,
"subscription": {
"channel": "alpha",
"installPlanApproval": "Automatic",
"name": "logic-operator-rhel8",
"namespace": "openshift-serverless-logic",
"sourceName": "redhat-operators",
"source": "redhat-operators",
"startingCSV": "logic-operator-rhel8.v1.34.0"
}
},
Expand All @@ -138,7 +136,7 @@ metadata:
capabilities: Basic Install
categories: Developer Tools
console.openshift.io/disable-operand-delete: "true"
createdAt: "2025-01-07T15:44:21Z"
createdAt: "2025-01-07T22:25:26Z"
features.operators.openshift.io/cnf: "false"
features.operators.openshift.io/cni: "false"
features.operators.openshift.io/csi: "false"
Expand Down
78 changes: 8 additions & 70 deletions bundle/manifests/rhdh.redhat.com_orchestrators.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,34 +78,6 @@ spec:
description: SonataflowPlatform contains the pod resource configuration
to be used for the data index and job services
properties:
dataIndexImage:
description: This field contains the location of a custom
DataIndex service container image to be used instead of
the provided one by SonataFlow
type: string
eventing:
description: SonataflowPlatform's eventing related properties
properties:
broker:
description: Broker contains the name and namespace of
the broker to use if using Knative eventing for components
communication
properties:
name:
description: Name describes the name of the broker
to use
type: string
namespace:
description: Namespace describes the namespace on
which the broker to use is deployed
type: string
type: object
type: object
jobServiceImage:
description: This field contains the location of a custom
Job Service container image to be used instead of the provided
one by SonataFlow
type: string
monitoring:
description: Contains the monitoring configuration fields
properties:
Expand Down Expand Up @@ -188,16 +160,6 @@ spec:
by platform services.
type: string
type: object
rhdh:
description: rhdh contains the configuration fields for the RHDH when
using release candidate
properties:
images:
description: Indicates RC builds images that should be used by
the chart to install RHDH
type: object
x-kubernetes-preserve-unknown-fields: true
type: object
rhdhOperator:
description: RHDH Operator contains the configuration fields for the
Red Hat Developer Hub operator
Expand All @@ -217,11 +179,6 @@ spec:
description: Enabled determines whether the operator should be
deployed by the chart. Defaults to true
type: boolean
isReleaseCandidate:
default: false
description: Indicates RC builds should be used by the chart to
install the Serverless Operator
type: boolean
secretRef:
description: Backstage secret reference information
properties:
Expand Down Expand Up @@ -399,20 +356,16 @@ spec:
default: redhat-operators
description: Source captures the name of the catalog source
type: string
sourceName:
default: redhat-operators
description: SourceName captures the name of the catalog source
type: string
startingCSV:
default: ""
description: The initial version of the operator
type: string
targetNamespace:
default: rhdh-operator
description: The target namespace for the backstage CR in
which RHDH instance is created
type: string
type: object
targetNamespace:
default: orchestrator
description: The target namespace for the backstage CR in which
Copy link
Collaborator

@masayag masayag Dec 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

For the default namespace for the Backstage CR, we should pick a different one than the target namespace of the operator, perhaps the orchestrator as default (if namespace exists) or require the user to specify if the RHDH is disabled.

Copy link
Collaborator Author

@jordigilh jordigilh Jan 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

On a second thought, I think we should remove it. Look at the logic where it is being referenced:

orchestrator-helm-operator/helm-charts/orchestrator/templates/network-policies.yaml

Lines 18 to 19 in 6bfbf3d

{{- else if (and (.Values.rhdhOperator.enabled .Values.rhdhOperator.targetNamespace )}}
{{- $namespace = .Values.rhdhOperator.targetNamespace }} # otherwise, use targetNamespace if defined

If the operator is enabled, why can't we use the subscription.namespace value and instead we have to have a new field? Maybe I'm missing something here, because I remember we had an extensive discussion about this field before, but my memory is failing me.

Thoughts @jenniferubah ?

Copy link
Collaborator

@jenniferubah jenniferubah Jan 7, 2025

Choose a reason for hiding this comment

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

We use rhdhOperator.targetNamespace because that is used the user to indicate the namespace they want the RHDH instance deployed and that can be different from the RHDH operator namespace subscription.namespace and also less confusing.

Copy link
Collaborator

@jenniferubah jenniferubah Jan 7, 2025

Choose a reason for hiding this comment

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

Maybe we could default the value of targetNamespace to rhdh if the operator is enabled instead of rhdh-operator since we want to keep those separate.

Copy link
Collaborator Author

@jordigilh jordigilh Jan 7, 2025

Choose a reason for hiding this comment

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

Ah I see it now. Thanks for refreshing my memory :)

Copy link
Collaborator Author

@jordigilh jordigilh Jan 7, 2025

Choose a reason for hiding this comment

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

@masayag I will change the default value to orchestrator as you suggest, to avoid the situation where the user is attempting to deploy the CR in the same namespace where rhdh is deployed by default

Copy link
Collaborator Author

@jordigilh jordigilh Jan 8, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@masayag should we also change the default location for RHDH in the setup.sh script? Currently it'srhdh-operator.

https://github.com/jordigilh/orchestrator-helm-operator/blob/d15e518d5b3f01fe7537758b2612d9f95bf63a19/hack/setup.sh#L18-L20

Copy link
Collaborator

@masayag masayag Jan 8, 2025

Choose a reason for hiding this comment

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

I have a concern about this one, since the same script is used for all releases.
So not sure what will be the impact of it.
And yet, I'd prefer for 1.4 the default to be orchestrator.

RHDH instance is created
type: string
type: object
rhdhPlugins:
description: Backstage plugins
Expand Down Expand Up @@ -472,7 +425,7 @@ spec:
type: string
type: object
scope:
default: 'https://github.com/rhdhorchestrator/orchestrator-plugins-internal-release/releases/download/1.4.0-rc.4'
default: https://github.com/rhdhorchestrator/orchestrator-plugins-internal-release/releases/download/1.4.0-rc.4
description: Scope of the plugins
type: string
type: object
Expand Down Expand Up @@ -507,7 +460,7 @@ spec:
description: Namespace determines the namespace where the
operator should be deployed. Defaults to openshift-serverless
type: string
sourceName:
source:
default: redhat-operators
description: SourceName captures the name of the catalog source
type: string
Expand All @@ -522,11 +475,6 @@ spec:
description: Enabled determines whether to deploy the SonataFlow
Operator operator or not. Defaults to true.
type: boolean
isReleaseCandidate:
default: false
description: Indicates RC builds should be used by the chart to
install Sonataflow
type: boolean
subscription:
description: Subscription specifies the subscription attributes
to use to deploy the operator.
Expand All @@ -551,7 +499,7 @@ spec:
description: Namespace determines the namespace where the
operator should be deployed. Defaults to openshift-serverless-logic
type: string
sourceName:
source:
default: redhat-operators
description: SourceName captures the name of the catalog source
type: string
Expand All @@ -561,16 +509,6 @@ spec:
type: string
type: object
type: object
sonataflow:
description: SonatafFlow contains the configuration fields for the
SonataFlow when using release candidate
properties:
images:
description: Indicates RC builds images that should be used by
the chart to install Sonataflow
type: object
x-kubernetes-preserve-unknown-fields: true
type: object
tekton:
description: Contains the tekton configuration fields
properties:
Expand Down
64 changes: 7 additions & 57 deletions config/crd/bases/rhdh.redhat.com_orchestrators.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,29 +42,9 @@ spec:
description: Spec defines the desired state of Orchestrator
type: object
properties:
rhdh:
description: rhdh contains the configuration fields for the RHDH when using release candidate
properties:
images:
description: Indicates RC builds images that should be used by the chart to install RHDH
type: object
x-kubernetes-preserve-unknown-fields: true
type: object
sonataflow:
description: SonatafFlow contains the configuration fields for the SonataFlow when using release candidate
properties:
images:
description: Indicates RC builds images that should be used by the chart to install Sonataflow
type: object
x-kubernetes-preserve-unknown-fields: true
type: object
sonataFlowOperator:
description: SonatafFlowOperator contains the configuration fields for the SonataFlow Operator
properties:
isReleaseCandidate:
default: false
description: Indicates RC builds should be used by the chart to install Sonataflow
type: boolean
enabled:
default: true
description: Enabled determines whether to deploy the SonataFlow Operator operator or not. Defaults to true.
Expand All @@ -88,7 +68,7 @@ spec:
default: openshift-serverless-logic
description: Namespace determines the namespace where the operator should be deployed. Defaults to openshift-serverless-logic
type: string
sourceName:
source:
default: "redhat-operators"
description: SourceName captures the name of the catalog source
type: string
Expand Down Expand Up @@ -124,7 +104,7 @@ spec:
description: Namespace determines the namespace where the operator should be deployed. Defaults to openshift-serverless
default: openshift-serverless
type: string
sourceName:
source:
description: SourceName captures the name of the catalog source
default: "redhat-operators"
type: string
Expand All @@ -133,14 +113,14 @@ spec:
rhdhOperator:
description: RHDH Operator contains the configuration fields for the Red Hat Developer Hub operator
properties:
isReleaseCandidate:
default: false
description: Indicates RC builds should be used by the chart to install the Serverless Operator
type: boolean
enabled:
default: true
description: Enabled determines whether the operator should be deployed by the chart. Defaults to true
type: boolean
targetNamespace:
Copy link
Collaborator

@masayag masayag Dec 22, 2024

Choose a reason for hiding this comment

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

same as above.

default: orchestrator
description: The target namespace for the backstage CR in which RHDH instance is created
type: string
enableGuestProvider:
default: false
description: EnableGuestProvider captures whether to enable the guest provider in RHDH. Defaults to false.
Expand Down Expand Up @@ -191,7 +171,7 @@ spec:
description: The name of the host for the Gitlab instance used. Required for launching software templates. Defaults to 'GITLAB_HOST', empty for not available.
default: GITLAB_HOST
type: string
type: object
type: object
k8s:
description: Kubernetes specific configuration fields that are injected to the Backstage instance to allow the plugin to communicate with the Kubernetes API Server.
properties:
Expand Down Expand Up @@ -258,10 +238,6 @@ spec:
default: rhdh-operator
description: Namespace determines the namespace where the operator should be deployed. Defaults to rhdh-operator
type: string
sourceName:
default: "redhat-operators"
description: SourceName captures the name of the catalog source
type: string
source:
default: "redhat-operators"
description: Source captures the name of the catalog source
Expand All @@ -270,10 +246,6 @@ spec:
default: ""
description: The initial version of the operator
type: string
targetNamespace:
default: rhdh-operator
description: The target namespace for the backstage CR in which RHDH instance is created
type: string
type: object
type: object
rhdhPlugins:
Expand Down Expand Up @@ -413,28 +385,6 @@ spec:
default: 64Mi
type: string
type: object
dataIndexImage:
description: This field contains the location of a custom DataIndex service container image to be used instead of the provided one by SonataFlow
default:
type: string
jobServiceImage:
description: This field contains the location of a custom Job Service container image to be used instead of the provided one by SonataFlow
default:
type: string
eventing:
description: SonataflowPlatform's eventing related properties
properties:
broker:
description: Broker contains the name and namespace of the broker to use if using Knative eventing for components communication
properties:
name:
description: Name describes the name of the broker to use
type: string
namespace:
description: Namespace describes the namespace on which the broker to use is deployed
type: string
type: object
type: object
type: object
type: object
tekton:
Expand Down
8 changes: 3 additions & 5 deletions config/samples/_v1alpha2_orchestrator.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,13 @@ metadata:
name: orchestrator-sample
spec:
sonataFlowOperator:
isReleaseCandidate: false # Indicates RC builds should be used by the chart to install Sonataflow
enabled: true # whether the operator should be deployed by the chart
subscription:
namespace: openshift-serverless-logic # namespace where the operator should be deployed
channel: alpha # channel of an operator package to subscribe to
installPlanApproval: Automatic # whether the update should be installed automatically
name: logic-operator-rhel8 # name of the operator package
sourceName: redhat-operators # name of the catalog source
source: redhat-operators # name of the catalog source
startingCSV: logic-operator-rhel8.v1.34.0 # The initial version of the operator
serverlessOperator:
enabled: true # whether the operator should be deployed by the chart
Expand All @@ -20,10 +19,10 @@ spec:
channel: stable # channel of an operator package to subscribe to
installPlanApproval: Automatic # whether the update should be installed automatically
name: serverless-operator # name of the operator package
sourceName: redhat-operators # name of the catalog source
source: redhat-operators # name of the catalog source
rhdhOperator:
isReleaseCandidate: false # Indicates RC builds should be used by the chart to install RHDH
enabled: true # whether the operator should be deployed by the chart
targetNamespace: rhdh-operator # the target namespace for the backstage CR in which RHDH instance is created
enableGuestProvider: false # whether to enable guest provider
secretRef:
name: backstage-backend-auth-secret # name of the secret that contains the credentials for the plugin to establish a communication channel with the Kubernetes API, ArgoCD, GitHub servers and SMTP mail server.
Expand Down Expand Up @@ -54,7 +53,6 @@ spec:
name: rhdh # name of the operator package
source: redhat-operators # name of the catalog source
startingCSV: "" # The initial version of the operator
targetNamespace: rhdh-operator # the target namespace for the backstage CR in which RHDH instance is created
rhdhPlugins: # RHDH plugins required for the Orchestrator
npmRegistry: "https://npm.registry.redhat.com" # NPM registry is defined already in the container, but sometimes the registry need to be modified to use different versions of the plugin, for example: staging(https://npm.stage.registry.redhat.com) or development repositories
scope: "https://github.com/rhdhorchestrator/orchestrator-plugins-internal-release/releases/download/1.4.0-rc.4"
Expand Down
Loading