rpk: brokers list exposing Host/Port/Rack/UUID

[daisukebe]

Relevant to redpanda-data/common-go#27.

rpk redpanda admin brokers list now exposes additional fields that makes troubleshooting easier.

Before:

NODE-ID  NUM-CORES  MEMBERSHIP-STATUS  IS-ALIVE  BROKER-VERSION
0        2          active             true      v24.2.3 - be49068f63acc31d34b9d186cdfa62087fd99222
1        2          active             true      v24.2.3 - be49068f63acc31d34b9d186cdfa62087fd99222
2        2          active             true      v24.2.3 - be49068f63acc31d34b9d186cdfa62087fd99222

After:

ID    HOST       PORT   RACK  CORES  MEMBERSHIP  IS-ALIVE  VERSION  UUID
0     localhost  33146  a     2      active      true      24.2.3   e4ff0f11-6fc2-4df1-b129-bbf2630e7c18
1     localhost  33147  -     2      active      true      24.2.3   8b4649c4-7a92-4818-a93e-a3a244fad6e5
3     localhost  33148  -     2      active      true      24.2.3   b00efb2e-6beb-46b1-86f8-6fa2566bfa9b

It uses the fairly new /v1/broker_uuids endpoint for the UUID field. If a cluster doesn't support the endpoint, the command just hide the column.

If multiple node UUIDs being found for a node ID, the command prints all with a comma separated fashion in the same row. It could happen when a new node joins the cluster using the same node ID, e.g. being hard-corded in redpanda.yaml. This is not encouraged though.

ID    HOST       PORT   RACK  CORES  MEMBERSHIP  IS-ALIVE  VERSION  UUID
0     localhost  33146  a     2      active      true      24.2.3   e4ff0f11-6fc2-4df1-b129-bbf2630e7c18
1     localhost  33147  -     2      active      true      24.2.3   8b4649c4-7a92-4818-a93e-a3a244fad6e5
3     localhost  33148  -     2      active      true      24.2.3   b00efb2e-6beb-46b1-86f8-6fa2566bfa9b, 88fc966d-1b6c-470b-beb7-fa3ba162f998

With the new --include-decommissioned flag, it can list all decommissioned brokers along with its ID and UUID. This is useful when we deal with the node_id_overrides feature, #22972

ID    HOST       PORT   RACK  CORES  MEMBERSHIP  IS-ALIVE  VERSION  UUID
0     localhost  33146  a     2      active      true      24.2.3   e4ff0f11-6fc2-4df1-b129-bbf2630e7c18
1     localhost  33147  -     2      active      true      24.2.3   8b4649c4-7a92-4818-a93e-a3a244fad6e5
3     localhost  33148  -     2      active      true      24.2.3   b00efb2e-6beb-46b1-86f8-6fa2566bfa9b, 88fc966d-1b6c-470b-beb7-fa3ba162f998
2     -          -      -     -      -           -         -        d671a64b-02c2-4bbf-8437-73deac4db43a

Added a detailed help text too.

Backports Required

• none - not a bug fix
• none - this is a backport
• none - issue does not exist in previous branches
• none - papercut/not impactful enough to backport
• v24.2.x
• v24.1.x
• v23.3.x

Release Notes

Improvements

• rpk: redpanda admin brokers list exposes Host/Port/Rack/UUID additionally

[vbotbuildovich]

ducktape was retried in https://buildkite.com/redpanda/redpanda/builds/55629#01924c7e-d38f-428e-9563-5089462bc888

ducktape was retried in https://buildkite.com/redpanda/redpanda/builds/55629#01924c7e-d388-4470-b640-f53f3aafd35e

ducktape was retried in https://buildkite.com/redpanda/redpanda/builds/55685#01924f5f-469e-4409-8a40-13e40b09f09e

ducktape was retried in https://buildkite.com/redpanda/redpanda/builds/55685#01924f4d-0efb-4933-8997-0f1184a5ece8

ducktape was retried in https://buildkite.com/redpanda/redpanda/builds/55989#01926b5a-748e-4715-9944-e4e574794df5

ducktape was retried in https://buildkite.com/redpanda/redpanda/builds/55989#01926b83-0f91-4606-8890-1d12692386f8

ducktape was retried in https://buildkite.com/redpanda/redpanda/builds/56025#01926d30-07b8-462c-90f5-6ae4d724eb2c

[oleiman]

/ci-repeat 1
skip-units
skip-redpanda-build

[daisukebe]

Rebased. In 2d1d078, I have made the following changes.

• Accepted help text suggestions
• Returning - when rack is not configured
• Added the --all flag to show decommissioned node ID & UUID, which is helpful when we deal with the node_id_overrides feature, CORE-7000: Node ID/UUID Override #22972

e.g. node 2 is a decommissioned host.

ID    HOST       PORT   RACK  CORES  MEMBERSHIP  IS-ALIVE  VERSION  UUID
0     localhost  33146  a     2      active      true      v24.2.3  e4ff0f11-6fc2-4df1-b129-bbf2630e7c18
1     localhost  33147  -     2      active      true      v24.2.3  8b4649c4-7a92-4818-a93e-a3a244fad6e5
3     localhost  33148  -     2      active      true      v24.2.3  b00efb2e-6beb-46b1-86f8-6fa2566bfa9b
2     -          -      -     -      -           -         -        d671a64b-02c2-4bbf-8437-73deac4db43a

[daisukebe]

Nit change; I should have considered the case where /v1/broker_uuids isn't supposed when --all is used.

[daisukebe]

/ci-repeat 1
skip-units
skip-redpanda-build

[r-vasquez]

LGTM, 2 minor comments/questions.

Thanks for this and for the detailed description of the command and the changes

[daisukebe]

In bf93c5d, I've made the following changes:

• Use redpanda.Version to extract the broker version
• Return hyphen when UUID is not found
• Change the flag from --all to --include-decommissioned / -d to make it more explicit

[daisukebe]

Sorry, did another rebase; merged checkEmpty and formatVersion to one func formatOutput.

[r-vasquez]

LGTM, just one small left over in the docs from the flag name change. Thanks!

[r-vasquez]

Thanks!

[vbotbuildovich]

/backport v24.2.x

[vbotbuildovich]

/backport v24.1.x

[vbotbuildovich]

Failed to create a backport PR to v24.1.x branch. I tried:

git remote add upstream https://github.com/redpanda-data/redpanda.git
git fetch --all
git checkout -b backport-pr-23595-v24.1.x-693 remotes/upstream/v24.1.x
git cherry-pick -x 08e30aa37d

Workflow run logs.