Skip to content

Commit

Permalink
V2 doc changes (apache#2174)
Browse files Browse the repository at this point in the history
* Apparently we've forgotten to add some `v2`s to the URLs.

* Fix random error

* Fix s/property/tenant, delete cluster from most URLs

* Delete documentation of obsolete "List namespaces within a cluster" command
  • Loading branch information
grantwwu authored and merlimat committed Jul 18, 2018
1 parent a5c339b commit d8c0f10
Show file tree
Hide file tree
Showing 8 changed files with 100 additions and 126 deletions.
18 changes: 9 additions & 9 deletions site/docs/latest/admin-api/brokers.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Pulsar brokers consist of two components:
{% popover Brokers %} can be managed via:

* The [`brokers`](../../reference/CliTools#pulsar-admin-brokers) command of the [`pulsar-admin`](../../reference/CliTools#pulsar-admin) tool
* The `/admin/brokers` endpoint of the admin [REST API](../../reference/RestApi)
* The `/admin/v2/brokers` endpoint of the admin [REST API](../../reference/RestApi)
* The `brokers` method of the {% javadoc PulsarAdmin admin org.apache.pulsar.client.admin.PulsarAdmin %} object in the [Java API](../../clients/Java)

In addition to being configurable when you start them up, brokers can also be [dynamically configured](#dynamic-broker-configuration).
Expand All @@ -44,7 +44,7 @@ See the [Configuration](../../reference/Configuration#broker) page for a full li

### List active brokers

Fetch all available active brokers that are serving traffic.
Fetch all available active brokers that are serving traffic.

#### pulsar-admin

Expand All @@ -59,7 +59,7 @@ broker1.use.org.com:8080

###### REST

{% endpoint GET /admin/brokers/:cluster %}
{% endpoint GET /admin/v2/brokers/:cluster %}

[More info](../../reference/RestApi#/admin/brokers/:cluster)

Expand All @@ -71,7 +71,7 @@ admin.brokers().getActiveBrokers(clusterName)

#### list of namespaces owned by a given broker

It finds all namespaces which are owned and served by a given broker.
It finds all namespaces which are owned and served by a given broker.

###### CLI

Expand All @@ -91,7 +91,7 @@ $ pulsar-admin brokers namespaces use \
```
###### REST

{% endpoint GET /admin/brokers/:cluster/:broker:/ownedNamespaces %}
{% endpoint GET /admin/v2/brokers/:cluster/:broker:/ownedNamespaces %}

###### Java

Expand All @@ -106,7 +106,7 @@ One way to configure a Pulsar {% popover broker %} is to supply a [configuration
But since all broker configuration in Pulsar is stored in {% popover ZooKeeper %}, configuration values can also be dynamically updated *while the broker is running*. When you update broker configuration dynamically, ZooKeeper will notify the broker of the change and the broker will then override any existing configuration values.

* The [`brokers`](../../reference/CliTools#pulsar-admin-brokers) command for the [`pulsar-admin`](../../reference/CliTools#pulsar-admin) tool has a variety of subcommands that enable you to manipulate a broker's configuration dynamically, enabling you to [update config values](#update-dynamic-configuration) and more.
* In the Pulsar admin [REST API](../../reference/RestApi), dynamic configuration is managed through the `/admin/brokers/configuration` endpoint.
* In the Pulsar admin [REST API](../../reference/RestApi), dynamic configuration is managed through the `/admin/v2/brokers/configuration` endpoint.

### Update dynamic configuration

Expand All @@ -120,7 +120,7 @@ $ pulsar-admin brokers update-dynamic-config brokerShutdownTimeoutMs 100

#### REST API

{% endpoint POST /admin/brokers/configuration/:configName/:configValue %}
{% endpoint POST /admin/v2/brokers/configuration/:configName/:configValue %}

[More info](../../reference/RestApi#/admin/brokers/configuration/:configName/:configValue)

Expand All @@ -143,7 +143,7 @@ brokerShutdownTimeoutMs

#### REST API

{% endpoint GET /admin/brokers/configuration %}
{% endpoint GET /admin/v2/brokers/configuration %}

[More info](../../reference/RestApi#/admin/brokers/configuration)

Expand All @@ -166,7 +166,7 @@ brokerShutdownTimeoutMs:100

#### REST API

{% endpoint GET /admin/brokers/configuration/values %}
{% endpoint GET /admin/v2/brokers/configuration/values %}

[More info](../../reference/RestApi#/admin/brokers/configuration/values)

Expand Down
14 changes: 7 additions & 7 deletions site/docs/latest/admin-api/clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Pulsar clusters consist of one or more Pulsar {% popover brokers %}, one or more
Clusters can be managed via:

* The [`clusters`](../../reference/CliTools#pulsar-admin-clusters) command of the [`pulsar-admin`](../../reference/CliTools#pulsar-admin) tool
* The `/admin/clusters` endpoint of the admin [REST API](../../reference/RestApi)
* The `/admin/v2/clusters` endpoint of the admin [REST API](../../reference/RestApi)
* The `clusters` method of the {% javadoc PulsarAdmin admin org.apache.pulsar.client.admin.PulsarAdmin %} object in the [Java API](../../clients/Java)

## Clusters resources
Expand All @@ -51,7 +51,7 @@ $ pulsar-admin clusters create cluster-1 \

#### REST API

{% endpoint PUT /admin/clusters/:cluster %}
{% endpoint PUT /admin/v2/clusters/:cluster %}

[More info](../../reference/RestApi#/admin/clusters/:cluster)

Expand Down Expand Up @@ -119,7 +119,7 @@ $ pulsar-admin clusters get cluster-1

#### REST API

{% endpoint GET /admin/clusters/:cluster %}
{% endpoint GET /admin/v2/clusters/:cluster %}

[More info](../../reference/RestApi#/admin/clusters/:cluster)

Expand All @@ -145,7 +145,7 @@ $ pulsar-admin clusters update cluster-1 \

#### REST

{% endpoint POST /admin/clusters/:cluster %}
{% endpoint POST /admin/v2/clusters/:cluster %}

[More info](../../reference/RestApi#/admin/clusters/:cluster)

Expand Down Expand Up @@ -175,7 +175,7 @@ $ pulsar-admin clusters delete cluster-1

#### REST API

{% endpoint DELETE /admin/clusters/:cluster %}
{% endpoint DELETE /admin/v2/clusters/:cluster %}

[More info](../../reference/RestApi#/admin/clusters/:cluster)

Expand All @@ -201,7 +201,7 @@ cluster-2

#### REST API

{% endpoint GET /admin/clusters %}
{% endpoint GET /admin/v2/clusters %}

[More info](../../reference/RestApi#/admin/clusters)

Expand All @@ -225,7 +225,7 @@ $ pulsar-admin update-peer-clusters cluster-1 --peer-clusters cluster-2

#### REST API

{% endpoint POST /admin/clusters/:cluster/peers %}
{% endpoint POST /admin/v2/clusters/:cluster/peers %}

[More info](../../reference/RestApi#/admin/clusters/:cluster/peers)

Expand Down
Loading

0 comments on commit d8c0f10

Please sign in to comment.