Update Cluster-API and providers #667
Conversation
Signed-off-by: Andrei Kvapil <kvapss@gmail.com>
dosubot
bot
added
the
size:L
WalkthroughThis pull request updates the Cluster API Operator’s Helm chart by incrementing version numbers and modifying hook annotations to include both post-install and post-upgrade events. It also expands the conditional logic in several templates to support additional configuration via a new manager field and introduces a new IPAM provider template with input validation. Deployment configurations are enhanced with a new service account, revised command-line arguments, and updated health probe settings. Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant H as Helm
participant T as Template Engine
participant K as Kubernetes API
participant O as Operator
U->>H: Execute helm install/upgrade
H->>T: Process chart templates
T->>T: Evaluate conditions (e.g., manager, ipam, configSecret)
T->>H: Render manifests with updated hook annotations
H->>K: Apply manifests to cluster
K->>K: Trigger post-install and post-upgrade hooks
K->>O: Operator monitors and reports health via probes
sequenceDiagram
participant U as User
participant H as Helm
participant I as IPAM Template Processor
participant K as Kubernetes API
U->>H: Initiate helm upgrade with ipam value
H->>I: Process ipam.yaml template
I->>I: Validate and parse ipam input (namespace, name, version)
I->>H: Render Namespace & IPAMProvider resources with annotations
H->>K: Deploy rendered IPAM resources to cluster
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
packages/system/capi-operator/charts/cluster-api-operator/templates/ipam.yaml (2)
1-23: IPAM Provider Input Parsing and Validation
This section splits the.Values.ipamstring usingsplitfor both ";" and ":" to extract the namespace, provider name, and version. Ensure that accessing list elements using dot notation (e.g.$ipamArgs._0) is supported in your templating engine; if not, consider using theindexfunction (e.g.index $ipamArgs 0) for improved robustness.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 2-2: syntax error: expected the node content, but found '-'
(syntax)
[warning] 11-11: wrong indentation: expected 0 but found 2
(indentation)
[warning] 12-12: wrong indentation: expected 0 but found 2
(indentation)
[warning] 13-13: wrong indentation: expected 0 but found 2
(indentation)
[warning] 14-14: too many spaces after hyphen
(hyphens)
[warning] 15-15: wrong indentation: expected 0 but found 2
(indentation)
[warning] 16-16: wrong indentation: expected 0 but found 2
(indentation)
[warning] 17-17: wrong indentation: expected 0 but found 2
(indentation)
[warning] 18-18: too many spaces after hyphen
(hyphens)
[warning] 19-19: wrong indentation: expected 0 but found 2
(indentation)
[warning] 20-20: wrong indentation: expected 0 but found 2
(indentation)
[warning] 22-22: wrong indentation: expected 0 but found 2
(indentation)
49-61: Manager Configuration and Feature Gates
This block conditionally includes amanagersection and iterates over feature gates when available. Consider simplifying the logic—for example, by directly indexing into$.Values.manager.featureGatesusing the IPAM name—to improve clarity and maintainability.packages/system/capi-operator/charts/cluster-api-operator/templates/addon.yaml (1)
1-23: Addon Provider Input Parsing and Validation
This section splits the.Values.addonstring to extract the namespace, name, and version for addon providers. As with the IPAM template, verify that using dot notation (e.g.$addonArgs._0) correctly accesses list elements—consider using theindexfunction if needed for better reliability.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 2-2: syntax error: expected the node content, but found '-'
(syntax)
[warning] 11-11: wrong indentation: expected 0 but found 2
(indentation)
[warning] 12-12: wrong indentation: expected 0 but found 2
(indentation)
[warning] 13-13: wrong indentation: expected 0 but found 2
(indentation)
[warning] 14-14: too many spaces after hyphen
(hyphens)
[warning] 15-15: wrong indentation: expected 0 but found 2
(indentation)
[warning] 16-16: wrong indentation: expected 0 but found 2
(indentation)
[warning] 17-17: wrong indentation: expected 0 but found 2
(indentation)
[warning] 18-18: too many spaces after hyphen
(hyphens)
[warning] 19-19: wrong indentation: expected 0 but found 2
(indentation)
[warning] 20-20: wrong indentation: expected 0 but found 2
(indentation)
[warning] 22-22: wrong indentation: expected 0 but found 2
(indentation)
packages/system/capi-operator/charts/cluster-api-operator/templates/infra-conditions.yaml (1)
45-70: ControlPlaneProvider Resource with Optional Manager Configuration
The ControlPlaneProvider forkubeadmis defined with proper metadata and hook annotations. The spec block conditionally includes a manager configuration with nested feature gates. Please verify the indentation and ensure the conditional manager block renders correctly in all scenarios.packages/system/capi-operator/charts/cluster-api-operator/values.yaml (1)
8-8: New Field 'ipam' Initialization
The newipamfield is introduced as an empty string. Consider adding inline documentation or comments to describe the expected values and usage for clarity.packages/system/capi-operator/charts/cluster-api-operator/templates/deployment.yaml (1)
100-105: Diagnostics Port Extraction Logic
The logic extracts the port number from$.Values.diagnosticsAddressif it contains a colon, converting the substring into an integer. Consider adding error handling or validation to ensure that the splitting and conversion behave as expected when the format is nonstandard.packages/system/capi-operator/charts/cluster-api-operator/templates/control-plane.yaml (1)
47-59: Manager Configuration Block – Consider Simplification
A new block has been added to conditionally include amanagersection when$.Values.manageris defined and contains a matching key for the current control plane name. While functionally correct, the nested conditions (first usinghasKeyand then checkingeqwithin the loop) might be streamlined for improved readability. Consider refactoring to combine the conditional logic if possible, ensuring that the YAML output remains correctly indented in all cases.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (12)
packages/system/capi-operator/charts/cluster-api-operator/Chart.yaml(1 hunks)packages/system/capi-operator/charts/cluster-api-operator/templates/addon.yaml(2 hunks)packages/system/capi-operator/charts/cluster-api-operator/templates/bootstrap.yaml(2 hunks)packages/system/capi-operator/charts/cluster-api-operator/templates/control-plane.yaml(2 hunks)packages/system/capi-operator/charts/cluster-api-operator/templates/core-conditions.yaml(2 hunks)packages/system/capi-operator/charts/cluster-api-operator/templates/core.yaml(2 hunks)packages/system/capi-operator/charts/cluster-api-operator/templates/deployment.yaml(4 hunks)packages/system/capi-operator/charts/cluster-api-operator/templates/infra-conditions.yaml(4 hunks)packages/system/capi-operator/charts/cluster-api-operator/templates/infra.yaml(3 hunks)packages/system/capi-operator/charts/cluster-api-operator/templates/ipam.yaml(1 hunks)packages/system/capi-operator/charts/cluster-api-operator/values.yaml(2 hunks)packages/system/capi-providers/templates/providers.yaml(2 hunks)
✅ Files skipped from review due to trivial changes (1)
- packages/system/capi-operator/charts/cluster-api-operator/Chart.yaml
🧰 Additional context used
🪛 YAMLlint (1.35.1)
packages/system/capi-operator/charts/cluster-api-operator/templates/ipam.yaml
[error] 2-2: syntax error: expected the node content, but found '-'
(syntax)
[warning] 11-11: wrong indentation: expected 0 but found 2
(indentation)
[warning] 12-12: wrong indentation: expected 0 but found 2
(indentation)
[warning] 13-13: wrong indentation: expected 0 but found 2
(indentation)
[warning] 14-14: too many spaces after hyphen
(hyphens)
[warning] 15-15: wrong indentation: expected 0 but found 2
(indentation)
[warning] 16-16: wrong indentation: expected 0 but found 2
(indentation)
[warning] 17-17: wrong indentation: expected 0 but found 2
(indentation)
[warning] 18-18: too many spaces after hyphen
(hyphens)
[warning] 19-19: wrong indentation: expected 0 but found 2
(indentation)
[warning] 20-20: wrong indentation: expected 0 but found 2
(indentation)
[warning] 22-22: wrong indentation: expected 0 but found 2
(indentation)
🔇 Additional comments (39)
packages/system/capi-providers/templates/providers.yaml (3)
8-8: Updated Cluster API Provider Version
Theversionfor the Cluster API provider has been updated tov1.9.5. This revision aligns the provider with the latest releases and should help ensure compatibility with updated operator features.
16-16: Updated Kamaji Provider Version
The Kamaji control plane provider version is nowv0.14.1. This change reflects the necessary updates and improvements implemented in the new release.
31-31: Updated Kubeadm Provider Version
The kubeadm bootstrap provider version has been updated tov1.9.5, ensuring consistency with the upgraded Cluster API provider versions across the configuration.packages/system/capi-operator/charts/cluster-api-operator/templates/ipam.yaml (5)
24-32: Namespace Resource Definition for IPAM Providers
The Namespace resource is defined with appropriate Helm hook annotations (post-install,post-upgrade) and sync-wave settings. While static analysis tools flag indentation issues, these are likely false positives due to templating syntax. Please verify the final rendered YAML withhelm template.
34-42: IPAMProvider Resource Definition
The IPAMProvider resource is properly set up with the necessary metadata and hook annotations. The conditional inclusion of aspecblock based on the presence of optional fields is a neat approach to maintain flexibility.
43-48: Conditional Spec Block for Version Assignment
The template conditionally adds theversionfield only if$ipamVersionis provided. This design keeps the resource definition clean when versioning is not specified.
62-71: Optional ConfigSecret and Additional Deployments Blocks
The conditional inclusion ofconfigSecretandadditionalDeploymentssections is well implemented. The use oftoYamlpiped withnindentensures proper formatting of complex values.
1-74: Note on Static Analysis Warnings
Several static analysis warnings (e.g., indentation and syntax issues) are reported by YAMLlint. These are likely false positives due to the Helm templating syntax. Please validate the rendered YAML output usinghelm templateto ensure correctness.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 2-2: syntax error: expected the node content, but found '-'
(syntax)
[warning] 11-11: wrong indentation: expected 0 but found 2
(indentation)
[warning] 12-12: wrong indentation: expected 0 but found 2
(indentation)
[warning] 13-13: wrong indentation: expected 0 but found 2
(indentation)
[warning] 14-14: too many spaces after hyphen
(hyphens)
[warning] 15-15: wrong indentation: expected 0 but found 2
(indentation)
[warning] 16-16: wrong indentation: expected 0 but found 2
(indentation)
[warning] 17-17: wrong indentation: expected 0 but found 2
(indentation)
[warning] 18-18: too many spaces after hyphen
(hyphens)
[warning] 19-19: wrong indentation: expected 0 but found 2
(indentation)
[warning] 20-20: wrong indentation: expected 0 but found 2
(indentation)
[warning] 22-22: wrong indentation: expected 0 but found 2
(indentation)
packages/system/capi-operator/charts/cluster-api-operator/templates/addon.yaml (4)
24-32: Namespace Resource for Addon Provider
The Namespace for the addon provider is defined with the expected Helm hook annotations (post-install,post-upgrade) and sync-wave settings. Confirm that the final YAML output renders with correct indentation despite potential static analysis warnings.
34-42: AddonProvider Resource Definition
The AddonProvider resource is structured correctly with appropriate metadata and hook annotations. The conditional inclusion of aspecblock is used effectively to handle optional configurations.
43-48: Conditional Spec Block for Version Assignment
Including theversionfield only when$addonVersionis provided ensures flexibility. This conditional rendering keeps the resource definition concise when version information is not necessary.
49-54: Optional Secret Configuration for Addon Provider
The template conditionally addssecretNameandsecretNamespaceif defined in the values. This allows for secure customization of the provider’s secret settings.packages/system/capi-operator/charts/cluster-api-operator/templates/infra-conditions.yaml (2)
4-32: Bootstrap Components Deployment for Infrastructure
This section deploys the bootstrap Namespace and BootstrapProvider resources when.Values.bootstrapis not set. The Helm hook annotations and sync-wave settings are updated to trigger on both installation and upgrade events, and the optionalconfigSecretconfiguration adds flexibility.
34-44: Control Plane Namespace Definition
A Namespace for the control plane (capi-kubeadm-control-plane-system) is defined with updated hook annotations. This aligns with the multi-environment deployment strategy and ensures consistent handling by Helm.packages/system/capi-operator/charts/cluster-api-operator/templates/core-conditions.yaml (3)
1-3: Conditional Deployment for Core Components
The template conditionally deploys core components only if they have not been explicitly set via.Values.core. This logic helps prevent resource conflicts in multi-component deployments.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 1-1: syntax error: expected the node content, but found '-'
(syntax)
5-11: Namespace Definition for Core Components
The Namespace (capi-system) for core components is defined with updated Helm hook annotations (post-install,post-upgrade) and a sync-wave setting. Verify that the final rendered YAML respects the intended indentation despite warnings from static analysis tools.
13-21: CoreProvider Resource Definition
The CoreProvider resource forcluster-apiis configured with the latest hook annotations and optionally includes aconfigSecretblock if provided. This configuration is consistent with the overall update strategy in the Helm chart.packages/system/capi-operator/charts/cluster-api-operator/values.yaml (5)
11-11: Introduction of 'fetchConfig' Configuration
A newfetchConfigfield (an empty map) has been added. Please verify that downstream templates properly validate and consume this field, and document its expected schema if necessary.
24-24: Manager Image Tag Update
Thetagfor the manager image is updated tov0.17.0, which aligns with the overall version bump. Ensure that all related documentation and image references are updated accordingly.
28-28: Diagnostics Address Format Update
ThediagnosticsAddressis now set to":8443", standardizing the format with a colon prefix. Verify that all components expecting this value are compatible with the new format.
29-29: Health Address Port Change
ThehealthAddrhas been updated to":9440". Ensure that any health probes or network configurations correctly reference this new port.
31-31: New 'watchConfigSecret' Flag Added
The new boolean flagwatchConfigSecretis introduced (set to false). Confirm that its conditional usage in deployment templates triggers the intended behavior and that adequate tests cover this functionality.packages/system/capi-operator/charts/cluster-api-operator/templates/core.yaml (3)
28-29: Hook Annotation Update for Namespace
The annotation"helm.sh/hook": "post-install,post-upgrade"now ensures that the Namespace resource is processed during both installation and upgrade events.
38-39: Hook Annotation Update for CoreProvider
The CoreProvider’s hook annotation is updated to trigger on both post-install and post-upgrade events, ensuring its lifecycle is managed consistently.
41-41: Enhanced Conditional Logic for Spec Rendering
The condition for rendering thespecfield now includes$.Values.manager(in addition to$coreVersionand$.Values.configSecret.name). Verify that this inclusion correctly handles scenarios where manager configurations are provided.packages/system/capi-operator/charts/cluster-api-operator/templates/bootstrap.yaml (2)
29-29: Hook Annotation Update for Namespace in Bootstrap Provider
The Namespace metadata now uses"helm.sh/hook": "post-install,post-upgrade", which will ensure it is reprocessed during upgrades as well as initial installs.
39-39: Hook Annotation Update for BootstrapProvider
The BootstrapProvider's metadata annotation is updated to trigger on both post-install and post-upgrade events, improving lifecycle management.packages/system/capi-operator/charts/cluster-api-operator/templates/deployment.yaml (4)
50-51: New Service Account Configuration
The deployment now specifiesserviceAccountName: capi-operator-managerand enablesautomountServiceAccountToken: true. This configuration ensures the operator pod runs with a dedicated service account. Please confirm that the corresponding RBAC roles and service account are configured in the cluster.
74-76: Conditional Watch ConfigSecret Argument
The new--watch-configsecretflag is conditionally added based on.Values.watchConfigSecret. Verify that the operator’s command-line parser correctly recognizes and uses this flag.
125-125: Termination Message Policy Set
The addition ofterminationMessagePolicy: FallbackToLogsOnErrorenhances error reporting, ensuring that logs are appropriately captured on container termination.
126-149: Enhanced Health Probes Configuration
New liveness and readiness probes are configured using a dynamically extracted port fromhealthAddr(with a default of 9440). Please confirm that the endpoints/healthzand/readyzare correctly implemented in the operator and that the probe parameters (delays, timeouts) meet the intended operational requirements.packages/system/capi-operator/charts/cluster-api-operator/templates/infra.yaml (5)
29-30: Namespace Hook Annotation Update
The Namespace metadata now uses"helm.sh/hook": "post-install,post-upgrade", ensuring that namespace resources are revisited during upgrade events.
40-41: InfrastructureProvider Hook Annotation Update
The InfrastructureProvider’s metadata annotation is updated to trigger on both post-install and post-upgrade events, which improves the resource’s lifecycle management.
43-43: Enhanced Spec Rendering Conditional
The condition to render thespecfield now includes$.Values.additionalDeploymentsalong with the existing checks. Please verify that this expanded condition correctly triggers spec rendering in all intended scenarios.
62-71: Dynamic FetchConfig Integration
A new block renders thefetchConfigsection if$.Values.fetchConfigis a map containing a key matching the infrastructure name. Confirm that the structure of entries underfetchConfigmeets the expected schema for downstream processing.
79-81: Additional Deployments Configuration
The new conditional block foradditionalDeploymentsallows extra deployment settings to be injected. Ensure that the YAML rendered bytoYamlis correctly indented and valid within the overall manifest structure.packages/system/capi-operator/charts/cluster-api-operator/templates/control-plane.yaml (3)
29-30: Update Namespace Hook Annotations
The hook annotation on the Namespace resource has been updated to include bothpost-installandpost-upgradeevents. This change ensures that the hook is triggered during both the installation and upgrade phases.
38-40: Update ControlPlaneProvider Hook Annotations
Similarly, theControlPlaneProviderresource now uses the updated hook annotation (post-install,post-upgrade) with an appropriate hook weight. This update helps maintain consistency across resources for lifecycle events.
41-43: Expanded Conditional for Spec Rendering
The conditional check for rendering thespecsection now includes an additional value ($.Values.manager). This accommodates extra configuration options and aligns with changes across other related templates.
Signed-off-by: Andrei Kvapil kvapss@gmail.com
Summary by CodeRabbit
New Features
Chores