api: Remove ClusterCapabilitiesProfile

We decided to structure optional features differently after a
lengthy discussion in
openshift-online/ocm-api-model#1037

This keeps the nice test framework in ocm_test.go even though
it doesn't do much now. This can be expanded upon in the future.

Author: Matthew Barnes

api/redhatopenshift/HcpCluster.Management/hcpCluster-models.tsp

@@ -68,29 +68,6 @@ model HcpOpenShiftClusterProperties {
   /** Azure platform configuration */
   @visibility(Lifecycle.Read, Lifecycle.Create)
   platform: PlatformProfile;
-
-  /** Configure cluter capabilities. */
-  @visibility(Lifecycle.Read, Lifecycle.Create)
-  capabilities?: ClusterCapabilitiesProfile;
-}
-
-/** Cluster capabilities configuration. */
-model ClusterCapabilitiesProfile {
-  /**
-   * Immutable list of disabled capabilities. May only contain "ImageRegistry" at
-   * this time. Additional capabilities may be available in the future. Clients
-   * should expect to handle additional values.
-   */
-  @visibility(Lifecycle.Read, Lifecycle.Create)
-  disabled?: OptionalClusterCapability[];
-}
-
-/** Cluster capabilities that can be disabled. */
-union OptionalClusterCapability {
-  string,
-
-  /** Enables the OpenShift internal image registry. */
-  ImageRegistry: "ImageRegistry",
 }
 
 /** The resource provisioning state. */

api/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/hcpclusters/preview/2024-06-10-preview/openapi.json

@@ -1063,23 +1063,6 @@
         }
       ]
     },
-    "ClusterCapabilitiesProfile": {
-      "type": "object",
-      "description": "Cluster capabilities configuration.",
-      "properties": {
-        "disabled": {
-          "type": "array",
-          "description": "Immutable list of disabled capabilities. May only contain \"ImageRegistry\" at\nthis time. Additional capabilities may be available in the future. Clients\nshould expect to handle additional values.",
-          "items": {
-            "$ref": "#/definitions/OptionalClusterCapability"
-          },
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
-        }
-      }
-    },
     "ConsoleProfile": {
       "type": "object",
       "description": "Configuration of the cluster web console",
@@ -1255,14 +1238,6 @@
             "read",
             "create"
           ]
-        },
-        "capabilities": {
-          "$ref": "#/definitions/ClusterCapabilitiesProfile",
-          "description": "Configure cluter capabilities.",
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
         }
       },
       "required": [
@@ -1796,24 +1771,6 @@
         "userAssignedIdentities"
       ]
     },
-    "OptionalClusterCapability": {
-      "type": "string",
-      "description": "Cluster capabilities that can be disabled.",
-      "enum": [
-        "ImageRegistry"
-      ],
-      "x-ms-enum": {
-        "name": "OptionalClusterCapability",
-        "modelAsString": true,
-        "values": [
-          {
-            "name": "ImageRegistry",
-            "value": "ImageRegistry",
-            "description": "Enables the OpenShift internal image registry."
-          }
-        ]
-      }
-    },
     "PlatformProfile": {
       "type": "object",
       "description": "Azure specific configuration",

frontend/pkg/frontend/ocm.go

@@ -81,38 +81,6 @@ func convertOutboundTypeRPToCS(outboundTypeRP api.OutboundType) (outboundTypeCS
 	return
 }
 
-func convertDisabledCapabilitiesToCS(in []api.OptionalClusterCapability) []string {
-	var out []string
-	for _, c := range in {
-		out = append(out, string(c))
-	}
-	return out
-}
-
-func convertDisableCapabilitiesToRP(in []string) []api.OptionalClusterCapability {
-	var out []api.OptionalClusterCapability
-	for _, c := range in {
-		out = append(out, api.OptionalClusterCapability(c))
-	}
-	return out
-}
-
-func convertClusterCapabilitiesToRP(in *arohcpv1alpha1.Cluster) api.ClusterCapabilitiesProfile {
-	out := api.ClusterCapabilitiesProfile{}
-	if in == nil {
-		return out
-	}
-	if in.Capabilities() != nil {
-		out.Disabled = convertDisableCapabilitiesToRP(in.Capabilities().Disabled())
-	}
-	return out
-}
-
-func convertClusterCapabilitiesToCSBuilder(in api.ClusterCapabilitiesProfile) *arohcpv1alpha1.ClusterCapabilitiesBuilder {
-	return arohcpv1alpha1.NewClusterCapabilities().
-		Disabled(convertDisabledCapabilitiesToCS(in.Disabled)...)
-}
-
 func convertEnableEncryptionAtHostToCSBuilder(in api.NodePoolPlatformProfile) *arohcpv1alpha1.AzureNodePoolEncryptionAtHostBuilder {
 	var state string
 
@@ -175,7 +143,6 @@ func ConvertCStoHCPOpenShiftCluster(resourceID *azcorearm.ResourceID, cluster *a
 				NetworkSecurityGroupID: cluster.Azure().NetworkSecurityGroupResourceID(),
 				IssuerURL:              "",
 			},
-			Capabilities: convertClusterCapabilitiesToRP(cluster),
 		},
 	}
 
@@ -284,8 +251,7 @@ func withImmutableAttributes(clusterBuilder *arohcpv1alpha1.ClusterBuilder, hcpC
 			MachineCIDR(hcpCluster.Properties.Network.MachineCIDR).
 			HostPrefix(int(hcpCluster.Properties.Network.HostPrefix))).
 		API(arohcpv1alpha1.NewClusterAPI().
-			Listening(convertVisibilityToListening(hcpCluster.Properties.API.Visibility))).
-		Capabilities(convertClusterCapabilitiesToCSBuilder(hcpCluster.Properties.Capabilities))
+			Listening(convertVisibilityToListening(hcpCluster.Properties.API.Visibility)))
 
 	azureBuilder := arohcpv1alpha1.NewAzure().
 		TenantID(tenantID).

frontend/pkg/frontend/ocm_test.go

@@ -84,30 +84,6 @@ func TestConvertCStoHCPOpenShiftCluster(t *testing.T) {
 			cluster: arohcpv1alpha1.NewCluster(),
 			want:    clusterResource(),
 		},
-		{
-			name: "disabled capability",
-			cluster: arohcpv1alpha1.NewCluster().
-				Capabilities(
-					arohcpv1alpha1.NewClusterCapabilities().
-						Disabled("red"),
-				),
-			want: clusterResource(withDisabledCapabilities("red")),
-		},
-		{
-			name: "disabled capabilities",
-			cluster: arohcpv1alpha1.NewCluster().
-				Capabilities(
-					arohcpv1alpha1.NewClusterCapabilities().
-						Disabled("red", "green", "blue"),
-				),
-			want: clusterResource(withDisabledCapabilities("red", "green", "blue")),
-		},
-		{
-			name: "disabled capabilities empty",
-			cluster: arohcpv1alpha1.NewCluster().
-				Capabilities(arohcpv1alpha1.NewClusterCapabilities()),
-			want: clusterResource(),
-		},
 	}
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
@@ -135,39 +111,6 @@ func TestWithImmutableAttributes(t *testing.T) {
 			},
 			want: ocmCluster(t, withOCMClusterDefaults()),
 		},
-		{
-			name: "disabled capability",
-			hcpCluster: &api.HCPOpenShiftCluster{
-				Properties: api.HCPOpenShiftClusterProperties{
-					Platform: api.PlatformProfile{
-						ManagedResourceGroup: "test",
-					},
-					Capabilities: api.ClusterCapabilitiesProfile{
-						Disabled: []api.OptionalClusterCapability{
-							api.OptionalClusterCapability("TEST_ONE"),
-						},
-					},
-				},
-			},
-			want: ocmCluster(t, withOCMClusterDefaults(), withOCMDisabledCapabilities("TEST_ONE")),
-		},
-		{
-			name: "disabled capabilities",
-			hcpCluster: &api.HCPOpenShiftCluster{
-				Properties: api.HCPOpenShiftClusterProperties{
-					Platform: api.PlatformProfile{
-						ManagedResourceGroup: "test",
-					},
-					Capabilities: api.ClusterCapabilitiesProfile{
-						Disabled: []api.OptionalClusterCapability{
-							api.OptionalClusterCapability("TEST_ONE"),
-							api.OptionalClusterCapability("TEST_TWO"),
-						},
-					},
-				},
-			},
-			want: ocmCluster(t, withOCMClusterDefaults(), withOCMDisabledCapabilities("TEST_ONE", "TEST_TWO")),
-		},
 	}
 
 	for _, tc := range testCases {
@@ -208,14 +151,6 @@ func clusterResource(opts ...func(*api.HCPOpenShiftCluster)) *api.HCPOpenShiftCl
 	return c
 }
 
-func withDisabledCapabilities(caps ...string) func(*api.HCPOpenShiftCluster) {
-	return func(c *api.HCPOpenShiftCluster) {
-		for _, capability := range caps {
-			c.Properties.Capabilities.Disabled = append(c.Properties.Capabilities.Disabled, api.OptionalClusterCapability(capability))
-		}
-	}
-}
-
 func ocmCluster(t *testing.T, opts ...func(*arohcpv1alpha1.ClusterBuilder) *arohcpv1alpha1.ClusterBuilder) *arohcpv1alpha1.Cluster {
 	b := arohcpv1alpha1.NewCluster()
 	for _, opt := range opts {
@@ -225,11 +160,6 @@ func ocmCluster(t *testing.T, opts ...func(*arohcpv1alpha1.ClusterBuilder) *aroh
 	assert.NoError(t, err)
 	return c
 }
-func withOCMDisabledCapabilities(values ...string) func(*arohcpv1alpha1.ClusterBuilder) *arohcpv1alpha1.ClusterBuilder {
-	return func(b *arohcpv1alpha1.ClusterBuilder) *arohcpv1alpha1.ClusterBuilder {
-		return b.Capabilities(arohcpv1alpha1.NewClusterCapabilities().Disabled(values...))
-	}
-}
 
 func withOCMClusterDefaults() func(*arohcpv1alpha1.ClusterBuilder) *arohcpv1alpha1.ClusterBuilder {
 	return func(b *arohcpv1alpha1.ClusterBuilder) *arohcpv1alpha1.ClusterBuilder {
@@ -248,8 +178,6 @@ func withOCMClusterDefaults() func(*arohcpv1alpha1.ClusterBuilder) *arohcpv1alph
 				SubscriptionID("test").
 				TenantID("test"),
 			).
-			Capabilities(arohcpv1alpha1.NewClusterCapabilities().
-				Disabled()).
 			CCS(arohcpv1alpha1.NewCCS().Enabled(true)).
 			CloudProvider(cmv1.NewCloudProvider().
 				ID("azure")).

internal/api/enums.go

@@ -56,11 +56,3 @@ const (
 	// EffectPreferNoSchedule - PreferNoSchedule taint effect
 	EffectPreferNoSchedule Effect = "PreferNoSchedule"
 )
-
-// OptionalClusterCapability - Cluster capabilities that can be disabled.
-type OptionalClusterCapability string
-
-const (
-	// OptionalClusterCapabilityImageRegistry - Enables the OpenShift internal image registry.
-	OptionalClusterCapabilityImageRegistry OptionalClusterCapability = "ImageRegistry"
-)

internal/api/hcpopenshiftcluster.go

@@ -35,14 +35,13 @@ type HCPOpenShiftCluster struct {
 
 // HCPOpenShiftClusterProperties represents the property bag of a HCPOpenShiftCluster resource.
 type HCPOpenShiftClusterProperties struct {
-	ProvisioningState arm.ProvisioningState      `json:"provisioningState,omitempty"             visibility:"read"`
-	Version           VersionProfile             `json:"version,omitempty"`
-	DNS               DNSProfile                 `json:"dns,omitempty"`
-	Network           NetworkProfile             `json:"network,omitempty"                       visibility:"read create"`
-	Console           ConsoleProfile             `json:"console,omitempty"                       visibility:"read"`
-	API               APIProfile                 `json:"api,omitempty"`
-	Platform          PlatformProfile            `json:"platform,omitempty"                      visibility:"read create"`
-	Capabilities      ClusterCapabilitiesProfile `json:"capabilities,omitempty"                  visibility:"read create"`
+	ProvisioningState arm.ProvisioningState `json:"provisioningState,omitempty"             visibility:"read"`
+	Version           VersionProfile        `json:"version,omitempty"`
+	DNS               DNSProfile            `json:"dns,omitempty"`
+	Network           NetworkProfile        `json:"network,omitempty"                       visibility:"read create"`
+	Console           ConsoleProfile        `json:"console,omitempty"                       visibility:"read"`
+	API               APIProfile            `json:"api,omitempty"`
+	Platform          PlatformProfile       `json:"platform,omitempty"                      visibility:"read create"`
 }
 
 // VersionProfile represents the cluster control plane version.
@@ -107,13 +106,6 @@ type UserAssignedIdentitiesProfile struct {
 	ServiceManagedIdentity string            `json:"serviceManagedIdentity,omitempty" validate:"omitempty,resource_id=Microsoft.ManagedIdentity/userAssignedIdentities"`
 }
 
-// ClusterCapabilitiesProfile - Cluster capabilities configuration.
-// Visibility for the entire struct is "read create".
-type ClusterCapabilitiesProfile struct {
-	// Disabled cluter capabilities.
-	Disabled []OptionalClusterCapability `json:"disabled,omitempty" validate:"dive,enum_optionalclustercapability"`
-}
-
 // Creates an HCPOpenShiftCluster with any non-zero default values.
 func NewDefaultHCPOpenShiftCluster() *HCPOpenShiftCluster {
 	return &HCPOpenShiftCluster{

internal/api/testhelpers.go

@@ -86,8 +86,6 @@ func NewTestValidator() *validator.Validate {
 		arm.ManagedServiceIdentityTypeSystemAssigned,
 		arm.ManagedServiceIdentityTypeSystemAssignedUserAssigned,
 		arm.ManagedServiceIdentityTypeUserAssigned))
-	validate.RegisterAlias("enum_optionalclustercapability", EnumValidateTag(
-		OptionalClusterCapabilityImageRegistry))
 
 	return validate
 }