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

[v24.1.x] rpk: add transfer-leadership command #18459

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
16 changes: 16 additions & 0 deletions src/go/rpk/pkg/adminapi/api_partition.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ import (
"io"
"net/http"
"strings"

"github.com/redpanda-data/redpanda/src/go/rpk/pkg/config"
"github.com/spf13/afero"
)

const partitionsBaseURL = "/v1/cluster/partitions"
Expand Down Expand Up @@ -188,3 +191,16 @@ func (a *AdminAPI) ForceRecoverFromNode(ctx context.Context, plan []MajorityLost
}
return a.sendAny(ctx, http.MethodPost, "/v1/partitions/force_recover_from_nodes", body, nil)
}

func (a *AdminAPI) TransferLeadership(ctx context.Context, fs afero.Fs, p *config.RpkProfile, source int, ns, topic string, partition int, target string) error {
brokerURL, err := a.brokerIDToURL(ctx, source)
if err != nil {
return err
}
cl, err := NewHostClient(fs, p, brokerURL)
if err != nil {
return err
}
path := fmt.Sprintf("/v1/partitions/%s/%s/%d/transfer_leadership?target=%s", ns, topic, partition, target)
return cl.sendOne(ctx, http.MethodPost, path, nil, nil, false)
}
1 change: 1 addition & 0 deletions src/go/rpk/pkg/cli/cluster/partitions/partitions.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ func NewPartitionsCommand(fs afero.Fs, p *config.Params) *cobra.Command {
newPartitionDisableCommand(fs, p),
newPartitionEnableCommand(fs, p),
newPartitionMovementsStatusCommand(fs, p),
newTransferLeaderCommand(fs, p),
newUnsafeRecoveryCommand(fs, p),
)
return cmd
Expand Down
154 changes: 154 additions & 0 deletions src/go/rpk/pkg/cli/cluster/partitions/transfer_leadership.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
// Copyright 2024 Redpanda Data, Inc.
//
// Use of this software is governed by the Business Source License
// included in the file licenses/BSL.md
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0

package partitions

import (
"fmt"
"regexp"
"strconv"
"strings"

"github.com/redpanda-data/redpanda/src/go/rpk/pkg/adminapi"
"github.com/redpanda-data/redpanda/src/go/rpk/pkg/config"
"github.com/redpanda-data/redpanda/src/go/rpk/pkg/out"
"github.com/spf13/afero"
"github.com/spf13/cobra"
)

func newTransferLeaderCommand(fs afero.Fs, p *config.Params) *cobra.Command {
var partitionArg string

cmd := &cobra.Command{
Use: "transfer-leadership",
Short: "Transfer partition leadership between brokers",
Long: `Transfer partition leadership between brokers.

This command allows you to transfer partition leadership.
You can transfer only one partition leader at a time.

To transfer partition leadership, use the following syntax:
rpk cluster partitions transfer-leadership foo --partition 0:2

Here, the command transfers leadership for the partition "kafka/foo/0"
to broker 2. By default, it assumes the "kafka" namespace, but you can specify
an internal namespace using the "{namespace}/" prefix.

Here is an equivalent command using different syntax:
rpk cluster partitions transfer-leadership --partition foo/0:2

Warning: Redpanda tries to balance leadership distribution across brokers by default.
If the distribution of leaders becomes uneven as a result of transferring leadership
across brokers, the cluster may move leadership back to the original
brokers automatically.
`,

Args: cobra.MaximumNArgs(1),
Run: func(cmd *cobra.Command, topicArg []string) {
f := p.Formatter
if h, ok := f.Help([]string{}); ok {
out.Exit(h)
}

p, err := p.LoadVirtualProfile(fs)
out.MaybeDie(err, "rpk unable to load config: %v", err)
config.CheckExitCloudAdmin(p)

cl, err := adminapi.NewClient(fs, p)
out.MaybeDie(err, "unable to initialize admin client: %v", err)

if len(topicArg) > 0 { // foo -p 0:1
_, _, partition, target, err := extractNTPTarget(topicArg[0], partitionArg)
out.MaybeDie(err, "failed to extract topic/partition: %s\n", err)

ns, topic := formatNT(topicArg[0])

partDetails, err := cl.GetPartition(cmd.Context(), ns, topic, partition)
out.MaybeDie(err, "failed to get partition details: %s\n", err)

source := partDetails.LeaderID

err = cl.TransferLeadership(cmd.Context(), fs, p, source, ns, topic, partition, target)
if err != nil {
fmt.Printf("failed to transfer the partition leadership: %v\n", err)
} else {
fmt.Println("Successfully began the partition leadership transfer(s).\n\nCheck the new leader assignment with 'rpk topic describe -p TOPIC'.")
}
} else { // -p foo/0:1
ns, topic, partition, target, err := extractNTPTarget("", partitionArg)
out.MaybeDie(err, "failed to extract topic/partition: %s\n", err)

partDetails, err := cl.GetPartition(cmd.Context(), ns, topic, partition)
out.MaybeDie(err, "failed to get partition details: %s\n", err)

source := partDetails.LeaderID

err = cl.TransferLeadership(cmd.Context(), fs, p, source, ns, topic, partition, target)
if err != nil {
fmt.Printf("failed to transfer the partition leader: %v\n", err)
} else {
fmt.Println("Successfully began the partition leadership transfer(s).\n\nCheck the new leader assignment with 'rpk topic describe -p TOPIC'.")
}
}
},
}
cmd.Flags().StringVarP(&partitionArg, "partition", "p", "", "Topic-partition to transfer leadership and new leader location")
p.InstallFormatFlag(cmd)
return cmd
}

// extractNTPTarget parses the partition flag with format; foo/0:1 or 0:1
// and returns namespace', 'topic', 'partition', and 'target node' separately.
func extractNTPTarget(topic string, ntp string) (ns string, t string, p int, target string, err error) {
ntpReOnce.Do(func() {
ntpRe = regexp.MustCompile(`^((?:[^:]+/)?\d+):(\d+)$`)
})
m := ntpRe.FindStringSubmatch(ntp)
if len(m) == 0 {
return "", "", -1, "", fmt.Errorf("invalid format for %s", ntp)
}
beforeColon := m[1]
target = m[2]
if topic != "" {
p, err = strconv.Atoi(beforeColon)
if err != nil {
return "", "", -1, "", fmt.Errorf("%s", err)
}
} else if n := strings.Split(beforeColon, "/"); len(n) == 3 {
ns = n[0]
t = n[1]
p, err = strconv.Atoi(n[2])
if err != nil {
return "", "", -1, "", fmt.Errorf("%s", err)
}
} else if len(n) == 2 {
ns = "kafka"
t = n[0]
p, err = strconv.Atoi(n[1])
if err != nil {
return "", "", -1, "", fmt.Errorf("%s", err)
}
} else {
return "", "", -1, "", fmt.Errorf("invalid format for %s", ntp)
}
return ns, t, p, target, nil
}

// formatNT parse a given '(namespace)/topic' string
// and return 'namespace' and 'topic' separately.
func formatNT(t string) (ns string, topic string) {
if nt := strings.Split(t, "/"); len(nt) == 1 {
ns = "kafka"
topic = nt[0]
} else {
ns = nt[0]
topic = nt[1]
}
return
}
Loading