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

rpk connect: show rpk help text with --help/-h #24068

Merged
merged 1 commit into from
Nov 12, 2024

Conversation

r-vasquez
Copy link
Contributor

Previously we were displaying only the connect
plugin help text, and not the rpk one. We were
missing the lifecycle commands (install, uninstall, upgrade).

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

  • none

Previously we were displaying only the `connect`
plugin help text, and not the rpk one. We were
missing the lifecycle commands (install, uninstall,
upgrade).
@gene-redpanda
Copy link
Contributor

Is it worth having some func RpkHelp(cmd) that can handle this + the plugin help?

@r-vasquez
Copy link
Contributor Author

@gene-redpanda part of the plugin installation process is adding the help text of the plugin into rpk, so displaying rpk's help text includes both. This is how it looks now:

$ rpk connect -h                                 
A stream processor for mundane tasks - https://docs.redpanda.com/redpanda-connect

Usage:
  rpk connect [flags]
  rpk connect [command]

Available Commands:
  blobl       Execute a Redpanda Connect mapping on documents consumed via stdin
  create      Create a new Redpanda Connect config
  echo        Parse a config file and echo back a normalised version
  help        Shows a list of commands or help for one command
  install     Install Redpanda Connect
  lint        Parse Redpanda Connect configs and report any linting errors
  list        List all Redpanda Connect component types
  run         Run Redpanda Connect in normal mode against a specified config file
  streams     Run Redpanda Connect in streams mode
  template    Interact and generate Redpanda Connect templates
  test        Execute Redpanda Connect unit tests
  uninstall   Uninstall the Redpanda Connect plugin
  upgrade     Upgrade to the latest Redpanda Connect version

Flags:
  -h, --help   Help for connect

Global Flags:
      --config string            Redpanda or rpk config file; default search paths are
                                 "/home/rvasquez/.config/rpk/rpk.yaml", $PWD/redpanda.yaml, and /etc/redpanda/redpanda.yaml
  -X, --config-opt stringArray   Override rpk configuration settings; '-X help' for detail or '-X list' for terser detail
      --profile string           rpk profile to use
  -v, --verbose                  Enable verbose logging

Use "rpk connect [command] --help" for more information about a command.

@vbotbuildovich
Copy link
Collaborator

the below tests from https://buildkite.com/redpanda/redpanda/builds/57814#0193090e-1857-4cae-8d83-6033ca84b165 have failed and will be retried

gtest_raft_rpunit

@r-vasquez r-vasquez merged commit 1fb3f4e into redpanda-data:dev Nov 12, 2024
23 checks passed
@vbotbuildovich
Copy link
Collaborator

/backport v24.2.x

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants