[docs]Add topic-level policy config #9108

Jennifer88huang-zz · 2021-01-02T11:01:32Z

Motivation

Topic-level policies are available since Pulsar 2.7.0.

Modifications

Add how to configure topic-level policies.

Related to #9161

Huanli-Meng

Leave my comments. PTAL

Huanli-Meng · 2021-01-11T01:07:09Z

site2/docs/reference-pulsar-admin.md


 Usage
 ```bash
 $ pulsar-admin topics subcommand
 ```

+From Pulsar 2.7.0, some namespace level policies are available on topic level. To enable topic level policy in Pulsar, you need to configure the following parameters in the `broker.conf` file. 


Suggested change

From Pulsar 2.7.0, some namespace level policies are available on topic level. To enable topic level policy in Pulsar, you need to configure the following parameters in the `broker.conf` file.

From Pulsar 2.7.0, some namespace-level policies are available on topic level. To enable topic-level policies in Pulsar, you need to configure the following parameters in the `broker.conf` file.

same comments for docs of other releases.

Updated, thank you.

freeznet

Please refer to my comments, some commands name are not aligned with code.

freeznet · 2021-01-11T07:57:48Z

site2/docs/reference-pulsar-admin.md

@@ -1815,6 +1822,36 @@ Subcommands
 * `get-deduplication`
 * `set-deduplication`
 * `remove-deduplication`
+* `get-max-producers`


according to code, this should be get-maxProducers, set-maxProducers and remove-maxProducers

freeznet · 2021-01-11T07:59:33Z

site2/docs/reference-pulsar-admin.md

+* `get-offload-policies`
+* `set-offload-policies`
+* `remove-offload-policies`
+* `get-max-unacked-messages-per-subscription`


get-max-unacked-messages-on-subscription

freeznet · 2021-01-11T07:59:42Z

site2/docs/reference-pulsar-admin.md

+* `set-offload-policies`
+* `remove-offload-policies`
+* `get-max-unacked-messages-per-subscription`
+* `set-max-unacked-messages-per-subscription`


set-max-unacked-messages-on-subscription

freeznet · 2021-01-11T07:59:59Z

site2/docs/reference-pulsar-admin.md

+* `remove-offload-policies`
+* `get-max-unacked-messages-per-subscription`
+* `set-max-unacked-messages-per-subscription`
+* `remove-max-unacked-messages-per-subscription`


remove-max-unacked-messages-on-subscription

freeznet · 2021-01-11T08:00:09Z

site2/docs/reference-pulsar-admin.md

+* `get-max-unacked-messages-per-subscription`
+* `set-max-unacked-messages-per-subscription`
+* `remove-max-unacked-messages-per-subscription`
+* `get-max-unacked-messages-per-consumer`


get-max-unacked-messages-on-consumer

freeznet · 2021-01-11T08:00:17Z

site2/docs/reference-pulsar-admin.md

+* `set-max-unacked-messages-per-subscription`
+* `remove-max-unacked-messages-per-subscription`
+* `get-max-unacked-messages-per-consumer`
+* `set-max-unacked-messages-per-consumer`


set-max-unacked-messages-on-consumer

freeznet · 2021-01-11T08:00:26Z

site2/docs/reference-pulsar-admin.md

+* `remove-max-unacked-messages-per-subscription`
+* `get-max-unacked-messages-per-consumer`
+* `set-max-unacked-messages-per-consumer`
+* `remove-max-unacked-messages-per-consumer`


remove-max-unacked-messages-on-consumer

Jennifer88huang-zz · 2021-01-11T11:23:00Z

@freeznet Thank you for your comments. Is it better to keep consistent for them in the code?

freeznet · 2021-01-11T13:01:02Z

@jennifer88huang I think all commands should in lower case and unified format, as for the blue blocks, like get-maxProducers, should changed to get-max-producers. For the red blocks, I think they are fine, since the command name is just same as the function name, like GetMaxConsumersPerSubscription -> get-max-consumers-per-subscription.

codelipenghui · 2021-01-11T13:08:42Z

@freeznet I think get-maxProducers is mistaken in the previous PR. We can add get-max-producers command first and add @Deprecated for the non-lower-case commands. And we can also make the non-lower-case command does not appear while run bin/pulsar-admin topics. This will guarantee compatibility.

Jennifer88huang-zz · 2021-01-11T13:59:56Z

@freeznet @codelipenghui thank you for your confirmation.
For those in the red boxes, I want to say that in namespaces, we use the word "xxx-per-xxx" (see screenshot below). Since those topic-level polices come from the namespace level, is it more user-friendly if we keep consistent and use the word "per" for topic-level policies? Otherwise, users might use the wrong commands if they want to adopt namespace-level policies to topic-level polices. cc @sijia-w

codelipenghui · 2021-01-11T14:45:27Z

@jennifer88huang No, topic policy always for one topic, so we don't need to add -per-topic

Jennifer88huang-zz · 2021-01-12T01:35:14Z

@sijia-w confirmed with eng, we need to keep topic-level commands consistent with that in the namespace-level.
So it should be "get-max-producers", "get-max-unacked-messages-per-consumer", get-max-unacked-messages-per-subscription". Use this kind of format in the docs, and eng will refine the code accordingly.
cc @codelipenghui @freeznet

#9215) Fixes #9205 ### Motivation In #9108, we add some topic-level policies commands, and found some commands are not consistent with that for namespace-level. For example, On namespace-level, the policies commands are: ``` get-max-producers set-max-producers remove-max-producers get-max-unacked-messages-per-subscription set-max-unacked-messages-per-subscription remove-max-unacked-messages-per-subscription ``` On topic-level, the polices commands are: ``` get-maxProducers set-maxProducers remove-maxProducers get-max-unacked-messages-on-subscription set-max-unacked-messages-on-subscription remove-max-unacked-messages-on-subscription ``` ### Modifications Keep topic-level policies commands consistent with that for namespace

#9215) Fixes #9205 In #9108, we add some topic-level policies commands, and found some commands are not consistent with that for namespace-level. For example, On namespace-level, the policies commands are: ``` get-max-producers set-max-producers remove-max-producers get-max-unacked-messages-per-subscription set-max-unacked-messages-per-subscription remove-max-unacked-messages-per-subscription ``` On topic-level, the polices commands are: ``` get-maxProducers set-maxProducers remove-maxProducers get-max-unacked-messages-on-subscription set-max-unacked-messages-on-subscription remove-max-unacked-messages-on-subscription ``` Keep topic-level policies commands consistent with that for namespace (cherry picked from commit d557e0a)

Jennifer88huang-zz · 2021-01-29T03:08:38Z

Thank you @315157973 for fixing the command name issues in #9215. Shall we go on with the doc PR? @freeznet

freeznet

LGTM

Jennifer88huang-zz · 2021-01-29T10:07:44Z

Thank you @freeznet
@315157973 @codelipenghui @Huanli-Meng do you have any concern on it?

Jennifer88huang-zz added 2 commits January 2, 2021 18:56

add topic-level policy config

0c70866

update

0be5cef

Jennifer88huang-zz self-assigned this Jan 2, 2021

Jennifer88huang-zz mentioned this pull request Jan 10, 2021

retention support per topic #8899

Closed

Jennifer88huang-zz changed the title ~~[WIP][docs]Add topic-level policy config~~ [docs]Add topic-level policy config Jan 10, 2021

Jennifer88huang-zz added this to the 2.8.0 milestone Jan 10, 2021

Jennifer88huang-zz added doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. component/topic-policy release/2.7.1 labels Jan 10, 2021

Jennifer88huang-zz requested review from codelipenghui, Huanli-Meng and sijie January 10, 2021 14:18

Jennifer88huang-zz added 2 commits January 10, 2021 22:21

update

0f98aca

apply to 270

bc204d4

Huanli-Meng reviewed Jan 11, 2021

View reviewed changes

update

543921e

Jennifer88huang-zz mentioned this pull request Jan 11, 2021

[DOCS] - Update the topic-level policies #9161

Closed

freeznet requested changes Jan 11, 2021

View reviewed changes

Jennifer88huang-zz mentioned this pull request Jan 14, 2021

Keep topic-level policies commands consistent with that for namespace level #9205

Closed

sijie mentioned this pull request Jan 14, 2021

ISSUE-9205: Keep topic-level policies commands consistent with that for namespace level streamnative/pulsar-archived#2010

Closed

315157973 mentioned this pull request Jan 15, 2021

Keep topic-level policies commands consistent with that for namespace… #9215

Merged

freeznet approved these changes Jan 29, 2021

View reviewed changes

Huanli-Meng approved these changes Feb 1, 2021

View reviewed changes

Jennifer88huang-zz merged commit 88c9e09 into apache:master Feb 1, 2021

Jennifer88huang-zz deleted the tp branch February 1, 2021 02:11

sijia-w mentioned this pull request Feb 9, 2021

[DOCS] - Update the topic-level policies #9530

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs]Add topic-level policy config #9108

[docs]Add topic-level policy config #9108

Jennifer88huang-zz commented Jan 2, 2021 •

edited

Loading

Huanli-Meng left a comment

Huanli-Meng Jan 11, 2021

Jennifer88huang-zz Jan 11, 2021

freeznet left a comment

freeznet Jan 11, 2021

freeznet Jan 11, 2021

freeznet Jan 11, 2021

freeznet Jan 11, 2021

freeznet Jan 11, 2021

freeznet Jan 11, 2021

freeznet Jan 11, 2021

Jennifer88huang-zz commented Jan 11, 2021 •

edited

Loading

freeznet commented Jan 11, 2021

codelipenghui commented Jan 11, 2021

Jennifer88huang-zz commented Jan 11, 2021 •

edited

Loading

codelipenghui commented Jan 11, 2021

Jennifer88huang-zz commented Jan 12, 2021

Jennifer88huang-zz commented Jan 29, 2021

freeznet left a comment

Jennifer88huang-zz commented Jan 29, 2021

	From Pulsar 2.7.0, some namespace level policies are available on topic level. To enable topic level policy in Pulsar, you need to configure the following parameters in the `broker.conf` file.
	From Pulsar 2.7.0, some namespace-level policies are available on topic level. To enable topic-level policies in Pulsar, you need to configure the following parameters in the `broker.conf` file.

[docs]Add topic-level policy config #9108

[docs]Add topic-level policy config #9108

Conversation

Jennifer88huang-zz commented Jan 2, 2021 • edited Loading

Motivation

Modifications

Huanli-Meng left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

freeznet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jennifer88huang-zz commented Jan 11, 2021 • edited Loading

freeznet commented Jan 11, 2021

codelipenghui commented Jan 11, 2021

Jennifer88huang-zz commented Jan 11, 2021 • edited Loading

codelipenghui commented Jan 11, 2021

Jennifer88huang-zz commented Jan 12, 2021

Jennifer88huang-zz commented Jan 29, 2021

freeznet left a comment

Choose a reason for hiding this comment

Jennifer88huang-zz commented Jan 29, 2021

Jennifer88huang-zz commented Jan 2, 2021 •

edited

Loading

Jennifer88huang-zz commented Jan 11, 2021 •

edited

Loading

Jennifer88huang-zz commented Jan 11, 2021 •

edited

Loading