Support for CacheCluster resource #137

cPu1 · 2024-06-28T13:48:33Z

Issue #, if available: aws-controllers-k8s/community#2079

Description of changes:

This changelist adds support for the ElastiCache CacheCluster resource. The generated code did not account for many fields in the call to ModifyCacheCluster, and the DescribeCacheClusters API does not return all fields in the spec and values for some fields are reported in the PendingModifiedValues field instead. To handle this, the last requested configuration for Spec.PreferredAvailabilityZones is stored as annotations and used to compute NewAvailabilityZones. Moreover, CacheNodeIdsToRemove is computed using Spec.NumCacheNodes and PendingModifiedValues.NumCacheNodes. Support for Spec.LogDeliveryConfigurations is explicitly removed and parked for later because the Describe API does not return all fields for this struct. There were many changes to other ElastiCache resources introduced in the newer SDK, so they have been removed for now and not ignored. As a result, a subsequent make build-controller will result in new changes.

The logic for syncing tags and comparing engine versions has been refactored to promote reusability.

Closes aws-controllers-k8s/community#2079.

Signed-off-by: cPu1 [email protected]

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

ack-prow · 2024-06-28T13:48:43Z

Hi @cPu1. Thanks for your PR.

I'm waiting for a aws-controllers-k8s 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.

a-hilaly · 2024-06-28T23:14:25Z

/ok-to-test

a-hilaly · 2024-07-08T21:24:06Z

/test all

a-hilaly

@cPu1 thank you so much! this is great. I left few comments in-line

a-hilaly · 2024-07-09T20:46:39Z

pkg/util/tags.go

We can import and reuse this for the other resource in a seperate PR

templates/hooks/cache_cluster/sdk_update_post_set_output.go.tpl

test/e2e/tests/test_cache_cluster.py

a-hilaly · 2024-07-09T21:08:07Z

test/e2e/tests/test_cache_cluster.py

nice testing

a-hilaly · 2024-07-09T21:09:25Z

pkg/util/engine_version.go

+	if len(parts) == 0 {
+		return major, minor, patch
+	}
+	major, _ = strconv.Atoi(parts[0])


need to handle the error here - if a user provides a completely wrong version we need to set the resource ona terminal condition stating that the engine version format is incorrect.

e.g https://github.com/aws-controllers-k8s/eks-controller/blob/78062e26cdc53435c0dae3913d959be6514d0f5f/pkg/resource/cluster/hook.go#L329

This wasn't introduced in this PR, the function was merely moved from pkg/resource/replication_group/delta_util.go. I did notice this but refactoring ReplicationGroup was out of scope for this PR, and this is only used for the delta comparison so the controller will still set the resource in a terminal condition after receiving one of the configured terminal error codes from the API. If we do add this validation, we'll have to do this for both create and update.

a-hilaly · 2024-07-09T21:13:47Z

pkg/util/engine_version.go

+			patch, _ = strconv.Atoi(parts[2])
+		}
+	}
+	return major, minor, patch


looks like the patch variable is never used

This function was also moved from pkg/resource/replication_group/delta_util.go.

a-hilaly · 2024-07-09T21:14:32Z

pkg/util/engine_version.go

+
+	// if the last character of desiredEV is "x" or the major version is higher than 5, ignore patch version when comparing.
+	// See https://github.com/aws-controllers-k8s/community/issues/1737
+	if dMaj > 5 || desiredEV[last:] == "x" {


qq: why 5? what if a user provides 4.x

This was also moved from pkg/resource/replication_group/delta_util.go. The reason is mentioned in this PR: #115.

The purpose of this changes is to avoid the controller to compare patch versions when Redis version is >=6, since It's managed by AWS. More details aws-controllers-k8s/community#1737.

a-hilaly · 2024-07-09T21:39:55Z

pkg/resource/cache_cluster/hooks.go

+		return diff.Path.Contains("Spec.PreferredAvailabilityZones")
+	}); idx != -1 && desired.ko.Spec.PreferredAvailabilityZones != nil {
+		if nodesDelta >= 0 {
+			return errors.New("spec.preferredAvailabilityZones can only be changed when new nodes are being added via spec.numCacheNodes")


do you want to make those terminal errors?

It's a terminal error. Any error returned from this function is treated as a terminal error.

a-hilaly · 2024-07-09T21:40:00Z

pkg/resource/cache_cluster/hooks.go

+			oldAZsLen = len(oldValues)
+		}
+		if len(desiredSpec.PreferredAvailabilityZones) <= oldAZsLen {
+			return errors.New("newly specified AZs in spec.preferredAvailabilityZones must match the number of cache nodes being added")


Same as above. It's a terminal error. Any error returned from this function is treated as a terminal error.

a-hilaly · 2024-07-09T21:40:59Z

pkg/resource/cache_cluster/hooks.go

+		if nodesDelta > 0 {
+			for i := numNodes; i > numNodes-nodesDelta; i-- {
+				nodeID := fmt.Sprintf("%04d", i)
+				input.CacheNodeIdsToRemove = append(input.CacheNodeIdsToRemove, &nodeID)


This is a very weird API...

This changelist adds support for the ElastiCache `CacheCluster` resource. The generated code did not account for many fields in the call to `ModifyCacheCluster`, and the `DescribeCacheClusters` API does not return all fields in the spec and values for some fields are reported in the `PendingModifiedValues` field instead. To handle this, the last requested configuration for `Spec.PreferredAvailabilityZones` is stored as annotations and used to compute `NewAvailabilityZones`. Moreover, `CacheNodeIdsToRemove` is computed using `Spec.NumCacheNodes` and `PendingModifiedValues.NumCacheNodes`. Support for `Spec.LogDeliveryConfigurations` is explicitly removed and parked for later because the Describe API does not return all fields for this struct. There were many changes to other ElastiCache resources introduced in the newer SDK, so they have been removed for now and not ignored. As a result, a subsequent `make build-controller` will result in new changes. The logic for syncing tags and comparing engine versions has been refactored to promote reusability. Closes aws-controllers-k8s/community#2079. Signed-off-by: cPu1 <[email protected]>

a-hilaly

Thank you @cPu1 ! 👍
/lgtm

ack-prow · 2024-07-11T17:13:58Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: a-hilaly, cPu1

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~~ [a-hilaly]

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

ack-prow bot requested review from a-hilaly and nmvk June 28, 2024 13:48

ack-prow bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 28, 2024

cPu1 force-pushed the resource/cachecluster branch from 69ddd82 to 044877e Compare June 28, 2024 14:35

ack-prow bot 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 28, 2024

a-hilaly reviewed Jul 9, 2024

View reviewed changes

cPu1 force-pushed the resource/cachecluster branch from 044877e to 267cea8 Compare July 10, 2024 09:14

cPu1 force-pushed the resource/cachecluster branch from 267cea8 to e057eb4 Compare July 10, 2024 10:16

a-hilaly approved these changes Jul 11, 2024

View reviewed changes

ack-prow bot assigned a-hilaly Jul 11, 2024

ack-prow bot added the lgtm Indicates that a PR is ready to be merged. label Jul 11, 2024

ack-prow bot added the approved label Jul 11, 2024

ack-prow bot merged commit 6e60bb7 into aws-controllers-k8s:main Jul 11, 2024
6 checks passed

cPu1 mentioned this pull request Jul 12, 2024

Ignore fields added in the new SDK version #141

Open

rahtr mentioned this pull request Aug 21, 2024

Validation to ensure that the CRD exists – Handling the non-existent CRD scenario. aws-controllers-k8s/community#2141

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for CacheCluster resource #137

Support for CacheCluster resource #137

cPu1 commented Jun 28, 2024

ack-prow bot commented Jun 28, 2024

a-hilaly commented Jun 28, 2024

a-hilaly commented Jul 8, 2024

a-hilaly left a comment

a-hilaly Jul 9, 2024

a-hilaly Jul 9, 2024

a-hilaly Jul 9, 2024

a-hilaly Jul 9, 2024

cPu1 Jul 10, 2024 •

edited

Loading

a-hilaly Jul 9, 2024

cPu1 Jul 10, 2024

a-hilaly Jul 9, 2024

cPu1 Jul 10, 2024

a-hilaly Jul 9, 2024

cPu1 Jul 10, 2024

a-hilaly Jul 9, 2024

cPu1 Jul 10, 2024

a-hilaly Jul 9, 2024

a-hilaly left a comment

ack-prow bot commented Jul 11, 2024

Support for CacheCluster resource #137

Support for CacheCluster resource #137

Conversation

cPu1 commented Jun 28, 2024

ack-prow bot commented Jun 28, 2024

a-hilaly commented Jun 28, 2024

a-hilaly commented Jul 8, 2024

a-hilaly 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

cPu1 Jul 10, 2024 • 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

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

a-hilaly left a comment

Choose a reason for hiding this comment

ack-prow bot commented Jul 11, 2024

cPu1 Jul 10, 2024 •

edited

Loading