apitech
/
loki
mirror of https://github.com/grafana/loki
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add default TopologySpreadContraints to distributor (#9383)

Browse Source 
Signed-off-by: Joao Marcal <jmarcal@redhat.com>
pull/9400/head^2
Joao Marcal 2 years ago committed by GitHub
parent 520e434446
commit 65ec35a18b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 101 additions and 43 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 1
      operator/CHANGELOG.md
  2. 5
      operator/internal/manifests/distributor.go
  3. 103
      operator/internal/manifests/distributor_test.go
  4. 35
      operator/internal/manifests/var.go

1
operator/CHANGELOG.md
Unescape View File

@ -1,5 +1,6 @@
## Main
- [9383](https://github.com/grafana/loki/pull/9383) **JoaoBraveCoding**: Add default TopologySpreadContaints to Distributor
- [9406](https://github.com/grafana/loki/pull/9406) **aminesnow**: Add label selector to zone awareness TopologySpreadConstraints
- [9366](https://github.com/grafana/loki/pull/9366) **periklis**: Add support for custom tenant topology in rules
- [9315](https://github.com/grafana/loki/pull/9315) **aminesnow**: Add zone awareness spec to LokiStack

5
operator/internal/manifests/distributor.go
Unescape View File

@ -59,7 +59,8 @@ func NewDistributorDeployment(opts Options) *appsv1.Deployment {
l := ComponentLabels(LabelDistributorComponent, opts.Name)
a := commonAnnotations(opts.ConfigSHA1, opts.CertRotationRequiredAt)
podSpec := corev1.PodSpec{
Affinity: configureAffinity(l, opts.Gates.DefaultNodeAffinity),
Affinity: configureAffinity(l, opts.Gates.DefaultNodeAffinity),
TopologySpreadConstraints: defaultTopologySpreadConstraints(l),
Volumes: []corev1.Volume{
{
Name: configVolumeName,
@ -128,7 +129,7 @@ func NewDistributorDeployment(opts Options) *appsv1.Deployment {
}
if opts.Stack.Replication != nil {
podSpec.TopologySpreadConstraints = topologySpreadConstraints(*opts.Stack.Replication, LabelDistributorComponent, opts.Name)
podSpec.TopologySpreadConstraints = append(podSpec.TopologySpreadConstraints, topologySpreadConstraints(*opts.Stack.Replication, LabelDistributorComponent, opts.Name)...)
}
return &appsv1.Deployment{

103
operator/internal/manifests/distributor_test.go
Unescape View File

@ -101,16 +101,30 @@ func TestBuildDistributor_PodDisruptionBudget(t *testing.T) {
require.EqualValues(t, manifests.ComponentLabels(manifests.LabelDistributorComponent, opts.Name), pdb.Spec.Selector.MatchLabels)
}
func TestNewDistributorDeployment_TopologySpreadConstraints(t *testing.T) {
depl := manifests.NewDistributorDeployment(manifests.Options{
Name: "abcd",
Namespace: "efgh",
Stack: lokiv1.LokiStackSpec{
Template: &lokiv1.LokiTemplateSpec{
Distributor: &lokiv1.LokiComponentSpec{
Replicas: 1,
func TestNewDistributoDeployment_TopologySpreadConstraints(t *testing.T) {
for _, tc := range []struct {
Name string
Replication *lokiv1.ReplicationSpec
ExpectedTopologySpreadContraint []corev1.TopologySpreadConstraint
}{
{
Name: "default",
ExpectedTopologySpreadContraint: []corev1.TopologySpreadConstraint{
{
MaxSkew: 1,
TopologyKey: "kubernetes.io/hostname",
LabelSelector: &metav1.LabelSelector{
MatchLabels: map[string]string{
"app.kubernetes.io/component": "distributor",
"app.kubernetes.io/instance": "abcd",
},
},
WhenUnsatisfiable: corev1.ScheduleAnyway,
},
},
},
{
Name: "replication_defined",
Replication: &lokiv1.ReplicationSpec{
Zones: []lokiv1.ZoneSpec{
{
@ -124,31 +138,58 @@ func TestNewDistributorDeployment_TopologySpreadConstraints(t *testing.T) {
},
Factor: 1,
},
},
})
require.Equal(t, []corev1.TopologySpreadConstraint{
{
MaxSkew: 3,
TopologyKey: "zone",
WhenUnsatisfiable: "DoNotSchedule",
LabelSelector: &metav1.LabelSelector{
MatchLabels: map[string]string{
"app.kubernetes.io/component": "distributor",
"app.kubernetes.io/instance": "abcd",
ExpectedTopologySpreadContraint: []corev1.TopologySpreadConstraint{
{
MaxSkew: 1,
TopologyKey: "kubernetes.io/hostname",
LabelSelector: &metav1.LabelSelector{
MatchLabels: map[string]string{
"app.kubernetes.io/component": "distributor",
"app.kubernetes.io/instance": "abcd",
},
},
WhenUnsatisfiable: corev1.ScheduleAnyway,
},
},
},
{
MaxSkew: 2,
TopologyKey: "region",
WhenUnsatisfiable: "DoNotSchedule",
LabelSelector: &metav1.LabelSelector{
MatchLabels: map[string]string{
"app.kubernetes.io/component": "distributor",
"app.kubernetes.io/instance": "abcd",
{
MaxSkew: 3,
TopologyKey: "zone",
WhenUnsatisfiable: "DoNotSchedule",
LabelSelector: &metav1.LabelSelector{
MatchLabels: map[string]string{
"app.kubernetes.io/component": "distributor",
"app.kubernetes.io/instance": "abcd",
},
},
},
{
MaxSkew: 2,
TopologyKey: "region",
WhenUnsatisfiable: "DoNotSchedule",
LabelSelector: &metav1.LabelSelector{
MatchLabels: map[string]string{
"app.kubernetes.io/component": "distributor",
"app.kubernetes.io/instance": "abcd",
},
},
},
},
},
}, depl.Spec.Template.Spec.TopologySpreadConstraints)
} {
t.Run(tc.Name, func(t *testing.T) {
depl := manifests.NewDistributorDeployment(manifests.Options{
Name: "abcd",
Namespace: "efgh",
Stack: lokiv1.LokiStackSpec{
Template: &lokiv1.LokiTemplateSpec{
Distributor: &lokiv1.LokiComponentSpec{
Replicas: 1,
},
},
Replication: tc.Replication,
},
})
require.Equal(t, tc.ExpectedTopologySpreadContraint, depl.Spec.Template.Spec.TopologySpreadConstraints)
})
}
}

35
operator/internal/manifests/var.go
Unescape View File

@ -105,7 +105,7 @@ const (
kubernetesNodeOSLabel = "kubernetes.io/os"
kubernetesNodeOSLinux = "linux"
kubernetesNodeHostnameLabel = "kubernetes.io/hostname"
kubernetesCompomentLabel = "app.kubernetes.io/component"
kubernetesComponentLabel = "app.kubernetes.io/component"
kubernetesInstanceLabel = "app.kubernetes.io/instance"
)
@ -135,6 +135,13 @@ func commonLabels(stackName string) map[string]string {
}
}
func componentInstaceLabels(component string, stackName string) map[string]string {
return map[string]string{
kubernetesInstanceLabel: stackName,
kubernetesComponentLabel: component,
}
}
func serviceAnnotations(serviceName string, enableSigningService bool) map[string]string {
annotations := map[string]string{}
if enableSigningService {
@ -154,7 +161,7 @@ func topologySpreadConstraints(spec lokiv1.ReplicationSpec, component string, st
WhenUnsatisfiable: corev1.DoNotSchedule,
LabelSelector: &metav1.LabelSelector{
MatchLabels: map[string]string{
kubernetesCompomentLabel: component,
kubernetesComponentLabel: component,
kubernetesInstanceLabel: stackName,
},
},
@ -168,7 +175,7 @@ func topologySpreadConstraints(spec lokiv1.ReplicationSpec, component string, st
// ComponentLabels is a list of all commonLabels including the app.kubernetes.io/component:<component> label
func ComponentLabels(component, stackName string) labels.Set {
return labels.Merge(commonLabels(stackName), map[string]string{
kubernetesCompomentLabel: component,
kubernetesComponentLabel: component,
})
}
@ -488,6 +495,19 @@ func gatewayServiceMonitorEndpoint(gatewayName, portName, serviceName, namespace
}
}
// defaultTopologySpreadConstraints returns a topology spread contraint that will
// instruct the scheduler to try and schedule pods from the same component in different nodes
func defaultTopologySpreadConstraints(labels labels.Set) []corev1.TopologySpreadConstraint {
return []corev1.TopologySpreadConstraint{{
MaxSkew: 1,
TopologyKey: kubernetesNodeHostnameLabel,
LabelSelector: &metav1.LabelSelector{
MatchLabels: componentInstaceLabels(labels[kubernetesComponentLabel], labels[kubernetesInstanceLabel]),
},
WhenUnsatisfiable: corev1.ScheduleAnyway,
}}
}
// configureAffinity returns an Affinity struture that can be used directly
// in a Deployment/StatefulSet. Parameters will affected configuration of the
// different fields in Affinity (NodeAffinity, PodAffinity, PodAntiAffinity).
@ -534,9 +554,7 @@ func defaultPodAntiAffinity(labels labels.Set) *corev1.PodAntiAffinity {
// This code assumes that this function will never be called with a set of labels
// that don't have the "component" and "instance" labels since we enforce those on
// all the components of the LokiStack
componentLabel := labels[kubernetesCompomentLabel]
stackName := labels[kubernetesInstanceLabel]
componentLabel := labels[kubernetesComponentLabel]
_, enablePodAntiAffinity := podAntiAffinityComponents[componentLabel]
if !enablePodAntiAffinity {
return nil
@ -548,10 +566,7 @@ func defaultPodAntiAffinity(labels labels.Set) *corev1.PodAntiAffinity {
Weight: 100,
PodAffinityTerm: corev1.PodAffinityTerm{
LabelSelector: &metav1.LabelSelector{
MatchLabels: map[string]string{
"app.kubernetes.io/component": componentLabel,
"app.kubernetes.io/instance": stackName,
},
MatchLabels: componentInstaceLabels(labels[kubernetesComponentLabel], labels[kubernetesInstanceLabel]),
},
TopologyKey: kubernetesNodeHostnameLabel,
},

Write Preview
Loading…
Cancel
Save