Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix some documents #767

Merged
merged 1 commit into from
Sep 19, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion site/_data/cli/pulsar-perf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ commands:
description: Continuously receive broker data and/or load reports
options:
- flags: --connect-string
description: A connection string for one or more brokers
description: A connection string for one or more ZooKeeper servers
- name: simulation-client
description: Run a simulation server acting as a Pulsar client. Uses the client configuration specified in `conf/client.conf`.
- name: simulation-controller
Expand Down
2 changes: 1 addition & 1 deletion site/_includes/explanations/client-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ pulsar://pulsar.us-west.example.com:6650
If you're using [TLS](../../admin/Authz#tls-client-auth) authentication, the URL will look like something like this:

```
pulsar+ssl://pulsar.us-west.example.com:6650
pulsar+ssl://pulsar.us-west.example.com:6651
```

### Global vs. cluster-specific topics
Expand Down
6 changes: 3 additions & 3 deletions site/_includes/explanations/partitioned-topic-admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ In all of the instructions and commands below, the topic name structure is:
Partitioned topics in Pulsar must be explicitly created. When creating a new partitioned topic you need to provide a name for the topic as well as the desired number of partitions.

{% include admonition.html type="info" title="Global partitioned topics" content="
If you'd like to create a [global]() partitioned topic, you need to create a partitioned topic using the instructions here and specify `global` as the cluster in the topic name.
If you'd like to create a global partitioned topic, you need to create a partitioned topic using the instructions here and specify `global` as the cluster in the topic name.
" %}

#### pulsar-admin
Expand Down Expand Up @@ -46,7 +46,7 @@ Field | Meaning

#### pulsar-admin

You can see the see number of partitions in a partitioned topic using the [`get-partitioned-topic-metadata`](../../reference/CliTools#pulsar-admin-persistent-get-partitioned-topic) subcommand. Here's an example:
You can see the number of partitions in a partitioned topic using the [`get-partitioned-topic-metadata`](../../reference/CliTools#pulsar-admin-persistent-get-partitioned-topic) subcommand. Here's an example:

```shell
$ pulsar-admin persistent get-partitioned-topic-metadata \
Expand Down Expand Up @@ -79,7 +79,7 @@ Already created partitioned producers and consumers can’t see newly created pa

#### pulsar-admin

Partitioned topics can be deleted using the [`update-partitioned-topic`](../../reference/CliTools#pulsar-admin-persistent-update-partitioned-topic) command.
Partitioned topics can be updated using the [`update-partitioned-topic`](../../reference/CliTools#pulsar-admin-persistent-update-partitioned-topic) command.

```shell
$ pulsar-admin persistent update-partitioned-topic \
Expand Down
2 changes: 1 addition & 1 deletion site/docs/latest/adaptors/PulsarSpark.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Spark Streaming Pulsar receiver
tags: [spark, streaming, java]
---

The Spark Streaming recevier for Pulsar is a custom receiver that enables Apache [Spark Streaming](https://spark.apache.org/streaming/) to receive data from Pulsar.
The Spark Streaming receiver for Pulsar is a custom receiver that enables Apache [Spark Streaming](https://spark.apache.org/streaming/) to receive data from Pulsar.

An application can receive data in [Resilient Distributed Dataset](https://spark.apache.org/docs/latest/programming-guide.html#resilient-distributed-datasets-rdds) (RDD) format via the Spark Streaming Pulsar receiver and can process it in a variety of ways.

Expand Down
2 changes: 1 addition & 1 deletion site/docs/latest/admin-api/brokers.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ admin.brokers().updateDynamicConfiguration(configName, configValue);

### List updated values

Fetch a list of all potentially updatable configuraton parameters.
Fetch a list of all potentially updatable configuration parameters.

#### pulsar-admin

Expand Down
6 changes: 2 additions & 4 deletions site/docs/latest/admin-api/clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ 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 `clusters` method of the {% javadoc PulsarAdmin admin org.apache.pulsar.client.admin.PulsarAdmin %} object in the [Java API](../../applications/JavaClient)
* The `clusters` method of the {% javadoc PulsarAdmin admin org.apache.pulsar.client.admin.PulsarAdmin %} object in the [Java API](../../clients/Java)

## Clusters resources

Expand Down Expand Up @@ -56,7 +56,7 @@ When provision a new cluster, you need to initialize that cluster's [metadata](.
* The web service URL for the cluster
* A broker service URL enabling interaction with the {% popover brokers %} in the cluster

You must initialize cluster metadata *before* starting up any [brokers](#managing-brokers) that will belong to the cluster.
You must initialize cluster metadata *before* starting up any [brokers](../brokers) that will belong to the cluster.

{% include admonition.html type="warning" title="No cluster metadata initialization through the REST API or the Java admin API" content='
Unlike most other admin functions in Pulsar, cluster metadata initialization cannot be performed via the admin REST API or the admin Java client, as metadata initialization involves communicating with ZooKeeper directly. Instead, you can use the [`pulsar`](../../reference/CliTools#pulsar) CLI tool, in particular the [`initialize-cluster-metadata`](../../reference/CliTools#pulsar-initialize-cluster-metadata) command.
Expand All @@ -77,8 +77,6 @@ bin/pulsar initialize-cluster-metadata \

You'll need to use `--*-tls` flags only if you're using [TLS authentication](../../admin/Authz#tls-client-auth) in your instance.

Make sure to initialize

### Get configuration

You can fetch the [configuration](../../reference/Configuration) for an existing cluster at any time.
Expand Down
4 changes: 2 additions & 2 deletions site/docs/latest/admin/Authz.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ needs to be able to publish to other clusters' topics.

```java
String authPluginClassName = "com.org.MyAuthPluginClass";
String authParams = "param1=value1";
String authParams = "param1:value1";
boolean useTls = false;
boolean tlsAllowInsecureConnection = false;
String tlsTrustCertsFilePath = null;
Expand All @@ -293,7 +293,7 @@ To use TLS:

```java
String authPluginClassName = "com.org.MyAuthPluginClass";
String authParams = "param1=value1";
String authParams = "param1:value1";
boolean useTls = false;
boolean tlsAllowInsecureConnection = false;
String tlsTrustCertsFilePath = null;
Expand Down
4 changes: 2 additions & 2 deletions site/docs/latest/admin/ModularLoadManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The *modular load manager*, implemented in {% javadoc ModularLoadManagerImpl bro

There are two ways that you can enable the modular load manager:

1. Change the value of the `loadManagerClassName` parameter in `conf/broker.con` from `org.apache.pulsar.broker.loadbalance.impl.SimpleLoadManagerImpl` to `org.apache.pulsar.broker.loadbalance.impl.ModularLoadManagerImpl`.
1. Change the value of the `loadManagerClassName` parameter in `conf/broker.conf` from `org.apache.pulsar.broker.loadbalance.impl.SimpleLoadManagerImpl` to `org.apache.pulsar.broker.loadbalance.impl.ModularLoadManagerImpl`.
2. Using the `pulsar-admin` tool. Here's an example:

```shell
Expand Down Expand Up @@ -87,7 +87,7 @@ There are a few different ways to determine which load manager is being used:
}
```

3. The command-line [broker monitor](../../reference/CliTools/#monitor-brokers) will have a different output format depending on which load manager implementation is being used.
3. The command-line [broker monitor](../../reference/CliTools/#pulsar-perf-monitor-brokers) will have a different output format depending on which load manager implementation is being used.

Here is an example from the modular load manager:

Expand Down
2 changes: 1 addition & 1 deletion site/docs/latest/admin/ZooKeeperBookKeeper.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ ledgerManagerType=hierarchical

In Pulsar, you can set *persistence policies*, at the {% popover namespace %} level, that determine how {% popover BookKeeper %} handles persistent storage of messages. Policies determine four things:

* The number of {% popover acks %} (guaranteed copies) to wait for for each ledger entry
* The number of {% popover acks %} (guaranteed copies) to wait for each ledger entry
* The number of {% popover bookies %} to use for a topic
* How many writes to make for each ledger entry
* The throttling rate for mark-delete operations
Expand Down
2 changes: 1 addition & 1 deletion site/docs/latest/advanced/RetentionExpiry.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Both of these parameters are in the [`broker.conf`](../../reference/Configuratio

### Set retention policy

You can a retention policy for a namespace by specifying the namespace as well as both a size limit *and* a time limit.
You can set a retention policy for a namespace by specifying the namespace as well as both a size limit *and* a time limit.

#### pulsar-admin

Expand Down
2 changes: 1 addition & 1 deletion site/docs/latest/clients/Java.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ Here's an example:
CompletableFuture<Message> asyncMessage = consumer.receiveAsync();
```

Async send operations return a {% javadoc Message client org.apache.pulsar.client.api.Message %} wrapped in a [`CompletableFuture`](http://www.baeldung.com/java-completablefuture).
Async receive operations return a {% javadoc Message client org.apache.pulsar.client.api.Message %} wrapped in a [`CompletableFuture`](http://www.baeldung.com/java-completablefuture).

## Authentication

Expand Down
6 changes: 2 additions & 4 deletions site/docs/latest/clients/WebSocket.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Key | Type | Required? | Explanation

### Consumer endpoint

The producer endpoint requires you to specify a {% popover property %}, {% popover cluster %}, {% popover namespace %}, and {% popover topic %}, as well as a {% popover subscription %}, in the URL:
The consumer endpoint requires you to specify a {% popover property %}, {% popover cluster %}, {% popover namespace %}, and {% popover topic %}, as well as a {% popover subscription %}, in the URL:

{% endpoint ws://broker-service-url:8080/ws/consumer/persistent/:property/:cluster/:namespace/:topic/:subscription %}

Expand All @@ -120,8 +120,7 @@ Server will push messages on the WebSocket session:
"messageId": "CAAQAw==",
"payload": "SGVsbG8gV29ybGQ=",
"properties": {"key1": "value1", "key2": "value2"},
"publishTime": "2016-08-30 16:45:57.785",
"context": "1"
"publishTime": "2016-08-30 16:45:57.785"
}
```

Expand All @@ -131,7 +130,6 @@ Key | Type | Required? | Explanation
`payload` | string | yes | Base-64 encoded payload
`publishTime` | string | yes | Publish timestamp
`properties` | key-value pairs | no | Application-defined properties
`context` | string | no | Application-defined request identifier
`key` | string | no | Original routing key set by producer

#### Acknowledging the message
Expand Down
6 changes: 3 additions & 3 deletions site/docs/latest/deployment/Kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ The easiest way to run a Kubernetes cluster is to do so locally. To install a mi
1. Use [minikube](https://kubernetes.io/docs/getting-started-guides/minikube/) to run a single-node Kubernetes cluster
1. Create a local cluster running on multiple VMs on the same machine

For the second option, follow the [instructions](https://github.com/pires/kubernetes-vagrant-coreos-cluster) for running Kubernetes using [CoreOS](https://coreos.com/) on [Vagrant](https://www.vagrantup.com/). We'll provided an abridged version of those instructions here.
For the second option, follow the [instructions](https://github.com/pires/kubernetes-vagrant-coreos-cluster) for running Kubernetes using [CoreOS](https://coreos.com/) on [Vagrant](https://www.vagrantup.com/). We'll provide an abridged version of those instructions here.


First, make sure you have [Vagrant](https://www.vagrantup.com/downloads.html) and [VirtualBox](https://www.virtualbox.org/wiki/Downloads) installed. Then clone the repo and start up the cluster:
Expand Down Expand Up @@ -205,7 +205,7 @@ To create properties and namespaces, connect to the `pulsar-admin` pod that has
$ kubectl exec pulsar-admin -it -- bash
```

From there, you can issue all admin commands. Here's an example command that would create a property named `prop` and a namespace within that property named `prop/us-central-ns`.
From there, you can issue all admin commands. Here's an example command that would create a property named `prop` and a namespace within that property named `prop/us-central/ns`.

```bash
export MY_PROPERTY=prop
Expand Down Expand Up @@ -248,7 +248,7 @@ The default monitoring stack for Pulsar on Kubernetes has consists of [Prometheu

#### Prometheus

All Pulsar metrics in Kubernetes are collected by a [Prometheus](https://prometheus.io) instance running inside the cluster. Typically, there is no need to access Prometheus directly. Instead, you can the [Grafana interface](#grafana) that displays the data stored in Prometheus.
All Pulsar metrics in Kubernetes are collected by a [Prometheus](https://prometheus.io) instance running inside the cluster. Typically, there is no need to access Prometheus directly. Instead, you can use the [Grafana interface](#grafana) that displays the data stored in Prometheus.

#### Grafana

Expand Down
2 changes: 0 additions & 2 deletions site/docs/latest/deployment/Monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,6 @@ attached to the data does not explode.

For that reason we only collect time series of metrics aggregated at the namespace level.

The

### Pulsar per-topic dashboard

The per-topic dashboard instructions are available at [Dashboard](../Dashboard).
Expand Down
4 changes: 2 additions & 2 deletions site/docs/latest/project/BinaryProtocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Since protobuf doesn't provide any sort of message frame, all messages in the Pu
The Pulsar protocol allows for two types of commands:

1. *Simple commands* that do not carry a message payload.
2. *Payload commands* that bear a payload that is used when publishing or delivering messages. In payload commands, the protobuf command data is followed by protobuf [metadata](#metadata-messages) and then the payload, which is passed in raw format outside of protobuf. All sizes are passed as 4-byte unsigned big endian integers.
2. *Payload commands* that bear a payload that is used when publishing or delivering messages. In payload commands, the protobuf command data is followed by protobuf [metadata](#message-metadata) and then the payload, which is passed in raw format outside of protobuf. All sizes are passed as 4-byte unsigned big endian integers.

{% include admonition.html type='info' content="Message payloads are passed in raw format rather than protobuf format for efficiency reasons." %}

Expand Down Expand Up @@ -428,7 +428,7 @@ reconnect a producer or a consumer. Lookup is used to discover which particular
broker is serving the topic we are about to use.

Lookup can be done with a REST call as described in the
[admin API](https://github.com/apache/incubator-pulsar/blob/master/docs/AdminInterface.md#lookup-of-topic)
[admin API](../admin-api/persistent-topics/#lookup-of-topic)
docs.

Since Pulsar-1.16 it is also possible to perform the lookup within the binary
Expand Down
2 changes: 1 addition & 1 deletion site/docs/latest/project/SimulationTools.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ pulsar-perf simulation-controller --cluster <cluster to simulate on> --client-po
The clients should already be started before the controller is started. You will then be presented with a simple prompt,
where you can issue commands to simulation clients. Arguments often refer to tenant names, namespace names, and topic
names. In all cases, the BASE name of the tenants, namespaces, and topics are used. For example, for the topic
`persistent://my_cluster/my_tenant/my_namespace/my_topic`, the tenant name is `my_tenant`, the namespace name is
`persistent://my_tenant/my_cluster/my_namespace/my_topic`, the tenant name is `my_tenant`, the namespace name is
`my_namespace`, and the topic name is `my_topic`. The controller can perform the following actions:

* Create a topic with a producer and a consumer
Expand Down
2 changes: 1 addition & 1 deletion site/docs/latest/reference/CliTools.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ tags:

Pulsar offers several command-line tools that you can use for managing Pulsar installations, performance testing, using command-line {% popover producers %} and {% popover consumers %}, and more.

All Pulsar command-line tools can be run from the `bin` directory of your [installed Pulsar package](../../getting-started/LocalCluster#installing). The following tools are currently documented:
All Pulsar command-line tools can be run from the `bin` directory of your [installed Pulsar package](../../getting-started/LocalCluster#installing-pulsar). The following tools are currently documented:

* [`pulsar`](#pulsar)
* [`pulsar-admin`](#pulsar-admin)
Expand Down
2 changes: 1 addition & 1 deletion site/docs/latest/reference/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The [`pulsar-client`](../CliTools#pulsar-client) CLI tool can be used to publish

{% include config.html id="zookeeper" %}

In addition to the parameters in the table above, configuring ZooKeeper for Pulsar involves adding a
In addition to the parameters in the table above, configuring ZooKeeper for Pulsar involves adding
a `server.N` line to the `conf/zookeeper.conf` file for each node in the ZooKeeper cluster, where `N` is the number of the ZooKeeper node. Here's an example for a three-node ZooKeeper cluster:

```properties
Expand Down