Skip to content

Commit

Permalink
chore: add custom node taints
Browse files Browse the repository at this point in the history
This PR adds support for custom node taints. Refer to `nodeTaints` in the `configuration` for more information.

Closes #7581

Signed-off-by: Dmitriy Matrenichev <dmitry.matrenichev@siderolabs.com>
  • Loading branch information
DmitriyMV committed Nov 25, 2023
1 parent 8e23074 commit dd45dd0
Show file tree
Hide file tree
Showing 18 changed files with 418 additions and 30 deletions.
43 changes: 33 additions & 10 deletions internal/app/machined/pkg/controllers/k8s/node_taint_spec.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ package k8s
import (
"context"
"fmt"
"strings"

"github.com/cosi-project/runtime/pkg/controller"
"github.com/cosi-project/runtime/pkg/safe"
Expand Down Expand Up @@ -53,7 +54,7 @@ func (ctrl *NodeTaintSpecController) Outputs() []controller.Output {
// Run implements controller.Controller interface.
//
//nolint:gocyclo
func (ctrl *NodeTaintSpecController) Run(ctx context.Context, r controller.Runtime, logger *zap.Logger) error {
func (ctrl *NodeTaintSpecController) Run(ctx context.Context, r controller.Runtime, _ *zap.Logger) error {
for {
select {
case <-ctx.Done():
Expand All @@ -68,16 +69,24 @@ func (ctrl *NodeTaintSpecController) Run(ctx context.Context, r controller.Runti

r.StartTrackingOutputs()

if cfg != nil && cfg.Config().Machine() != nil && cfg.Config().Cluster() != nil {
if cfg.Config().Machine().Type().IsControlPlane() && !cfg.Config().Cluster().ScheduleOnControlPlanes() {
if err = safe.WriterModify(ctx, r, k8s.NewNodeTaintSpec(constants.LabelNodeRoleControlPlane), func(k *k8s.NodeTaintSpec) error {
k.TypedSpec().Key = constants.LabelNodeRoleControlPlane
k.TypedSpec().Value = ""
k.TypedSpec().Effect = string(v1.TaintEffectNoSchedule)
if cfg != nil && cfg.Config().Machine() != nil {
if cfg.Config().Cluster() != nil {
if cfg.Config().Machine().Type().IsControlPlane() && !cfg.Config().Cluster().ScheduleOnControlPlanes() {
if err = createTaint(ctx, r, constants.LabelNodeRoleControlPlane, "", string(v1.TaintEffectNoSchedule)); err != nil {
return err
}
}
}

return nil
}); err != nil {
return fmt.Errorf("error updating node taint spec: %w", err)
for key, val := range cfg.Config().Machine().NodeTaints() {
value, effect, found := strings.Cut(val, ":")
if !found {
effect = value
value = ""
}

if err = createTaint(ctx, r, key, value, effect); err != nil {
return err
}
}
}
Expand All @@ -87,3 +96,17 @@ func (ctrl *NodeTaintSpecController) Run(ctx context.Context, r controller.Runti
}
}
}

func createTaint(ctx context.Context, r controller.Runtime, key string, val string, effect string) error {
if err := safe.WriterModify(ctx, r, k8s.NewNodeTaintSpec(key), func(k *k8s.NodeTaintSpec) error {
k.TypedSpec().Key = key
k.TypedSpec().Value = val
k.TypedSpec().Effect = effect

return nil
}); err != nil {
return fmt.Errorf("error updating node taint spec: %w", err)
}

return nil
}
34 changes: 32 additions & 2 deletions internal/app/machined/pkg/controllers/k8s/node_taint_spec_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (
"github.com/cosi-project/runtime/pkg/resource/rtestutils"
"github.com/cosi-project/runtime/pkg/safe"
"github.com/cosi-project/runtime/pkg/state"
"github.com/siderolabs/gen/xslices"
"github.com/siderolabs/go-pointer"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/suite"
Expand Down Expand Up @@ -43,16 +44,19 @@ func TestNodeTaintsSuite(t *testing.T) {
})
}

func (suite *NodeTaintsSuite) updateMachineConfig(machineType machine.Type, allowScheduling bool) {
func (suite *NodeTaintsSuite) updateMachineConfig(machineType machine.Type, allowScheduling bool, taints ...customTaint) {
cfg, err := safe.StateGetByID[*config.MachineConfig](suite.Ctx(), suite.State(), config.V1Alpha1ID)
if err != nil && !state.IsNotFoundError(err) {
suite.Require().NoError(err)
}

nodeTaints := xslices.ToMap(taints, func(t customTaint) (string, string) { return t.key, t.value })

if cfg == nil {
cfg = config.NewMachineConfig(container.NewV1Alpha1(&v1alpha1.Config{
MachineConfig: &v1alpha1.MachineConfig{
MachineType: machineType.String(),
MachineType: machineType.String(),
MachineNodeTaints: nodeTaints,
},
ClusterConfig: &v1alpha1.ClusterConfig{
AllowSchedulingOnControlPlanes: pointer.To(allowScheduling),
Expand All @@ -63,6 +67,7 @@ func (suite *NodeTaintsSuite) updateMachineConfig(machineType machine.Type, allo
} else {
cfg.Container().RawV1Alpha1().ClusterConfig.AllowSchedulingOnControlPlanes = pointer.To(allowScheduling)
cfg.Container().RawV1Alpha1().MachineConfig.MachineType = machineType.String()
cfg.Container().RawV1Alpha1().MachineConfig.MachineNodeTaints = nodeTaints
suite.Require().NoError(suite.State().Update(suite.Ctx(), cfg))
}
}
Expand All @@ -86,3 +91,28 @@ func (suite *NodeTaintsSuite) TestControlplane() {

rtestutils.AssertNoResource[*k8s.NodeTaintSpec](suite.Ctx(), suite.T(), suite.State(), constants.LabelNodeRoleControlPlane)
}

func (suite *NodeTaintsSuite) TestCustomTaints() {
const customTaintKey = "key1"

suite.updateMachineConfig(machine.TypeControlPlane, false, customTaint{
key: customTaintKey,
value: "value1:NoSchedule",
})

rtestutils.AssertResources(suite.Ctx(), suite.T(), suite.State(), []string{customTaintKey},
func(labelSpec *k8s.NodeTaintSpec, asrt *assert.Assertions) {
asrt.Equal(customTaintKey, labelSpec.TypedSpec().Key)
asrt.Equal("value1", labelSpec.TypedSpec().Value)
asrt.Equal(string(v1.TaintEffectNoSchedule), labelSpec.TypedSpec().Effect)
})

suite.updateMachineConfig(machine.TypeControlPlane, false)

rtestutils.AssertNoResource[*k8s.NodeTaintSpec](suite.Ctx(), suite.T(), suite.State(), customTaintKey)
}

type customTaint struct {
key string
value string
}
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ func (r *Runtime) CanApplyImmediate(cfg config.Provider) error {
newConfig.MachineConfig.MachinePods = currentConfig.MachineConfig.MachinePods
newConfig.MachineConfig.MachineSeccompProfiles = currentConfig.MachineConfig.MachineSeccompProfiles
newConfig.MachineConfig.MachineNodeLabels = currentConfig.MachineConfig.MachineNodeLabels
newConfig.MachineConfig.MachineNodeTaints = currentConfig.MachineConfig.MachineNodeTaints

if newConfig.MachineConfig.MachineFeatures != nil {
if currentConfig.MachineConfig.MachineFeatures != nil {
Expand Down
12 changes: 7 additions & 5 deletions internal/integration/api/node-labels.go
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ func (suite *NodeLabelsSuite) TestUpdateWorker() {
suite.testUpdate(node, false)
}

const metadataKeyName = "metadata.name="

// testUpdate cycles through a set of node label updates reverting the change in the end.
func (suite *NodeLabelsSuite) testUpdate(node string, isControlplane bool) {
k8sNode, err := suite.GetK8sNodeByInternalIP(suite.ctx, node)
Expand All @@ -71,7 +73,7 @@ func (suite *NodeLabelsSuite) testUpdate(node string, isControlplane bool) {
suite.T().Logf("updating labels on node %q (%q)", node, k8sNode.Name)

watcher, err := suite.Clientset.CoreV1().Nodes().Watch(suite.ctx, metav1.ListOptions{
FieldSelector: "metadata.name=" + k8sNode.Name,
FieldSelector: metadataKeyName + k8sNode.Name,
Watch: true,
})
suite.Require().NoError(err)
Expand Down Expand Up @@ -135,7 +137,7 @@ func (suite *NodeLabelsSuite) TestAllowScheduling() {
suite.T().Logf("updating taints on node %q (%q)", node, k8sNode.Name)

watcher, err := suite.Clientset.CoreV1().Nodes().Watch(suite.ctx, metav1.ListOptions{
FieldSelector: "metadata.name=" + k8sNode.Name,
FieldSelector: metadataKeyName + k8sNode.Name,
Watch: true,
})
suite.Require().NoError(err)
Expand All @@ -160,9 +162,9 @@ outer:
select {
case ev := <-watcher.ResultChan():
k8sNode, ok := ev.Object.(*v1.Node)
suite.Require().True(ok, "watch event is not of type v1.Node")
suite.Require().Truef(ok, "watch event is not of type v1.Node but was %T", ev.Object)

suite.T().Logf("labels %v, taints %v", k8sNode.Labels, k8sNode.Spec.Taints)
suite.T().Logf("labels %#v, taints %#v", k8sNode.Labels, k8sNode.Spec.Taints)

for k, v := range expectedLabels {
if v == "" {
Expand All @@ -175,7 +177,7 @@ outer:
}

if k8sNode.Labels[k] != v {
suite.T().Logf("label %q is not %q", k, v)
suite.T().Logf("label %q is %q but expected %q", k, k8sNode.Labels[k], v)

continue outer
}
Expand Down
189 changes: 189 additions & 0 deletions internal/integration/api/node-taints.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

//go:build integration_api

package api

import (
"context"
"slices"
"strings"
"time"

"github.com/siderolabs/gen/maps"
"github.com/siderolabs/gen/xslices"
"github.com/siderolabs/gen/xtesting/must"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/watch"

"github.com/siderolabs/talos/internal/integration/base"
machineapi "github.com/siderolabs/talos/pkg/machinery/api/machine"
"github.com/siderolabs/talos/pkg/machinery/client"
"github.com/siderolabs/talos/pkg/machinery/config/container"
"github.com/siderolabs/talos/pkg/machinery/config/machine"
"github.com/siderolabs/talos/pkg/machinery/constants"
)

// NodeTaintsSuite verifies updating node taints via machine config.
type NodeTaintsSuite struct {
base.K8sSuite

ctx context.Context //nolint:containedctx
ctxCancel context.CancelFunc
}

// SuiteName ...
func (suite *NodeTaintsSuite) SuiteName() string {
return "api.NodeTaintsSuite"
}

// SetupTest ...
func (suite *NodeTaintsSuite) SetupTest() {
// make sure API calls have timeout
suite.ctx, suite.ctxCancel = context.WithTimeout(context.Background(), 5*time.Minute)
}

// TearDownTest ...
func (suite *NodeTaintsSuite) TearDownTest() {
if suite.ctxCancel != nil {
suite.ctxCancel()
}
}

// TestUpdateControlPlane verifies node taints updates on control plane nodes.
func (suite *NodeTaintsSuite) TestUpdateControlPlane() {
node := suite.RandomDiscoveredNodeInternalIP(machine.TypeControlPlane)

suite.testUpdate(node)
}

// testUpdate cycles through a set of node taints updates reverting the change in the end.
func (suite *NodeTaintsSuite) testUpdate(node string) {
k8sNode, err := suite.GetK8sNodeByInternalIP(suite.ctx, node)
suite.Require().NoError(err)

suite.T().Logf("updating taints on node %q (%q)", node, k8sNode.Name)

watcher, err := suite.Clientset.CoreV1().Nodes().Watch(suite.ctx, metav1.ListOptions{
FieldSelector: metadataKeyName + k8sNode.Name,
Watch: true,
})
suite.Require().NoError(err)

defer watcher.Stop()

// set two new taints
suite.setNodeTaints(node, map[string]string{
"talos.dev/test1": "value1:NoSchedule",
"talos.dev/test2": "NoSchedule",
})

suite.waitUntil(watcher, map[string]string{
constants.LabelNodeRoleControlPlane: "NoSchedule",
"talos.dev/test1": "value1:NoSchedule",
"talos.dev/test2": "NoSchedule",
})

// remove one taint
suite.setNodeTaints(node, map[string]string{
"talos.dev/test1": "value1:NoSchedule",
})

suite.waitUntil(watcher, map[string]string{
constants.LabelNodeRoleControlPlane: "NoSchedule",
"talos.dev/test1": "value1:NoSchedule",
})

// remove all taints
suite.setNodeTaints(node, nil)

suite.waitUntil(watcher, map[string]string{
constants.LabelNodeRoleControlPlane: "NoSchedule",
})
}

func (suite *NodeTaintsSuite) waitUntil(watcher watch.Interface, expectedTaints map[string]string) {
outer:
for {
select {
case ev := <-watcher.ResultChan():
k8sNode, ok := ev.Object.(*v1.Node)
suite.Require().Truef(ok, "watch event is not of type v1.Node but was %T", ev.Object)

suite.T().Logf("labels %#v, taints %#v", k8sNode.Labels, k8sNode.Spec.Taints)

taints := xslices.ToMap(k8sNode.Spec.Taints, func(t v1.Taint) (string, string) {
switch {
case t.Value == "":
return t.Key, string(t.Effect)
case t.Effect == "":
return t.Key, t.Value
default:
return t.Key, strings.Join([]string{t.Value, string(t.Effect)}, ":")
}
})

expectedTaintsKeys := maps.Keys(expectedTaints)

slices.Sort(expectedTaintsKeys)

for _, key := range expectedTaintsKeys {
actualValue, ok := taints[key]
if !ok {
suite.T().Logf("taint %q is not present", key)

continue outer
}

expectedValue := expectedTaints[key]

if expectedValue != actualValue {
suite.T().Logf("expected taint %q to be %q but was %q", key, expectedValue, actualValue)

continue outer
}

delete(taints, key)
}

if len(taints) > 0 {
keys := maps.Keys(taints)

slices.Sort(keys)

suite.T().Logf("taints %v are still present", keys)

continue outer
}

return
case <-suite.ctx.Done():
suite.T().Fatal("timeout")
}
}
}

func (suite *NodeTaintsSuite) setNodeTaints(nodeIP string, nodeTaints map[string]string) {
nodeCtx := client.WithNode(suite.ctx, nodeIP)

nodeConfig := must.Value(suite.ReadConfigFromNode(nodeCtx))(suite.T())

nodeConfigRaw := nodeConfig.RawV1Alpha1()
suite.Require().NotNil(nodeConfigRaw, "node config is not of type v1alpha1.Config")

nodeConfigRaw.MachineConfig.MachineNodeTaints = nodeTaints

bytes := must.Value(container.NewV1Alpha1(nodeConfigRaw).Bytes())(suite.T())

must.Value(suite.Client.ApplyConfiguration(nodeCtx, &machineapi.ApplyConfigurationRequest{
Data: bytes,
Mode: machineapi.ApplyConfigurationRequest_NO_REBOOT,
}))(suite.T())
}

func init() {
allSuites = append(allSuites, new(NodeTaintsSuite))
}
4 changes: 4 additions & 0 deletions pkg/machinery/config/config/machine.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ type MachineConfig interface {
Kernel() Kernel
SeccompProfiles() []SeccompProfile
NodeLabels() NodeLabels
NodeTaints() NodeTaints
}

// SeccompProfile defines the requirements for a config that pertains to seccomp
Expand All @@ -54,6 +55,9 @@ type SeccompProfile interface {
// NodeLabels defines the labels that should be set on a node.
type NodeLabels map[string]string

// NodeTaints defines the taints that should be set on a node.
type NodeTaints map[string]string

// Disk represents the options available for partitioning, formatting, and
// mounting extra disks.
type Disk interface {
Expand Down

0 comments on commit dd45dd0

Please sign in to comment.