You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by ur...@apache.org on 2022/07/07 12:01:47 UTC
[pulsar-site] branch main updated: Docs sync done from apache/pulsar(#318432e)
This is an automated email from the ASF dual-hosted git repository.
urfree pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new f69265b26b5 Docs sync done from apache/pulsar(#318432e)
f69265b26b5 is described below
commit f69265b26b51ad7face95436b31e1cbfce80aaed
Author: Pulsar Site Updater <de...@pulsar.apache.org>
AuthorDate: Thu Jul 7 12:01:43 2022 +0000
Docs sync done from apache/pulsar(#318432e)
---
site2/website-next/docs/admin-api-brokers.md | 2 +-
site2/website-next/docs/admin-api-functions.md | 36 +++---
site2/website-next/docs/admin-api-namespaces.md | 134 +-------------------
site2/website-next/docs/admin-api-topics.md | 58 ++-------
site2/website-next/docs/administration-upgrade.md | 139 ++++++++++++++-------
site2/website-next/docs/schema-manage.md | 6 +-
.../versioned_sidebars/version-2.8.3-sidebars.json | 2 +-
7 files changed, 131 insertions(+), 246 deletions(-)
diff --git a/site2/website-next/docs/admin-api-brokers.md b/site2/website-next/docs/admin-api-brokers.md
index 661db9cad42..b2d3a4da2c7 100644
--- a/site2/website-next/docs/admin-api-brokers.md
+++ b/site2/website-next/docs/admin-api-brokers.md
@@ -128,7 +128,7 @@ BrokerInfo(serviceUrl=broker1.use.org.com:8080)
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|GET|/admin/v2/brokers/leaderBroker?version=@pulsar:version_number@}
+{@inject: endpoint|GET|/admin/v2/brokers/leaderBroker|operation/getLeaderBroker?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
diff --git a/site2/website-next/docs/admin-api-functions.md b/site2/website-next/docs/admin-api-functions.md
index cc8ab2fb8e3..faebe28565c 100644
--- a/site2/website-next/docs/admin-api-functions.md
+++ b/site2/website-next/docs/admin-api-functions.md
@@ -68,7 +68,7 @@ $ pulsar-admin functions create \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName?version=@pulsar:version_number@}
+{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName|operation/registerFunction?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
@@ -124,7 +124,7 @@ $ pulsar-admin functions update \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|PUT|/admin/v3/functions/:tenant/:namespace/:functionName?version=@pulsar:version_number@}
+{@inject: endpoint|PUT|/admin/v3/functions/:tenant/:namespace/:functionName|operation/updateFunction?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
@@ -174,7 +174,7 @@ $ pulsar-admin functions start \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/start?version=@pulsar:version_number@}
+{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/start|operation/startFunction?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
@@ -216,7 +216,7 @@ $ pulsar-admin functions start \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/start?version=@pulsar:version_number@}
+{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/start|operation/startFunction?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
@@ -259,7 +259,7 @@ $ pulsar-admin functions stop \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stop?version=@pulsar:version_number@}
+{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stop|operation/stopFunction?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
@@ -301,7 +301,7 @@ $ pulsar-admin functions stop \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/stop?version=@pulsar:version_number@}
+{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/stop|operation/stopFunction?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
@@ -344,7 +344,7 @@ $ pulsar-admin functions restart \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/restart?version=@pulsar:version_number@}
+{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/restart|operation/restartFunction?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
@@ -386,7 +386,7 @@ $ pulsar-admin functions restart \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/restart?version=@pulsar:version_number@}
+{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/restart|operation/restartFunction?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
@@ -427,7 +427,7 @@ $ pulsar-admin functions list \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace?version=@pulsar:version_number@}
+{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace|operation/listFunctions?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
@@ -469,7 +469,7 @@ $ pulsar-admin functions delete \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|DELETE|/admin/v3/functions/:tenant/:namespace/:functionName?version=@pulsar:version_number@}
+{@inject: endpoint|DELETE|/admin/v3/functions/:tenant/:namespace/:functionName|operation/deregisterFunction?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
@@ -511,7 +511,7 @@ $ pulsar-admin functions get \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName?version=@pulsar:version_number@}
+{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName|operation/getFunctionInfo?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
@@ -553,7 +553,7 @@ $ pulsar-admin functions status \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/status?version=@pulsar:version_number@}
+{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/status|operation/getFunctionInstanceStatus?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
@@ -595,7 +595,7 @@ $ pulsar-admin functions status \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/status?version=@pulsar:version_number@}
+{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/status|operation/getFunctionStatus?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
@@ -637,7 +637,7 @@ $ pulsar-admin functions stats \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stats?version=@pulsar:version_number@}
+{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stats|operation/getFunctionInstanceStats?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
@@ -679,7 +679,7 @@ $ pulsar-admin functions stats \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/stats?version=@pulsar:version_number@}
+{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/stats|operation/getFunctionStats?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
@@ -724,7 +724,7 @@ $ pulsar-admin functions trigger \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/trigger?version=@pulsar:version_number@}
+{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/trigger|operation/triggerFunction?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
@@ -767,7 +767,7 @@ $ pulsar-admin functions putstate \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/state/:key?version=@pulsar:version_number@}
+{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/state/:key|operation/putFunctionState?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
@@ -812,7 +812,7 @@ $ pulsar-admin functions querystate \
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/state/:key?version=@pulsar:version_number@}
+{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/state/:key|operation/getFunctionState?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java Admin API">
diff --git a/site2/website-next/docs/admin-api-namespaces.md b/site2/website-next/docs/admin-api-namespaces.md
index cc6597f3dc8..ce159d6fbbc 100644
--- a/site2/website-next/docs/admin-api-namespaces.md
+++ b/site2/website-next/docs/admin-api-namespaces.md
@@ -51,12 +51,8 @@ $ pulsar-admin namespaces create test-tenant/test-namespace
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace|operation/createNamespace?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -113,12 +109,8 @@ $ pulsar-admin namespaces policies test-tenant/test-namespace
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace|operation/getPolicies?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -156,12 +148,8 @@ test-tenant/ns2
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|GET|/admin/v2/namespaces/:tenant|operation/getTenantNamespaces?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -197,12 +185,8 @@ $ pulsar-admin namespaces delete test-tenant/ns1
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace|operation/deleteNamespace?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -239,12 +223,8 @@ $ pulsar-admin namespaces set-clusters test-tenant/ns1 \
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/replication|operation/setNamespaceReplicationClusters?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -284,12 +264,8 @@ cl2
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/replication|operation/getNamespaceReplicationClusters?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -333,12 +309,8 @@ $ pulsar-admin namespaces set-backlog-quota --limit 10G --limitTime 36000 --poli
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/backlogQuota|operation/setBacklogQuota?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -383,12 +355,8 @@ $ pulsar-admin namespaces get-backlog-quotas test-tenant/ns1
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/backlogQuotaMap|operation/getBacklogQuotaMap?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -422,12 +390,8 @@ $ pulsar-admin namespaces remove-backlog-quota test-tenant/ns1
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace/backlogQuota|operation/removeBacklogQuota?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -471,12 +435,8 @@ $ pulsar-admin namespaces set-persistence --bookkeeper-ack-quorum 2 --bookkeeper
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/persistence|operation/setPersistence?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -521,12 +481,8 @@ $ pulsar-admin namespaces get-persistence test-tenant/ns1
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/persistence|operation/getPersistence?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -562,12 +518,8 @@ $ pulsar-admin namespaces unload --bundle 0x00000000_0xffffffff test-tenant/ns1
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace/{bundle}/unload|operation/unloadNamespaceBundle?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -601,12 +553,8 @@ $ pulsar-admin namespaces split-bundle --bundle 0x00000000_0xffffffff test-tenan
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace/{bundle}/split|operation/splitNamespaceBundle?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -642,12 +590,8 @@ $ pulsar-admin namespaces set-message-ttl --messageTTL 100 test-tenant/ns1
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/messageTTL|operation/setNamespaceMessageTTL?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -687,18 +631,8 @@ $ pulsar-admin namespaces get-message-ttl test-tenant/ns1
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/messageTTL|operation/getNamespaceMessageTTL?version=@pulsar:version_number@}
-```
-
-```
-
-100
-
-```
-
</TabItem>
<TabItem value="Java">
@@ -738,12 +672,8 @@ $ pulsar-admin namespaces remove-message-ttl test-tenant/ns1
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace/messageTTL|operation/removeNamespaceMessageTTL?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -780,12 +710,8 @@ $ pulsar-admin namespaces clear-backlog --sub my-subscription test-tenant/ns1
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/clearBacklog|operation/clearNamespaceBacklogForSubscription?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -819,11 +745,7 @@ $ pulsar-admin namespaces clear-backlog --bundle 0x00000000_0xffffffff --sub m
</TabItem>
<TabItem value="REST API">
-```
-
-{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/{bundle}/clearBacklog|operation?version=@pulsar:version_number@/clearNamespaceBundleBacklogForSubscription}
-
-```
+{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/{bundle}/clearBacklog|operation/clearNamespaceBundleBacklogForSubscription?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
@@ -860,12 +782,8 @@ $ pulsar-admin namespaces set-retention --size 100 --time 10 test-tenant/ns1
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/retention|operation/setRetention?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -908,12 +826,8 @@ $ pulsar-admin namespaces get-retention test-tenant/ns1
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/retention|operation/getRetention?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -963,12 +877,8 @@ $ pulsar-admin namespaces set-dispatch-rate test-tenant/ns1 \
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/dispatchRate|operation/setDispatchRate?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -1012,12 +922,8 @@ $ pulsar-admin namespaces get-dispatch-rate test-tenant/ns1
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/dispatchRate|operation/getDispatchRate?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -1059,12 +965,8 @@ $ pulsar-admin namespaces set-subscription-dispatch-rate test-tenant/ns1 \
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/subscriptionDispatchRate|operation/setDispatchRate?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -1108,12 +1010,8 @@ $ pulsar-admin namespaces get-subscription-dispatch-rate test-tenant/ns1
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/subscriptionDispatchRate|operation/getDispatchRate?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -1155,12 +1053,8 @@ $ pulsar-admin namespaces set-replicator-dispatch-rate test-tenant/ns1 \
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/replicatorDispatchRate|operation/setDispatchRate?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -1204,12 +1098,8 @@ $ pulsar-admin namespaces get-replicator-dispatch-rate test-tenant/ns1
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/replicatorDispatchRate|operation/getDispatchRate?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
@@ -1245,11 +1135,7 @@ $ pulsar-admin namespaces get-deduplication-snapshot-interval test-tenant/ns1
</TabItem>
<TabItem value="REST API">
-```
-
-{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/deduplicationSnapshotInterval?version=@pulsar:version_number@}
-
-```
+{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/deduplicationSnapshotInterval|operation/getDeduplicationSnapshotInterval?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
@@ -1285,11 +1171,7 @@ $ pulsar-admin namespaces set-deduplication-snapshot-interval test-tenant/ns1 --
</TabItem>
<TabItem value="REST API">
-```
-
-{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/deduplicationSnapshotInterval?version=@pulsar:version_number@}
-
-```
+{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/deduplicationSnapshotInterval|operation/setDeduplicationSnapshotInterval?version=@pulsar:version_number@}
```json
@@ -1332,11 +1214,7 @@ $ pulsar-admin namespaces remove-deduplication-snapshot-interval test-tenant/ns1
</TabItem>
<TabItem value="REST API">
-```
-
-{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/deduplicationSnapshotInterval?version=@pulsar:version_number@}
-
-```
+{@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace/deduplicationSnapshotInterval|operation/deleteDeduplicationSnapshotInterval?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
@@ -1379,12 +1257,8 @@ $ pulsar-admin namespaces unload my-tenant/my-ns
</TabItem>
<TabItem value="REST API">
-```
-
{@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace/unload|operation/unloadNamespace?version=@pulsar:version_number@}
-```
-
</TabItem>
<TabItem value="Java">
diff --git a/site2/website-next/docs/admin-api-topics.md b/site2/website-next/docs/admin-api-topics.md
index 30b0ff1d583..0db608818cd 100644
--- a/site2/website-next/docs/admin-api-topics.md
+++ b/site2/website-next/docs/admin-api-topics.md
@@ -810,7 +810,7 @@ msg-payload
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/subscription/:subName/position/:messagePosition|operation?version=@pulsar:version_number@/peekNthMessage}
+{@inject: endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/subscription/:subName/position/:messagePosition|operation/peekNthMessage?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
@@ -1250,7 +1250,7 @@ pulsar-admin topics last-message-id topic-name
</TabItem>
<TabItem value="REST API">
-{@inject: endpoint|Get|/admin/v2/:schema/:tenant/:namespace/:topic/lastMessageId?version=@pulsar:version_number@}
+{@inject: endpoint|Get|/admin/v2/:schema/:tenant/:namespace/:topic/lastMessageId|operation/getLastMessageId?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
@@ -1328,11 +1328,7 @@ pulsar-admin topics get-deduplication-snapshot-interval options
</TabItem>
<TabItem value="REST API">
-```
-
-{@inject: endpoint|GET|/admin/v2/topics/:tenant/:namespace/:topic/deduplicationSnapshotInterval?version=@pulsar:version_number@}
-
-```
+{@inject: endpoint|GET|/admin/v2/topics/:tenant/:namespace/:topic/deduplicationSnapshotInterval|operation/getDeduplicationSnapshotInterval?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
@@ -1369,11 +1365,7 @@ pulsar-admin topics set-deduplication-snapshot-interval options
</TabItem>
<TabItem value="REST API">
-```
-
-{@inject: endpoint|POST|/admin/v2/topics/:tenant/:namespace/:topic/deduplicationSnapshotInterval?version=@pulsar:version_number@}
-
-```
+{@inject: endpoint|POST|/admin/v2/topics/:tenant/:namespace/:topic/deduplicationSnapshotInterval|operation/setDeduplicationSnapshotInterval?version=@pulsar:version_number@}
```json
@@ -1416,11 +1408,7 @@ pulsar-admin topics remove-deduplication-snapshot-interval options
</TabItem>
<TabItem value="REST API">
-```
-
-{@inject: endpoint|DELETE|/admin/v2/topics/:tenant/:namespace/:topic/deduplicationSnapshotInterval?version=@pulsar:version_number@}
-
-```
+{@inject: endpoint|DELETE|/admin/v2/topics/:tenant/:namespace/:topic/deduplicationSnapshotInterval|operation/deleteDeduplicationSnapshotInterval?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
@@ -1458,11 +1446,7 @@ pulsar-admin topics get-inactive-topic-policies options
</TabItem>
<TabItem value="REST API">
-```
-
-{@inject: endpoint|GET|/admin/v2/topics/:tenant/:namespace/:topic/inactiveTopicPolicies?version=@pulsar:version_number@}
-
-```
+{@inject: endpoint|GET|/admin/v2/topics/:tenant/:namespace/:topic/inactiveTopicPolicies|operation/getInactiveTopicPolicies?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
@@ -1497,11 +1481,7 @@ pulsar-admin topics set-inactive-topic-policies options
</TabItem>
<TabItem value="REST API">
-```
-
-{@inject: endpoint|POST|/admin/v2/topics/:tenant/:namespace/:topic/inactiveTopicPolicies?version=@pulsar:version_number@}
-
-```
+{@inject: endpoint|POST|/admin/v2/topics/:tenant/:namespace/:topic/inactiveTopicPolicies|operation/setInactiveTopicPolicies?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
@@ -1536,11 +1516,7 @@ pulsar-admin topics remove-inactive-topic-policies options
</TabItem>
<TabItem value="REST API">
-```
-
-{@inject: endpoint|DELETE|/admin/v2/topics/:tenant/:namespace/:topic/inactiveTopicPolicies?version=@pulsar:version_number@}
-
-```
+{@inject: endpoint|DELETE|/admin/v2/topics/:tenant/:namespace/:topic/inactiveTopicPolicies|operation/removeInactiveTopicPolicies?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
@@ -1578,11 +1554,7 @@ pulsar-admin topics get-offload-policies options
</TabItem>
<TabItem value="REST API">
-```
-
-{@inject: endpoint|GET|/admin/v2/topics/:tenant/:namespace/:topic/offloadPolicies?version=@pulsar:version_number@}
-
-```
+{@inject: endpoint|GET|/admin/v2/topics/:tenant/:namespace/:topic/offloadPolicies|operation/getOffloadPolicies?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
@@ -1617,11 +1589,7 @@ pulsar-admin topics set-offload-policies options
</TabItem>
<TabItem value="REST API">
-```
-
-{@inject: endpoint|POST|/admin/v2/topics/:tenant/:namespace/:topic/offloadPolicies?version=@pulsar:version_number@}
-
-```
+{@inject: endpoint|POST|/admin/v2/topics/:tenant/:namespace/:topic/offloadPolicies|operation/setOffloadPolicies?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
@@ -1656,11 +1624,7 @@ pulsar-admin topics remove-offload-policies options
</TabItem>
<TabItem value="REST API">
-```
-
-{@inject: endpoint|DELETE|/admin/v2/topics/:tenant/:namespace/:topic/offloadPolicies?version=@pulsar:version_number@}
-
-```
+{@inject: endpoint|DELETE|/admin/v2/topics/:tenant/:namespace/:topic/offloadPolicies|operation/removeOffloadPolicies?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
diff --git a/site2/website-next/docs/administration-upgrade.md b/site2/website-next/docs/administration-upgrade.md
index ea09e1da148..e2d216c2067 100644
--- a/site2/website-next/docs/administration-upgrade.md
+++ b/site2/website-next/docs/administration-upgrade.md
@@ -4,33 +4,42 @@ title: Upgrade Guide
sidebar_label: "Upgrade"
---
+````mdx-code-block
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+````
+
## Upgrade guidelines
-Apache Pulsar is comprised of multiple components, ZooKeeper, bookies, and brokers. These components are either stateful or stateless. You do not have to upgrade ZooKeeper nodes unless you have special requirement. While you upgrade, you need to pay attention to bookies (stateful), brokers and proxies (stateless).
+Apache Pulsar is comprised of multiple components, ZooKeeper, bookies, and brokers. These components are either stateful or stateless. You do not have to upgrade ZooKeeper nodes unless you have special requirements. While you upgrade, you need to pay attention to bookies (stateful), brokers, and proxies (stateless).
-The following are some guidelines on upgrading a Pulsar cluster. Read the guidelines before upgrading.
+Read the following guidelines before upgrading a Pulsar cluster.
-- Backup all your configuration files before upgrading.
-- Read guide entirely, make a plan, and then execute the plan. When you make upgrade plan, you need to take your specific requirements and environment into consideration.
-- Pay attention to the upgrading order of components. In general, you do not need to upgrade your ZooKeeper or configuration store cluster (the global ZooKeeper cluster). You need to upgrade bookies first, and then upgrade brokers, proxies, and your clients.
+- Back up all your configuration files before upgrading.
+- Read the guide entirely, make a plan, and then execute the plan. When you make an upgrade plan, you need to take your specific requirements and environment into consideration.
+- Pay attention to the [upgrade sequence of components](#upgrade-sequence). In general, you do not need to upgrade your ZooKeeper or configuration store cluster (the global ZooKeeper cluster). You need to upgrade bookies first, and then upgrade brokers, proxies, and your clients.
- If `autorecovery` is enabled, you need to disable `autorecovery` in the upgrade process, and re-enable it after completing the process.
-- Read the release notes carefully for each release. Release notes contain features, configuration changes that might impact your upgrade.
+- Read the release notes carefully for each release. Release notes contain features and configuration changes that might impact your upgrade.
- Upgrade a small subset of nodes of each type to canary test the new version before upgrading all nodes of that type in the cluster. When you have upgraded the canary nodes, run for a while to ensure that they work correctly.
-- Upgrade one data center to verify new version before upgrading all data centers if your cluster runs in multi-cluster replicated mode.
+- Upgrade one data center to verify the new version before upgrading all data centers if your cluster runs in multi-cluster replicated mode.
+
+:::note
+
+Currently, Apache Pulsar is compatible between versions.
-> Note: Currently, Apache Pulsar is compatible between versions.
+:::
## Upgrade sequence
To upgrade an Apache Pulsar cluster, follow the upgrade sequence.
-1. Upgrade ZooKeeper (optional)
-- Canary test: test an upgraded version in one or a small set of ZooKeeper nodes.
-- Rolling upgrade: rollout the upgraded version to all ZooKeeper servers incrementally, one at a time. Monitor your dashboard during the whole rolling upgrade process.
-2. Upgrade bookies
-- Canary test: test an upgraded version in one or a small set of bookies.
-- Rolling upgrade:
- - a. Disable `autorecovery` with the following command.
+1. Upgrade ZooKeeper (optional).
+ - Canary test: test an upgraded version in one or a small set of ZooKeeper nodes.
+ - Rolling upgrade: roll out the upgraded version to all ZooKeeper servers incrementally, one at a time. Monitor your dashboard during the whole rolling upgrade process.
+2. Upgrade bookies.
+ - Canary test: test an upgraded version in one or a small set of bookies.
+ - Rolling upgrade:
+ - a. Disable `autorecovery` with the following command.
```shell
@@ -39,8 +48,8 @@ To upgrade an Apache Pulsar cluster, follow the upgrade sequence.
```
- - b. Rollout the upgraded version to all bookies in the cluster after you determine that a version is safe after canary.
- - c. After you upgrade all bookies, re-enable `autorecovery` with the following command.
+ - b. Roll out the upgraded version to all bookies in the cluster after you determine that a version is safe after canary.
+ - c. After you upgrade all bookies, re-enable `autorecovery` with the following command.
```shell
@@ -48,52 +57,54 @@ To upgrade an Apache Pulsar cluster, follow the upgrade sequence.
```
-3. Upgrade brokers
-- Canary test: test an upgraded version in one or a small set of brokers.
-- Rolling upgrade: rollout the upgraded version to all brokers in the cluster after you determine that a version is safe after canary.
-4. Upgrade proxies
-- Canary test: test an upgraded version in one or a small set of proxies.
-- Rolling upgrade: rollout the upgraded version to all proxies in the cluster after you determine that a version is safe after canary.
+3. Upgrade brokers.
+ - Canary test: test an upgraded version in one or a small set of brokers.
+ - Rolling upgrade: roll out the upgraded version to all brokers in the cluster after you determine that a version is safe after canary.
+4. Upgrade proxies.
+ - Canary test: test an upgraded version in one or a small set of proxies.
+ - Rolling upgrade: roll out the upgraded version to all proxies in the cluster after you determine that a version is safe after canary.
## Upgrade ZooKeeper (optional)
-While you upgrade ZooKeeper servers, you can do canary test first, and then upgrade all ZooKeeper servers in the cluster.
+While you upgrade ZooKeeper servers, you can do a canary test first, and then upgrade all ZooKeeper servers in the cluster.
### Canary test
You can test an upgraded version in one of ZooKeeper servers before upgrading all ZooKeeper servers in your cluster.
-To upgrade ZooKeeper server to a new version, complete the following steps:
+To upgrade a ZooKeeper server to a new version, complete the following steps:
-1. Stop a ZooKeeper server.
+1. Stop the ZooKeeper server.
2. Upgrade the binary and configuration files.
3. Start the ZooKeeper server with the new binary files.
4. Use `pulsar zookeeper-shell` to connect to the newly upgraded ZooKeeper server and run a few commands to verify if it works as expected.
5. Run the ZooKeeper server for a few days, observe and make sure the ZooKeeper cluster runs well.
-#### Canary rollback
+:::tip
-If issues occur during canary test, you can shut down the problematic ZooKeeper node, revert the binary and configuration, and restart the ZooKeeper with the reverted binary.
+If issues occur during the canary test, you can shut down the problematic ZooKeeper node, revert the binary and configuration, and restart the ZooKeeper with the reverted binary.
+
+:::
### Upgrade all ZooKeeper servers
-After canary test to upgrade one ZooKeeper in your cluster, you can upgrade all ZooKeeper servers in your cluster.
+After the canary test to upgrade one ZooKeeper in your cluster, you can upgrade all ZooKeeper servers in your cluster.
-You can upgrade all ZooKeeper servers one by one by following steps in canary test.
+You can upgrade all ZooKeeper servers one by one by following the steps in the canary test.
## Upgrade bookies
-While you upgrade bookies, you can do canary test first, and then upgrade all bookies in the cluster.
+While you upgrade bookies, you can do a canary test first, and then upgrade all bookies in the cluster.
For more details, you can read Apache BookKeeper [Upgrade guide](https://bookkeeper.apache.org/docs/next/admin/upgrade).
### Canary test
You can test an upgraded version in one or a small set of bookies before upgrading all bookies in your cluster.
-To upgrade bookie to a new version, complete the following steps:
+To upgrade a bookie to a new version, complete the following steps:
-1. Stop a bookie.
+1. Stop the bookie.
2. Upgrade the binary and configuration files.
-3. Start the bookie in `ReadOnly` mode to verify if the bookie of this new version runs well for read workload.
+3. Start the bookie in `ReadOnly` mode to verify if the bookie of this new version runs well for reading workload.
```shell
@@ -111,13 +122,15 @@ To upgrade bookie to a new version, complete the following steps:
5. Observe and make sure the cluster serves both write and read traffic.
-#### Canary rollback
+:::tip
+
+If issues occur during the canary test, you can shut down the problematic bookie node. Other bookies in the cluster replace this problematic bookie node with auto-recovery.
-If issues occur during the canary test, you can shut down the problematic bookie node. Other bookies in the cluster replaces this problematic bookie node with autorecovery.
+:::
### Upgrade all bookies
-After canary test to upgrade some bookies in your cluster, you can upgrade all bookies in your cluster.
+After the canary test to upgrade some bookies in your cluster, you can upgrade all bookies in your cluster.
Before upgrading, you have to decide whether to upgrade the whole cluster at once, including downtime and rolling upgrade scenarios.
@@ -129,8 +142,11 @@ While you upgrade in both scenarios, the procedure is the same for each bookie.
2. Upgrade the software (either new binary or new configuration files).
2. Start the bookie.
-> **Advanced operations**
-> When you upgrade a large BookKeeper cluster in a rolling upgrade scenario, upgrading one bookie at a time is slow. If you configure rack-aware or region-aware placement policy, you can upgrade bookies rack by rack or region by region, which speeds up the whole upgrade process.
+:::tip
+
+When you upgrade a large BookKeeper cluster in a rolling upgrade scenario, upgrading one bookie at a time is slow. If you configure a rack-aware or region-aware placement policy, you can upgrade bookies rack by rack or region by region, which speeds up the whole upgrade process.
+
+:::
## Upgrade brokers and proxies
@@ -140,28 +156,59 @@ The upgrade procedure for brokers and proxies is the same. Brokers and proxies a
You can test an upgraded version in one or a small set of nodes before upgrading all nodes in your cluster.
-To upgrade to a new version, complete the following steps:
+To upgrade a broker (or proxy) to a new version, complete the following steps:
1. Stop a broker (or proxy).
2. Upgrade the binary and configuration file.
3. Start a broker (or proxy).
-#### Canary rollback
+:::tip
+
+If issues occur during the canary test, you can shut down the problematic broker (or proxy) node. Revert to the old version and restart the broker (or proxy).
-If issues occur during canary test, you can shut down the problematic broker (or proxy) node. Revert to the old version and restart the broker (or proxy).
+:::
### Upgrade all brokers or proxies
-After canary test to upgrade some brokers or proxies in your cluster, you can upgrade all brokers or proxies in your cluster.
+After the canary test to upgrade some brokers or proxies in your cluster, you can upgrade all brokers or proxies in your cluster.
Before upgrading, you have to decide whether to upgrade the whole cluster at once, including downtime and rolling upgrade scenarios.
-In a rolling upgrade scenario, you can upgrade one broker or one proxy at a time if the size of the cluster is small. If your cluster is large, you can upgrade brokers or proxies in batches. When you upgrade a batch of brokers or proxies, make sure the remaining brokers and proxies in the cluster have enough capacity to handle the traffic during upgrade.
+In a rolling upgrade scenario, you can upgrade one broker or one proxy at a time if the size of the cluster is small. If your cluster is large, you can upgrade brokers or proxies in batches. When you upgrade a batch of brokers or proxies, make sure the remaining brokers and proxies in the cluster have enough capacity to handle the traffic during the upgrade.
In a downtime upgrade scenario, shut down the entire cluster, upgrade each broker or proxy, and then start the cluster.
While you upgrade in both scenarios, the procedure is the same for each broker or proxy.
-1. Stop the broker or proxy.
+1. Stop the broker (or proxy).
2. Upgrade the software (either new binary or new configuration files).
-3. Start the broker or proxy.
+3. Start the broker (or proxy).
+
+:::tip
+
+To check the health of the broker, you can use the following command or API.
+
+````mdx-code-block
+<Tabs groupId="api-choice"
+ defaultValue="Admin CLI"
+ values={[{"label":"Admin CLI","value":"Admin CLI"},{"label":"REST API","value":"REST API"}]}>
+
+<TabItem value="Admin CLI">
+
+```bash
+
+$ pulsar-admin brokers healthcheck
+
+```
+
+</TabItem>
+<TabItem value="REST API">
+
+Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v2/brokers/health|operation/healthCheck?version=@pulsar:version_number@}
+
+</TabItem>
+
+</Tabs>
+````
+
+:::
\ No newline at end of file
diff --git a/site2/website-next/docs/schema-manage.md b/site2/website-next/docs/schema-manage.md
index a55b3356849..e6b5f898abd 100644
--- a/site2/website-next/docs/schema-manage.md
+++ b/site2/website-next/docs/schema-manage.md
@@ -233,7 +233,7 @@ Here are examples of the `schema-definition-file` for a JSON schema.
</TabItem>
<TabItem value="REST API">
-Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/uploadSchem?version=@pulsar:version_number@a}
+Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/uploadSchema?version=@pulsar:version_number@}
The post payload is in JSON format.
@@ -324,7 +324,7 @@ $ pulsar-admin schemas get <topic-name>
</TabItem>
<TabItem value="REST API">
-Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/getSchem?version=@pulsar:version_number@a}
+Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/getSchema?version=@pulsar:version_number@}
Here is an example of a response, which is returned in JSON format.
@@ -405,7 +405,7 @@ $ pulsar-admin schemas get <topic-name> --version=<version>
</TabItem>
<TabItem value="REST API">
-Send a `GET` request to a schema endpoint: {@inject: endpoint|GET|/admin/v2/schemas/:tenant/:namespace/:topic/schema/:version|operation/getSchem?version=@pulsar:version_number@a}
+Send a `GET` request to a schema endpoint: {@inject: endpoint|GET|/admin/v2/schemas/:tenant/:namespace/:topic/schema/:version|operation/getSchema?version=@pulsar:version_number@}
Here is an example of a response, which is returned in JSON format.
diff --git a/site2/website-next/versioned_sidebars/version-2.8.3-sidebars.json b/site2/website-next/versioned_sidebars/version-2.8.3-sidebars.json
index aeeb61b6399..fe90c3a08dc 100644
--- a/site2/website-next/versioned_sidebars/version-2.8.3-sidebars.json
+++ b/site2/website-next/versioned_sidebars/version-2.8.3-sidebars.json
@@ -384,7 +384,7 @@
},
{
"type": "doc",
- "id": "version-2.8.2/security-basic-auth"
+ "id": "version-2.8.3/security-basic-auth"
},
{
"type": "doc",