From 0d0af45e7b385456c2219558bcdb7f3cda6f7d54 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=86=89=E5=B0=8F=E9=BE=99?= <ranxiaolong716@gmail.com>
Date: Thu, 10 Oct 2019 19:15:27 +0800
Subject: [PATCH] [Docs] Add putstate, set-replicator-dispatch-rate and
 get-replicator-dispatch-rate cli docs for pulsar admin (#5338)

Signed-off-by: xiaolong.ran <ranxiaolong716@gmail.com>

### Motivation

In [pulsar-admin](https://pulsar.apache.org/docs/en/pulsar-admin), we have not listed the document information related to the `putstate`, `set-replicator-dispatch-rate` and `get-replicator-dispatch-rate`command.

### Modifications

*Describe the modifications you've done.*

Add `putstate` command for **pulsar-admin functions**.
Add `set-replicator-dispatch-rate` command for **pulsar-admin namespaces**.
Add `get-replicator-dispatch-rate` command for **pulsar-admin namespaces**.
---
 site2/docs/reference-pulsar-admin.md | 43 ++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/site2/docs/reference-pulsar-admin.md b/site2/docs/reference-pulsar-admin.md
index 4564aa758c1c6..935b0f2b0ae91 100644
--- a/site2/docs/reference-pulsar-admin.md
+++ b/site2/docs/reference-pulsar-admin.md
@@ -391,6 +391,7 @@ Subcommands
 * `stats`
 * `list`
 * `querystate`
+* `putstate`
 * `trigger`
 
 
@@ -696,6 +697,23 @@ Options
 |`--tenant`|The function's tenant||
 |`-w`, `--watch`|Watch for changes in the value associated with a key for a Pulsar Function|false|
 
+### `putstate`
+Put a key/value pair to the state associated with a Pulsar Function
+
+Usage
+```bash
+$ pulsar-admin functions putstate options
+```
+
+Options
+
+|Flag|Description|Default|
+|---|---|---|
+|`--fqfn`|The Fully Qualified Function Name (FQFN) for the Pulsar Function||
+|`--name`|The name of a Pulsar Function||
+|`--namespace`|The namespace of a Pulsar Function||
+|`--tenant`|The tenant of a Pulsar Function||
+|`-s`, `--state`|The FunctionState that needs to be put||
 
 ### `trigger`
 Triggers the specified Pulsar Function with a supplied value
@@ -757,6 +775,8 @@ Subcommands
 * `split-bundle`
 * `set-dispatch-rate`
 * `get-dispatch-rate`
+* `set-replicator-dispatch-rate`
+* `get-replicator-dispatch-rate`
 * `set-subscribe-rate`
 * `get-subscribe-rate`
 * `set-subscription-dispatch-rate`
@@ -1130,6 +1150,29 @@ Usage
 $ pulsar-admin namespaces get-dispatch-rate tenant/namespace
 ```
 
+### set-replicator-dispatch-rate
+Set replicator message-dispatch-rate for all topics of the namespace
+
+Usage
+```bash
+$ pulsar-admin namespaces set-replicator-dispatch-rate tenant/namespace options
+```
+
+Options
+|Flag|Description|Default|
+|----|---|---|
+|`-bd`, `--byte-dispatch-rate`|The byte dispatch rate (default -1 will be overwrite if not passed)|-1|
+|`-dt`, `--dispatch-rate-period`|The dispatch rate period in second type (default 1 second will be overwrite if not passed)|1|
+|`-md`, `--msg-dispatch-rate`|The message dispatch rate (default -1 will be overwrite if not passed)|-1|
+
+### get-replicator-dispatch-rate
+Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0)
+
+Usage
+```bash
+$ pulsar-admin namespaces get-replicator-dispatch-rate tenant/namespace
+```
+
 ### `set-subscribe-rate`
 Set subscribe-rate per consumer for all topics of the namespace