Update command descriptions from old 'property/cluster/namespace' for…

…mat to current 'tenant/namespace' format
datastax · Dec 24, 2020 · 8171007 · 8171007
1 parent dbe1fee
commit 8171007
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 40 deletions.
diff --git a/docker/publish.sh b/docker/publish.sh
@@ -50,6 +50,8 @@ fi
 MVN_VERSION=`./get-version.sh`
 echo "Pulsar version: ${MVN_VERSION}"
 
+exit
+
 if [[ -z ${DOCKER_REGISTRY} ]]; then
     docker_registry_org=${DOCKER_ORG}
 else

diff --git a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdNonPersistentTopics.java b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdNonPersistentTopics.java
@@ -45,7 +45,7 @@ public CmdNonPersistentTopics(PulsarAdmin admin) {
 
     @Parameters(commandDescription = "Lookup a topic from the current serving broker")
     private class Lookup extends CliCommand {
-        @Parameter(description = "non-persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "non-persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -58,7 +58,7 @@ void run() throws PulsarAdminException {
     @Parameters(commandDescription = "Get the stats for the topic and its connected producers and consumers. \n"
             + "\t       All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.")
     private class GetStats extends CliCommand {
-        @Parameter(description = "non-persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "non-persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -70,7 +70,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Get the internal stats for the topic")
     private class GetInternalStats extends CliCommand {
-        @Parameter(description = "non-persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "non-persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -84,7 +84,7 @@ void run() throws PulsarAdminException {
             + "\t\tThe partitioned topic has to be created before creating a producer on it.")
     private class CreatePartitionedCmd extends CliCommand {
 
-        @Parameter(description = "non-persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "non-persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = { "-p",
@@ -102,7 +102,7 @@ void run() throws Exception {
             + "\t\tIf the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions")
     private class GetPartitionedTopicMetadataCmd extends CliCommand {
 
-        @Parameter(description = "non-persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "non-persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -114,7 +114,7 @@ void run() throws Exception {
 
     @Parameters(commandDescription = "Get list of non-persistent topics present under a namespace")
     private class GetList extends CliCommand {
-        @Parameter(description = "property/cluster/namespace\n", required = true)
+        @Parameter(description = "tenant/namespaces\n", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -126,7 +126,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Get list of non-persistent topics present under a namespace bundle")
     private class GetListInBundle extends CliCommand {
-        @Parameter(description = "property/cluster/namespace\n", required = true)
+        @Parameter(description = "tenant/namespaces\n", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = { "-b",

diff --git a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdPersistentTopics.java b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdPersistentTopics.java
@@ -89,7 +89,7 @@ public CmdPersistentTopics(PulsarAdmin admin) {
 
     @Parameters(commandDescription = "Get the list of topics under a namespace.")
     private class ListCmd extends CliCommand {
-        @Parameter(description = "property/cluster/namespace\n", required = true)
+        @Parameter(description = "tenant/namespaces\n", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -101,7 +101,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Get the list of partitioned topics under a namespace.")
     private class PartitionedTopicListCmd extends CliCommand {
-        @Parameter(description = "property/cluster/namespace\n", required = true)
+        @Parameter(description = "tenant/namespaces\n", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -113,7 +113,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Grant a new permission to a client role on a single topic.")
     private class GrantPermissions extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = "--role", description = "Client role to which grant permissions", required = true)
@@ -134,7 +134,7 @@ void run() throws PulsarAdminException {
             + "\t\t\t   was not set at the topic level, but rather at the namespace level, this \n"
             + "\t\t\t   operation will return an error (HTTP status code 412).")
     private class RevokePermissions extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = "--role", description = "Client role to which revoke permissions", required = true)
@@ -152,7 +152,7 @@ void run() throws PulsarAdminException {
             + "\t\t     by the permissions set at the namespace level combined (union) with any eventual \n"
             + "\t\t     specific permission set on the topic.")
     private class Permissions extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -164,7 +164,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Lookup a topic from the current serving broker")
     private class Lookup extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -176,7 +176,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Get Namespace bundle range of a topic")
     private class GetBundleRange extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -190,7 +190,7 @@ void run() throws PulsarAdminException {
             + "\t\tThe partitioned topic has to be created before creating a producer on it.")
     private class CreatePartitionedCmd extends CliCommand {
 
-        @Parameter(description = "persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = { "-p",
@@ -208,7 +208,7 @@ void run() throws Exception {
             + "\t\tNew updating number of partitions must be greater than existing number of partitions.")
     private class UpdatePartitionedCmd extends CliCommand {
 
-        @Parameter(description = "persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = { "-p",
@@ -226,7 +226,7 @@ void run() throws Exception {
             + "\t\tIf the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions")
     private class GetPartitionedTopicMetadataCmd extends CliCommand {
 
-        @Parameter(description = "persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -240,7 +240,7 @@ void run() throws Exception {
             + "\t\tIt will also delete all the partitions of the topic if it exists.")
     private class DeletePartitionedCmd extends CliCommand {
 
-        @Parameter(description = "persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = "--force", description = "Close all producer/consumer/replicator and delete topic forcefully")
@@ -256,7 +256,7 @@ void run() throws Exception {
     @Parameters(commandDescription = "Delete a topic. \n"
             + "\t\tThe topic cannot be deleted if there's any active subscription or producers connected to it.")
     private class DeleteCmd extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = "--force", description = "Close all producer/consumer/replicator and delete topic forcefully")
@@ -271,7 +271,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Unload a topic. \n")
     private class UnloadCmd extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -283,7 +283,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Get the list of subscriptions on the topic")
     private class ListSubscriptions extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -296,7 +296,7 @@ void run() throws Exception {
     @Parameters(commandDescription = "Delete a durable subscriber from a topic. \n"
             + "\t\tThe subscription cannot be deleted if there are any active consumers attached to it \n")
     private class DeleteSubscription extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = { "-f",
@@ -316,7 +316,7 @@ void run() throws PulsarAdminException {
     @Parameters(commandDescription = "Get the stats for the topic and its connected producers and consumers. \n"
             + "\t       All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.")
     private class GetStats extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -328,7 +328,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Get the internal stats for the topic")
     private class GetInternalStats extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -340,7 +340,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Get the internal metadata info for the topic")
     private class GetInternalInfo extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -355,7 +355,7 @@ void run() throws PulsarAdminException {
     @Parameters(commandDescription = "Get the stats for the partitioned topic and its connected producers and consumers. \n"
             + "\t       All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.")
     private class GetPartitionedStats extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = "--per-partition", description = "Get per partition stats")
@@ -371,7 +371,7 @@ void run() throws Exception {
     @Parameters(commandDescription = "Get the stats-internal for the partitioned topic and its connected producers and consumers. \n"
             + "\t       All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.")
     private class GetPartitionedStatsInternal extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic\n", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic\n", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -383,7 +383,7 @@ void run() throws Exception {
 
     @Parameters(commandDescription = "Skip all the messages for the subscription")
     private class SkipAll extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = { "-s", "--subscription" }, description = "Subscription to be cleared", required = true)
@@ -398,7 +398,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Skip some messages for the subscription")
     private class Skip extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = { "-s",
@@ -417,7 +417,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Expire messages that older than given expiry time (in seconds) for the subscription")
     private class ExpireMessages extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = { "-s",
@@ -436,7 +436,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Expire messages that older than given expiry time (in seconds) for all subscriptions")
     private class ExpireMessagesForAllSubscriptions extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = { "-t", "--expireTime" }, description = "Expire messages older than time in seconds", required = true)
@@ -451,7 +451,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Create a new subscription on a topic")
     private class CreateSubscription extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = { "-s",
@@ -480,7 +480,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Reset position for subscription to position closest to timestamp or messageId")
     private class ResetCursor extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = { "-s",
@@ -516,7 +516,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Terminate a topic and don't allow any more messages to be published")
     private class Terminate extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -534,7 +534,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Peek some messages for the subscription")
     private class PeekMessages extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = { "-s",
@@ -612,7 +612,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Compact a topic")
     private class Compact extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic", required = true)
         private java.util.List<String> params;
 
         @Override
@@ -626,7 +626,7 @@ void run() throws PulsarAdminException {
 
     @Parameters(commandDescription = "Status of compaction on a topic")
     private class CompactionStatusCmd extends CliCommand {
-        @Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
+        @Parameter(description = "persistent://tenant/namespaces/topic", required = true)
         private java.util.List<String> params;
 
         @Parameter(names = { "-w", "--wait-complete" },