Skip to content
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
6 changes: 2 additions & 4 deletions config/v1/types_infrastructure.go
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,8 @@ type InfrastructureStatus struct {
// The 'External' mode indicates that the control plane is hosted externally to the cluster and that
// its components are not visible within the cluster.
// +kubebuilder:default=HighlyAvailable
// +openshift:validation:FeatureGateAwareEnum:featureGate="",enum=HighlyAvailable;SingleReplica;External
// +openshift:validation:FeatureGateAwareEnum:featureGate=HighlyAvailableArbiter,enum=HighlyAvailable;HighlyAvailableArbiter;SingleReplica;External
// +openshift:validation:FeatureGateAwareEnum:featureGate=DualReplica,enum=HighlyAvailable;SingleReplica;DualReplica;External
// +openshift:validation:FeatureGateAwareEnum:requiredFeatureGate=HighlyAvailableArbiter;DualReplica,enum=HighlyAvailable;HighlyAvailableArbiter;SingleReplica;DualReplica;External
// +openshift:validation:FeatureGateAwareEnum:featureGate="",enum=HighlyAvailable;HighlyAvailableArbiter;SingleReplica;External
// +openshift:validation:FeatureGateAwareEnum:featureGate=DualReplica,enum=HighlyAvailable;HighlyAvailableArbiter;SingleReplica;DualReplica;External
Comment on lines +106 to +107

Choose a reason for hiding this comment

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

Action required

1. controlplanetopology enum undocumented 📘 Rule violation ✓ Correctness

The controlPlaneTopology field comment does not document the HighlyAvailableArbiter and
DualReplica enum values that are now allowed by validation markers. This leaves API consumers
without an explanation of the behavior/meaning of these permitted values.
Agent Prompt
## Issue description
The `controlPlaneTopology` field's validation markers allow additional enum values (`HighlyAvailableArbiter` and `DualReplica`), but the field comment does not explain those values.

## Issue Context
Compliance requires that enum constraints implied by validation markers be documented in the field comment so users understand the API contract.

## Fix Focus Areas
- config/v1/types_infrastructure.go[99-109]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

// +optional
ControlPlaneTopology TopologyMode `json:"controlPlaneTopology"`

Expand Down
2 changes: 0 additions & 2 deletions config/v1/zz_generated.featuregated-crd-manifests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -372,8 +372,6 @@ infrastructures.config.openshift.io:
- DualReplica
- DyanmicServiceEndpointIBMCloud
- GCPClusterHostedDNSInstall
- HighlyAvailableArbiter
- HighlyAvailableArbiter+DualReplica
- NutanixMultiSubnets
- OnPremDNSRecords
- VSphereHostVMGroupZonal
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1040,6 +1040,7 @@ spec:
its components are not visible within the cluster.
enum:
- HighlyAvailable
- HighlyAvailableArbiter
- SingleReplica
- External
type: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1038,6 +1038,7 @@ spec:
its components are not visible within the cluster.
enum:
- HighlyAvailable
- HighlyAvailableArbiter
- SingleReplica
- DualReplica
- External
Expand Down

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion features.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,6 @@
| ExternalOIDC| <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> |
| ExternalOIDCWithUIDAndExtraClaimMappings| <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> |
| GCPClusterHostedDNSInstall| <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> |
| HighlyAvailableArbiter| <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> |
| ImageStreamImportMode| <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> |
| ImageVolume| <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> |
| InsightsConfig| <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> |
Expand Down
34 changes: 13 additions & 21 deletions features/features.go
Original file line number Diff line number Diff line change
Expand Up @@ -697,14 +697,6 @@ var (
enable(inDevPreviewNoUpgrade(), inTechPreviewNoUpgrade()).
mustRegister()

FeatureGateHighlyAvailableArbiter = newFeatureGate("HighlyAvailableArbiter").
reportProblemsToJiraComponent("Two Node with Arbiter").
contactPerson("eggfoobar").
productScope(ocpSpecific).
enhancementPR("https://github.com/openshift/enhancements/pull/1674").
enable(inDefault(), inOKD(), inTechPreviewNoUpgrade(), inDevPreviewNoUpgrade()).
mustRegister()

FeatureGateCVOConfiguration = newFeatureGate("ClusterVersionOperatorConfiguration").
reportProblemsToJiraComponent("Cluster Version Operator").
contactPerson("dhurta").
Expand All @@ -722,12 +714,12 @@ var (
mustRegister()

FeatureGateClusterUpdatePreflight = newFeatureGate("ClusterUpdatePreflight").
reportProblemsToJiraComponent("Cluster Version Operator").
contactPerson("fao89").
productScope(ocpSpecific).
enhancementPR("https://github.com/openshift/enhancements/pull/1930").
enable(inDevPreviewNoUpgrade()).
mustRegister()
reportProblemsToJiraComponent("Cluster Version Operator").
contactPerson("fao89").
productScope(ocpSpecific).
enhancementPR("https://github.com/openshift/enhancements/pull/1930").
enable(inDevPreviewNoUpgrade()).
mustRegister()

FeatureGateGCPCustomAPIEndpoints = newFeatureGate("GCPCustomAPIEndpoints").
reportProblemsToJiraComponent("Installer").
Expand Down Expand Up @@ -817,13 +809,13 @@ var (
mustRegister()

FeatureGateAWSServiceLBNetworkSecurityGroup = newFeatureGate("AWSServiceLBNetworkSecurityGroup").
reportProblemsToJiraComponent("Cloud Compute / Cloud Controller Manager").
contactPerson("mtulio").
productScope(ocpSpecific).
enhancementPR("https://github.com/openshift/enhancements/pull/1802").
enable(inClusterProfile(SelfManaged), inDefault(), inOKD(), inTechPreviewNoUpgrade(), inDevPreviewNoUpgrade()).
enable(inClusterProfile(Hypershift), inTechPreviewNoUpgrade(), inDevPreviewNoUpgrade()).
mustRegister()
reportProblemsToJiraComponent("Cloud Compute / Cloud Controller Manager").
contactPerson("mtulio").
productScope(ocpSpecific).
enhancementPR("https://github.com/openshift/enhancements/pull/1802").
enable(inClusterProfile(SelfManaged), inDefault(), inOKD(), inTechPreviewNoUpgrade(), inDevPreviewNoUpgrade()).
enable(inClusterProfile(Hypershift), inTechPreviewNoUpgrade(), inDevPreviewNoUpgrade()).
mustRegister()

FeatureGateImageVolume = newFeatureGate("ImageVolume").
reportProblemsToJiraComponent("Node").
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ controllerconfigs.machineconfiguration.openshift.io:
- DualReplica
- DyanmicServiceEndpointIBMCloud
- GCPClusterHostedDNSInstall
- HighlyAvailableArbiter
- HighlyAvailableArbiter+DualReplica
- NutanixMultiSubnets
- OnPremDNSRecords
- VSphereHostVMGroupZonal
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1333,6 +1333,7 @@ spec:
its components are not visible within the cluster.
enum:
- HighlyAvailable
- HighlyAvailableArbiter
- SingleReplica
- External
type: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1331,6 +1331,7 @@ spec:
its components are not visible within the cluster.
enum:
- HighlyAvailable
- HighlyAvailableArbiter
- SingleReplica
- DualReplica
- External
Expand Down
Loading