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

[improve][cli]Support for pulsar-shell persistent modes #22522

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

sandeep-mst
Copy link

Fixes 21194 of apache/pulsar

Motivation

Pulsar shell doesn't support persistent mode for admin, client, config. If we need to run a lot of admin commands for example, we would need to prefix admin each time. This will provide an alternative approach.

Modifications

Modified so that admin, client, config commands individually will launch their own mode and prompt message also gets updated. exit or quit command will exit from the mode to the default mode.
In the admin mode, we can run command topics instead of admin topics.

Verifying this change

  • Make sure that the change passes the CI checks.

(Please pick either of the following options)

This change is already covered by existing tests, such as (please describe tests).

Does this pull request potentially affect one of the following parts:

If the box was checked, please highlight the changes

  • Dependencies (add or upgrade a dependency)
  • The public API
  • The schema
  • The default values of configurations
  • The threading model
  • The binary protocol
  • The REST endpoints
  • The admin CLI options
  • The metrics
  • Anything that affects deployment

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

Matching PR in forked repository

PR in forked repository:
cognitree#6

@github-actions github-actions bot added the doc-not-needed Your PR changes do not impact docs label Apr 17, 2024
Copy link
Member

@lhotari lhotari left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work @sandeep-mst . A few minor review comments.

Copy link
Contributor

@nicoloboschi nicoloboschi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this idea.

  1. I think we should register the new commands like other commands in registerProviders(..) so automatic autocompletion will work for these modes too.

  2. I don't understand the title, what do you mean by persistent modes ? I think we need a better name for this feature.

  3. We should add docs, at least in the help (might be mitigated by 1.)

spaces where required, single line variable, promptmessage value stays the same but the prompt varies
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-not-needed Your PR changes do not impact docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

pulsar-shell persistent modes
3 participants