✨(kustomize/v1, go/v3) : Add new LeaderElectionReleaseOnCancel as true option commented to let users know when they can use it #2596

NikhilSharmaWe · 2022-04-03T18:30:10Z

NikhilSharmaWe · 2022-04-03T19:21:05Z

@joelanford @camilamacedo86 @AlmogBaku
Error logs says vet: ./main.go:64:3: unknown field LeaderElectionReleaseOnCancel in struct literal. Unable to understand the cause of it. The function NewManager uses type Options as one of the parameters, since Options is actually manager.Options and since it has LeaderElectionReleaseOnCancel field in it why this error is being displayed.

AlmogBaku · 2022-04-04T06:45:22Z

This feature wasn't supported in the controller-runtime:v0.6.4 which is the version that the go/v2 plugin uses - therefore, you should only patch go/v3

NikhilSharmaWe · 2022-04-04T07:21:50Z

pkg/plugins/golang/v3/scaffolds/internal/templates/main.go

@@ -238,13 +238,16 @@ func main() {
 	ctrl.SetLogger(zap.New(zap.UseFlagOptions(&opts)))

 {{ if not .ComponentConfig }}
+	// Setting LeaderElectionReleaseOnCancel to true prevents main.go 
+	// scripts to close when Manager is done and improves the performance of re-election. 


@AlmogBaku All tests are passing now. Could you please review this explanation comment added before moving forward.

camilamacedo86

I think we need to discuss if this option should or NOT be added by default?
Also, what is the motivation for that?
What issue are you facing that you want to add to the default scaffold?

See : #2593 (comment)

Let's discuss it in the issue.

/hold

NikhilSharmaWe · 2022-05-01T04:55:41Z

@camilamacedo86 and @AlmogBaku Do we also need to add the comment here https://github.com/kubernetes-sigs/kubebuilder/blob/master/testdata/project-v3-config/main.go#L66?

How can we check that it is possible via the ComponentConfig as well (since @camilamacedo86 mentioned that this is needed for this case)?

camilamacedo86 · 2022-05-05T10:30:08Z

Hi @NikhilSharmaWe,

I think we also need to update the template used by the ComponentConfig option so that we will check its results in the sample. Why? Ensure that all have the same options, and follow the same standard making it easier for us to keep the project maintained.

NikhilSharmaWe · 2022-05-05T11:23:06Z

@camilamacedo86 Are talking about adding the comment for this case as well?

kubebuilder/pkg/plugins/golang/v3/scaffolds/internal/templates/main.go

Line 262 in 43525de

options := ctrl.Options{Scheme: scheme}

camilamacedo86 · 2022-05-05T12:15:27Z

Hi @NikhilSharmaWe,

The change shows to be here:

kubebuilder/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/manager/controller_manager_config.go

Lines 47 to 57 in 019c185

    
           const controllerManagerConfigTemplate = `apiVersion: controller-runtime.sigs.k8s.io/v1alpha1 
        
           kind: ControllerManagerConfig 
        
           health: 
        
             healthProbeBindAddress: :8081 
        
           metrics: 
        
             bindAddress: 127.0.0.1:8080 
        
           webhook: 
        
             port: 9443 
        
           leaderElection: 
        
             leaderElect: true 
        
             resourceName: {{ hashFNV .Repo }}.{{ .Domain }}

We need to pass the option under the leader election options
That should be also commented ( since it is an yaml file to comment you will use the prefix # )
Also, it should have the same comment explanation.

everettraven

/lgtm

camilamacedo86

/lgtm

k8s-ci-robot · 2022-05-18T09:47:09Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, everettraven, NikhilSharmaWe

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:

~~OWNERS~~ [camilamacedo86]

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

camilamacedo86 · 2022-05-18T10:43:06Z

/test pull-kubebuilder-e2e-k8s-1-14-10

* Upgrade Kubebuilder dep from 3.4.1 to the commit 800fdeec6e5c Signed-off-by: Camila Macedo <[email protected]> - For Golang/Ansible/Helm language-based operators (go/v3, ansible/v1 and helm/v1): applying restrictive SCC for all containers scaffolded by the tool (k8s versions < 1.19 will no longer work with). - For Golang-based language (go/v2) fix the issue introduced by removing the GO111MODULE=on from Dockerfile. ([More info](kubernetes-sigs/kubebuilder#2678)) - For Golang/Ansible/Helm language-based operators (go/v3, ansible/v1 and helm/v1 language (go/v3), add a new comment with the option `leaderElectionReleaseOnCancel` ((More info)[kubernetes-sigs/kubebuilder#2596]) Only to get the changes from what we currently use in SDK from kubebuilder. - Ensure that scaffolds begin to be performed with a restrive Security Context - Be able to do specific follow up PR so we can discuss properly how we will consume the new additions on Kubebuilder - Make eaiser the process to keep SDK updated, otherwise, it is hard to properly review if we wait to do a big PR with all. - Ensure that SDK features can work with the latest changes performed in Kubebuilder **Extra info** You can check the latest changes on Kubebuilder by looking: kubernetes-sigs/kubebuilder@v3.4.1...master Note that SDK users Kubebuilder as a LIB. So that all that is currently important is updated by default when we bump. However, all that was added to Kubebuilder but still not imported/used in SDK will not be added here. Therefore we can do follow up PRs to get the additions. Why? we have significant changes and additions for example adding the support for the phase 2 plugin, but if we try to do it all in the same PR it will be very hard to get properly reviewed. Co-authored-by: Varsha <[email protected]> * trying to fix ansible lint Co-authored-by: Varsha <[email protected]>

…or-framework#5814) * Upgrade Kubebuilder dep from 3.4.1 to the commit 800fdeec6e5c Signed-off-by: Camila Macedo <[email protected]> - For Golang/Ansible/Helm language-based operators (go/v3, ansible/v1 and helm/v1): applying restrictive SCC for all containers scaffolded by the tool (k8s versions < 1.19 will no longer work with). - For Golang-based language (go/v2) fix the issue introduced by removing the GO111MODULE=on from Dockerfile. ([More info](kubernetes-sigs/kubebuilder#2678)) - For Golang/Ansible/Helm language-based operators (go/v3, ansible/v1 and helm/v1 language (go/v3), add a new comment with the option `leaderElectionReleaseOnCancel` ((More info)[kubernetes-sigs/kubebuilder#2596]) Only to get the changes from what we currently use in SDK from kubebuilder. - Ensure that scaffolds begin to be performed with a restrive Security Context - Be able to do specific follow up PR so we can discuss properly how we will consume the new additions on Kubebuilder - Make eaiser the process to keep SDK updated, otherwise, it is hard to properly review if we wait to do a big PR with all. - Ensure that SDK features can work with the latest changes performed in Kubebuilder **Extra info** You can check the latest changes on Kubebuilder by looking: kubernetes-sigs/kubebuilder@v3.4.1...master Note that SDK users Kubebuilder as a LIB. So that all that is currently important is updated by default when we bump. However, all that was added to Kubebuilder but still not imported/used in SDK will not be added here. Therefore we can do follow up PRs to get the additions. Why? we have significant changes and additions for example adding the support for the phase 2 plugin, but if we try to do it all in the same PR it will be very hard to get properly reviewed. Co-authored-by: Varsha <[email protected]> * trying to fix ansible lint Co-authored-by: Varsha <[email protected]>

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 3, 2022

k8s-ci-robot requested review from camilamacedo86 and joelanford April 3, 2022 18:30

NikhilSharmaWe force-pushed the managerScaffolds branch from 7d61129 to 3f67d96 Compare April 3, 2022 19:16

NikhilSharmaWe force-pushed the managerScaffolds branch from 3f67d96 to 915c186 Compare April 4, 2022 07:03

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 4, 2022

NikhilSharmaWe commented Apr 4, 2022

View reviewed changes

camilamacedo86 requested changes Apr 4, 2022

View reviewed changes

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 4, 2022

NikhilSharmaWe force-pushed the managerScaffolds branch from 915c186 to 38470dc Compare April 28, 2022 12:38

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 28, 2022

NikhilSharmaWe force-pushed the managerScaffolds branch from 38470dc to 43525de Compare April 28, 2022 12:46

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Apr 28, 2022

NikhilSharmaWe requested a review from camilamacedo86 April 28, 2022 12:47

NikhilSharmaWe force-pushed the managerScaffolds branch from 43525de to 9fd41d4 Compare May 5, 2022 14:33

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 5, 2022

NikhilSharmaWe force-pushed the managerScaffolds branch from 9fd41d4 to 97062b2 Compare May 5, 2022 14:44

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 5, 2022

everettraven approved these changes May 9, 2022

View reviewed changes

camilamacedo86 approved these changes May 18, 2022

View reviewed changes

k8s-ci-robot assigned camilamacedo86 May 18, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 18, 2022

k8s-ci-robot merged commit fc59b56 into kubernetes-sigs:master May 18, 2022

camilamacedo86 mentioned this pull request May 29, 2022

Upgrade Kubebuilder dep from 3.4.1 to the commit 800fdeec6e5c operator-framework/operator-sdk#5814

Merged

camilamacedo86 mentioned this pull request Jun 8, 2022

remove the trailing space from the comments and the reduce the blank space #2716

Closed

renovate bot mentioned this pull request Jun 15, 2022

chore(deps): update dependency operator-framework/operator-sdk to v1.22.0 aquaproj/aqua-registry#4011

Merged

1 task

everettraven mentioned this pull request Jun 24, 2022

REQUEST: New membership for @everettraven kubernetes/org#3522

Closed

9 tasks

itsmitul9 mentioned this pull request Jun 29, 2022

[Doc] Added git url release note v1.22.0.md operator-framework/operator-sdk#5915

Merged

2 tasks

DomHeal mentioned this pull request Dec 23, 2022

Update dependency operator-framework/operator-sdk to v1.26.0 DomHeal/devops-tooling-container#4

Merged

1 task

renovate bot mentioned this pull request Apr 7, 2023

Update module github.com/operator-framework/operator-sdk to v1 Jmainguy/cert-julip#13

Closed

1 task

This was referenced Dec 2, 2023

Update dependency operator-framework/operator-sdk to v1.32.0 garethahealy/github-workflows-operators#6

Merged

Update dependency operator-framework/operator-sdk to v1.32.0 garethahealy/github-workflows-operators#8

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨(kustomize/v1, go/v3) : Add new LeaderElectionReleaseOnCancel as true option commented to let users know when they can use it #2596

✨(kustomize/v1, go/v3) : Add new LeaderElectionReleaseOnCancel as true option commented to let users know when they can use it #2596

NikhilSharmaWe commented Apr 3, 2022

NikhilSharmaWe commented Apr 3, 2022 •

edited

Loading

AlmogBaku commented Apr 4, 2022

NikhilSharmaWe Apr 4, 2022

camilamacedo86 left a comment •

edited

Loading

NikhilSharmaWe commented May 1, 2022 •

edited

Loading

camilamacedo86 commented May 5, 2022

NikhilSharmaWe commented May 5, 2022

camilamacedo86 commented May 5, 2022

everettraven left a comment •

edited

Loading

camilamacedo86 left a comment

k8s-ci-robot commented May 18, 2022

camilamacedo86 commented May 18, 2022

✨(kustomize/v1, go/v3) : Add new LeaderElectionReleaseOnCancel as true option commented to let users know when they can use it #2596

✨(kustomize/v1, go/v3) : Add new LeaderElectionReleaseOnCancel as true option commented to let users know when they can use it #2596

Conversation

NikhilSharmaWe commented Apr 3, 2022

NikhilSharmaWe commented Apr 3, 2022 • edited Loading

AlmogBaku commented Apr 4, 2022

NikhilSharmaWe Apr 4, 2022

Choose a reason for hiding this comment

camilamacedo86 left a comment • edited Loading

Choose a reason for hiding this comment

NikhilSharmaWe commented May 1, 2022 • edited Loading

camilamacedo86 commented May 5, 2022

NikhilSharmaWe commented May 5, 2022

camilamacedo86 commented May 5, 2022

everettraven left a comment • edited Loading

Choose a reason for hiding this comment

camilamacedo86 left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented May 18, 2022

camilamacedo86 commented May 18, 2022

NikhilSharmaWe commented Apr 3, 2022 •

edited

Loading

camilamacedo86 left a comment •

edited

Loading

NikhilSharmaWe commented May 1, 2022 •

edited

Loading

everettraven left a comment •

edited

Loading