Add registerAPIService option to external metrics feature to allow disabling external metrics endpoint registration #953

adel121 · 2023-10-19T15:34:44Z

What does this PR do?

This PR allows the user to enable creating an external metrics server while still disabling registering the external metrics server as an APIService.

It allows this by adding the option registerAPIService to the externalMetrics feature to allow the user to disable registering external-metrics server as an APIService

Motivation

This allows the user to use other external-metrics providers (such as KEDA) in the cluster, but also use the datadog cluster-agent as a metrics proxy to datadog.

Additional Notes

registerAPIService is defaulted to true in externalMetrics feature for backward compatibility. By default we register the endpoint if the user enables external metrics server.

Describe your test plan

We can test this by deploying the agent using the operator on a kind cluster locally.

Steps:

Build and deploy the operator as described here:
- Build the operator image make IMG=test/operator:test docker-build
- Load the image into kind : kind load docker-image test/operator:test
- Deploy the operator: make IMG=test/operator:test deploy
Deploy the agent and cluster agent as described here
- Instead of using the Datadog definition in examples/datadogagent/v2alpha1/min.yaml by the following definition

apiVersion: datadoghq.com/v2alpha1
kind: DatadogAgent
metadata:
  name: datadog
spec:
  features:
    externalMetricsServer:
      enabled: true
      useDatadogMetrics: false
      registerAPIService: true
  global:
    credentials:
      apiSecret:
        secretName: datadog-secret
        keyName: api-key
      appSecret:
        secretName: datadog-secret
        keyName: app-key
  override:
    clusterAgent:
      replicas: 2
    nodeAgent:
      tolerations:
        - operator: Exists

Check if the endpoint is registered or not by running kubectl get apiservices.apiregistration.k8s.io | grep external . It should produce an empty output if the endpoint is not registered. If it is registered, the output should show the endpoint name with status being True (Example: v1beta1.external.metrics.k8s.io system/datadog-cluster-agent-metrics-server True 12s )

Checklist

PR has at least one valid label: bug, enhancement, refactoring, documentation, tooling, and/or dependencies
PR has a milestone or the qa/skip-qa label

…user to disable external metrics registration

codecov-commenter · 2023-10-19T15:55:19Z

Codecov Report

Merging #953 (9bb568a) into main (00979d6) will increase coverage by 0.01%.
The diff coverage is 59.45%.

@@            Coverage Diff             @@
##             main     #953      +/-   ##
==========================================
+ Coverage   56.82%   56.83%   +0.01%     
==========================================
  Files         155      155              
  Lines       19279    19284       +5     
==========================================
+ Hits        10956    10961       +5     
  Misses       7675     7675              
  Partials      648      648

Flag	Coverage Δ
unittests	`56.83% <59.45%> (+0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
apis/datadoghq/v2alpha1/datadogagent_default.go	`87.42% <100.00%> (ø)`
apis/datadoghq/v2alpha1/datadogagent_types.go	`100.00% <ø> (ø)`
...rs/datadogagent/feature/externalmetrics/feature.go	`42.15% <58.33%> (+0.96%)`	⬆️

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 00979d6...9bb568a. Read the comment docs.

levan-m

Thanks for comprehensive test plan in PR description.

levan-m · 2023-10-19T18:45:10Z

controllers/datadogagent/feature/externalmetrics/feature_test.go

-			DDAv2:         newV2Agent(true, true, false, secretV2),
+			DDAv2:         newV2Agent(true, true, true, false, secretV2),
+			WantConfigure: true,
+			ClusterAgent:  testDCAResources(true, false, true),


This and next test pass different values for registerAPIService but make same assertions usingtestDCAResources(true, false, true) which means testDCAResources is probably not covering resources what's inside if f.registerAPIService {... Could you please fix that?

levan-m · 2023-10-19T18:46:43Z

apis/datadoghq/v2alpha1/datadogagent_types.go

@@ -535,6 +535,11 @@ type ExternalMetricsServerFeatureConfig struct {
 	// +optional
 	Enabled *bool `json:"enabled,omitempty"`

+	// RegisterAPIService registers the External Metrics endpoint as an APIService
+	// Default: true


Could you please add default value to datadogagent_default.go and set it in the same file, see this example.

levan-m · 2023-10-19T18:50:03Z

apis/datadoghq/v2alpha1/zz_generated.openapi.go

@@ -19,33 +19,33 @@ import (

 func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition {
 	return map[string]common.OpenAPIDefinition{
-		"./apis/datadoghq/v2alpha1.CSPMHostBenchmarksConfig":          schema__apis_datadoghq_v2alpha1_CSPMHostBenchmarksConfig(ref),


Could you check this please as well, diff shouldn't be this big. It also causes CI failure.

This file is automatically generated by running make generate manifests

For some reason, if $GOPATH is set, it results in a huge diff.

Setting $GOPATH to "/tmp" temporarily fixes the issue.

I am not sure why this is the case.

…e default value

levan-m · 2023-10-23T19:36:12Z

controllers/datadogagent/feature/externalmetrics/feature_test.go

+			Name:          "v2alpha1 external metrics enabled, secrets set, registerAPIService enabled",
+			DDAv2:         newV2Agent(true, true, true, false, secretV2),
+			WantConfigure: true,
+			WantDependenciesFunc: func(t testing.TB, store dependencies.StoreClient) {


Thanks for improving the test!

…sabling external metrics endpoint registration (#953) * Add registerEndpoint option to external metrics feature to allow the user to disable external metrics registration * generate manifests * Rename field to registerAPIService * fix generate manifests * Add defaultRegisterAPIService in datadogagent_default.go * Add unit tests for external metrics feature and for RegisterAPIService default value

Add registerEndpoint option to external metrics feature to allow the …

c48f013

…user to disable external metrics registration

adel121 added the enhancement New feature or request label Oct 19, 2023

adel121 added this to the v1.3.0 milestone Oct 19, 2023

adel121 requested review from a team as code owners October 19, 2023 15:34

github-actions bot approved these changes Oct 19, 2023

View reviewed changes

generate manifests

055e245

adel121 force-pushed the adelhajhassan/allow_disabling_external_metrics_endpoint_registration branch 2 times, most recently from cdd11ec to 88041cc Compare October 19, 2023 15:51

Rename field to registerAPIService

8d7661c

adel121 force-pushed the adelhajhassan/allow_disabling_external_metrics_endpoint_registration branch from 88041cc to 8d7661c Compare October 19, 2023 15:54

adel121 changed the title ~~Add registerEndpoint option to external metrics feature to allow disabling external metrics endpoint registration~~ Add registerAPIService option to external metrics feature to allow disabling external metrics endpoint registration Oct 19, 2023

aliciascott approved these changes Oct 19, 2023

View reviewed changes

levan-m reviewed Oct 19, 2023

View reviewed changes

adel121 added 3 commits October 20, 2023 11:28

fix generate manifests

2cc8617

Add defaultRegisterAPIService in datadogagent_default.go

3e74775

Add unit tests for external metrics feature and for RegisterAPIServic…

9bb568a

…e default value

adel121 requested a review from levan-m October 20, 2023 14:06

levan-m reviewed Oct 23, 2023

View reviewed changes

levan-m approved these changes Oct 23, 2023

View reviewed changes

adel121 merged commit 2e0fcc8 into main Oct 24, 2023
19 checks passed

adel121 deleted the adelhajhassan/allow_disabling_external_metrics_endpoint_registration branch October 24, 2023 08:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add registerAPIService option to external metrics feature to allow disabling external metrics endpoint registration #953

Add registerAPIService option to external metrics feature to allow disabling external metrics endpoint registration #953

adel121 commented Oct 19, 2023 •

edited

Loading

codecov-commenter commented Oct 19, 2023 •

edited

Loading

levan-m left a comment

levan-m Oct 19, 2023

levan-m Oct 19, 2023

levan-m Oct 19, 2023

adel121 Oct 20, 2023

levan-m Oct 23, 2023

Add registerAPIService option to external metrics feature to allow disabling external metrics endpoint registration #953

Add registerAPIService option to external metrics feature to allow disabling external metrics endpoint registration #953

Conversation

adel121 commented Oct 19, 2023 • edited Loading

What does this PR do?

Motivation

Additional Notes

Describe your test plan

Checklist

codecov-commenter commented Oct 19, 2023 • edited Loading

Codecov Report

levan-m left a comment

Choose a reason for hiding this comment

levan-m Oct 19, 2023

Choose a reason for hiding this comment

levan-m Oct 19, 2023

Choose a reason for hiding this comment

levan-m Oct 19, 2023

Choose a reason for hiding this comment

adel121 Oct 20, 2023

Choose a reason for hiding this comment

levan-m Oct 23, 2023

Choose a reason for hiding this comment

adel121 commented Oct 19, 2023 •

edited

Loading

codecov-commenter commented Oct 19, 2023 •

edited

Loading