Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ Add featureGates to ControlPlaneProvider #536

Merged
merged 2 commits into from
Dec 12, 2024

Conversation

kahirokunn
Copy link
Contributor

@kahirokunn kahirokunn commented May 24, 2024

What this PR does / why we need it:

This PR adds support for specifying featureGates in the ControlPlaneProvider. This is particularly necessary when using infrastructure=docker, as we need to pass CLUSTER_TOPOLOGY=true to the kubeadm provider. Currently, there is no way to do this, and this feature is essential for enabling cluster topology features in kubeadm.

Usage Example:

To use this feature, you can install the capi-operator with Helm and specify the feature gates in your values file. Here is an example:

helm install capi-operator cluster-api-operator/cluster-api-operator --version 0.10.1 -n capi-operator-system --create-namespace --values ./example-values.yaml

example-values.yaml:

cert-manager:
  enabled: false
  installCRDs: false
infrastructure: docker:v1.7.2
core: cluster-api:v1.7.2
controlPlane: kubeadm:v1.7.2
manager:
  featureGates:
    core:
      ClusterTopology: true
      MachinePool: true
    docker:
      ClusterTopology: true
      MachinePool: true
    kubeadm:
      ClusterTopology: true
      MachinePool: true

Sample Output:

Here is a portion of the expanded manifest showing the applied feature gates:

# Source: cluster-api-operator/templates/control-plane.yaml
apiVersion: operator.cluster.x-k8s.io/v1alpha2
kind: ControlPlaneProvider
metadata:
  name: kubeadm
  namespace: kubeadm-control-plane-system
  annotations:
    "helm.sh/hook": "post-install"
    "helm.sh/hook-weight": "2"
spec:
  version: v1.7.2
  manager:
    featureGates:
      ClusterTopology: true
      MachinePool: true

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 24, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @kahirokunn!

It looks like this is your first PR to kubernetes-sigs/cluster-api-operator 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api-operator has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @kahirokunn. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 24, 2024
Copy link

netlify bot commented May 24, 2024

Deploy Preview for kubernetes-sigs-cluster-api-operator ready!

Name Link
🔨 Latest commit 80c8b64
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-cluster-api-operator/deploys/674d4e5e5c76090008cc4b26
😎 Deploy Preview https://deploy-preview-536--kubernetes-sigs-cluster-api-operator.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@kahirokunn kahirokunn force-pushed the kubeadm-feature-flag branch from f0c4aea to 4ba6b3e Compare May 24, 2024 07:09
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 24, 2024
@kahirokunn kahirokunn changed the title ✨ Add featureGates to kubeadm ControlPlaneProvider ✨ Add featureGates to ControlPlaneProvider May 24, 2024
Copy link
Contributor

@alexander-demicev alexander-demicev left a comment

Choose a reason for hiding this comment

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

@alexander-demicev
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 4, 2024
@furkatgofurov7
Copy link
Member

/retest

@furkatgofurov7
Copy link
Member

LGTM, but CI was not agreeing with me. Let's wait if retrigger helps (assuming it was a CI flake).

@furkatgofurov7
Copy link
Member

LGTM, but CI was not agreeing with me. Let's wait if retrigger helps (assuming it was a CI flake).

We would need to check in template if feature gates are set before trying to access them, so that tests won't fail

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 22, 2024
@furkatgofurov7
Copy link
Member

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 23, 2024
@furkatgofurov7
Copy link
Member

@kahirokunn can you rebase on top of the main and look at the CI failure? This is almost ready to take in IMO

@kahirokunn kahirokunn force-pushed the kubeadm-feature-flag branch 2 times, most recently from 24031f9 to be3948d Compare November 20, 2024 01:20
@kahirokunn
Copy link
Contributor Author

@furkatgofurov7 I fixed it by checking for the existence of the value so that the nil pointer exception would not occur.
I'd be happy if we could merge!

@furkatgofurov7
Copy link
Member

@kahirokunn this looks good already, the only pending comment that needs addressing is #536 (review)

@kahirokunn
Copy link
Contributor Author

@furkatgofurov7
I have resolved the comment as the content has already been addressed.
Would this be acceptable to you?

@furkatgofurov7
Copy link
Member

https://github.com/kubernetes-sigs/cluster-api-operator/blob/main/test/e2e/helm_test.go

@kahirokunn maybe you missed it, but what I was referring to miss in this patch seems to be updating a tests in https://github.com/kubernetes-sigs/cluster-api-operator/blob/main/test/e2e/helm_test.go as per review comment

@kahirokunn
Copy link
Contributor Author

I understand.
I'll add it.

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Dec 2, 2024
@kahirokunn
Copy link
Contributor Author

@furkatgofurov7 Thank you for pointing that out! I’ve written the necessary test and updated the file at test/e2e/helm_test.go as per the review comment. Please let me know if there’s anything else that needs to be addressed.

@Danil-Grigorev
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 12, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: abe7e21f9b57fcce28f94f971269939c07dd74c8

@furkatgofurov7
Copy link
Member

@furkatgofurov7 Thank you for pointing that out! I’ve written the necessary test and updated the file at test/e2e/helm_test.go as per the review comment. Please let me know if there’s anything else that needs to be addressed.

Thanks for your patience and work on this PR, and sorry for late reply (I was on PTO), this looks good to me.

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: furkatgofurov7

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 12, 2024
@k8s-ci-robot k8s-ci-robot merged commit 7eb2d57 into kubernetes-sigs:main Dec 12, 2024
14 checks passed
@kahirokunn
Copy link
Contributor Author

Thxs!

@kahirokunn kahirokunn deleted the kubeadm-feature-flag branch December 12, 2024 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants