Skip to content

Commit

Permalink
[docs]Add topic-level policy config (apache#9108)
Browse files Browse the repository at this point in the history
* add topic-level policy config

* update

* update

* apply to 270

* update
  • Loading branch information
Jennifer88huang-zz authored Feb 1, 2021
1 parent 25484d7 commit 88c9e09
Show file tree
Hide file tree
Showing 3 changed files with 112 additions and 1 deletion.
39 changes: 38 additions & 1 deletion site2/docs/reference-pulsar-admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -1759,13 +1759,20 @@ Options
|`--broker`|Broker name to get namespace-isolation policies attached to it||

## `topics`
Operations for managing Pulsar topics (both persistent and non persistent)
Operations for managing Pulsar topics (both persistent and non-persistent).

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.

```shell
systemTopicEnabled=true
topicLevelPoliciesEnabled=true
```

Subcommands
* `compact`
* `compaction-status`
Expand Down Expand Up @@ -1815,6 +1822,36 @@ Subcommands
* `get-deduplication`
* `set-deduplication`
* `remove-deduplication`
* `get-max-producers`
* `set-max-producers`
* `remove-max-producers`
* `get-max-consumers`
* `set-max-consumers`
* `remove-max-consumers`
* `get-retention`
* `set-retention`
* `remove-retention`
* `get-dispatch-rate`
* `set-dispatch-rate`
* `remove-dispatch-rate`
* `get-compaction-threshold`
* `set-compaction-threshold`
* `remove-compaction-threshold`
* `get-offload-policies`
* `set-offload-policies`
* `remove-offload-policies`
* `get-max-unacked-messages-per-subscription`
* `set-max-unacked-messages-per-subscription`
* `remove-max-unacked-messages-per-subscription`
* `get-max-unacked-messages-per-consumer`
* `set-max-unacked-messages-per-consumer`
* `remove-max-unacked-messages-per-consumer`
* `get-delayed-delivery`
* `set-delayed-delivery`
* `remove-delayed-delivery`
* `get-inactive-topic-policies`
* `set-inactive-topic-policies`
* `remove-inactive-topic-policies`

### `compact`
Run compaction on the specified topic (persistent topics only)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1764,6 +1764,13 @@ Usage
$ pulsar-admin topics subcommand
```

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.

```shell
systemTopicEnabled=true
topicLevelPoliciesEnabled=true
```

Subcommands
* `compact`
* `compaction-status`
Expand Down Expand Up @@ -1813,6 +1820,36 @@ Subcommands
* `get-deduplication`
* `set-deduplication`
* `remove-deduplication`
* `get-max-producers`
* `set-max-producers`
* `remove-max-producers`
* `get-max-consumers`
* `set-max-consumers`
* `remove-max-consumers`
* `get-retention`
* `set-retention`
* `remove-retention`
* `get-dispatch-rate`
* `set-dispatch-rate`
* `remove-dispatch-rate`
* `get-compaction-threshold`
* `set-compaction-threshold`
* `remove-compaction-threshold`
* `get-offload-policies`
* `set-offload-policies`
* `remove-offload-policies`
* `get-max-unacked-messages-per-subscription`
* `set-max-unacked-messages-per-subscription`
* `remove-max-unacked-messages-per-subscription`
* `get-max-unacked-messages-per-consumer`
* `set-max-unacked-messages-per-consumer`
* `remove-max-unacked-messages-per-consumer`
* `get-delayed-delivery`
* `set-delayed-delivery`
* `remove-delayed-delivery`
* `get-inactive-topic-policies`
* `set-inactive-topic-policies`
* `remove-inactive-topic-policies`

### `compact`
Run compaction on the specified topic (persistent topics only)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1767,6 +1767,13 @@ Usage
$ pulsar-admin topics subcommand
```

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.

```shell
systemTopicEnabled=true
topicLevelPoliciesEnabled=true
```

Subcommands
* `compact`
* `compaction-status`
Expand Down Expand Up @@ -1816,6 +1823,36 @@ Subcommands
* `get-deduplication`
* `set-deduplication`
* `remove-deduplication`
* `get-max-producers`
* `set-max-producers`
* `remove-max-producers`
* `get-max-consumers`
* `set-max-consumers`
* `remove-max-consumers`
* `get-retention`
* `set-retention`
* `remove-retention`
* `get-dispatch-rate`
* `set-dispatch-rate`
* `remove-dispatch-rate`
* `get-compaction-threshold`
* `set-compaction-threshold`
* `remove-compaction-threshold`
* `get-offload-policies`
* `set-offload-policies`
* `remove-offload-policies`
* `get-max-unacked-messages-per-subscription`
* `set-max-unacked-messages-per-subscription`
* `remove-max-unacked-messages-per-subscription`
* `get-max-unacked-messages-per-consumer`
* `set-max-unacked-messages-per-consumer`
* `remove-max-unacked-messages-per-consumer`
* `get-delayed-delivery`
* `set-delayed-delivery`
* `remove-delayed-delivery`
* `get-inactive-topic-policies`
* `set-inactive-topic-policies`
* `remove-inactive-topic-policies`

### `compact`
Run compaction on the specified topic (persistent topics only)
Expand Down

0 comments on commit 88c9e09

Please sign in to comment.