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.

Sign up for GitHub

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

Jump to bottom

Implements automatic-kubernetes-api-monitoring-cluster-name feature flag #797

Merged
merged 6 commits into from
May 25, 2022
Merged

Implements automatic-kubernetes-api-monitoring-cluster-name feature flag #797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e45d53d
Implements `automatic-kubernetes-api-monitoring-cluster-label` ff
mjgrzybek May 24, 2022
268acb9
`createFakeClientAndReconcile` -> `createFakeClientAndReconciler`
mjgrzybek May 24, 2022
a72df00
Fix code smell
mjgrzybek May 24, 2022
bddd7ac
Rename annotation - `...-cluster-label` -> `...-cluster-name`
mjgrzybek May 25, 2022
b56d666
Simplified if condition
mjgrzybek May 25, 2022
81ace47
Check if mock client was called; fix token scopes
mjgrzybek May 25, 2022
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
22 changes: 14 additions & 8 deletions src/api/v1beta1/feature_flags.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,14 @@ const (
AnnotationFeaturePrefix = "feature.dynatrace.com/"

// activeGate
AnnotationFeatureDisableActiveGateUpdates = AnnotationFeaturePrefix + "disable-activegate-updates"
AnnotationFeatureDisableActiveGateRawImage = AnnotationFeaturePrefix + "disable-activegate-raw-image"
AnnotationFeatureActiveGateAppArmor = AnnotationFeaturePrefix + "activegate-apparmor"
AnnotationFeatureActiveGateReadOnlyFilesystem = AnnotationFeaturePrefix + "activegate-readonly-fs"
AnnotationFeatureAutomaticKubernetesApiMonitoring = AnnotationFeaturePrefix + "automatic-kubernetes-api-monitoring"
AnnotationFeatureActiveGateIgnoreProxy = AnnotationFeaturePrefix + "activegate-ignore-proxy"
AnnotationFeatureActiveGateAuthToken = AnnotationFeaturePrefix + "enable-activegate-authtoken"
AnnotationFeatureDisableActiveGateUpdates = AnnotationFeaturePrefix + "disable-activegate-updates"
AnnotationFeatureDisableActiveGateRawImage = AnnotationFeaturePrefix + "disable-activegate-raw-image"
AnnotationFeatureActiveGateAppArmor = AnnotationFeaturePrefix + "activegate-apparmor"
AnnotationFeatureActiveGateReadOnlyFilesystem = AnnotationFeaturePrefix + "activegate-readonly-fs"
AnnotationFeatureAutomaticK8sApiMonitoring = AnnotationFeaturePrefix + "automatic-kubernetes-api-monitoring"
AnnotationFeatureAutomaticK8sApiMonitoringClusterName = AnnotationFeaturePrefix + "automatic-kubernetes-api-monitoring-cluster-name"
AnnotationFeatureActiveGateIgnoreProxy = AnnotationFeaturePrefix + "activegate-ignore-proxy"
AnnotationFeatureActiveGateAuthToken = AnnotationFeaturePrefix + "enable-activegate-authtoken"

// statsD
AnnotationFeatureUseActiveGateImageForStatsd = AnnotationFeaturePrefix + "use-activegate-image-for-statsd"
Expand Down Expand Up @@ -130,7 +131,12 @@ func (dk *DynaKube) getDefaultIgnoredNamespaces() []string {
// FeatureAutomaticKubernetesApiMonitoring is a feature flag to enable automatic kubernetes api monitoring,
// which ensures that settings for this kubernetes cluster exist in Dynatrace
func (dk *DynaKube) FeatureAutomaticKubernetesApiMonitoring() bool {
return dk.getFeatureFlagRaw(AnnotationFeatureAutomaticKubernetesApiMonitoring) == "true"
return dk.getFeatureFlagRaw(AnnotationFeatureAutomaticK8sApiMonitoring) == "true"
}

// FeatureAutomaticKubernetesApiMonitoringClusterName is a feature flag to set custom cluster name for automatic-kubernetes-api-monitoring
func (dk *DynaKube) FeatureAutomaticKubernetesApiMonitoringClusterName() string {
return dk.getFeatureFlagRaw(AnnotationFeatureAutomaticK8sApiMonitoringClusterName)
}

// FeatureDisableMetadataEnrichment is a feature flag to disable metadata enrichment,
Expand Down
12 changes: 6 additions & 6 deletions src/controllers/activegate/reconciler/automaticapimonitoring/reconciler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ import (

type AutomaticApiMonitoringReconciler struct {
dtc dtclient.Client
name string
clusterLabel string
chrismuellner marked this conversation as resolved.
Show resolved Hide resolved
kubeSystemUUID string
}

func NewReconciler(dtc dtclient.Client, name, kubeSystemUUID string) *AutomaticApiMonitoringReconciler {
func NewReconciler(dtc dtclient.Client, clusterLabel, kubeSystemUUID string) *AutomaticApiMonitoringReconciler {
return &AutomaticApiMonitoringReconciler{
dtc,
name,
clusterLabel,
kubeSystemUUID,
}
}
Expand All @@ -29,9 +29,9 @@ func (r *AutomaticApiMonitoringReconciler) Reconcile() error {
}

if objectID != "" {
log.Info("created kubernetes cluster setting", "name", r.name, "cluster", r.kubeSystemUUID, "object id", objectID)
log.Info("created kubernetes cluster setting", "clusterLabel", r.clusterLabel, "cluster", r.kubeSystemUUID, "object id", objectID)
} else {
log.Info("kubernetes cluster setting already exists", "name", r.name, "cluster", r.kubeSystemUUID)
log.Info("kubernetes cluster setting already exists", "clusterLabel", r.clusterLabel, "cluster", r.kubeSystemUUID)
}

return nil
Expand Down Expand Up @@ -60,7 +60,7 @@ func (r *AutomaticApiMonitoringReconciler) ensureSettingExists() (string, error)

// determine newest ME (can be empty string), and create or update a settings object accordingly
meID := determineNewestMonitoredEntity(monitoredEntities)
objectID, err := r.dtc.CreateOrUpdateKubernetesSetting(r.name, r.kubeSystemUUID, meID)
objectID, err := r.dtc.CreateOrUpdateKubernetesSetting(r.clusterLabel, r.kubeSystemUUID, meID)

if err != nil {
return "", err
Expand Down
2 changes: 1 addition & 1 deletion src/controllers/activegate/reconciler/automaticapimonitoring/reconciler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import (

const (
testUID = "test-uid"
testName = "test-name"
testName = "test-clusterLabel"
testObjectID = "test-objectid"
)

Expand Down
2 changes: 1 addition & 1 deletion src/controllers/dynakube/dtclient_reconciler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ func TestReconcileDynatraceClient_TokenValidation(t *testing.T) {
t.Run("API token has missing scope for automatic kubernetes api monitoring", func(t *testing.T) {
dk := base.DeepCopy()
dk.Annotations = map[string]string{
dynatracev1beta1.AnnotationFeatureAutomaticKubernetesApiMonitoring: "true",
dynatracev1beta1.AnnotationFeatureAutomaticK8sApiMonitoring: "true",
}
dk.Spec.ActiveGate = dynatracev1beta1.ActiveGateSpec{
Capabilities: []dynatracev1beta1.CapabilityDisplayName{dynatracev1beta1.KubeMonCapability.DisplayName},
Expand Down
8 changes: 7 additions & 1 deletion src/controllers/dynakube/dynakube_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,13 @@ func (controller *DynakubeController) reconcileActiveGateCapabilities(dynakubeSt
if dynakubeState.Instance.Status.KubeSystemUUID != "" &&
dynakubeState.Instance.FeatureAutomaticKubernetesApiMonitoring() &&
dynakubeState.Instance.KubernetesMonitoringMode() {
err := automaticapimonitoring.NewReconciler(dtc, dynakubeState.Instance.Name, dynakubeState.Instance.Status.KubeSystemUUID).

clusterLabel := dynakubeState.Instance.FeatureAutomaticKubernetesApiMonitoringClusterName()
chrismuellner marked this conversation as resolved.
Show resolved Hide resolved
if clusterLabel == "" {
clusterLabel = dynakubeState.Instance.Name
}

err := automaticapimonitoring.NewReconciler(dtc, clusterLabel, dynakubeState.Instance.Status.KubeSystemUUID).
Reconcile()
if err != nil {
log.Error(err, "could not create setting")
Expand Down
70 changes: 57 additions & 13 deletions src/controllers/dynakube/dynakube_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ func TestMonitoringModesDynakube_Reconcile(t *testing.T) {
OneAgent: deploymentModes[mode],
},
}
controller := createFakeClientAndReconcile(mockClient, instance, testPaasToken, testAPIToken)
controller := createFakeClientAndReconciler(mockClient, instance, testPaasToken, testAPIToken)

result, err := controller.Reconcile(context.TODO(), reconcile.Request{
NamespacedName: types.NamespacedName{Namespace: testNamespace, Name: testName},
Expand Down Expand Up @@ -107,7 +107,7 @@ func TestReconcileActiveGate_Reconcile(t *testing.T) {
Name: testName,
Namespace: testNamespace,
}}
controller := createFakeClientAndReconcile(mockClient, instance, testPaasToken, testAPIToken)
controller := createFakeClientAndReconciler(mockClient, instance, testPaasToken, testAPIToken)

result, err := controller.Reconcile(context.TODO(), reconcile.Request{
NamespacedName: types.NamespacedName{Namespace: testNamespace, Name: testName},
Expand All @@ -128,7 +128,7 @@ func TestReconcileActiveGate_Reconcile(t *testing.T) {
KubernetesMonitoring: dynatracev1beta1.KubernetesMonitoringSpec{
Enabled: true,
}}}
controller := createFakeClientAndReconcile(mockClient, instance, testPaasToken, testAPIToken)
controller := createFakeClientAndReconciler(mockClient, instance, testPaasToken, testAPIToken)

result, err := controller.Reconcile(context.TODO(), reconcile.Request{
NamespacedName: types.NamespacedName{Namespace: testNamespace, Name: testName},
Expand All @@ -148,13 +148,13 @@ func TestReconcileActiveGate_Reconcile(t *testing.T) {
})
t.Run(`Reconcile reconciles automatic kubernetes api monitoring`, func(t *testing.T) {
mockClient := createDTMockClient(dtclient.TokenScopes{dtclient.TokenScopeInstallerDownload},
dtclient.TokenScopes{dtclient.TokenScopeDataExport})
dtclient.TokenScopes{dtclient.TokenScopeDataExport, dtclient.TokenScopeEntitiesRead, dtclient.TokenScopeSettingsRead, dtclient.TokenScopeSettingsWrite})
instance := &dynatracev1beta1.DynaKube{
ObjectMeta: metav1.ObjectMeta{
Name: testName,
Namespace: testNamespace,
Annotations: map[string]string{
dynatracev1beta1.AnnotationFeatureAutomaticKubernetesApiMonitoring: "true",
dynatracev1beta1.AnnotationFeatureAutomaticK8sApiMonitoring: "true",
},
},
Spec: dynatracev1beta1.DynaKubeSpec{
Expand All @@ -164,14 +164,58 @@ func TestReconcileActiveGate_Reconcile(t *testing.T) {
},
},
}}
controller := createFakeClientAndReconcile(mockClient, instance, testPaasToken, testAPIToken)
controller := createFakeClientAndReconciler(mockClient, instance, testPaasToken, testAPIToken)

result, err := controller.Reconcile(context.TODO(), reconcile.Request{
NamespacedName: types.NamespacedName{Namespace: testNamespace, Name: testName},
})

mockClient.AssertCalled(t, "CreateOrUpdateKubernetesSetting",
testName,
testUID,
mock.AnythingOfType("string"))
assert.NoError(t, err)
assert.NotNil(t, result)
assert.Equal(t, false, result.Requeue)
})
t.Run(`Reconcile reconciles automatic kubernetes api monitoring with custom cluster name`, func(t *testing.T) {
const clusterLabel = "..blabla..;.🙃"
mjgrzybek marked this conversation as resolved.
Show resolved Hide resolved

mockClient := createDTMockClient(dtclient.TokenScopes{dtclient.TokenScopeInstallerDownload},
dtclient.TokenScopes{dtclient.TokenScopeDataExport, dtclient.TokenScopeEntitiesRead, dtclient.TokenScopeSettingsRead, dtclient.TokenScopeSettingsWrite})
mockClient.On("CreateOrUpdateKubernetesSetting",
mock.AnythingOfType("string"),
mock.AnythingOfType("string"),
mock.AnythingOfType("string")).Return(testUID, nil)

instance := &dynatracev1beta1.DynaKube{
ObjectMeta: metav1.ObjectMeta{
Name: testName,
Namespace: testNamespace,
Annotations: map[string]string{
dynatracev1beta1.AnnotationFeatureAutomaticK8sApiMonitoring: "true",
dynatracev1beta1.AnnotationFeatureAutomaticK8sApiMonitoringClusterName: clusterLabel,
},
},
Spec: dynatracev1beta1.DynaKubeSpec{
ActiveGate: dynatracev1beta1.ActiveGateSpec{
Capabilities: []dynatracev1beta1.CapabilityDisplayName{
dynatracev1beta1.KubeMonCapability.DisplayName,
},
},
}}
controller := createFakeClientAndReconciler(mockClient, instance, testPaasToken, testAPIToken)

result, err := controller.Reconcile(context.TODO(), reconcile.Request{
NamespacedName: types.NamespacedName{Namespace: testNamespace, Name: testName},
})

mockClient.AssertCalled(t, "CreateOrUpdateKubernetesSetting",
clusterLabel,
testUID,
mock.AnythingOfType("string"))

assert.NoError(t, err)
assert.Equal(t, false, result.Requeue)
})
t.Run(`Reconcile reconciles proxy secret`, func(t *testing.T) {
mockClient := createDTMockClient(dtclient.TokenScopes{dtclient.TokenScopeInstallerDownload},
Expand All @@ -186,7 +230,7 @@ func TestReconcileActiveGate_Reconcile(t *testing.T) {
Value: "https://proxy:1234",
ValueFrom: "",
}}}
controller := createFakeClientAndReconcile(mockClient, instance, testPaasToken, testAPIToken)
controller := createFakeClientAndReconciler(mockClient, instance, testPaasToken, testAPIToken)
mjgrzybek marked this conversation as resolved.
Show resolved Hide resolved

result, err := controller.Reconcile(context.TODO(), reconcile.Request{
NamespacedName: types.NamespacedName{Namespace: testNamespace, Name: testName},
Expand Down Expand Up @@ -216,7 +260,7 @@ func TestReconcileActiveGate_Reconcile(t *testing.T) {
ValueFrom: "",
}}}
instance.Annotations = map[string]string{dynatracev1beta1.AnnotationFeatureActiveGateIgnoreProxy: "true"}
controller := createFakeClientAndReconcile(mockClient, instance, testPaasToken, testAPIToken)
controller := createFakeClientAndReconciler(mockClient, instance, testPaasToken, testAPIToken)

result, err := controller.Reconcile(context.TODO(), reconcile.Request{
NamespacedName: types.NamespacedName{Namespace: testNamespace, Name: testName},
Expand Down Expand Up @@ -245,7 +289,7 @@ func TestReconcileOnlyOneTokenProvided_Reconcile(t *testing.T) {
Namespace: testNamespace,
},
Spec: dynatracev1beta1.DynaKubeSpec{}}
controller := createFakeClientAndReconcile(mockClient, instance, "", testAPIToken)
controller := createFakeClientAndReconciler(mockClient, instance, "", testAPIToken)

result, err := controller.Reconcile(context.TODO(), reconcile.Request{
NamespacedName: types.NamespacedName{Namespace: testNamespace, Name: testName},
Expand Down Expand Up @@ -335,7 +379,7 @@ func TestReconcile_RemoveRoutingIfDisabled(t *testing.T) {
Routing: dynatracev1beta1.RoutingSpec{
Enabled: true,
}}}
controller := createFakeClientAndReconcile(mockClient, instance, testPaasToken, testAPIToken)
controller := createFakeClientAndReconciler(mockClient, instance, testPaasToken, testAPIToken)
request := reconcile.Request{
NamespacedName: types.NamespacedName{Namespace: testNamespace, Name: testName},
}
Expand Down Expand Up @@ -417,7 +461,7 @@ func TestReconcile_ActiveGateMultiCapability(t *testing.T) {
},
},
}}
r := createFakeClientAndReconcile(mockClient, instance, testPaasToken, testAPIToken)
r := createFakeClientAndReconciler(mockClient, instance, testPaasToken, testAPIToken)
request := reconcile.Request{
NamespacedName: types.NamespacedName{Namespace: testNamespace, Name: testName},
}
Expand Down Expand Up @@ -513,7 +557,7 @@ func createDTMockClient(paasTokenScopes, apiTokenScopes dtclient.TokenScopes) *d
return mockClient
}

func createFakeClientAndReconcile(mockClient dtclient.Client, instance *dynatracev1beta1.DynaKube, paasToken, apiToken string) *DynakubeController {
func createFakeClientAndReconciler(mockClient dtclient.Client, instance *dynatracev1beta1.DynaKube, paasToken, apiToken string) *DynakubeController {
data := map[string][]byte{
dtclient.DynatraceApiToken: []byte(apiToken),
}
Expand Down
4 changes: 2 additions & 2 deletions src/dtclient/kubernetes_settings.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ type constraintViolations []struct {
Path string
}

func (dtc *dynatraceClient) CreateOrUpdateKubernetesSetting(name, kubeSystemUUID, scope string) (string, error) {
func (dtc *dynatraceClient) CreateOrUpdateKubernetesSetting(clusterLabel, kubeSystemUUID, scope string) (string, error) {
chrismuellner marked this conversation as resolved.
Show resolved Hide resolved
if kubeSystemUUID == "" {
return "", errors.New("no kube-system namespace UUID given")
}
Expand All @@ -78,7 +78,7 @@ func (dtc *dynatraceClient) CreateOrUpdateKubernetesSetting(name, kubeSystemUUID
SchemaVersion: "1.0.27",
Value: postKubernetesSettings{
Enabled: true,
Label: name,
Label: clusterLabel,
ClusterIdEnabled: true,
ClusterId: kubeSystemUUID,
CloudApplicationPipelineEnabled: true,
Expand Down