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

Fix: CC config checksum should include generated config as well #805

Merged
merged 1 commit into from
May 2, 2022
Merged
Show file tree
Hide file tree
Changes from all 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
31 changes: 31 additions & 0 deletions controllers/tests/kafkacluster_controller_cruisecontrol_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ package tests

import (
"context"
"crypto/sha256"
"encoding/hex"
"fmt"

. "github.com/onsi/gomega"
Expand Down Expand Up @@ -331,4 +333,33 @@ func expectCruiseControlDeployment(kafkaCluster *v1beta1.KafkaCluster) {
// Check if the securityContext values are propagated correctly
Expect(deployment.Spec.Template.Spec.SecurityContext.RunAsNonRoot).To(Equal(util.BoolPointer(false)))
Expect(container.SecurityContext.Privileged).To(Equal(util.BoolPointer(true)))

// Check config checksum annotations
configMap := &corev1.ConfigMap{}
Eventually(func() error {
return k8sClient.Get(context.Background(), types.NamespacedName{
Namespace: kafkaCluster.Namespace,
Name: fmt.Sprintf("%s-cruisecontrol-config", kafkaCluster.Name),
}, configMap)
}).Should(Succeed())

userProvidedCCPodAnnotations := kafkaCluster.Spec.CruiseControlConfig.GetCruiseControlAnnotations()
ccConfigHash := sha256.Sum256([]byte(configMap.Data["cruisecontrol.properties"]))
ccClusterConfigHash := sha256.Sum256([]byte(configMap.Data["clusterConfigs.json"]))
ccLogConfigHash := sha256.Sum256([]byte(configMap.Data["log4j.properties"]))
ccBrokerCapacityConfigHash := sha256.Sum256([]byte(configMap.Data["capacity.json"]))
expectedPodAnnotations := util.MergeAnnotations(
userProvidedCCPodAnnotations,
map[string]string{
"cruiseControlConfig.json": hex.EncodeToString(ccConfigHash[:]),
"cruiseControlClusterConfig.json": hex.EncodeToString(ccClusterConfigHash[:]),
"cruiseControlLogConfig.json": hex.EncodeToString(ccLogConfigHash[:]),
},
)

if capacityConfigType, ok := userProvidedCCPodAnnotations["cruise-control.banzaicloud.com/broker-capacity-config"]; !ok || capacityConfigType == "static" {
expectedPodAnnotations["cruiseControlCapacity.json"] = hex.EncodeToString(ccBrokerCapacityConfigHash[:])
}

Expect(deployment.Spec.Template.GetAnnotations()).To(Equal(expectedPodAnnotations))
}
3 changes: 2 additions & 1 deletion controllers/tests/kafkacluster_controller_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ var _ = Describe("KafkaCluster", func() {
Partitions: 7,
ReplicationFactor: 2,
},
Config: "some.config=value",
Config: "some.config=value",
CruiseControlAnnotations: map[string]string{"test-cc-ann": "test-cc-ann-val"},
}
kafkaCluster.Spec.ReadOnlyConfig = ""
// Set some Kafka pod and container related SecurityContext values
Expand Down
2 changes: 1 addition & 1 deletion pkg/resources/cruisecontrol/configmap.go
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ type JBODInvariantCapacityConfig struct {
Capacities []interface{} `json:"brokerCapacities"`
}

// generateCapacityConfig generates a CC capacity config with default values or returns the manually overridden value if it exists
// GenerateCapacityConfig generates a CC capacity config with default values or returns the manually overridden value if it exists
func GenerateCapacityConfig(kafkaCluster *v1beta1.KafkaCluster, log logr.Logger, config *corev1.ConfigMap) (string, error) {
var err error

Expand Down
5 changes: 4 additions & 1 deletion pkg/resources/cruisecontrol/cruisecontrol.go
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,10 @@ func (r *Reconciler) Reconcile(log logr.Logger) error {
return errors.WrapIfWithDetails(err, "failed to reconcile resource", "resource", o.GetObjectKind().GroupVersionKind())
}

podAnnotations := GeneratePodAnnotations(r.KafkaCluster, capacityConfig)
podAnnotations := GeneratePodAnnotations(
r.KafkaCluster.Spec.CruiseControlConfig.GetCruiseControlAnnotations(),
o.(*corev1.ConfigMap).Data,
)

o = r.deployment(podAnnotations)
err = k8sutil.Reconcile(log, r.Client, o, r.KafkaCluster)
Expand Down
15 changes: 7 additions & 8 deletions pkg/resources/cruisecontrol/deployment.go
Original file line number Diff line number Diff line change
Expand Up @@ -182,23 +182,22 @@ fi`},
}
}

func GeneratePodAnnotations(kafkaCluster *v1beta1.KafkaCluster, capacityConfig string) map[string]string {
ccAnnotationsFromCR := kafkaCluster.Spec.CruiseControlConfig.GetCruiseControlAnnotations()
hashedCruiseControlConfigJson := sha256.Sum256([]byte(kafkaCluster.Spec.CruiseControlConfig.Config))
hashedCruiseControlClusterConfigJson := sha256.Sum256([]byte(kafkaCluster.Spec.CruiseControlConfig.ClusterConfig))
hashedCruiseControlLogConfigJson := sha256.Sum256([]byte(kafkaCluster.Spec.CruiseControlConfig.GetCCLog4jConfig()))
func GeneratePodAnnotations(cruiseControlAnnotations, cruiseControlConfig map[string]string) map[string]string {
hashedCruiseControlConfigJson := sha256.Sum256([]byte(cruiseControlConfig["cruisecontrol.properties"]))
hashedCruiseControlClusterConfigJson := sha256.Sum256([]byte(cruiseControlConfig["clusterConfigs.json"]))
hashedCruiseControlLogConfigJson := sha256.Sum256([]byte(cruiseControlConfig["log4j.properties"]))

annotations := []map[string]string{
cruiseControlAnnotations,
{
"cruiseControlConfig.json": hex.EncodeToString(hashedCruiseControlConfigJson[:]),
"cruiseControlClusterConfig.json": hex.EncodeToString(hashedCruiseControlClusterConfigJson[:]),
"cruiseControlLogConfig.json": hex.EncodeToString(hashedCruiseControlLogConfigJson[:]),
},
ccAnnotationsFromCR,
}
if value, ok := ccAnnotationsFromCR[capacityConfigAnnotation]; !ok ||
if value, ok := cruiseControlAnnotations[capacityConfigAnnotation]; !ok ||
value == string(staticCapacityConfig) {
hashedCruiseControlCapacityJson := sha256.Sum256([]byte(capacityConfig))
hashedCruiseControlCapacityJson := sha256.Sum256([]byte(cruiseControlConfig["capacity.json"]))
annotations = append(annotations,
map[string]string{"cruiseControlCapacity.json": hex.EncodeToString(hashedCruiseControlCapacityJson[:])})
}
Expand Down