[api][pulsar-client]Add get version command for pulsar rest api, pulsar-admin, pulsar-client #9975

tuteng · 2021-03-19T13:19:41Z

(If this PR fixes a github issue, please add Fixes #<xyz>.)

Motivation

Add the version command:
Get broker version by rest API:

curl http://localhost:8080/admin/v2/brokers/version

Get broker version by pulsar-admin:

./bin/pulsar-admin brokers version

Get broker version by the command pulsar:

./bin/pulsar version

Get version of pulsar admin client:

./bin/pulsar-admin -v
./bin/pulsra-admin --version

Get version of pulsar client:

./bin/pulsar-client -v
./bin/pulsra-client --version

Modifications

Add rest API for get version of broker
Add getVersion for the command pulsar
Add getVersion for the command pulsar-admin
Add getVersion for the command pulsar-client

Verifying this change

Add unit test
Add integration test

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

If yes was chosen, please highlight the changes

Dependencies (does it add or upgrade a dependency): (yes / no)
The public API: (yes / no)
The schema: (yes / no / don't know)
The default values of configurations: (yes / no)
The wire protocol: (yes / no)
The rest endpoints: (yes / no)
The admin cli options: (yes / no)
Anything that affects deployment: (yes / no / don't know)

Documentation

Does this pull request introduce a new feature? (yes / no)
If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
If a feature is not applicable for documentation, explain why?
If a feature is not documented yet in this PR, please create a followup issue for adding the documentation

codelipenghui · 2021-03-22T04:44:30Z

pulsar-broker/src/main/java/org/apache/pulsar/PulsarVersionStarter.java

+/**
+ * Pulsar version entry point.
+ */
+public class PulsarVersionStarter {


Do we need this change?

Yes, I found that other commands such as pulsar broker, pulsar proxy are a public class with a main function, pulsar version as a separate command, also needs to be a class with a main function, otherwise, it needs to be a subcommand of other commands

eolivelli

+1
Overall looks good.

I left a proposal, probably for a future enhancement

eolivelli · 2021-03-22T14:27:41Z

pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdBrokers.java

+
+        @Override
+        void run() throws Exception {
+            System.out.println( getAdmin().brokers().getVersion());


I believe that we have a little usability problem here.

The user does not know which broker reported the version.

Proposals:

return the address of the broker that reported the version (a BrokerInfo structure ?)

add a (optional) parameter to specify the id of the broker that we want to query

In a Pulsar cluster usually you have the same version of the software, but this may not be the case during upgrades or in case you have special versions of Pulsar on some nodes.

Thanks, I agree with you, but I think the current version of the broker can be queried explicitly using the pulsar-admin brokers version command, for example, the pulsar-admin brokers version command will use the webServiceUrl configuration in the client.conf configuration file, and of course, the webServiceUrl parameter can be used to specify the address of the broker to be queried by the command pulsar-admin --admin-url, In a pulsar cluster upgrade, multiple versions of the broker will exist at the same time, and with the --admin-url parameter, we can explicitly get the version of the specified broker

Anonymitaet · 2021-03-23T00:57:23Z

@tuteng thanks for your contribution.

For docs side:

REST API & pulsar-admin
You've added descriptions, they will be shown on websites.
pulsar-client
Think descriptions should be added to the pulsar-client page.
Our community has submitted a request that it is better to generate the pulsar-client page (https://pulsar.apache.org/docs/en/next/pulsar-admin/) from code automatically for a long time. In this case, we do not need to add descriptions manually, which eats up much time. May I know the process of the automatic work? Many thanks

tuteng · 2021-03-23T02:12:36Z

@codelipenghui PTAL

Anonymitaet · 2021-03-26T00:12:26Z

Add docs w/ other changes here.

…ar-admin, pulsar-client (#9975) Add the version command: Get broker version by rest API: ``` curl http://localhost:8080/admin/v2/brokers/version ``` Get broker version by `pulsar-admin`: ``` ./bin/pulsar-admin brokers version ``` Get broker version by the command `pulsar`: ``` ./bin/pulsar version ``` Get version of pulsar admin client: ``` ./bin/pulsar-admin -v ./bin/pulsra-admin --version ``` Get version of pulsar client: ``` ./bin/pulsar-client -v ./bin/pulsra-client --version (cherry picked from commit 5d85a2f)

Add get version command for pulsar rest api, pulsar-admin, pulsar-client

cb10b7a

tuteng changed the title ~~Add get version command for pulsar rest api, pulsar-admin, pulsar-client~~ [api][pulsar-client]Add get version command for pulsar rest api, pulsar-admin, pulsar-client Mar 19, 2021

tuteng added 2 commits March 19, 2021 21:22

Fixed boolean flag

cfa139f

Fixed client version

b7a4765

tuteng requested review from codelipenghui, jiazhai, sijie and zymap March 19, 2021 14:35

tuteng self-assigned this Mar 19, 2021

tuteng added area/admin area/broker area/client component/rest doc-required Your PR changes impact docs and you will update later. labels Mar 19, 2021

tuteng added this to the 2.8.0 milestone Mar 19, 2021

jiazhai approved these changes Mar 21, 2021

View reviewed changes

codelipenghui reviewed Mar 22, 2021

View reviewed changes

Add integration test for version command

b9ce866

sijie approved these changes Mar 22, 2021

View reviewed changes

tuteng added 2 commits March 22, 2021 17:20

Fixed build failed

bb271ea

Fixed assertTrue

95c6913

eolivelli approved these changes Mar 22, 2021

View reviewed changes

format code, fixed space

be79b07

codelipenghui approved these changes Mar 23, 2021

View reviewed changes

codelipenghui merged commit 5d85a2f into apache:master Mar 23, 2021

Anonymitaet removed the doc-required Your PR changes impact docs and you will update later. label Mar 26, 2021

codelipenghui added the release/2.7.2 label Mar 26, 2021

codelipenghui added the cherry-picked/branch-2.7 Archived: 2.7 is end of life label Mar 30, 2021

linlinnn mentioned this pull request May 13, 2021

CLI tools should have a command for showing the currently running/installed version. #10577

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[api][pulsar-client]Add get version command for pulsar rest api, pulsar-admin, pulsar-client #9975

[api][pulsar-client]Add get version command for pulsar rest api, pulsar-admin, pulsar-client #9975

tuteng commented Mar 19, 2021 •

edited

codelipenghui Mar 22, 2021

tuteng Mar 22, 2021 •

edited

eolivelli left a comment

eolivelli Mar 22, 2021

tuteng Mar 23, 2021

Anonymitaet commented Mar 23, 2021 •

edited

tuteng commented Mar 23, 2021

Anonymitaet commented Mar 26, 2021

[api][pulsar-client]Add get version command for pulsar rest api, pulsar-admin, pulsar-client #9975

[api][pulsar-client]Add get version command for pulsar rest api, pulsar-admin, pulsar-client #9975

Conversation

tuteng commented Mar 19, 2021 • edited

Motivation

Modifications

Verifying this change

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

Documentation

codelipenghui Mar 22, 2021

Choose a reason for hiding this comment

tuteng Mar 22, 2021 • edited

Choose a reason for hiding this comment

eolivelli left a comment

Choose a reason for hiding this comment

eolivelli Mar 22, 2021

Choose a reason for hiding this comment

tuteng Mar 23, 2021

Choose a reason for hiding this comment

Anonymitaet commented Mar 23, 2021 • edited

tuteng commented Mar 23, 2021

Anonymitaet commented Mar 26, 2021

tuteng commented Mar 19, 2021 •

edited

tuteng Mar 22, 2021 •

edited

Anonymitaet commented Mar 23, 2021 •

edited