Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
418 changes: 209 additions & 209 deletions apis/datadoghq/v1alpha1/zz_generated.openapi.go

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions apis/datadoghq/v2alpha1/datadogagent_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -535,6 +535,11 @@ type ExternalMetricsServerFeatureConfig struct {
// +optional
Enabled *bool `json:"enabled,omitempty"`

// RegisterAPIService registers the External Metrics endpoint as an APIService
// Default: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

// +optional
RegisterAPIService *bool `json:"registerAPIService,omitempty"`

// WPAController enables the informer and controller of the Watermark Pod Autoscaler.
// NOTE: The Watermark Pod Autoscaler controller needs to be installed.
// See also: https://github.com/DataDog/watermarkpodautoscaler.
Expand Down
5 changes: 5 additions & 0 deletions apis/datadoghq/v2alpha1/zz_generated.deepcopy.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

182 changes: 91 additions & 91 deletions apis/datadoghq/v2alpha1/zz_generated.openapi.go

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions config/crd/bases/v1/datadoghq.com_datadogagents.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8112,6 +8112,9 @@ spec:
description: 'Port specifies the metricsProvider External Metrics Server service port. Default: 8443'
format: int32
type: integer
registerAPIService:
description: 'RegisterAPIService registers the External Metrics endpoint as an APIService Default: true'
type: boolean
useDatadogMetrics:
description: 'UseDatadogMetrics enables usage of the DatadogMetrics CRD (allowing one to scale on arbitrary Datadog metric queries). Default: true'
type: boolean
Expand Down
3 changes: 3 additions & 0 deletions config/crd/bases/v1beta1/datadoghq.com_datadogagents.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15662,6 +15662,9 @@ spec:
description: 'Port specifies the metricsProvider External Metrics Server service port. Default: 8443'
format: int32
type: integer
registerAPIService:
description: 'RegisterAPIService registers the External Metrics endpoint as an APIService Default: true'
type: boolean
useDatadogMetrics:
description: 'UseDatadogMetrics enables usage of the DatadogMetrics CRD (allowing one to scale on arbitrary Datadog metric queries). Default: true'
type: boolean
Expand Down
72 changes: 39 additions & 33 deletions controllers/datadogagent/feature/externalmetrics/feature.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ type externalMetricsFeature struct {

createKubernetesNetworkPolicy bool
createCiliumNetworkPolicy bool
registerAPIService bool
}

type secret struct {
Expand All @@ -76,6 +77,9 @@ func (f *externalMetricsFeature) Configure(dda *v2alpha1.DatadogAgent) (reqComp
em := dda.Spec.Features.ExternalMetricsServer

if em != nil && apiutils.BoolValue(em.Enabled) {
// By default, we register the external metrics endpoint
f.registerAPIService = em.RegisterAPIService == nil || apiutils.BoolValue(em.RegisterAPIService)

f.useWPA = apiutils.BoolValue(em.WPAController)
f.useDDM = apiutils.BoolValue(em.UseDatadogMetrics)
f.port = *em.Port
Expand Down Expand Up @@ -230,44 +234,46 @@ func (f *externalMetricsFeature) ManageDependencies(managers feature.ResourceMan
return fmt.Errorf("error adding external metrics provider service to store: %w", err)
}

// apiservice
apiServiceSpec := apiregistrationv1.APIServiceSpec{
Service: &apiregistrationv1.ServiceReference{
Name: serviceName,
Namespace: ns,
Port: &f.port,
},
Version: "v1beta1",
InsecureSkipTLSVerify: true,
Group: rbac.ExternalMetricsAPIGroup,
GroupPriorityMinimum: 100,
VersionPriority: 100,
}
if err := managers.APIServiceManager().AddAPIService(componentdca.GetMetricsServerAPIServiceName(), ns, apiServiceSpec); err != nil {
return fmt.Errorf("error adding external metrics provider apiservice to store: %w", err)
}
if f.registerAPIService {
// apiservice
apiServiceSpec := apiregistrationv1.APIServiceSpec{
Service: &apiregistrationv1.ServiceReference{
Name: serviceName,
Namespace: ns,
Port: &f.port,
},
Version: "v1beta1",
InsecureSkipTLSVerify: true,
Group: rbac.ExternalMetricsAPIGroup,
GroupPriorityMinimum: 100,
VersionPriority: 100,
}
if err := managers.APIServiceManager().AddAPIService(componentdca.GetMetricsServerAPIServiceName(), ns, apiServiceSpec); err != nil {
return fmt.Errorf("error adding external metrics provider apiservice to store: %w", err)
}

// credential secret
if len(f.keySecret) != 0 {
for idx, s := range f.keySecret {
if len(s.data) != 0 {
if err := managers.SecretManager().AddSecret(ns, componentdca.GetDefaultExternalMetricSecretName(f.owner), idx, string(s.data)); err != nil {
return fmt.Errorf("error adding external metrics provider credentials secret to store: %w", err)
// credential secret
if len(f.keySecret) != 0 {
for idx, s := range f.keySecret {
if len(s.data) != 0 {
if err := managers.SecretManager().AddSecret(ns, componentdca.GetDefaultExternalMetricSecretName(f.owner), idx, string(s.data)); err != nil {
return fmt.Errorf("error adding external metrics provider credentials secret to store: %w", err)
}
}
}
}
}

// rbac
rbacResourcesName := componentdca.GetClusterAgentRbacResourcesName(f.owner)
if err := managers.RBACManager().AddClusterPolicyRules(ns, rbacResourcesName, f.serviceAccountName, getDCAClusterPolicyRules(f.useDDM, f.useWPA)); err != nil {
return fmt.Errorf("error adding external metrics provider dca clusterrole and clusterrolebinding to store: %w", err)
}
if err := managers.RBACManager().AddClusterPolicyRules("kube-system", componentdca.GetExternalMetricsReaderClusterRoleName(f.owner, managers.Store().GetVersionInfo()), "horizontal-pod-autoscaler", getExternalMetricsReaderPolicyRules()); err != nil {
return fmt.Errorf("error adding external metrics provider external metrics reader clusterrole and clusterrolebinding to store: %w", err)
}
if err := managers.RBACManager().AddClusterRoleBinding(ns, componentdca.GetHPAClusterRoleBindingName(f.owner), f.serviceAccountName, getAuthDelegatorRoleRef()); err != nil {
return fmt.Errorf("error adding external metrics provider auth delegator clusterrolebinding to store: %w", err)
// rbac
rbacResourcesName := componentdca.GetClusterAgentRbacResourcesName(f.owner)
if err := managers.RBACManager().AddClusterPolicyRules(ns, rbacResourcesName, f.serviceAccountName, getDCAClusterPolicyRules(f.useDDM, f.useWPA)); err != nil {
return fmt.Errorf("error adding external metrics provider dca clusterrole and clusterrolebinding to store: %w", err)
}
if err := managers.RBACManager().AddClusterPolicyRules("kube-system", componentdca.GetExternalMetricsReaderClusterRoleName(f.owner, managers.Store().GetVersionInfo()), "horizontal-pod-autoscaler", getExternalMetricsReaderPolicyRules()); err != nil {
return fmt.Errorf("error adding external metrics provider external metrics reader clusterrole and clusterrolebinding to store: %w", err)
}
if err := managers.RBACManager().AddClusterRoleBinding(ns, componentdca.GetHPAClusterRoleBindingName(f.owner), f.serviceAccountName, getAuthDelegatorRoleRef()); err != nil {
return fmt.Errorf("error adding external metrics provider auth delegator clusterrolebinding to store: %w", err)
}
}

// network policies
Expand Down
27 changes: 17 additions & 10 deletions controllers/datadogagent/feature/externalmetrics/feature_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -85,30 +85,36 @@ func TestExternalMetricsFeature(t *testing.T) {
//////////////////////////
{
Name: "v2alpha1 external metrics not enabled",
DDAv2: newV2Agent(false, false, false, v2alpha1.DatadogCredentials{}),
DDAv2: newV2Agent(false, true, false, false, v2alpha1.DatadogCredentials{}),
WantConfigure: false,
},
{
Name: "v2alpha1 external metrics enabled",
DDAv2: newV2Agent(true, true, false, v2alpha1.DatadogCredentials{}),
DDAv2: newV2Agent(true, true, true, false, v2alpha1.DatadogCredentials{}),
WantConfigure: true,
ClusterAgent: testDCAResources(true, false, false),
},
{
Name: "v2alpha1 external metrics enabled, wpa controller enabled",
DDAv2: newV2Agent(true, true, true, v2alpha1.DatadogCredentials{}),
DDAv2: newV2Agent(true, true, true, true, v2alpha1.DatadogCredentials{}),
WantConfigure: true,
ClusterAgent: testDCAResources(true, true, false),
},
{
Name: "v2alpha1 external metrics enabled, ddm disabled",
DDAv2: newV2Agent(true, false, false, v2alpha1.DatadogCredentials{}),
DDAv2: newV2Agent(true, true, false, false, v2alpha1.DatadogCredentials{}),
WantConfigure: true,
ClusterAgent: testDCAResources(false, false, false),
},
{
Name: "v2alpha1 external metrics enabled, secrets set",
DDAv2: newV2Agent(true, true, false, secretV2),
DDAv2: newV2Agent(true, true, true, false, secretV2),
WantConfigure: true,
ClusterAgent: testDCAResources(true, false, true),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

},
{
Name: "v2alpha1 external metrics enabled, secrets set, registerAPIService disabled",
DDAv2: newV2Agent(true, false, true, false, secretV2),
WantConfigure: true,
ClusterAgent: testDCAResources(true, false, true),
},
Expand All @@ -135,15 +141,16 @@ func TestExternalMetricsFeature(t *testing.T) {
// }
// }

func newV2Agent(enabled, useDDM, wpaController bool, secret v2alpha1.DatadogCredentials) *v2alpha1.DatadogAgent {
func newV2Agent(enabled, registerAPIService, useDDM, wpaController bool, secret v2alpha1.DatadogCredentials) *v2alpha1.DatadogAgent {
return &v2alpha1.DatadogAgent{
Spec: v2alpha1.DatadogAgentSpec{
Features: &v2alpha1.DatadogFeatures{
ExternalMetricsServer: &v2alpha1.ExternalMetricsServerFeatureConfig{
Enabled: apiutils.NewBoolPointer(enabled),
WPAController: apiutils.NewBoolPointer(wpaController),
UseDatadogMetrics: apiutils.NewBoolPointer(useDDM),
Port: apiutils.NewInt32Pointer(8443),
Enabled: apiutils.NewBoolPointer(enabled),
RegisterAPIService: apiutils.NewBoolPointer(registerAPIService),
WPAController: apiutils.NewBoolPointer(wpaController),
UseDatadogMetrics: apiutils.NewBoolPointer(useDDM),
Port: apiutils.NewInt32Pointer(8443),
Endpoint: &v2alpha1.Endpoint{
Credentials: &secret,
},
Expand Down
1 change: 1 addition & 0 deletions docs/configuration.v2alpha1.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ spec:
| features.externalMetricsServer.endpoint.credentials.appSecret.secretName | SecretName is the name of the secret. |
| features.externalMetricsServer.endpoint.url | URL defines the endpoint URL. |
| features.externalMetricsServer.port | Port specifies the metricsProvider External Metrics Server service port. Default: 8443 |
| features.externalMetricsServer.registerAPIService | RegisterAPIService registers the External Metrics endpoint as an APIService Default: true |
| features.externalMetricsServer.useDatadogMetrics | UseDatadogMetrics enables usage of the DatadogMetrics CRD (allowing one to scale on arbitrary Datadog metric queries). Default: true |
| features.externalMetricsServer.wpaController | WPAController enables the informer and controller of the Watermark Pod Autoscaler. NOTE: The Watermark Pod Autoscaler controller needs to be installed. See also: https://github.com/DataDog/watermarkpodautoscaler. Default: false |
| features.kubeStateMetricsCore.conf.configData | ConfigData corresponds to the configuration file content. |
Expand Down
Loading