rpk: add --format flag to `rpk topic describe` #24387

r-vasquez · 2024-11-29T23:58:14Z

Continuation of https://github.com/redpanda-data/redpanda/pull/23418/files

This PR introduces the support of --format flag to rpk topic describe.

Example output:

$ rpk topic describe foo --format json
[{"summary":{"name":"foo","internal":false,"partitions":1,"replicas":1,"error":""},"configs":[{"key":"cleanup.policy","value":"delete","source":"DEFAULT_CONFIG"},{"key":"compression.type","value":"producer","source":"DEFAULT_CONFIG"},{"key":"delete.retention.ms","value":"-1","source":"DEFAULT_CONFIG"},{"key":"flush.bytes","value":"262144","source":"DEFAULT_CONFIG"},{"key":"flush.ms","value":"100","source":"DEFAULT_CONFIG"},{"key":"initial.retention.local.target.bytes","value":"-1","source":"DEFAULT_CONFIG"},{"key":"initial.retention.local.target.ms","value":"-1","source":"DEFAULT_CONFIG"},{"key":"max.message.bytes","value":"1048576","source":"DEFAULT_CONFIG"},{"key":"message.timestamp.type","value":"CreateTime","source":"DEFAULT_CONFIG"},{"key":"redpanda.iceberg.delete","value":"true","source":"DEFAULT_CONFIG"},{"key":"redpanda.iceberg.mode","value":"disabled","source":"DEFAULT_CONFIG"},{"key":"redpanda.leaders.preference","value":"none","source":"DEFAULT_CONFIG"},{"key":"redpanda.remote.delete","value":"true","source":"DEFAULT_CONFIG"},{"key":"redpanda.remote.read","value":"false","source":"DEFAULT_CONFIG"},{"key":"redpanda.remote.write","value":"false","source":"DEFAULT_CONFIG"},{"key":"retention.bytes","value":"-1","source":"DEFAULT_CONFIG"},{"key":"retention.local.target.bytes","value":"-1","source":"DEFAULT_CONFIG"},{"key":"retention.local.target.ms","value":"86400000","source":"DEFAULT_CONFIG"},{"key":"retention.ms","value":"604800000","source":"DEFAULT_CONFIG"},{"key":"segment.bytes","value":"134217728","source":"DEFAULT_CONFIG"},{"key":"segment.ms","value":"1209600000","source":"DEFAULT_CONFIG"},{"key":"write.caching","value":"true","source":"DEFAULT_CONFIG"}],"partitions":[{"partition":0,"leader":0,"epoch":1,"replicas":[0],"log_start_offset":0,"high_watermark":0}]}]

[
  {
    "summary": {
      "name": "foo",
      "internal": false,
      "partitions": 1,
      "replicas": 1,
      "error": ""
    },
    "configs": [
      {
        "key": "cleanup.policy",
        "value": "delete",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "compression.type",
        "value": "producer",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "delete.retention.ms",
        "value": "-1",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "flush.bytes",
        "value": "262144",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "flush.ms",
        "value": "100",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "initial.retention.local.target.bytes",
        "value": "-1",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "initial.retention.local.target.ms",
        "value": "-1",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "max.message.bytes",
        "value": "1048576",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "message.timestamp.type",
        "value": "CreateTime",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "redpanda.iceberg.delete",
        "value": "true",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "redpanda.iceberg.mode",
        "value": "disabled",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "redpanda.leaders.preference",
        "value": "none",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "redpanda.remote.delete",
        "value": "true",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "redpanda.remote.read",
        "value": "false",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "redpanda.remote.write",
        "value": "false",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "retention.bytes",
        "value": "-1",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "retention.local.target.bytes",
        "value": "-1",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "retention.local.target.ms",
        "value": "86400000",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "retention.ms",
        "value": "604800000",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "segment.bytes",
        "value": "134217728",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "segment.ms",
        "value": "1209600000",
        "source": "DEFAULT_CONFIG"
      },
      {
        "key": "write.caching",
        "value": "true",
        "source": "DEFAULT_CONFIG"
      }
    ],
    "partitions": [
      {
        "partition": 0,
        "leader": 0,
        "epoch": 1,
        "replicas": [
          0
        ],
        "log_start_offset": 0,
        "high_watermark": 0
      }
    ]
  }
]

Fixes ENG-124

Backports Required

Release Notes

Improvements

rpk topic describe now supports the --format flag to display the output in either JSON or YAML.

r-vasquez · 2024-11-30T00:00:19Z

/dt

r-vasquez · 2024-12-02T22:45:28Z

/dt

vbotbuildovich · 2024-12-03T01:13:37Z

the below tests from https://buildkite.com/redpanda/redpanda/builds/59139#0193898e-873a-4163-b3a7-f1c924b80eba have failed and will be retried

gtest_raft_rpunit

vbotbuildovich · 2024-12-03T02:48:15Z

Adds format flag to rpk topic describe. Supports JSON and YAML

gene-redpanda

LGTM

vbotbuildovich · 2024-12-03T22:44:22Z

Retry command for Build#59187

please wait until all jobs are finished before running the slash command

/ci-repeat 1
tests/rptest/tests/license_enforcement_test.py::LicenseEnforcementTest.test_license_enforcement@{"clean_node_after_recovery":true,"clean_node_before_recovery":false}
tests/rptest/tests/license_enforcement_test.py::LicenseEnforcementTest.test_license_enforcement@{"clean_node_after_recovery":false,"clean_node_before_recovery":false}
tests/rptest/tests/license_enforcement_test.py::LicenseEnforcementTest.test_escape_hatch_license_variable@{"clean_node_before_upgrade":false}
tests/rptest/tests/license_enforcement_test.py::LicenseEnforcementTest.test_license_enforcement@{"clean_node_after_recovery":false,"clean_node_before_recovery":true}
tests/rptest/tests/license_enforcement_test.py::LicenseEnforcementTest.test_escape_hatch_license_variable@{"clean_node_before_upgrade":true}
tests/rptest/tests/license_enforcement_test.py::LicenseEnforcementTest.test_license_enforcement@{"clean_node_after_recovery":true,"clean_node_before_recovery":true}

vbotbuildovich · 2024-12-03T22:45:45Z

non flaky failures in https://buildkite.com/redpanda/redpanda/builds/59187#01938e5c-db8c-4a15-8f3f-e4b2559a9cfa:

"rptest.tests.license_enforcement_test.LicenseEnforcementTest.test_license_enforcement.clean_node_before_recovery=True.clean_node_after_recovery=False"

non flaky failures in https://buildkite.com/redpanda/redpanda/builds/59187#01938e5c-db92-446d-8a33-214acd316f85:

"rptest.tests.license_enforcement_test.LicenseEnforcementTest.test_escape_hatch_license_variable.clean_node_before_upgrade=True"

non flaky failures in https://buildkite.com/redpanda/redpanda/builds/59187#01938e78-9377-4443-8943-caea72010d16:

"rptest.tests.license_enforcement_test.LicenseEnforcementTest.test_license_enforcement.clean_node_before_recovery=True.clean_node_after_recovery=False"

non flaky failures in https://buildkite.com/redpanda/redpanda/builds/59187#01938e78-9378-492b-98a6-b76f343cd4a9:

"rptest.tests.license_enforcement_test.LicenseEnforcementTest.test_escape_hatch_license_variable.clean_node_before_upgrade=True"

r-vasquez · 2024-12-04T16:34:31Z

^ Unrelated License enforcement issues were fixed by #24426

I'm going to retry the whole CI pipeline just to make sure we are good.

vbotbuildovich · 2024-12-04T20:20:29Z

/backport v24.3.x

github-actions bot added area/rpk area/build labels Nov 29, 2024

r-vasquez force-pushed the format-flag-rogger branch from faf1c11 to 14112a3 Compare November 29, 2024 23:58

redpanda-data deleted a comment from vbotbuildovich Dec 2, 2024

r-vasquez force-pushed the format-flag-rogger branch from 14112a3 to c05443f Compare December 2, 2024 22:43

rpk: add --format to rpk topic describe

b773a06

Adds format flag to rpk topic describe. Supports JSON and YAML

r-vasquez force-pushed the format-flag-rogger branch from c05443f to b773a06 Compare December 3, 2024 19:17

r-vasquez marked this pull request as ready for review December 3, 2024 19:57

r-vasquez requested review from twmb, gene-redpanda and Deflaimun as code owners December 3, 2024 19:57

r-vasquez changed the title ~~[WIP] rpk: add --format flag to rpk topic describe~~ rpk: add --format flag to rpk topic describe Dec 3, 2024

r-vasquez mentioned this pull request Dec 3, 2024

rpk Add Format Flags to topic's describe #23418

Closed

7 tasks

gene-redpanda approved these changes Dec 3, 2024

View reviewed changes

twmb approved these changes Dec 4, 2024

View reviewed changes

r-vasquez merged commit cddb5ef into redpanda-data:dev Dec 4, 2024
25 checks passed

vbotbuildovich mentioned this pull request Dec 4, 2024

[v24.3.x] rpk: add --format flag to rpk topic describe #24438

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rpk: add --format flag to `rpk topic describe` #24387

rpk: add --format flag to `rpk topic describe` #24387

r-vasquez commented Nov 29, 2024 •

edited

Loading

r-vasquez commented Nov 30, 2024

r-vasquez commented Dec 2, 2024

vbotbuildovich commented Dec 3, 2024

vbotbuildovich commented Dec 3, 2024 •

edited

Loading

gene-redpanda left a comment

vbotbuildovich commented Dec 3, 2024 •

edited

Loading

vbotbuildovich commented Dec 3, 2024 •

edited

Loading

r-vasquez commented Dec 4, 2024

vbotbuildovich commented Dec 4, 2024

rpk: add --format flag to rpk topic describe #24387

rpk: add --format flag to rpk topic describe #24387

Conversation

r-vasquez commented Nov 29, 2024 • edited Loading

Backports Required

Release Notes

Improvements

r-vasquez commented Nov 30, 2024

r-vasquez commented Dec 2, 2024

vbotbuildovich commented Dec 3, 2024

vbotbuildovich commented Dec 3, 2024 • edited Loading

gene-redpanda left a comment

Choose a reason for hiding this comment

vbotbuildovich commented Dec 3, 2024 • edited Loading

Retry command for Build#59187

vbotbuildovich commented Dec 3, 2024 • edited Loading

r-vasquez commented Dec 4, 2024

vbotbuildovich commented Dec 4, 2024

rpk: add --format flag to `rpk topic describe` #24387

rpk: add --format flag to `rpk topic describe` #24387

r-vasquez commented Nov 29, 2024 •

edited

Loading

vbotbuildovich commented Dec 3, 2024 •

edited

Loading

vbotbuildovich commented Dec 3, 2024 •

edited

Loading

vbotbuildovich commented Dec 3, 2024 •

edited

Loading