chore(discovery): ensure consistent names for discovery options in CRD

Signed-off-by: Thuan Vo <thuan.votann@gmail.com>
cryostatio · May 22, 2024 · b00ef09 · b00ef09
1 parent ad96512
commit b00ef09
Show file tree

Hide file tree

Showing 9 changed files with 37 additions and 29 deletions.
diff --git a/api/v1beta1/cryostat_conversion.go b/api/v1beta1/cryostat_conversion.go
@@ -245,7 +245,7 @@ func convertTargetDiscoveryTo(srcOpts *TargetDiscoveryOptions) *operatorv1beta2.
 	var dstOpts *operatorv1beta2.TargetDiscoveryOptions
 	if srcOpts != nil {
 		dstOpts = &operatorv1beta2.TargetDiscoveryOptions{
-			BuiltInDiscoveryDisabled:  srcOpts.BuiltInDiscoveryDisabled,
+			DisableBuiltInDiscovery:   srcOpts.BuiltInDiscoveryDisabled,
 			DisableBuiltInPortNames:   srcOpts.DisableBuiltInPortNames,
 			DiscoveryPortNames:        srcOpts.DiscoveryPortNames,
 			DisableBuiltInPortNumbers: srcOpts.DisableBuiltInPortNumbers,
@@ -507,7 +507,7 @@ func convertTargetDiscoveryFrom(srcOpts *operatorv1beta2.TargetDiscoveryOptions)
 	var dstOpts *TargetDiscoveryOptions
 	if srcOpts != nil {
 		dstOpts = &TargetDiscoveryOptions{
-			BuiltInDiscoveryDisabled:  srcOpts.BuiltInDiscoveryDisabled,
+			BuiltInDiscoveryDisabled:  srcOpts.DisableBuiltInDiscovery,
 			DisableBuiltInPortNames:   srcOpts.DisableBuiltInPortNames,
 			DiscoveryPortNames:        srcOpts.DiscoveryPortNames,
 			DisableBuiltInPortNumbers: srcOpts.DisableBuiltInPortNumbers,

diff --git a/api/v1beta2/cryostat_types.go b/api/v1beta2/cryostat_types.go
@@ -584,16 +584,16 @@ type TargetDiscoveryOptions struct {
 	// When true, the Cryostat application will disable the built-in discovery mechanisms. Defaults to false
 	// +optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Disable Built-in Discovery",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:booleanSwitch"}
-	BuiltInDiscoveryDisabled bool `json:"builtInDiscoveryDisabled,omitempty"`
-	// When true, the Cryostat application will use the default port name jfr-jmx to look for JMX connectable targets.
+	DisableBuiltInDiscovery bool `json:"disableBuiltInDiscovery,omitempty"`
+	// When false and discoveryPortNames is empty, the Cryostat application will use the default port name jfr-jmx to look for JMX connectable targets. Defaults to false.
 	// +optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Disable Built-in Port Names",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:booleanSwitch"}
 	DisableBuiltInPortNames bool `json:"disableBuiltInPortNames,omitempty"`
 	// List of port names that the Cryostat application should look for in order to consider a target as JMX connectable.
 	// +optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:fieldDependency:targetDiscoveryOptions.disableBuiltInPortNames:true"}
 	DiscoveryPortNames []string `json:"discoveryPortNames,omitempty"`
-	// When true, the Cryostat application will use the default port number 9091 to look for JMX connectable targets.
+	// When false and discoveryPortNumbers is empty, the Cryostat application will use the default port number 9091 to look for JMX connectable targets. Defaults to false.
 	// +optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Disable Built-in Port Numbers",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:booleanSwitch"}
 	DisableBuiltInPortNumbers bool `json:"disableBuiltInPortNumbers,omitempty"`

diff --git a/bundle/manifests/cryostat-operator.clusterserviceversion.yaml b/bundle/manifests/cryostat-operator.clusterserviceversion.yaml
@@ -53,7 +53,7 @@ metadata:
     capabilities: Seamless Upgrades
     categories: Monitoring, Developer Tools
     containerImage: quay.io/cryostat/cryostat-operator:3.0.0-dev
-    createdAt: "2024-05-20T05:12:58Z"
+    createdAt: "2024-05-22T05:20:41Z"
     description: JVM monitoring and profiling tool
     operatorframework.io/initialization-resource: |-
       {
@@ -842,17 +842,19 @@ spec:
       - description: When true, the Cryostat application will disable the built-in
           discovery mechanisms. Defaults to false
         displayName: Disable Built-in Discovery
-        path: targetDiscoveryOptions.builtInDiscoveryDisabled
+        path: targetDiscoveryOptions.disableBuiltInDiscovery
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:booleanSwitch
-      - description: When true, the Cryostat application will use the default port
-          name jfr-jmx to look for JMX connectable targets.
+      - description: When false and discoveryPortNames is empty, the Cryostat application
+          will use the default port name jfr-jmx to look for JMX connectable targets.
+          Defaults to false.
         displayName: Disable Built-in Port Names
         path: targetDiscoveryOptions.disableBuiltInPortNames
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:booleanSwitch
-      - description: When true, the Cryostat application will use the default port
-          number 9091 to look for JMX connectable targets.
+      - description: When false and discoveryPortNumbers is empty, the Cryostat application
+          will use the default port number 9091 to look for JMX connectable targets.
+          Defaults to false.
         displayName: Disable Built-in Port Numbers
         path: targetDiscoveryOptions.disableBuiltInPortNumbers
         x-descriptors:

diff --git a/bundle/manifests/operator.cryostat.io_cryostats.yaml b/bundle/manifests/operator.cryostat.io_cryostats.yaml
@@ -9711,17 +9711,19 @@ spec:
                 description: Options to configure the Cryostat application's target
                   discovery mechanisms.
                 properties:
-                  builtInDiscoveryDisabled:
+                  disableBuiltInDiscovery:
                     description: When true, the Cryostat application will disable
                       the built-in discovery mechanisms. Defaults to false
                     type: boolean
                   disableBuiltInPortNames:
-                    description: When true, the Cryostat application will use the
-                      default port name jfr-jmx to look for JMX connectable targets.
+                    description: When false and discoveryPortNames is empty, the Cryostat
+                      application will use the default port name jfr-jmx to look for
+                      JMX connectable targets. Defaults to false.
                     type: boolean
                   disableBuiltInPortNumbers:
-                    description: When true, the Cryostat application will use the
-                      default port number 9091 to look for JMX connectable targets.
+                    description: When false and discoveryPortNumbers is empty, the
+                      Cryostat application will use the default port number 9091 to
+                      look for JMX connectable targets. Defaults to false.
                     type: boolean
                   discoveryPortNames:
                     description: List of port names that the Cryostat application

diff --git a/config/crd/bases/operator.cryostat.io_cryostats.yaml b/config/crd/bases/operator.cryostat.io_cryostats.yaml
@@ -9701,17 +9701,19 @@ spec:
                 description: Options to configure the Cryostat application's target
                   discovery mechanisms.
                 properties:
-                  builtInDiscoveryDisabled:
+                  disableBuiltInDiscovery:
                     description: When true, the Cryostat application will disable
                       the built-in discovery mechanisms. Defaults to false
                     type: boolean
                   disableBuiltInPortNames:
-                    description: When true, the Cryostat application will use the
-                      default port name jfr-jmx to look for JMX connectable targets.
+                    description: When false and discoveryPortNames is empty, the Cryostat
+                      application will use the default port name jfr-jmx to look for
+                      JMX connectable targets. Defaults to false.
                     type: boolean
                   disableBuiltInPortNumbers:
-                    description: When true, the Cryostat application will use the
-                      default port number 9091 to look for JMX connectable targets.
+                    description: When false and discoveryPortNumbers is empty, the
+                      Cryostat application will use the default port number 9091 to
+                      look for JMX connectable targets. Defaults to false.
                     type: boolean
                   discoveryPortNames:
                     description: List of port names that the Cryostat application

diff --git a/config/manifests/bases/cryostat-operator.clusterserviceversion.yaml b/config/manifests/bases/cryostat-operator.clusterserviceversion.yaml
@@ -387,17 +387,19 @@ spec:
       - description: When true, the Cryostat application will disable the built-in
           discovery mechanisms. Defaults to false
         displayName: Disable Built-in Discovery
-        path: targetDiscoveryOptions.builtInDiscoveryDisabled
+        path: targetDiscoveryOptions.disableBuiltInDiscovery
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:booleanSwitch
-      - description: When true, the Cryostat application will use the default port
-          name jfr-jmx to look for JMX connectable targets.
+      - description: When false and discoveryPortNames is empty, the Cryostat application
+          will use the default port name jfr-jmx to look for JMX connectable targets.
+          Defaults to false.
         displayName: Disable Built-in Port Names
         path: targetDiscoveryOptions.disableBuiltInPortNames
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:booleanSwitch
-      - description: When true, the Cryostat application will use the default port
-          number 9091 to look for JMX connectable targets.
+      - description: When false and discoveryPortNumbers is empty, the Cryostat application
+          will use the default port number 9091 to look for JMX connectable targets.
+          Defaults to false.
         displayName: Disable Built-in Port Numbers
         path: targetDiscoveryOptions.disableBuiltInPortNumbers
         x-descriptors:

diff --git a/internal/controllers/common/resource_definitions/resource_definitions.go b/internal/controllers/common/resource_definitions/resource_definitions.go
@@ -1095,7 +1095,7 @@ func NewCoreContainer(cr *model.CryostatInstance, specs *ServiceSpecs, imageTag
 	k8sDiscoveryPortNames := "jfr-jmx"
 	k8sDiscoveryPortNumbers := "9091"
 	if cr.Spec.TargetDiscoveryOptions != nil {
-		k8sDiscoveryEnabled = !cr.Spec.TargetDiscoveryOptions.BuiltInDiscoveryDisabled
+		k8sDiscoveryEnabled = !cr.Spec.TargetDiscoveryOptions.DisableBuiltInDiscovery
 
 		if len(cr.Spec.TargetDiscoveryOptions.DiscoveryPortNames) > 0 {
 			k8sDiscoveryPortNames = strings.Join(cr.Spec.TargetDiscoveryOptions.DiscoveryPortNames[:], ",")

diff --git a/internal/controllers/reconciler_test.go b/internal/controllers/reconciler_test.go
@@ -2616,7 +2616,7 @@ func (t *cryostatTestInput) checkMainPodTemplate(deployment *appsv1.Deployment,
 	hasPortConfig := cr.Spec.TargetDiscoveryOptions != nil &&
 		len(cr.Spec.TargetDiscoveryOptions.DiscoveryPortNames) > 0 &&
 		len(cr.Spec.TargetDiscoveryOptions.DiscoveryPortNumbers) > 0
-	builtInDiscoveryDisabled := cr.Spec.TargetDiscoveryOptions != nil && cr.Spec.TargetDiscoveryOptions.BuiltInDiscoveryDisabled
+	builtInDiscoveryDisabled := cr.Spec.TargetDiscoveryOptions != nil && cr.Spec.TargetDiscoveryOptions.DisableBuiltInDiscovery
 	builtInPortConfigDisabled := cr.Spec.TargetDiscoveryOptions != nil &&
 		cr.Spec.TargetDiscoveryOptions.DisableBuiltInPortNames &&
 		cr.Spec.TargetDiscoveryOptions.DisableBuiltInPortNumbers

diff --git a/internal/test/resources.go b/internal/test/resources.go
@@ -466,7 +466,7 @@ func (r *TestResources) NewCryostatWithLowResourceLimit() *model.CryostatInstanc
 func (r *TestResources) NewCryostatWithBuiltInDiscoveryDisabled() *model.CryostatInstance {
 	cr := r.NewCryostat()
 	cr.Spec.TargetDiscoveryOptions = &operatorv1beta2.TargetDiscoveryOptions{
-		BuiltInDiscoveryDisabled: true,
+		DisableBuiltInDiscovery: true,
 	}
 	return cr
 }