✨Added support for helm options like wait, skip-crds, timeout, waitForJobs, etc. #82

manoj-nutanix · 2023-06-06T07:15:27Z

What this PR does / why we need it:
PR adds support for helm options like wait, skip-crds, timeout, waitForJobs, etc. with help of CRD fields. Users can now control behaviour of helm operations(Install, Upgrade, Delete, etc) with helm options by specifying it in HCP CR as follows -

apiVersion: addons.cluster.x-k8s.io/v1alpha1
kind: HelmChartProxy
metadata:
  name: mysql-operator
spec:
  options:
    waitForJobs: true
    wait: true
    timeout: 5m
    install:
      createNamespace: true
  namespace: mysql
  clusterSelector:
    matchLabels:
      cluster.x-k8s.io/cluster-name: manoj
  repoURL: https://mysql.github.io/mysql-operator/
  chartName: mysql-operator

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 #79

k8s-ci-robot · 2023-06-06T07:15:36Z

Hi @manoj-nutanix. 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/test-infra repository.

jackfrancis · 2023-06-06T19:43:45Z

api/v1alpha1/helmchartproxy_webhook.go

+
+	// If 'Wait' is set, we need to set default 'Timeout' to make install successful.
+	if p.Spec.Options != nil && p.Spec.Options.Wait {
+		p.Spec.Options.Timeout = &metaV1.Duration{Duration: time.Second * 600}


Should we make this timeout a user-configurable flag so that when they enable wait they can also configure the upper time limit?

Yes. My bad, forgot to add p.Spec.Options.Timeout == nil check. Thanks for the pointer.

Updated. Please review.

let's make this default timeout value a const so that we can easily write a UT and validate the default flow from a single source of truth

We could also check in the Helm repo too to see if there's a const they already set.

Sure, updated. Please review.

jackfrancis · 2023-06-06T19:45:53Z

This looks really cool, thanks @manoj-nutanix!

manoj-nutanix · 2023-06-07T05:11:44Z

This looks really cool, thanks @manoj-nutanix!

Thanks, could you please comment ok-to-test to run test-jobs?

Jont828 · 2023-06-07T16:45:47Z

/ok-to-test

Jont828

Nice work! I had a couple points to clarify but looks good overall. Have you tried testing it out yet?

Jont828 · 2023-06-07T17:22:27Z

api/v1alpha1/helmchartproxy_webhook.go

+
+	// If 'Wait' is set, we need to set default 'Timeout' to make install successful.
+	if p.Spec.Options != nil && p.Spec.Options.Wait {
+		p.Spec.Options.Timeout = &metaV1.Duration{Duration: time.Second * 600}


We could also check in the Helm repo too to see if there's a const they already set.

Jont828 · 2023-06-07T17:45:28Z

api/v1alpha1/helmchartproxy_webhook.go

@@ -38,13 +43,29 @@ func (r *HelmChartProxy) SetupWebhookWithManager(mgr ctrl.Manager) error {

 var _ webhook.Defaulter = &HelmChartProxy{}

+var trueValuePtr = func(i bool) *bool { return &i }(true)


We can use the pointer package to get the true value pointer instead.

Sure, updated. Please review.

api/v1alpha1/helmchartproxy_webhook.go

Jont828 · 2023-06-07T17:49:59Z

api/v1alpha1/helmchartproxy_types.go

@@ -58,6 +58,104 @@ type HelmChartProxySpec struct {
 	// fields from each selected workload Cluster and programatically create and set values.
 	// +optional
 	ValuesTemplate string `json:"valuesTemplate,omitempty"`
+
+	// Options represents the helm setting options which can be used to control behaviour of helm operations(Install, Upgrade, Delete, etc)


Suggested change

// Options represents the helm setting options which can be used to control behaviour of helm operations(Install, Upgrade, Delete, etc)

// Options represents the CLI flags passed to Helm operations (i.e. install, upgrade, delete) and include options such as wait, skipCRDs, timeout, waitForJobs, etc.

Sure, updated. Please review.

Jont828 · 2023-06-08T23:32:28Z

api/v1alpha1/helmchartproxy_types.go

+
+	// SkipCRDs controls whether CRDs should be installed during install/upgrade operation.
+	// If set, no CRDs will be installed.
+	// By default, CRDs are installed if not already present.


Nit: maybe move this back to the line above.

Sure, updated. Please review.

manoj-nutanix · 2023-06-09T06:04:00Z

Nice work! I had a couple points to clarify but looks good overall. Have you tried testing it out yet?

Yes, I've done sanity testing for all operation viz. helm install, upgrade, uninstall. Do we have automation tests written somewhere? I could not find any test files in this repo.

We could also check in the Helm repo too to see if there's a const they already set.

I could not find any const for timeout so I've declared our const. FYI, helm cli uses 300s timeout but I've kept it on higher side (600s) for safety due to reconciliation pattern as user wouldn't want to keep checking failure and update HCP CRs on every failure.

manoj-nutanix · 2023-06-09T06:06:55Z

@Jont828 @jackfrancis I've addressed review comments and added support of helm flags for Uninstall operation as well, please review.

Jont828

Think we're almost good!

Jont828 · 2023-06-09T22:29:24Z

api/v1alpha1/helmchartproxy_webhook.go

@@ -38,13 +44,31 @@ func (r *HelmChartProxy) SetupWebhookWithManager(mgr ctrl.Manager) error {

 var _ webhook.Defaulter = &HelmChartProxy{}

+var trueValuePtr = pointer.Bool(true)


Nit: I think the convention we've been using has just been to use the function return value instead of declaring a variable for it

sure, updated. Please review.

Jont828 · 2023-06-09T22:45:50Z

Gotcha. I haven't set up e2e tests or controller tests yet, but that's definitely going to be a bigger priority moving forward. I'd be happy to collab on that if you'd like as well.

Jont828 · 2023-06-12T22:51:08Z

@manoj-nutanix LGTM pending squash

manoj-nutanix · 2023-06-13T04:59:21Z

@manoj-nutanix LGTM pending squash

Just to understand, why don't we use squash and merge option while merging PR?

…Jobs, etc. Added nil check for Timeout in webhook defaulting to make Timeout user configurable Added const helmTimeoutSeconds in HCP webhook checks Added support for helm flags for uninstall operation as well Removed var trueValuePtr from webhook check

Jont828 · 2023-06-13T23:13:48Z

@manoj-nutanix That's a good question, it's just the convention we've been following with CAPI PRs. I think the main reason is that we want to use the approve command to let the K8s bot merge it so that there's your commit and the merge commit from prow.

Jont828 · 2023-06-13T23:13:53Z

/lgtm
/approve

k8s-ci-robot · 2023-06-13T23:14:00Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Jont828, manoj-nutanix

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~~ [Jont828]

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

manoj-nutanix · 2023-06-14T05:58:00Z

@manoj-nutanix That's a good question, it's just the convention we've been following with CAPI PRs. I think the main reason is that we want to use the approve command to let the K8s bot merge it so that there's your commit and the merge commit from prow.

I believe, this label will do the job for us.

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 6, 2023

k8s-ci-robot requested review from jackfrancis and Jont828 June 6, 2023 07:15

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 6, 2023

k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jun 6, 2023

jackfrancis reviewed Jun 6, 2023

View reviewed changes

manoj-nutanix force-pushed the KRBN-6938 branch from 131db4d to 7b7c8ed Compare June 7, 2023 11:02

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 7, 2023

manoj-nutanix force-pushed the KRBN-6938 branch from 7b7c8ed to eb778f2 Compare June 7, 2023 18:12

Jont828 reviewed Jun 8, 2023

View reviewed changes

Jont828 reviewed Jun 9, 2023

View reviewed changes

manoj-nutanix force-pushed the KRBN-6938 branch from a79a8b2 to 8fc01d1 Compare June 13, 2023 05:14

k8s-ci-robot assigned Jont828 Jun 13, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 13, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 13, 2023

k8s-ci-robot merged commit ecbd8f3 into kubernetes-sigs:main Jun 13, 2023
13 checks passed

manoj-nutanix deleted the KRBN-6938 branch June 14, 2023 05:56

Jont828 mentioned this pull request Jun 28, 2023

CAAPH panic when a HRP should be deleted #92

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨Added support for helm options like wait, skip-crds, timeout, waitForJobs, etc. #82

✨Added support for helm options like wait, skip-crds, timeout, waitForJobs, etc. #82

manoj-nutanix commented Jun 6, 2023

k8s-ci-robot commented Jun 6, 2023

jackfrancis Jun 6, 2023

manoj-nutanix Jun 7, 2023 •

edited

Loading

manoj-nutanix Jun 7, 2023

jackfrancis Jun 7, 2023

Jont828 Jun 7, 2023

manoj-nutanix Jun 7, 2023

jackfrancis commented Jun 6, 2023

manoj-nutanix commented Jun 7, 2023

Jont828 commented Jun 7, 2023

Jont828 left a comment

Jont828 Jun 7, 2023

Jont828 Jun 7, 2023

manoj-nutanix Jun 9, 2023

Jont828 Jun 7, 2023

manoj-nutanix Jun 9, 2023

Jont828 Jun 8, 2023

manoj-nutanix Jun 9, 2023

manoj-nutanix commented Jun 9, 2023 •

edited

Loading

manoj-nutanix commented Jun 9, 2023

Jont828 left a comment

Jont828 Jun 9, 2023

manoj-nutanix Jun 12, 2023

Jont828 commented Jun 9, 2023

Jont828 commented Jun 12, 2023

manoj-nutanix commented Jun 13, 2023 •

edited

Loading

Jont828 commented Jun 13, 2023

Jont828 commented Jun 13, 2023

k8s-ci-robot commented Jun 13, 2023

manoj-nutanix commented Jun 14, 2023

		@@ -38,13 +43,29 @@ func (r *HelmChartProxy) SetupWebhookWithManager(mgr ctrl.Manager) error {

		var _ webhook.Defaulter = &HelmChartProxy{}

		var trueValuePtr = func(i bool) *bool { return &i }(true)

	// Options represents the helm setting options which can be used to control behaviour of helm operations(Install, Upgrade, Delete, etc)
	// Options represents the CLI flags passed to Helm operations (i.e. install, upgrade, delete) and include options such as wait, skipCRDs, timeout, waitForJobs, etc.

		@@ -38,13 +44,31 @@ func (r *HelmChartProxy) SetupWebhookWithManager(mgr ctrl.Manager) error {

		var _ webhook.Defaulter = &HelmChartProxy{}

		var trueValuePtr = pointer.Bool(true)

✨Added support for helm options like wait, skip-crds, timeout, waitForJobs, etc. #82

✨Added support for helm options like wait, skip-crds, timeout, waitForJobs, etc. #82

Conversation

manoj-nutanix commented Jun 6, 2023

k8s-ci-robot commented Jun 6, 2023

Choose a reason for hiding this comment

manoj-nutanix Jun 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jackfrancis commented Jun 6, 2023

manoj-nutanix commented Jun 7, 2023

Jont828 commented Jun 7, 2023

Jont828 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

manoj-nutanix commented Jun 9, 2023 • edited Loading

manoj-nutanix commented Jun 9, 2023

Jont828 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jont828 commented Jun 9, 2023

Jont828 commented Jun 12, 2023

manoj-nutanix commented Jun 13, 2023 • edited Loading

Jont828 commented Jun 13, 2023

Jont828 commented Jun 13, 2023

k8s-ci-robot commented Jun 13, 2023

manoj-nutanix commented Jun 14, 2023

manoj-nutanix Jun 7, 2023 •

edited

Loading

manoj-nutanix commented Jun 9, 2023 •

edited

Loading

manoj-nutanix commented Jun 13, 2023 •

edited

Loading