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

fix(backendconnection): add annotation to prevent ArgoCD pruning #157

Merged
merged 1 commit into from
Sep 26, 2024
Merged

fix(backendconnection): add annotation to prevent ArgoCD pruning #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
54 changes: 38 additions & 16 deletions internal/backendconnection/otelcolresources/desired_state.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ type collectorConfigurationTemplateValues struct {
DevelopmentMode bool
}

// This type just exists to ensure all created objects go through addCommonMetadata.
type clientObject struct {
object client.Object
}

const (
OtlpGrpcHostPort = 40317
OtlpHttpHostPort = 40318
Expand Down Expand Up @@ -150,39 +155,39 @@ var (
deploymentReplicas int32 = 1
)

func assembleDesiredState(config *oTelColConfig, forDeletion bool) ([]client.Object, error) {
var desiredState []client.Object
desiredState = append(desiredState, assembleServiceAccountForDaemonSet(config))
func assembleDesiredState(config *oTelColConfig, forDeletion bool) ([]clientObject, error) {
var desiredState []clientObject
desiredState = append(desiredState, addCommonMetadata(assembleServiceAccountForDaemonSet(config)))
daemonSetCollectorConfigMap, err := assembleDaemonSetCollectorConfigMap(config, forDeletion)
if err != nil {
return desiredState, err
}
desiredState = append(desiredState, daemonSetCollectorConfigMap)
desiredState = append(desiredState, assembleFilelogOffsetsConfigMap(config))
desiredState = append(desiredState, assembleClusterRoleForDaemonSet(config))
desiredState = append(desiredState, assembleClusterRoleBindingForDaemonSet(config))
desiredState = append(desiredState, assembleRole(config))
desiredState = append(desiredState, assembleRoleBinding(config))
desiredState = append(desiredState, assembleService(config))
desiredState = append(desiredState, addCommonMetadata(daemonSetCollectorConfigMap))
desiredState = append(desiredState, addCommonMetadata(assembleFilelogOffsetsConfigMap(config)))
desiredState = append(desiredState, addCommonMetadata(assembleClusterRoleForDaemonSet(config)))
desiredState = append(desiredState, addCommonMetadata(assembleClusterRoleBindingForDaemonSet(config)))
desiredState = append(desiredState, addCommonMetadata(assembleRole(config)))
desiredState = append(desiredState, addCommonMetadata(assembleRoleBinding(config)))
desiredState = append(desiredState, addCommonMetadata(assembleService(config)))
collectorDaemonSet, err := assembleCollectorDaemonSet(config)
if err != nil {
return desiredState, err
}
desiredState = append(desiredState, collectorDaemonSet)
desiredState = append(desiredState, addCommonMetadata(collectorDaemonSet))

desiredState = append(desiredState, assembleServiceAccountForDeployment(config))
desiredState = append(desiredState, assembleClusterRoleForDeployment(config))
desiredState = append(desiredState, assembleClusterRoleBindingForDeployment(config))
desiredState = append(desiredState, addCommonMetadata(assembleServiceAccountForDeployment(config)))
desiredState = append(desiredState, addCommonMetadata(assembleClusterRoleForDeployment(config)))
desiredState = append(desiredState, addCommonMetadata(assembleClusterRoleBindingForDeployment(config)))
deploymentCollectorConfigMap, err := assembleDeploymentCollectorConfigMap(config, forDeletion)
if err != nil {
return desiredState, err
}
desiredState = append(desiredState, deploymentCollectorConfigMap)
desiredState = append(desiredState, addCommonMetadata(deploymentCollectorConfigMap))
collectorDeployment, err := assembleCollectorDeployment(config)
if err != nil {
return desiredState, err
}
desiredState = append(desiredState, collectorDeployment)
desiredState = append(desiredState, addCommonMetadata(collectorDeployment))

return desiredState, nil
}
Expand Down Expand Up @@ -1011,6 +1016,23 @@ func labels(addOptOutLabel bool) map[string]string {
return lbls
}

func addCommonMetadata(object client.Object) clientObject {
// For clusters managed by ArgoCD, we need to prevent ArgoCD to prune resources that have no owner reference
// which are all cluster-scoped resources, like cluster roles & cluster role bindings. We could add the annotation
// to achieve that only to the cluster-scoped resources, but instead we just apply it to all resources we manage.
// * https://github.com/argoproj/argo-cd/issues/4764#issuecomment-722661940 -- this is where they say that only top
// level resources are pruned (that is basically the same as resources without an owner reference).
// * The docs for preventing this on a resource level are here:
// https://argo-cd.readthedocs.io/en/stable/user-guide/sync-options/#no-prune-resources
if object.GetAnnotations() == nil {
object.SetAnnotations(map[string]string{})
}
object.GetAnnotations()["argocd.argoproj.io/sync-options"] = "Prune=false"
return clientObject{
object: object,
}
}

func compileObsoleteResources(namespace string, namePrefix string) []client.Object {
openTelemetryCollectorSuffix := "opentelemetry-collector"
openTelemetryCollectorAgentSuffix := "opentelemetry-collector-agent"
Expand Down
25 changes: 16 additions & 9 deletions internal/backendconnection/otelcolresources/desired_state_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import (

appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
"sigs.k8s.io/controller-runtime/pkg/client"

dash0v1alpha1 "github.com/dash0hq/dash0-operator/api/dash0monitoring/v1alpha1"
"github.com/dash0hq/dash0-operator/internal/dash0/selfmonitoring"
Expand Down Expand Up @@ -53,6 +52,14 @@ var _ = Describe("The desired state of the OpenTelemetry Collector resources", f

Expect(err).ToNot(HaveOccurred())
Expect(desiredState).To(HaveLen(14))

for _, wrapper := range desiredState {
object := wrapper.object
annotations := object.GetAnnotations()
Expect(annotations).To(HaveLen(1))
Expect(annotations["argocd.argoproj.io/sync-options"]).To(Equal("Prune=false"))
}

collectorConfigConfigMapContent := getCollectorConfigConfigMapContent(desiredState)
Expect(collectorConfigConfigMapContent).To(ContainSubstring(fmt.Sprintf("endpoint: %s", EndpointDash0TestQuoted)))
Expect(collectorConfigConfigMapContent).NotTo(ContainSubstring("file/traces"))
Expand Down Expand Up @@ -264,37 +271,37 @@ var _ = Describe("The desired state of the OpenTelemetry Collector resources", f
})
})

func getConfigMap(desiredState []client.Object, name string) *corev1.ConfigMap {
func getConfigMap(desiredState []clientObject, name string) *corev1.ConfigMap {
for _, object := range desiredState {
if cm, ok := object.(*corev1.ConfigMap); ok && cm.Name == name {
if cm, ok := object.object.(*corev1.ConfigMap); ok && cm.Name == name {
return cm
}
}
return nil
}

func getCollectorConfigConfigMapContent(desiredState []client.Object) string {
func getCollectorConfigConfigMapContent(desiredState []clientObject) string {
cm := getConfigMap(desiredState, ExpectedDaemonSetCollectorConfigMapName)
return cm.Data["config.yaml"]
}

func getFileOffsetConfigMapContent(desiredState []client.Object) string {
func getFileOffsetConfigMapContent(desiredState []clientObject) string {
cm := getConfigMap(desiredState, ExpectedDaemonSetFilelogOffsetSynchConfigMapName)
return cm.Data["config.yaml"]
}

func getDaemonSet(desiredState []client.Object) *appsv1.DaemonSet {
func getDaemonSet(desiredState []clientObject) *appsv1.DaemonSet {
for _, object := range desiredState {
if ds, ok := object.(*appsv1.DaemonSet); ok {
if ds, ok := object.object.(*appsv1.DaemonSet); ok {
return ds
}
}
return nil
}

func getDeployment(desiredState []client.Object) *appsv1.Deployment {
func getDeployment(desiredState []clientObject) *appsv1.Deployment {
for _, object := range desiredState {
if d, ok := object.(*appsv1.Deployment); ok {
if d, ok := object.object.(*appsv1.Deployment); ok {
return d
}
}
Expand Down
6 changes: 4 additions & 2 deletions internal/backendconnection/otelcolresources/otelcol_resources.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,8 @@ func (m *OTelColResourceManager) CreateOrUpdateOpenTelemetryCollectorResources(
}
resourcesHaveBeenCreated := false
resourcesHaveBeenUpdated := false
for _, desiredResource := range desiredState {
for _, wrapper := range desiredState {
desiredResource := wrapper.object
isNew, isChanged, err := m.createOrUpdateResource(
ctx,
desiredResource,
Expand Down Expand Up @@ -346,7 +347,8 @@ func (m *OTelColResourceManager) DeleteResources(
return err
}
var allErrors []error
for _, desiredResource := range desiredResources {
for _, wrapper := range desiredResources {
desiredResource := wrapper.object
err = m.Client.Delete(ctx, desiredResource)
if err != nil {
if apierrors.IsNotFound(err) {
Expand Down