NO-ISSUE: Fixes KubeletConfig API doc, adds tests and kubebuilder validation #2651
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| apiVersion: apiextensions.k8s.io/v1 # Hack because controller-gen complains if we don't have this | ||
| name: "KubeletConfig" | ||
| crdName: kubeletconfigs.machineconfiguration.openshift.io | ||
| tests: | ||
| onCreate: | ||
| # LogLevel Boundary Tests | ||
| - name: Should be able to set logLevel to 0 (minimum) | ||
| initial: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| logLevel: 0 | ||
| expected: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| logLevel: 0 | ||
| - name: Should be able to set logLevel to 10 (maximum) | ||
| initial: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| logLevel: 10 | ||
| expected: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| logLevel: 10 | ||
| - name: Should reject logLevel less than 0 | ||
| initial: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| logLevel: -1 | ||
| expectedError: "Invalid value" | ||
| - name: Should reject logLevel greater than 10 | ||
| initial: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| logLevel: 11 | ||
| expectedError: "Invalid value" | ||
|
|
||
| # TLSSecurityProfile CEL Validation tests | ||
| - name: Should allow tlsSecurityProfile with Old type | ||
| initial: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| tlsSecurityProfile: | ||
| type: Old | ||
| expected: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| tlsSecurityProfile: | ||
| type: Old | ||
| - name: Should allow tlsSecurityProfile with Intermediate type | ||
| initial: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| tlsSecurityProfile: | ||
| type: Intermediate | ||
| expected: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| tlsSecurityProfile: | ||
| type: Intermediate | ||
| - name: Should allow tlsSecurityProfile with Modern type | ||
| initial: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| tlsSecurityProfile: | ||
| type: Modern | ||
| expected: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| tlsSecurityProfile: | ||
| type: Modern | ||
| - name: Should allow tlsSecurityProfile with Custom type | ||
| initial: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| tlsSecurityProfile: | ||
| type: Custom | ||
| custom: | ||
| ciphers: | ||
| - ECDHE-ECDSA-AES128-GCM-SHA256 | ||
| minTLSVersion: VersionTLS12 | ||
| expected: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| tlsSecurityProfile: | ||
| type: Custom | ||
| custom: | ||
| ciphers: | ||
| - ECDHE-ECDSA-AES128-GCM-SHA256 | ||
| minTLSVersion: VersionTLS12 | ||
| - name: Should reject tlsSecurityProfile with invalid type | ||
| initial: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| tlsSecurityProfile: | ||
| type: Invalid | ||
| expectedError: "Unsupported value: \"Invalid\"" | ||
| # Note: enum validation runs before the CEL validation | ||
| - name: Should reject tlsSecurityProfile with Custom type and invalid minTLSVersion | ||
| initial: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| tlsSecurityProfile: | ||
| type: Custom | ||
| custom: | ||
| ciphers: | ||
| - ECDHE-ECDSA-AES128-GCM-SHA256 | ||
| minTLSVersion: VersionTLS14 | ||
| expectedError: "Unsupported value: \"VersionTLS14\"" | ||
| - name: Should allow tlsSecurityProfile without type field for backward compatibility | ||
| initial: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| tlsSecurityProfile: | ||
| custom: | ||
| ciphers: | ||
| - ECDHE-ECDSA-AES128-GCM-SHA256 | ||
| minTLSVersion: VersionTLS12 | ||
| expected: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| tlsSecurityProfile: | ||
| custom: | ||
| ciphers: | ||
| - ECDHE-ECDSA-AES128-GCM-SHA256 | ||
| minTLSVersion: VersionTLS12 | ||
|
|
||
| onUpdate: | ||
| # Ratcheting tests - ensure existing objects with previously valid values can be updated | ||
| - name: Should allow updating other fields with a previously valid logLevel outside current range | ||
| initialCRDPatches: | ||
| - op: remove | ||
| path: /spec/versions/0/schema/openAPIV3Schema/properties/spec/properties/logLevel/maximum | ||
| - op: remove | ||
| path: /spec/versions/0/schema/openAPIV3Schema/properties/spec/properties/logLevel/minimum | ||
| initial: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| logLevel: 15 | ||
| updated: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| logLevel: 15 | ||
| autoSizingReserved: true | ||
| expected: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| logLevel: 15 | ||
| autoSizingReserved: true | ||
| - name: Should allow migrating from invalid logLevel to valid value | ||
| initialCRDPatches: | ||
| - op: remove | ||
| path: /spec/versions/0/schema/openAPIV3Schema/properties/spec/properties/logLevel/maximum | ||
| - op: remove | ||
| path: /spec/versions/0/schema/openAPIV3Schema/properties/spec/properties/logLevel/minimum | ||
ngopalak-redhat marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| initial: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| logLevel: 15 | ||
| updated: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| logLevel: 5 | ||
| expected: | | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: KubeletConfig | ||
| spec: | ||
| logLevel: 5 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -737,27 +737,41 @@ type KubeletConfig struct { | |
| Status KubeletConfigStatus `json:"status"` | ||
| } | ||
|
|
||
| // KubeletConfigSpec configures the kubelet running on cluster nodes. | ||
| type KubeletConfigSpec struct { | ||
| // autoSizingReserved controls whether system-reserved CPU and memory are automatically | ||
| // calculated based on each node's installed capacity. When set to true, this prevents node failure | ||
| // from resource starvation of system components (kubelet, CRI-O) without manual configuration. | ||
| // When omitted, this means the user has no opinion and the platform is left to choose a reasonable default, | ||
| // which is subject to change over time. The current default is true for worker nodes and false for control plane nodes. | ||
| // When set to false, automatic resource reservation is disabled and manual settings must be configured. | ||
| // +optional | ||
| AutoSizingReserved *bool `json:"autoSizingReserved,omitempty"` | ||
| // logLevel sets the kubelet log verbosity, controlling the amount of detail in kubelet logs. | ||
| // Valid values range from 0 (minimal logging) to 10 (maximum verbosity with trace-level detail). | ||
| // Higher log levels may impact node performance. When omitted, the platform chooses a reasonable default, | ||
| // which is subject to change over time. The current default is 2 (standard informational logging). | ||
| // +kubebuilder:validation:Minimum=0 | ||
| // +kubebuilder:validation:Maximum=10 | ||
ngopalak-redhat marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // +optional | ||
| LogLevel *int32 `json:"logLevel,omitempty"` | ||
|
|
||
| // machineConfigPoolSelector selects which pools the KubeletConfig should apply to. | ||
| // When omitted or set to an empty selector {}, no pools are selected, which is equivalent | ||
| // to not matching any MachineConfigPool. | ||
| // +optional | ||
| MachineConfigPoolSelector *metav1.LabelSelector `json:"machineConfigPoolSelector,omitempty"` | ||
ngopalak-redhat marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // kubeletConfig contains upstream Kubernetes kubelet configuration fields. | ||
| // Values are validated by the kubelet itself. Invalid values may render nodes unusable. | ||
| // Refer to OpenShift documentation for the Kubernetes version corresponding to your | ||
| // OpenShift release to find valid kubelet configuration options. | ||
| // +optional | ||
| KubeletConfig *runtime.RawExtension `json:"kubeletConfig,omitempty"` | ||
|
|
||
| // tlsSecurityProfile configures TLS settings for the kubelet. | ||
| // When omitted, the TLS configuration defaults to the value from apiservers.config.openshift.io/cluster. | ||
| // When specified, the type field can be set to either "Old", "Intermediate", "Modern", "Custom" or omitted for backward compatibility. | ||
| // +kubebuilder:validation:XValidation:rule="!has(self.type) || self.type == 'Old' || self.type == 'Intermediate' || self.type == 'Modern' || self.type == 'Custom'",message="only Old, Intermediate, Modern and Custom TLS profiles are supported for kubelet" | ||
|
Comment on lines
+773
to
+774
Contributor
There was a problem hiding this comment. If you are allowing the type to be any of the types that are valid for the
Contributor
Author
There was a problem hiding this comment. @everettraven Let's say there is a addition to
Contributor
There was a problem hiding this comment. In theory, yes. In practice, this is unlikely. Any changes to the |
||
| // +optional | ||
| TLSSecurityProfile *configv1.TLSSecurityProfile `json:"tlsSecurityProfile,omitempty"` | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.