Add support for HPA Container Resource metrics #1647

arybolovlev · 2022-03-16T15:55:44Z

Description

This PR adds support for HPA Container Resource metrics. More details in Kubernetes documentation.

Acceptance tests

Have you added an acceptance test for the functionality being added?
Have you run the acceptance tests on this branch?

Output from acceptance testing:

$ make testacc TESTARGS='-run ^TestAccKubernetesHorizontalPodAutoscalerV2Beta2*'

=== RUN   TestAccKubernetesHorizontalPodAutoscalerV2Beta2_basic
--- PASS: TestAccKubernetesHorizontalPodAutoscalerV2Beta2_basic (12.44s)
=== RUN   TestAccKubernetesHorizontalPodAutoscalerV2Beta2_containerResource
--- PASS: TestAccKubernetesHorizontalPodAutoscalerV2Beta2_containerResource (5.79s)
PASS
ok  	github.com/hashicorp/terraform-provider-kubernetes/kubernetes	18.748s

Release Note

Release note for CHANGELOG:

Add a new metric type `container_resource` in resource `kubernetes_horizontal_pod_autoscaler_v2beta2`.

References

#1637

Community Note

Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
If you are interested in working on this issue or have submitted a pull request, please leave a comment

…izontal_pod_autoscaler_v2beta2.

jrhouston · 2022-03-21T17:58:27Z

kubernetes/resource_kubernetes_horizontal_pod_autoscaler_v2beta2.go

@@ -53,6 +53,7 @@ func resourceKubernetesHorizontalPodAutoscalerV2Beta2() *schema.Resource {
 						"behavior": {
 							Type:        schema.TypeList,
 							Description: "Behavior configures the scaling behavior of the target in both Up and Down directions (scale_up and scale_down fields respectively).",
+							Computed:    true,


How come this needs to be computed?

While I was working on this PR I noticed that terraform apply constantly produces a plan with changes related to the behavior attribute. Kubernetes uses default HPA Scaling rules if they are not set and the default values of these rules are part of the API response. That updates the state file with the behavior attribute after applying and causes the attribute deletion during the next plan.

Kubernetes documentation link: behavior ... If not set, the default HPAScalingRules for scale up and scale down are used.

You are right, it doesn't relate to the aim of this PR and shouldn't be here. Removed, thank you!

jrhouston

Good work @arybolovlev, just a couple of things.

jrhouston · 2022-03-25T15:29:22Z

kubernetes/schema_horizontal_pod_autoscaler.go

@@ -194,7 +225,7 @@ func metricSpecFields() *schema.Resource {
 			"type": {
 				Type:        schema.TypeString,
 				Required:    true,
-				Description: `type is the type of metric source. It should be one of "Object", "Pods", "External" or "Resource", each mapping to a matching field in the object.`,
+				Description: `type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled`,


Let's add validation to this attribute to check that it's one of the values documented here. You can use validation.StringInSlice

Thanks, @jrhouston! Since the current K8s API library supports only autoscaling/v2beta2, I have added it as it is. Once we bump up the version and autoscaling/v2 becomes available, I will update the code.

jrhouston · 2022-03-25T15:38:22Z

kubernetes/resource_kubernetes_horizontal_pod_autoscaler_v2beta2_test.go

@@ -129,6 +129,48 @@ func TestAccKubernetesHorizontalPodAutoscalerV2Beta2_basic(t *testing.T) {
 	})
 }

+func TestAccKubernetesHorizontalPodAutoscalerV2Beta2_containerResource(t *testing.T) {


This test will fail on clusters where the HPAContainerMetrics feature gate is not enabled. Right now there isn't a reliable way to check if a feature gate has been enabled programmatically. You have to check the --feature-gates args supplied to the apiserver, which we can't even do on EKS, GKE, et al.

For the moment I would add a t.Skip() to this test with a message explaining this. We can remove when the feature gate becomes defaulted to true.

I have added ErrorCheck with t.Skip(). In this case, the step will be executed and skipped only if it fails.

github-actions · 2022-04-30T02:33:07Z

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

Aleksandr Rybolovlev added 2 commits March 16, 2022 15:31

Add a new metric type 'container_resource' in resource kubernetes_hor…

2cab8a0

…izontal_pod_autoscaler_v2beta2.

Add acceptance test.

8db3e2f

github-actions bot added documentation size/L labels Mar 16, 2022

Update HPA documentation with a new attribute.

18df103

arybolovlev force-pushed the add-hpa-container-resource branch from 14e2169 to 18df103 Compare March 18, 2022 11:30

arybolovlev marked this pull request as ready for review March 18, 2022 11:44

jrhouston reviewed Mar 21, 2022

View reviewed changes

Remove 'Computed' from the attribute 'behavior'

4403469

arybolovlev requested a review from jrhouston March 25, 2022 15:03

jrhouston changed the title ~~Add support for HPA Container Resource metics~~ Add support for HPA Container Resource metrics Mar 25, 2022

jrhouston requested changes Mar 25, 2022

View reviewed changes

Aleksandr Rybolovlev added 2 commits March 28, 2022 12:55

Add HPA metric type validation

895be0d

Add error check for HPAContainerMetrics acceptance test

ecb7e46

arybolovlev requested a review from jrhouston March 28, 2022 11:59

jrhouston approved these changes Mar 30, 2022

View reviewed changes

arybolovlev linked an issue Mar 30, 2022 that may be closed by this pull request

kubernetes_horizontal_pod_autoscaler_v2beta2: containerResource not support #1637

Closed

arybolovlev merged commit bd0f076 into main Mar 30, 2022

arybolovlev deleted the add-hpa-container-resource branch March 30, 2022 15:01

github-actions bot locked as resolved and limited conversation to collaborators Apr 30, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for HPA Container Resource metrics #1647

Add support for HPA Container Resource metrics #1647

arybolovlev commented Mar 16, 2022 •

edited by jrhouston

jrhouston Mar 21, 2022

arybolovlev Mar 22, 2022

jrhouston left a comment

jrhouston Mar 25, 2022

arybolovlev Mar 28, 2022

jrhouston Mar 25, 2022 •

edited

arybolovlev Mar 28, 2022

github-actions bot commented Apr 30, 2022

Add support for HPA Container Resource metrics #1647

Add support for HPA Container Resource metrics #1647

Conversation

arybolovlev commented Mar 16, 2022 • edited by jrhouston

Description

Acceptance tests

Release Note

References

Community Note

jrhouston Mar 21, 2022

Choose a reason for hiding this comment

arybolovlev Mar 22, 2022

Choose a reason for hiding this comment

jrhouston left a comment

Choose a reason for hiding this comment

jrhouston Mar 25, 2022

Choose a reason for hiding this comment

arybolovlev Mar 28, 2022

Choose a reason for hiding this comment

jrhouston Mar 25, 2022 • edited

Choose a reason for hiding this comment

arybolovlev Mar 28, 2022

Choose a reason for hiding this comment

github-actions bot commented Apr 30, 2022

arybolovlev commented Mar 16, 2022 •

edited by jrhouston

jrhouston Mar 25, 2022 •

edited