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/04/26 06:03:07 UTC
[pulsar-site] branch main updated: Docs sync done from apache/pulsar(#230d4a1)
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 ee23793a42 Docs sync done from apache/pulsar(#230d4a1)
ee23793a42 is described below
commit ee23793a42cdd54f4a07de833f8002fdc2fa95bf
Author: Pulsar Site Updater <de...@pulsar.apache.org>
AuthorDate: Tue Apr 26 06:03:02 2022 +0000
Docs sync done from apache/pulsar(#230d4a1)
---
site2/docs/concepts-architecture-overview.md | 2 +-
site2/docs/concepts-proxy-sni-routing.md | 2 +-
site2/docs/getting-started-standalone.md | 2 +-
.../docs/concepts-architecture-overview.md | 2 +-
.../docs/concepts-proxy-sni-routing.md | 2 +-
.../docs/getting-started-standalone.md | 152 ++++++++++++-------
.../getting-started-standalone.md | 74 +++++----
.../version-2.1.1-incubating/client-libraries.md | 2 +-
.../concepts-architecture-overview.md | 2 +-
.../getting-started-standalone.md | 76 ++++++----
.../concepts-architecture-overview.md | 2 +-
.../version-2.10.0/concepts-proxy-sni-routing.md | 2 +-
.../version-2.10.0}/getting-started-standalone.md | 153 ++++++++++++-------
.../concepts-architecture-overview.md | 2 +-
.../version-2.2.0/getting-started-standalone.md | 96 +++++++-----
.../concepts-architecture-overview.md | 2 +-
.../version-2.2.1/getting-started-standalone.md | 96 +++++++-----
.../concepts-architecture-overview.md | 2 +-
.../version-2.3.0/getting-started-standalone.md | 90 +++++++----
.../concepts-architecture-overview.md | 2 +-
.../version-2.3.1/getting-started-standalone.md | 86 +++++++----
.../concepts-architecture-overview.md | 2 +-
.../version-2.3.2/getting-started-standalone.md | 150 ++++++++++++-------
.../concepts-architecture-overview.md | 2 +-
.../version-2.4.0/getting-started-standalone.md | 150 ++++++++++++-------
.../concepts-architecture-overview.md | 2 +-
.../version-2.4.1/getting-started-standalone.md | 159 ++++++++++++--------
.../concepts-architecture-overview.md | 2 +-
.../version-2.4.2}/getting-started-standalone.md | 160 ++++++++++++--------
.../concepts-architecture-overview.md | 2 +-
.../version-2.5.0}/getting-started-standalone.md | 159 ++++++++++++--------
.../concepts-architecture-overview.md | 2 +-
.../version-2.5.1}/getting-started-standalone.md | 163 ++++++++++++--------
.../concepts-architecture-overview.md | 2 +-
.../version-2.5.2}/getting-started-standalone.md | 152 ++++++++++++-------
.../version-2.6.0/getting-started-standalone.md | 157 ++++++++++++--------
.../version-2.6.1/concepts-proxy-sni-routing.md | 2 +-
.../version-2.6.1}/getting-started-standalone.md | 157 ++++++++++++--------
.../version-2.6.2/concepts-proxy-sni-routing.md | 2 +-
.../version-2.6.2}/getting-started-standalone.md | 157 ++++++++++++--------
.../version-2.6.3/concepts-proxy-sni-routing.md | 2 +-
.../version-2.6.3}/getting-started-standalone.md | 157 ++++++++++++--------
.../version-2.6.4/concepts-proxy-sni-routing.md | 2 +-
.../version-2.6.4}/getting-started-standalone.md | 157 ++++++++++++--------
.../version-2.7.0/concepts-proxy-sni-routing.md | 2 +-
.../version-2.7.0}/getting-started-standalone.md | 157 ++++++++++++--------
.../version-2.7.1/concepts-proxy-sni-routing.md | 2 +-
.../version-2.7.1}/getting-started-standalone.md | 157 ++++++++++++--------
.../version-2.7.2/concepts-proxy-sni-routing.md | 2 +-
.../version-2.7.2}/getting-started-standalone.md | 163 ++++++++++++--------
.../version-2.7.3/concepts-proxy-sni-routing.md | 2 +-
.../version-2.7.3/getting-started-standalone.md | 157 ++++++++++++--------
.../version-2.7.4/concepts-proxy-sni-routing.md | 2 +-
.../version-2.7.4}/getting-started-standalone.md | 157 ++++++++++++--------
.../concepts-architecture-overview.md | 2 +-
.../version-2.8.0/concepts-proxy-sni-routing.md | 2 +-
.../version-2.8.0/getting-started-standalone.md | 165 +++++++++++++--------
.../concepts-architecture-overview.md | 2 +-
.../version-2.8.1/concepts-proxy-sni-routing.md | 2 +-
.../version-2.8.1}/getting-started-standalone.md | 165 +++++++++++++--------
.../concepts-architecture-overview.md | 2 +-
.../version-2.8.2/concepts-proxy-sni-routing.md | 2 +-
.../version-2.8.2}/getting-started-standalone.md | 165 +++++++++++++--------
.../concepts-architecture-overview.md | 2 +-
.../version-2.8.3/concepts-proxy-sni-routing.md | 2 +-
.../version-2.8.3}/getting-started-standalone.md | 165 +++++++++++++--------
.../concepts-architecture-overview.md | 2 +-
.../version-2.9.0/concepts-proxy-sni-routing.md | 2 +-
.../version-2.9.0/getting-started-standalone.md | 152 ++++++++++++-------
.../concepts-architecture-overview.md | 2 +-
.../version-2.9.1/concepts-proxy-sni-routing.md | 2 +-
.../version-2.9.1}/getting-started-standalone.md | 152 ++++++++++++-------
.../concepts-architecture-overview.md | 2 +-
.../version-2.9.2/concepts-proxy-sni-routing.md | 2 +-
.../version-2.9.2/getting-started-standalone.md | 152 ++++++++++++-------
.../version-2.1.0-incubating-sidebars.json | 4 +
.../version-2.1.1-incubating-sidebars.json | 4 +
.../version-2.10.0-sidebars.json | 4 +
.../versioned_sidebars/version-2.2.0-sidebars.json | 4 +
.../versioned_sidebars/version-2.2.1-sidebars.json | 4 +
.../versioned_sidebars/version-2.3.0-sidebars.json | 4 +
.../versioned_sidebars/version-2.3.1-sidebars.json | 4 +
.../versioned_sidebars/version-2.3.2-sidebars.json | 4 +
.../versioned_sidebars/version-2.4.0-sidebars.json | 4 +
.../versioned_sidebars/version-2.4.1-sidebars.json | 4 +
.../versioned_sidebars/version-2.4.2-sidebars.json | 4 +
.../versioned_sidebars/version-2.5.0-sidebars.json | 4 +
.../versioned_sidebars/version-2.5.1-sidebars.json | 4 +
.../versioned_sidebars/version-2.5.2-sidebars.json | 4 +
.../versioned_sidebars/version-2.6.0-sidebars.json | 4 +
.../versioned_sidebars/version-2.6.1-sidebars.json | 4 +
.../versioned_sidebars/version-2.6.2-sidebars.json | 4 +
.../versioned_sidebars/version-2.6.3-sidebars.json | 4 +
.../versioned_sidebars/version-2.6.4-sidebars.json | 4 +
.../versioned_sidebars/version-2.7.0-sidebars.json | 4 +
.../versioned_sidebars/version-2.7.1-sidebars.json | 4 +
.../versioned_sidebars/version-2.7.2-sidebars.json | 4 +
.../versioned_sidebars/version-2.7.3-sidebars.json | 4 +
.../versioned_sidebars/version-2.7.4-sidebars.json | 4 +
.../versioned_sidebars/version-2.8.0-sidebars.json | 4 +
.../versioned_sidebars/version-2.8.1-sidebars.json | 4 +
.../versioned_sidebars/version-2.8.2-sidebars.json | 4 +
.../versioned_sidebars/version-2.8.3-sidebars.json | 4 +
.../versioned_sidebars/version-2.9.0-sidebars.json | 4 +
.../versioned_sidebars/version-2.9.1-sidebars.json | 4 +
.../versioned_sidebars/version-2.9.2-sidebars.json | 4 +
.../getting-started-standalone.md | 4 +-
.../getting-started-clients.md | 2 +-
.../getting-started-standalone.md | 4 +-
.../concepts-architecture-overview.md | 2 +-
.../version-2.10.0/concepts-proxy-sni-routing.md | 2 +-
.../version-2.10.0/getting-started-standalone.md | 4 +-
.../version-2.2.0/getting-started-standalone.md | 4 +-
.../version-2.2.1/getting-started-standalone.md | 4 +-
.../version-2.3.0/getting-started-standalone.md | 4 +-
.../version-2.3.1/getting-started-standalone.md | 4 +-
.../version-2.3.2/getting-started-standalone.md | 4 +-
.../version-2.4.0/getting-started-standalone.md | 4 +-
.../version-2.4.1/getting-started-standalone.md | 4 +-
.../version-2.4.2/getting-started-standalone.md | 4 +-
.../version-2.5.0/getting-started-standalone.md | 4 +-
.../concepts-architecture-overview.md | 2 +-
.../getting-started-standalone.md | 4 +-
.../version-2.6.0/getting-started-standalone.md | 4 +-
.../version-2.6.1/concepts-proxy-sni-routing.md | 2 +-
.../version-2.6.1/getting-started-standalone.md | 4 +-
.../version-2.6.2/concepts-proxy-sni-routing.md | 2 +-
.../version-2.6.2/getting-started-standalone.md | 4 +-
.../version-2.6.3/concepts-proxy-sni-routing.md | 2 +-
.../version-2.6.3/getting-started-standalone.md | 4 +-
.../version-2.6.4/concepts-proxy-sni-routing.md | 2 +-
.../version-2.6.4/getting-started-standalone.md | 4 +-
.../version-2.7.0/concepts-proxy-sni-routing.md | 2 +-
.../version-2.7.0/getting-started-standalone.md | 4 +-
.../version-2.7.1/concepts-proxy-sni-routing.md | 2 +-
.../version-2.7.1/getting-started-standalone.md | 4 +-
.../version-2.7.2/concepts-proxy-sni-routing.md | 2 +-
.../version-2.7.2/getting-started-standalone.md | 4 +-
.../version-2.7.3/concepts-proxy-sni-routing.md | 2 +-
.../version-2.7.3/getting-started-standalone.md | 4 +-
.../version-2.7.4/concepts-proxy-sni-routing.md | 2 +-
.../version-2.7.4/getting-started-standalone.md | 4 +-
.../concepts-architecture-overview.md | 2 +-
.../version-2.8.0/concepts-proxy-sni-routing.md | 2 +-
.../version-2.8.0/getting-started-standalone.md | 4 +-
.../concepts-architecture-overview.md | 2 +-
.../version-2.8.1/concepts-proxy-sni-routing.md | 2 +-
.../version-2.8.1/getting-started-standalone.md | 4 +-
.../concepts-architecture-overview.md | 2 +-
.../version-2.8.2/concepts-proxy-sni-routing.md | 2 +-
.../version-2.8.2/getting-started-standalone.md | 4 +-
.../concepts-architecture-overview.md | 2 +-
.../version-2.8.3/concepts-proxy-sni-routing.md | 2 +-
.../version-2.8.3/getting-started-standalone.md | 4 +-
.../concepts-architecture-overview.md | 2 +-
.../version-2.9.0/concepts-proxy-sni-routing.md | 2 +-
.../version-2.9.0/getting-started-standalone.md | 4 +-
.../concepts-architecture-overview.md | 2 +-
.../version-2.9.1/concepts-proxy-sni-routing.md | 2 +-
.../version-2.9.1/getting-started-standalone.md | 4 +-
.../concepts-architecture-overview.md | 2 +-
.../version-2.9.2/concepts-proxy-sni-routing.md | 2 +-
.../version-2.9.2/getting-started-standalone.md | 4 +-
.../version-2.1.0-incubating-sidebars.json | 2 +-
.../version-2.1.1-incubating-sidebars.json | 2 +-
.../version-2.10.0-sidebars.json | 2 +-
.../versioned_sidebars/version-2.2.0-sidebars.json | 2 +-
.../versioned_sidebars/version-2.2.1-sidebars.json | 2 +-
.../versioned_sidebars/version-2.3.0-sidebars.json | 2 +-
.../versioned_sidebars/version-2.3.1-sidebars.json | 2 +-
.../versioned_sidebars/version-2.3.2-sidebars.json | 2 +-
.../versioned_sidebars/version-2.4.0-sidebars.json | 2 +-
.../versioned_sidebars/version-2.4.1-sidebars.json | 2 +-
.../versioned_sidebars/version-2.4.2-sidebars.json | 2 +-
.../versioned_sidebars/version-2.5.0-sidebars.json | 2 +-
.../versioned_sidebars/version-2.5.1-sidebars.json | 2 +-
.../versioned_sidebars/version-2.5.2-sidebars.json | 2 +-
.../versioned_sidebars/version-2.6.0-sidebars.json | 2 +-
.../versioned_sidebars/version-2.6.1-sidebars.json | 2 +-
.../versioned_sidebars/version-2.6.2-sidebars.json | 2 +-
.../versioned_sidebars/version-2.6.3-sidebars.json | 2 +-
.../versioned_sidebars/version-2.6.4-sidebars.json | 2 +-
.../versioned_sidebars/version-2.7.0-sidebars.json | 2 +-
.../versioned_sidebars/version-2.7.1-sidebars.json | 2 +-
.../versioned_sidebars/version-2.7.2-sidebars.json | 2 +-
.../versioned_sidebars/version-2.7.3-sidebars.json | 2 +-
.../versioned_sidebars/version-2.7.4-sidebars.json | 2 +-
.../versioned_sidebars/version-2.8.0-sidebars.json | 2 +-
.../versioned_sidebars/version-2.8.1-sidebars.json | 2 +-
.../versioned_sidebars/version-2.8.2-sidebars.json | 2 +-
.../versioned_sidebars/version-2.8.3-sidebars.json | 2 +-
.../versioned_sidebars/version-2.9.0-sidebars.json | 2 +-
.../versioned_sidebars/version-2.9.1-sidebars.json | 2 +-
.../versioned_sidebars/version-2.9.2-sidebars.json | 2 +-
194 files changed, 3212 insertions(+), 1842 deletions(-)
diff --git a/site2/docs/concepts-architecture-overview.md b/site2/docs/concepts-architecture-overview.md
index 14f81b8c33..7a25763233 100644
--- a/site2/docs/concepts-architecture-overview.md
+++ b/site2/docs/concepts-architecture-overview.md
@@ -45,7 +45,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
> Pulsar also supports more metadata backend services, including [ETCD](https://etcd.io/) and [RocksDB](http://rocksdb.org/) (for standalone Pulsar only).
diff --git a/site2/docs/concepts-proxy-sni-routing.md b/site2/docs/concepts-proxy-sni-routing.md
index eabcf513bd..08a20ae1ae 100644
--- a/site2/docs/concepts-proxy-sni-routing.md
+++ b/site2/docs/concepts-proxy-sni-routing.md
@@ -43,7 +43,7 @@ CONFIG proxy.config.ssl.client.cert.filename STRING /proxy-key.pem
CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/docs/getting-started-standalone.md b/site2/docs/getting-started-standalone.md
index 2d0e760f37..b7be56c5f9 100644
--- a/site2/docs/getting-started-standalone.md
+++ b/site2/docs/getting-started-standalone.md
@@ -1,5 +1,5 @@
---
-id: standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
sidebar_label: Run Pulsar locally
---
diff --git a/site2/website-next/docs/concepts-architecture-overview.md b/site2/website-next/docs/concepts-architecture-overview.md
index 24493c277b..0d96b59f8a 100644
--- a/site2/website-next/docs/concepts-architecture-overview.md
+++ b/site2/website-next/docs/concepts-architecture-overview.md
@@ -45,7 +45,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
> Pulsar also supports more metadata backend services, including [ETCD](https://etcd.io/) and [RocksDB](http://rocksdb.org/) (for standalone Pulsar only).
diff --git a/site2/website-next/docs/concepts-proxy-sni-routing.md b/site2/website-next/docs/concepts-proxy-sni-routing.md
index 6673fdf41f..8e917a37d9 100644
--- a/site2/website-next/docs/concepts-proxy-sni-routing.md
+++ b/site2/website-next/docs/concepts-proxy-sni-routing.md
@@ -51,7 +51,7 @@ CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/docs/getting-started-standalone.md b/site2/website-next/docs/getting-started-standalone.md
similarity index 59%
copy from site2/docs/getting-started-standalone.md
copy to site2/website-next/docs/getting-started-standalone.md
index 2d0e760f37..9357c9e2ad 100644
--- a/site2/docs/getting-started-standalone.md
+++ b/site2/website-next/docs/getting-started-standalone.md
@@ -1,13 +1,13 @@
---
-id: standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
+sidebar_label: "Run Pulsar locally"
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary [RocksDB](http://rocksdb.org/) and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> **Pulsar in production?**
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -17,17 +17,23 @@ This tutorial guides you through every step of installing Pulsar locally.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions
-> **Tip**
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
-> **Note**
-> Broker is only supported on 64-bit JVM.
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
+
+:::note
+
+Broker is only supported on 64-bit JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -36,14 +42,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -53,9 +63,9 @@ The Pulsar binary package initially contains the following directories:
Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
-`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker) and more.<br />**Note:** Pulsar standalone uses RocksDB as the local metadata store and its configuration file path [`metadataStoreConfigPath`](reference-configuration.md) is configurable in the `standalone.conf` file. For more information about the configurations of RocksDB, see [here](https://github.com/facebook/rocksdb/blob/main/examples/rocksdb_option_file_example.ini) and rel [...]
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker) and more.<br />**Note:** Pulsar standalone uses RocksDB as the local metadata store and its configuration file path [`metadataStoreConfigPath`](reference-configuration) is configurable in the `standalone.conf` file. For more information about the configurations of RocksDB, see [here](https://github.com/facebook/rocksdb/blob/main/examples/rocksdb_option_file_example.ini) and relate [...]
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -66,20 +76,21 @@ Directory | Contains
`data` | The data storage directory used by RocksDB and BookKeeper.
`logs` | Logs created by the installation.
-> **Tip**
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -88,35 +99,44 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> **Note**
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/), you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/), you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> **Tip**
-> - Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> - To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+- Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+- To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+:::
+
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -125,52 +145,66 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> **Note**
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or DC/OS), you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or DC/OS), you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
21:59:29.327 [DLM-/stream/storage-OrderedScheduler-3-0] INFO org.apache.bookkeeper.stream.storage.impl.sc.StorageContainerImpl - Successfully started storage container (0).
21:59:34.576 [main] INFO org.apache.pulsar.broker.authentication.AuthenticationService - Authentication is disabled
21:59:34.576 [main] INFO org.apache.pulsar.websocket.WebSocketService - Pulsar WebSocket Service started
+
```
-> **Tip**
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `bin/pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -183,37 +217,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
22:17:16.781 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully consumed
+
```
-> **Tip**
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
22:21:08.693 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> **Tip**
-> If the service runs as a background process using the `bin/pulsar-daemon start standalone` command, then use the `bin/pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `bin/pulsar-daemon start standalone` command, then use the `bin/pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website/versioned_docs/version-2.1.0-incubating/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.1.0-incubating/getting-started-standalone.md
similarity index 84%
copy from site2/website/versioned_docs/version-2.1.0-incubating/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.1.0-incubating/getting-started-standalone.md
index a3822d9cc1..844ba265fb 100644
--- a/site2/website/versioned_docs/version-2.1.0-incubating/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.1.0-incubating/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.1.0-incubating-standalone
+id: getting-started-standalone
title: Setting up a local standalone cluster
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For the purposes of local development and testing, you can run Pulsar in standalone mode on your own machine. Standalone mode includes a Pulsar broker as well as the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Run Pulsar Standalone Manually
@@ -24,21 +24,25 @@ To get started running Pulsar, download a binary tarball release in one of the f
* by clicking the link below and downloading the release from an Apache mirror:
- * <a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>
+ * <a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>
* from the Pulsar [downloads page](pulsar:download_page_url)
* from the Pulsar [releases page](https://github.com/apache/incubator-pulsar/releases/latest)
* using [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
Once the tarball is downloaded, untar it and `cd` into the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
### What your package contains
@@ -47,9 +51,9 @@ The Pulsar binary package initially contains the following directories:
Directory | Contains
:---------|:--------
-`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin.md)
+`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin)
`conf` | Configuration files for Pulsar, including for [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more
-`examples` | A Java JAR file containing example [Pulsar Functions](functions-overview.md)
+`examples` | A Java JAR file containing example [Pulsar Functions](functions-overview)
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar
`licenses` | License files, in `.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar)
@@ -58,7 +62,7 @@ These directories will be created once you begin running Pulsar:
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md)
+`instances` | Artifacts created for [Pulsar Functions](functions-overview)
`logs` | Logs created by the installation
@@ -69,35 +73,39 @@ If you would like to enable those `builtin` connectors, you can download the con
* by clicking the link below and downloading the release from an Apache mirror:
- * <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+ * <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* from the Pulsar [downloads page](pulsar:download_page_url)
* from the Pulsar [releases page](https://github.com/apache/incubator-pulsar/releases/latest)
* using [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:connector_release_url
+
```
Once the tarball is downloaded, in the pulsar directory, untar the io-connectors package and copy the connectors as `connectors`
in the pulsar directory:
```bash
-$ tar xvfz /path/to/apache-pulsar-io-connectors-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-io-connectors-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz /path/to/apache-pulsar-io-connectors-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-io-connectors-@pulsar:version@` in the pulsar directory
// then copy the connectors
-$ cd apache-pulsar-io-connectors-{{pulsar:version}}/connectors connectors
+$ cd apache-pulsar-io-connectors-@pulsar:version@/connectors connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
-pulsar-io-cassandra-{{pulsar:version}}.nar
-pulsar-io-kafka-{{pulsar:version}}.nar
-pulsar-io-kinesis-{{pulsar:version}}.nar
-pulsar-io-rabbitmq-{{pulsar:version}}.nar
-pulsar-io-twitter-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
+pulsar-io-cassandra-@pulsar:version@.nar
+pulsar-io-kafka-@pulsar:version@.nar
+pulsar-io-kinesis-@pulsar:version@.nar
+pulsar-io-rabbitmq-@pulsar:version@.nar
+pulsar-io-twitter-@pulsar:version@.nar
...
+
```
> #### NOTES
@@ -105,7 +113,7 @@ pulsar-io-twitter-{{pulsar:version}}.nar
> If you are running Pulsar in a bare metal cluster, you need to make sure `connectors` tarball is unzipped in every broker's pulsar directory
> (or in every function-worker's pulsar directory if you are running a separate worker cluster for Pulsar functions).
>
-> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
+> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
> you can use `apachepulsar/pulsar-all` image instead of `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
### Starting the cluster
@@ -113,15 +121,19 @@ pulsar-io-twitter-{{pulsar:version}}.nar
Once you have an up-to-date local copy of the release, you can start up a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start up Pulsar in standalone mode:
```bash
+
$ bin/pulsar standalone
+
```
If Pulsar has been successfully started, you should see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
> #### Automatically created namespace
@@ -132,47 +144,55 @@ If Pulsar has been successfully started, you should see `INFO`-level log message
Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsar-client) that enables you to do things like send messages to a Pulsar topic in a running cluster. This command will send a simple message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you should see a confirmation like this in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
-```
+```
> #### No need to explicitly create new topics
> You may have noticed that we did not explicitly create the `my-topic` topic to which we sent the `hello-pulsar` message. If you attempt to write a message to a topic that does not yet exist, Pulsar will automatically create that topic for you.
## Using Pulsar clients locally
-Pulsar currently offers client libraries for [Java](client-libraries-java.md), [Python](client-libraries-python.md), and [C++](client-libraries-cpp.md). If you're running a local standalone cluster, you can use one of these root URLs for interacting with your cluster:
+Pulsar currently offers client libraries for [Java](client-libraries-java.md), [Python](client-libraries-python.md), and [C++](client-libraries-cpp). If you're running a local standalone cluster, you can use one of these root URLs for interacting with your cluster:
* `http://localhost:8080`
* `pulsar://localhost:6650`
-Here's an example producer for a Pulsar topic using the [Java](client-libraries-java.md) client:
+Here's an example producer for a Pulsar topic using the [Java](client-libraries-java) client:
```java
+
String localClusterUrl = "pulsar://localhost:6650";
PulsarClient client = PulsarClient.builder().serviceUrl(localClusterUrl).build();
Producer<byte[]> producer = client.newProducer().topic("my-topic").create();
+
```
-Here's an example [Python](client-libraries-python.md) producer:
+Here's an example [Python](client-libraries-python) producer:
```python
+
import pulsar
client = pulsar.Client('pulsar://localhost:6650')
producer = client.create_producer('my-topic')
+
```
-Finally, here's an example [C++](client-libraries-cpp.md) producer:
+Finally, here's an example [C++](client-libraries-cpp) producer:
```cpp
+
Client client("pulsar://localhost:6650");
Producer producer;
Result result = client.createProducer("my-topic", producer);
@@ -180,4 +200,6 @@ if (result != ResultOk) {
LOG_ERROR("Error creating producer: " << result);
return -1;
}
+
```
+
diff --git a/site2/website-next/versioned_docs/version-2.1.1-incubating/client-libraries.md b/site2/website-next/versioned_docs/version-2.1.1-incubating/client-libraries.md
index fcbe52c001..3fb4f60b62 100644
--- a/site2/website-next/versioned_docs/version-2.1.1-incubating/client-libraries.md
+++ b/site2/website-next/versioned_docs/version-2.1.1-incubating/client-libraries.md
@@ -42,7 +42,7 @@ There are also [Doxygen](http://www.stack.nl/~dimitri/doxygen/)-generated API do
## Feature Matrix
-This matrix listing all the features among different languages in Pulsar master can be found [here](https://github.com/apache/incubator-pulsar/wiki/Client-Features-Matrix).
+This matrix listing all the features among different languages in Pulsar master can be found [here](https://github.com/apache/pulsar/wiki/PIP-108:-Pulsar-Feature-Matrix-(Client-and-Function)).
## Thirdparty Clients
diff --git a/site2/website-next/versioned_docs/version-2.1.1-incubating/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.1.1-incubating/concepts-architecture-overview.md
index 24493c277b..0d96b59f8a 100644
--- a/site2/website-next/versioned_docs/version-2.1.1-incubating/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.1.1-incubating/concepts-architecture-overview.md
@@ -45,7 +45,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
> Pulsar also supports more metadata backend services, including [ETCD](https://etcd.io/) and [RocksDB](http://rocksdb.org/) (for standalone Pulsar only).
diff --git a/site2/website/versioned_docs/version-2.1.1-incubating/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.1.1-incubating/getting-started-standalone.md
similarity index 85%
copy from site2/website/versioned_docs/version-2.1.1-incubating/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.1.1-incubating/getting-started-standalone.md
index 91bf0e37e0..bb5fe2d512 100644
--- a/site2/website/versioned_docs/version-2.1.1-incubating/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.1.1-incubating/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.1.1-incubating-standalone
+id: getting-started-standalone
title: Setting up a local standalone cluster
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For the purposes of local development and testing, you can run Pulsar in standalone mode on your own machine. Standalone mode includes a Pulsar broker as well as the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Run Pulsar Standalone Manually
@@ -23,21 +23,25 @@ To get started running Pulsar, download a binary tarball release in one of the f
* by clicking the link below and downloading the release from an Apache mirror:
- * <a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>
+ * <a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>
* from the Pulsar [downloads page](pulsar:download_page_url)
* from the Pulsar [releases page](https://github.com/apache/incubator-pulsar/releases/latest)
* using [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
Once the tarball is downloaded, untar it and `cd` into the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
### What your package contains
@@ -46,9 +50,9 @@ The Pulsar binary package initially contains the following directories:
Directory | Contains
:---------|:--------
-`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin.md)
+`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin)
`conf` | Configuration files for Pulsar, including for [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more
-`examples` | A Java JAR file containing example [Pulsar Functions](functions-overview.md)
+`examples` | A Java JAR file containing example [Pulsar Functions](functions-overview)
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar
`licenses` | License files, in `.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar)
@@ -57,7 +61,7 @@ These directories will be created once you begin running Pulsar:
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md)
+`instances` | Artifacts created for [Pulsar Functions](functions-overview)
`logs` | Logs created by the installation
@@ -68,35 +72,39 @@ If you would like to enable those `builtin` connectors, you can download the con
* by clicking the link below and downloading the release from an Apache mirror:
- * <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+ * <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* from the Pulsar [downloads page](pulsar:download_page_url)
* from the Pulsar [releases page](https://github.com/apache/incubator-pulsar/releases/latest)
* using [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:connector_release_url
+
```
Once the tarball is downloaded, in the pulsar directory, untar the io-connectors package and copy the connectors as `connectors`
in the pulsar directory:
```bash
-$ tar xvfz /path/to/apache-pulsar-io-connectors-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-io-connectors-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz /path/to/apache-pulsar-io-connectors-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-io-connectors-@pulsar:version@` in the pulsar directory
// then copy the connectors
-$ cd apache-pulsar-io-connectors-{{pulsar:version}}/connectors connectors
+$ cd apache-pulsar-io-connectors-@pulsar:version@/connectors connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
-pulsar-io-cassandra-{{pulsar:version}}.nar
-pulsar-io-kafka-{{pulsar:version}}.nar
-pulsar-io-kinesis-{{pulsar:version}}.nar
-pulsar-io-rabbitmq-{{pulsar:version}}.nar
-pulsar-io-twitter-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
+pulsar-io-cassandra-@pulsar:version@.nar
+pulsar-io-kafka-@pulsar:version@.nar
+pulsar-io-kinesis-@pulsar:version@.nar
+pulsar-io-rabbitmq-@pulsar:version@.nar
+pulsar-io-twitter-@pulsar:version@.nar
...
+
```
> #### NOTES
@@ -104,7 +112,7 @@ pulsar-io-twitter-{{pulsar:version}}.nar
> If you are running Pulsar in a bare metal cluster, you need to make sure `connectors` tarball is unzipped in every broker's pulsar directory
> (or in every function-worker's pulsar directory if you are running a separate worker cluster for Pulsar functions).
>
-> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
+> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
> you can use `apachepulsar/pulsar-all` image instead of `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
### Starting the cluster
@@ -112,15 +120,19 @@ pulsar-io-twitter-{{pulsar:version}}.nar
Once you have an up-to-date local copy of the release, you can start up a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start up Pulsar in standalone mode:
```bash
+
$ bin/pulsar standalone
+
```
If Pulsar has been successfully started, you should see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
> #### Automatically created namespace
@@ -131,7 +143,9 @@ If Pulsar has been successfully started, you should see `INFO`-level log message
Alternatively, you can run pulsar standalone locally in docker.
```bash
+
docker run -it -p 80:80 -p 8080:8080 -p 6650:6650 apachepulsar/pulsar-standalone
+
```
The command forwards following port to localhost:
@@ -147,47 +161,55 @@ After the docker container is running, you can access the dashboard under http:/
Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsar-client) that enables you to do things like send messages to a Pulsar topic in a running cluster. This command will send a simple message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you should see a confirmation like this in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
-```
+```
> #### No need to explicitly create new topics
> You may have noticed that we did not explicitly create the `my-topic` topic to which we sent the `hello-pulsar` message. If you attempt to write a message to a topic that does not yet exist, Pulsar will automatically create that topic for you.
## Using Pulsar clients locally
-Pulsar currently offers client libraries for [Java](client-libraries-java.md), [Python](client-libraries-python.md), and [C++](client-libraries-cpp.md). If you're running a local standalone cluster, you can use one of these root URLs for interacting with your cluster:
+Pulsar currently offers client libraries for [Java](client-libraries-java.md), [Python](client-libraries-python.md), and [C++](client-libraries-cpp). If you're running a local standalone cluster, you can use one of these root URLs for interacting with your cluster:
* `http://localhost:8080`
* `pulsar://localhost:6650`
-Here's an example producer for a Pulsar topic using the [Java](client-libraries-java.md) client:
+Here's an example producer for a Pulsar topic using the [Java](client-libraries-java) client:
```java
+
String localClusterUrl = "pulsar://localhost:6650";
PulsarClient client = PulsarClient.builder().serviceUrl(localClusterUrl).build();
Producer<byte[]> producer = client.newProducer().topic("my-topic").create();
+
```
-Here's an example [Python](client-libraries-python.md) producer:
+Here's an example [Python](client-libraries-python) producer:
```python
+
import pulsar
client = pulsar.Client('pulsar://localhost:6650')
producer = client.create_producer('my-topic')
+
```
-Finally, here's an example [C++](client-libraries-cpp.md) producer:
+Finally, here's an example [C++](client-libraries-cpp) producer:
```cpp
+
Client client("pulsar://localhost:6650");
Producer producer;
Result result = client.createProducer("my-topic", producer);
@@ -195,4 +217,6 @@ if (result != ResultOk) {
LOG_ERROR("Error creating producer: " << result);
return -1;
}
+
```
+
diff --git a/site2/website-next/versioned_docs/version-2.10.0/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.10.0/concepts-architecture-overview.md
index a0ac389a2a..a9e5141dd1 100644
--- a/site2/website-next/versioned_docs/version-2.10.0/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.10.0/concepts-architecture-overview.md
@@ -46,7 +46,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
> Pulsar also supports more metadata backend services, including [ETCD](https://etcd.io/) and [RocksDB](http://rocksdb.org/) (for standalone Pulsar only).
diff --git a/site2/website-next/versioned_docs/version-2.10.0/concepts-proxy-sni-routing.md b/site2/website-next/versioned_docs/version-2.10.0/concepts-proxy-sni-routing.md
index 7a683b8395..7eee6df551 100644
--- a/site2/website-next/versioned_docs/version-2.10.0/concepts-proxy-sni-routing.md
+++ b/site2/website-next/versioned_docs/version-2.10.0/concepts-proxy-sni-routing.md
@@ -52,7 +52,7 @@ CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/docs/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.10.0/getting-started-standalone.md
similarity index 59%
copy from site2/docs/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.10.0/getting-started-standalone.md
index 2d0e760f37..a5e1c00fdf 100644
--- a/site2/docs/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.10.0/getting-started-standalone.md
@@ -1,13 +1,14 @@
---
-id: standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary [RocksDB](http://rocksdb.org/) and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> **Pulsar in production?**
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -17,17 +18,23 @@ This tutorial guides you through every step of installing Pulsar locally.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions
-> **Tip**
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
-> **Note**
-> Broker is only supported on 64-bit JVM.
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
+
+:::note
+
+Broker is only supported on 64-bit JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -36,14 +43,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -53,9 +64,9 @@ The Pulsar binary package initially contains the following directories:
Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
-`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker) and more.<br />**Note:** Pulsar standalone uses RocksDB as the local metadata store and its configuration file path [`metadataStoreConfigPath`](reference-configuration.md) is configurable in the `standalone.conf` file. For more information about the configurations of RocksDB, see [here](https://github.com/facebook/rocksdb/blob/main/examples/rocksdb_option_file_example.ini) and rel [...]
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker) and more.<br />**Note:** Pulsar standalone uses RocksDB as the local metadata store and its configuration file path [`metadataStoreConfigPath`](reference-configuration) is configurable in the `standalone.conf` file. For more information about the configurations of RocksDB, see [here](https://github.com/facebook/rocksdb/blob/main/examples/rocksdb_option_file_example.ini) and relate [...]
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -66,20 +77,21 @@ Directory | Contains
`data` | The data storage directory used by RocksDB and BookKeeper.
`logs` | Logs created by the installation.
-> **Tip**
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -88,35 +100,44 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> **Note**
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/), you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/), you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> **Tip**
-> - Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> - To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+- Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+- To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+:::
+
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -125,52 +146,66 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> **Note**
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or DC/OS), you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or DC/OS), you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
21:59:29.327 [DLM-/stream/storage-OrderedScheduler-3-0] INFO org.apache.bookkeeper.stream.storage.impl.sc.StorageContainerImpl - Successfully started storage container (0).
21:59:34.576 [main] INFO org.apache.pulsar.broker.authentication.AuthenticationService - Authentication is disabled
21:59:34.576 [main] INFO org.apache.pulsar.websocket.WebSocketService - Pulsar WebSocket Service started
+
```
-> **Tip**
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `bin/pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -183,37 +218,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
22:17:16.781 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully consumed
+
```
-> **Tip**
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
22:21:08.693 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> **Tip**
-> If the service runs as a background process using the `bin/pulsar-daemon start standalone` command, then use the `bin/pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `bin/pulsar-daemon start standalone` command, then use the `bin/pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.2.0/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.2.0/concepts-architecture-overview.md
index 24493c277b..0d96b59f8a 100644
--- a/site2/website-next/versioned_docs/version-2.2.0/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.2.0/concepts-architecture-overview.md
@@ -45,7 +45,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
> Pulsar also supports more metadata backend services, including [ETCD](https://etcd.io/) and [RocksDB](http://rocksdb.org/) (for standalone Pulsar only).
diff --git a/site2/website/versioned_docs/version-2.2.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.2.0/getting-started-standalone.md
similarity index 83%
copy from site2/website/versioned_docs/version-2.2.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.2.0/getting-started-standalone.md
index d9c2d382b6..805b82e626 100644
--- a/site2/website/versioned_docs/version-2.2.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.2.0/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.2.0-standalone
+id: getting-started-standalone
title: Setting up a local standalone cluster
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For the purposes of local development and testing, you can run Pulsar in standalone mode on your own machine. Standalone mode includes a Pulsar broker as well as the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Run Pulsar Standalone Manually
@@ -23,21 +23,25 @@ To get started running Pulsar, download a binary tarball release in one of the f
* by clicking the link below and downloading the release from an Apache mirror:
- * <a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>
+ * <a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>
* from the Pulsar [downloads page](pulsar:download_page_url)
* from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest)
* using [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
Once the tarball is downloaded, untar it and `cd` into the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
### What your package contains
@@ -46,9 +50,9 @@ The Pulsar binary package initially contains the following directories:
Directory | Contains
:---------|:--------
-`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin.md)
+`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin)
`conf` | Configuration files for Pulsar, including for [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more
-`examples` | A Java JAR file containing example [Pulsar Functions](functions-overview.md)
+`examples` | A Java JAR file containing example [Pulsar Functions](functions-overview)
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar
`licenses` | License files, in `.txt` form, for various components of the Pulsar [codebase](http://github.com/apache/pulsar)
@@ -57,7 +61,7 @@ These directories will be created once you begin running Pulsar:
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md)
+`instances` | Artifacts created for [Pulsar Functions](functions-overview)
`logs` | Logs created by the installation
@@ -68,35 +72,39 @@ If you would like to enable those `builtin` connectors, you can download the con
* by clicking the link below and downloading the release from an Apache mirror:
- * <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+ * <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* from the Pulsar [downloads page](pulsar:download_page_url)
* from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest)
* using [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:connector_release_url
+
```
Once the tarball is downloaded, in the pulsar directory, untar the io-connectors package and copy the connectors as `connectors`
in the pulsar directory:
```bash
-$ tar xvfz /path/to/apache-pulsar-io-connectors-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-io-connectors-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz /path/to/apache-pulsar-io-connectors-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-io-connectors-@pulsar:version@` in the pulsar directory
// then copy the connectors
-$ cd apache-pulsar-io-connectors-{{pulsar:version}}/connectors connectors
+$ cd apache-pulsar-io-connectors-@pulsar:version@/connectors connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
-pulsar-io-cassandra-{{pulsar:version}}.nar
-pulsar-io-kafka-{{pulsar:version}}.nar
-pulsar-io-kinesis-{{pulsar:version}}.nar
-pulsar-io-rabbitmq-{{pulsar:version}}.nar
-pulsar-io-twitter-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
+pulsar-io-cassandra-@pulsar:version@.nar
+pulsar-io-kafka-@pulsar:version@.nar
+pulsar-io-kinesis-@pulsar:version@.nar
+pulsar-io-rabbitmq-@pulsar:version@.nar
+pulsar-io-twitter-@pulsar:version@.nar
...
+
```
> #### NOTES
@@ -104,7 +112,7 @@ pulsar-io-twitter-{{pulsar:version}}.nar
> If you are running Pulsar in a bare metal cluster, you need to make sure `connectors` tarball is unzipped in every broker's pulsar directory
> (or in every function-worker's pulsar directory if you are running a separate worker cluster for Pulsar functions).
>
-> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
+> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
> you can use `apachepulsar/pulsar-all` image instead of `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
## Installing Tiered Storage Offloaders (optional)
@@ -113,43 +121,47 @@ pulsar-io-twitter-{{pulsar:version}}.nar
> If you would like to enable tiered storage feature, you can follow the instructions as below; otherwise you can
> skip this section for now.
-To get started using [tiered storage offloaders](concepts-tiered-storage.md), you'll need to download the offloaders tarball release on every broker node in
+To get started using [tiered storage offloaders](concepts-tiered-storage), you'll need to download the offloaders tarball release on every broker node in
one of the following ways:
* by clicking the link below and downloading the release from an Apache mirror:
- * <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+ * <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* from the Pulsar [downloads page](pulsar:download_page_url)
* from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest)
* using [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
Once the tarball is downloaded, in the pulsar directory, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more details of how to configure tiered storage feature, you could reference this [Tiered storage cookbook](cookbooks-tiered-storage.md)
+For more details of how to configure tiered storage feature, you could reference this [Tiered storage cookbook](cookbooks-tiered-storage)
> #### NOTES
>
> If you are running Pulsar in a bare metal cluster, you need to make sure `offloaders` tarball is unzipped in every broker's pulsar directory
>
-> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
+> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
> you can use `apachepulsar/pulsar-all` image instead of `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
@@ -158,15 +170,19 @@ For more details of how to configure tiered storage feature, you could reference
Once you have an up-to-date local copy of the release, you can start up a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start up Pulsar in standalone mode:
```bash
+
$ bin/pulsar standalone
+
```
If Pulsar has been successfully started, you should see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
> #### Automatically created namespace
@@ -177,7 +193,9 @@ If Pulsar has been successfully started, you should see `INFO`-level log message
Alternatively, you can run pulsar standalone locally in docker.
```bash
+
docker run -it -p 80:80 -p 8080:8080 -p 6650:6650 apachepulsar/pulsar-standalone
+
```
The command forwards following port to localhost:
@@ -193,47 +211,55 @@ After the docker container is running, you can access the dashboard under http:/
Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsar-client) that enables you to do things like send messages to a Pulsar topic in a running cluster. This command will send a simple message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you should see a confirmation like this in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
-```
+```
> #### No need to explicitly create new topics
> You may have noticed that we did not explicitly create the `my-topic` topic to which we sent the `hello-pulsar` message. If you attempt to write a message to a topic that does not yet exist, Pulsar will automatically create that topic for you.
## Using Pulsar clients locally
-Pulsar currently offers client libraries for [Java](client-libraries-java.md), [Python](client-libraries-python.md), and [C++](client-libraries-cpp.md). If you're running a local standalone cluster, you can use one of these root URLs for interacting with your cluster:
+Pulsar currently offers client libraries for [Java](client-libraries-java.md), [Python](client-libraries-python.md), and [C++](client-libraries-cpp). If you're running a local standalone cluster, you can use one of these root URLs for interacting with your cluster:
* `http://localhost:8080`
* `pulsar://localhost:6650`
-Here's an example producer for a Pulsar topic using the [Java](client-libraries-java.md) client:
+Here's an example producer for a Pulsar topic using the [Java](client-libraries-java) client:
```java
+
String localClusterUrl = "pulsar://localhost:6650";
PulsarClient client = PulsarClient.builder().serviceUrl(localClusterUrl).build();
Producer<byte[]> producer = client.newProducer().topic("my-topic").create();
+
```
-Here's an example [Python](client-libraries-python.md) producer:
+Here's an example [Python](client-libraries-python) producer:
```python
+
import pulsar
client = pulsar.Client('pulsar://localhost:6650')
producer = client.create_producer('my-topic')
+
```
-Finally, here's an example [C++](client-libraries-cpp.md) producer:
+Finally, here's an example [C++](client-libraries-cpp) producer:
```cpp
+
Client client("pulsar://localhost:6650");
Producer producer;
Result result = client.createProducer("my-topic", producer);
@@ -241,4 +267,6 @@ if (result != ResultOk) {
LOG_ERROR("Error creating producer: " << result);
return -1;
}
+
```
+
diff --git a/site2/website-next/versioned_docs/version-2.2.1/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.2.1/concepts-architecture-overview.md
index 24493c277b..0d96b59f8a 100644
--- a/site2/website-next/versioned_docs/version-2.2.1/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.2.1/concepts-architecture-overview.md
@@ -45,7 +45,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
> Pulsar also supports more metadata backend services, including [ETCD](https://etcd.io/) and [RocksDB](http://rocksdb.org/) (for standalone Pulsar only).
diff --git a/site2/website/versioned_docs/version-2.2.1/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.2.1/getting-started-standalone.md
similarity index 83%
copy from site2/website/versioned_docs/version-2.2.1/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.2.1/getting-started-standalone.md
index e3fe5a8ee0..93a5ef8566 100644
--- a/site2/website/versioned_docs/version-2.2.1/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.2.1/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.2.1-standalone
+id: getting-started-standalone
title: Setting up a local standalone cluster
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For the purposes of local development and testing, you can run Pulsar in standalone mode on your own machine. Standalone mode includes a Pulsar broker as well as the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Run Pulsar Standalone Manually
@@ -23,21 +23,25 @@ To get started running Pulsar, download a binary tarball release in one of the f
* by clicking the link below and downloading the release from an Apache mirror:
- * <a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>
+ * <a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>
* from the Pulsar [downloads page](pulsar:download_page_url)
* from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest)
* using [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
Once the tarball is downloaded, untar it and `cd` into the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
### What your package contains
@@ -46,9 +50,9 @@ The Pulsar binary package initially contains the following directories:
Directory | Contains
:---------|:--------
-`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin.md)
+`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin)
`conf` | Configuration files for Pulsar, including for [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more
-`examples` | A Java JAR file containing example [Pulsar Functions](functions-overview.md)
+`examples` | A Java JAR file containing example [Pulsar Functions](functions-overview)
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar
`licenses` | License files, in `.txt` form, for various components of the Pulsar [codebase](http://github.com/apache/pulsar)
@@ -57,7 +61,7 @@ These directories will be created once you begin running Pulsar:
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md)
+`instances` | Artifacts created for [Pulsar Functions](functions-overview)
`logs` | Logs created by the installation
@@ -68,35 +72,39 @@ If you would like to enable those `builtin` connectors, you can download the con
* by clicking the link below and downloading the release from an Apache mirror:
- * <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+ * <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* from the Pulsar [downloads page](pulsar:download_page_url)
* from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest)
* using [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:connector_release_url
+
```
Once the tarball is downloaded, in the pulsar directory, untar the io-connectors package and copy the connectors as `connectors`
in the pulsar directory:
```bash
-$ tar xvfz /path/to/apache-pulsar-io-connectors-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-io-connectors-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz /path/to/apache-pulsar-io-connectors-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-io-connectors-@pulsar:version@` in the pulsar directory
// then copy the connectors
-$ cd apache-pulsar-io-connectors-{{pulsar:version}}/connectors connectors
+$ cd apache-pulsar-io-connectors-@pulsar:version@/connectors connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
-pulsar-io-cassandra-{{pulsar:version}}.nar
-pulsar-io-kafka-{{pulsar:version}}.nar
-pulsar-io-kinesis-{{pulsar:version}}.nar
-pulsar-io-rabbitmq-{{pulsar:version}}.nar
-pulsar-io-twitter-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
+pulsar-io-cassandra-@pulsar:version@.nar
+pulsar-io-kafka-@pulsar:version@.nar
+pulsar-io-kinesis-@pulsar:version@.nar
+pulsar-io-rabbitmq-@pulsar:version@.nar
+pulsar-io-twitter-@pulsar:version@.nar
...
+
```
> #### NOTES
@@ -104,7 +112,7 @@ pulsar-io-twitter-{{pulsar:version}}.nar
> If you are running Pulsar in a bare metal cluster, you need to make sure `connectors` tarball is unzipped in every broker's pulsar directory
> (or in every function-worker's pulsar directory if you are running a separate worker cluster for Pulsar functions).
>
-> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
+> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
> you can use `apachepulsar/pulsar-all` image instead of `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
## Installing Tiered Storage Offloaders (optional)
@@ -113,43 +121,47 @@ pulsar-io-twitter-{{pulsar:version}}.nar
> If you would like to enable tiered storage feature, you can follow the instructions as below; otherwise you can
> skip this section for now.
-To get started using [tiered storage offloaders](concepts-tiered-storage.md), you'll need to download the offloaders tarball release on every broker node in
+To get started using [tiered storage offloaders](concepts-tiered-storage), you'll need to download the offloaders tarball release on every broker node in
one of the following ways:
* by clicking the link below and downloading the release from an Apache mirror:
- * <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+ * <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* from the Pulsar [downloads page](pulsar:download_page_url)
* from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest)
* using [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
Once the tarball is downloaded, in the pulsar directory, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more details of how to configure tiered storage feature, you could reference this [Tiered storage cookbook](cookbooks-tiered-storage.md)
+For more details of how to configure tiered storage feature, you could reference this [Tiered storage cookbook](cookbooks-tiered-storage)
> #### NOTES
>
> If you are running Pulsar in a bare metal cluster, you need to make sure `offloaders` tarball is unzipped in every broker's pulsar directory
>
-> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
+> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
> you can use `apachepulsar/pulsar-all` image instead of `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
@@ -158,15 +170,19 @@ For more details of how to configure tiered storage feature, you could reference
Once you have an up-to-date local copy of the release, you can start up a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start up Pulsar in standalone mode:
```bash
+
$ bin/pulsar standalone
+
```
If Pulsar has been successfully started, you should see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
> #### Automatically created namespace
@@ -177,7 +193,9 @@ If Pulsar has been successfully started, you should see `INFO`-level log message
Alternatively, you can run pulsar standalone locally in docker.
```bash
+
docker run -it -p 80:80 -p 8080:8080 -p 6650:6650 apachepulsar/pulsar-standalone
+
```
The command forwards following port to localhost:
@@ -193,47 +211,55 @@ After the docker container is running, you can access the dashboard under http:/
Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsar-client) that enables you to do things like send messages to a Pulsar topic in a running cluster. This command will send a simple message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you should see a confirmation like this in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
-```
+```
> #### No need to explicitly create new topics
> You may have noticed that we did not explicitly create the `my-topic` topic to which we sent the `hello-pulsar` message. If you attempt to write a message to a topic that does not yet exist, Pulsar will automatically create that topic for you.
## Using Pulsar clients locally
-Pulsar currently offers client libraries for [Java](client-libraries-java.md), [Go](client-libraries-go.md), [Python](client-libraries-python.md) and [C++](client-libraries-cpp.md). If you're running a local standalone cluster, you can use one of these root URLs for interacting with your cluster:
+Pulsar currently offers client libraries for [Java](client-libraries-java.md), [Go](client-libraries-go.md), [Python](client-libraries-python.md) and [C++](client-libraries-cpp). If you're running a local standalone cluster, you can use one of these root URLs for interacting with your cluster:
* `http://localhost:8080`
* `pulsar://localhost:6650`
-Here's an example producer for a Pulsar topic using the [Java](client-libraries-java.md) client:
+Here's an example producer for a Pulsar topic using the [Java](client-libraries-java) client:
```java
+
String localClusterUrl = "pulsar://localhost:6650";
PulsarClient client = PulsarClient.builder().serviceUrl(localClusterUrl).build();
Producer<byte[]> producer = client.newProducer().topic("my-topic").create();
+
```
-Here's an example [Python](client-libraries-python.md) producer:
+Here's an example [Python](client-libraries-python) producer:
```python
+
import pulsar
client = pulsar.Client('pulsar://localhost:6650')
producer = client.create_producer('my-topic')
+
```
-Finally, here's an example [C++](client-libraries-cpp.md) producer:
+Finally, here's an example [C++](client-libraries-cpp) producer:
```cpp
+
Client client("pulsar://localhost:6650");
Producer producer;
Result result = client.createProducer("my-topic", producer);
@@ -241,4 +267,6 @@ if (result != ResultOk) {
LOG_ERROR("Error creating producer: " << result);
return -1;
}
+
```
+
diff --git a/site2/website-next/versioned_docs/version-2.3.0/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.3.0/concepts-architecture-overview.md
index 24493c277b..0d96b59f8a 100644
--- a/site2/website-next/versioned_docs/version-2.3.0/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.3.0/concepts-architecture-overview.md
@@ -45,7 +45,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
> Pulsar also supports more metadata backend services, including [ETCD](https://etcd.io/) and [RocksDB](http://rocksdb.org/) (for standalone Pulsar only).
diff --git a/site2/website/versioned_docs/version-2.3.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.3.0/getting-started-standalone.md
similarity index 85%
copy from site2/website/versioned_docs/version-2.3.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.3.0/getting-started-standalone.md
index 86c2a3ad8a..cac7aafc3c 100644
--- a/site2/website/versioned_docs/version-2.3.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.3.0/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.3.0-standalone
+id: getting-started-standalone
title: Setting up a local standalone cluster
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For the purposes of local development and testing, you can run Pulsar in standalone mode on your own machine. Standalone mode includes a Pulsar broker as well as the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Run Pulsar Standalone Manually
@@ -23,21 +23,25 @@ To get started running Pulsar, download a binary tarball release in one of the f
* by clicking the link below and downloading the release from an Apache mirror:
- * <a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>
+ * <a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>
* from the Pulsar [downloads page](pulsar:download_page_url)
* from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest)
* using [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
Once the tarball is downloaded, untar it and `cd` into the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
### What your package contains
@@ -46,9 +50,9 @@ The Pulsar binary package initially contains the following directories:
Directory | Contains
:---------|:--------
-`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin.md)
+`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin)
`conf` | Configuration files for Pulsar, including for [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more
-`examples` | A Java JAR file containing example [Pulsar Functions](functions-overview.md)
+`examples` | A Java JAR file containing example [Pulsar Functions](functions-overview)
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar
`licenses` | License files, in `.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar)
@@ -57,7 +61,7 @@ These directories will be created once you begin running Pulsar:
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md)
+`instances` | Artifacts created for [Pulsar Functions](functions-overview)
`logs` | Logs created by the installation
@@ -68,26 +72,30 @@ If you would like to enable those `builtin` connectors, you can download the con
* by clicking the link below and downloading the release from an Apache mirror:
- * <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+ * <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* from the Pulsar [downloads page](pulsar:download_page_url)
* from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest)
* using [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
Once the nar file is downloaded, copy the file to directory `connectors` in the pulsar directory,
-for example, if the connector file `pulsar-io-aerospike-{{pulsar:version}}.nar` is downloaded:
+for example, if the connector file `pulsar-io-aerospike-@pulsar:version@.nar` is downloaded:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
> #### NOTES
@@ -95,7 +103,7 @@ pulsar-io-aerospike-{{pulsar:version}}.nar
> If you are running Pulsar in a bare metal cluster, you need to make sure `connectors` tarball is unzipped in every broker's pulsar directory
> (or in every function-worker's pulsar directory if you are running a separate worker cluster for Pulsar functions).
>
-> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
+> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
> you can use `apachepulsar/pulsar-all` image instead of `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
## Installing Tiered Storage Offloaders (optional)
@@ -104,43 +112,47 @@ pulsar-io-aerospike-{{pulsar:version}}.nar
> If you would like to enable tiered storage feature, you can follow the instructions as below; otherwise you can
> skip this section for now.
-To get started using [tiered storage offloaders](concepts-tiered-storage.md), you'll need to download the offloaders tarball release on every broker node in
+To get started using [tiered storage offloaders](concepts-tiered-storage), you'll need to download the offloaders tarball release on every broker node in
one of the following ways:
* by clicking the link below and downloading the release from an Apache mirror:
- * <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+ * <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* from the Pulsar [downloads page](pulsar:download_page_url)
* from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest)
* using [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
Once the tarball is downloaded, in the pulsar directory, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more details of how to configure tiered storage feature, you could reference this [Tiered storage cookbook](cookbooks-tiered-storage.md)
+For more details of how to configure tiered storage feature, you could reference this [Tiered storage cookbook](cookbooks-tiered-storage)
> #### NOTES
>
> If you are running Pulsar in a bare metal cluster, you need to make sure `offloaders` tarball is unzipped in every broker's pulsar directory
>
-> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
+> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
> you can use `apachepulsar/pulsar-all` image instead of `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
@@ -149,15 +161,19 @@ For more details of how to configure tiered storage feature, you could reference
Once you have an up-to-date local copy of the release, you can start up a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start up Pulsar in standalone mode:
```bash
+
$ bin/pulsar standalone
+
```
If Pulsar has been successfully started, you should see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
> #### Automatically created namespace
@@ -168,7 +184,9 @@ If Pulsar has been successfully started, you should see `INFO`-level log message
Alternatively, you can run pulsar standalone locally in docker.
```bash
+
docker run -it -p 80:80 -p 8080:8080 -p 6650:6650 apachepulsar/pulsar-standalone
+
```
The command forwards following port to localhost:
@@ -184,15 +202,18 @@ After the docker container is running, you can access the dashboard under http:/
Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsar-client) that enables you to do things like send messages to a Pulsar topic in a running cluster. This command will send a simple message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you should see a confirmation like this in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
-```
+```
> #### No need to explicitly create new topics
> You may have noticed that we did not explicitly create the `my-topic` topic to which we sent the `hello-pulsar` message. If you attempt to write a message to a topic that does not yet exist, Pulsar will automatically create that topic for you.
@@ -202,44 +223,53 @@ If the message has been successfully published to the topic, you should see a co
Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsar-client) that enables you to do things like receive messages from a Pulsar topic in a running cluster. This command will receive a simple message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -t Shared -s demo-sub -n 0
+
```
If the message has been successfully published to the topic as above, you should see a confirmation like this in the `pulsar-client` logs:
```
+
----- got message -----
hello-pulsar
+
```
## Using Pulsar clients locally
-Pulsar currently offers client libraries for [Java](client-libraries-java.md), [Go](client-libraries-go.md), [Python](client-libraries-python.md) and [C++](client-libraries-cpp.md). If you're running a local standalone cluster, you can use one of these root URLs for interacting with your cluster:
+Pulsar currently offers client libraries for [Java](client-libraries-java.md), [Go](client-libraries-go.md), [Python](client-libraries-python.md) and [C++](client-libraries-cpp). If you're running a local standalone cluster, you can use one of these root URLs for interacting with your cluster:
* `http://localhost:8080`
* `pulsar://localhost:6650`
-Here's an example producer for a Pulsar topic using the [Java](client-libraries-java.md) client:
+Here's an example producer for a Pulsar topic using the [Java](client-libraries-java) client:
```java
+
String localClusterUrl = "pulsar://localhost:6650";
PulsarClient client = PulsarClient.builder().serviceUrl(localClusterUrl).build();
Producer<byte[]> producer = client.newProducer().topic("my-topic").create();
+
```
-Here's an example [Python](client-libraries-python.md) producer:
+Here's an example [Python](client-libraries-python) producer:
```python
+
import pulsar
client = pulsar.Client('pulsar://localhost:6650')
producer = client.create_producer('my-topic')
+
```
-Finally, here's an example [C++](client-libraries-cpp.md) producer:
+Finally, here's an example [C++](client-libraries-cpp) producer:
```cpp
+
Client client("pulsar://localhost:6650");
Producer producer;
Result result = client.createProducer("my-topic", producer);
@@ -247,4 +277,6 @@ if (result != ResultOk) {
LOG_ERROR("Error creating producer: " << result);
return -1;
}
+
```
+
diff --git a/site2/website-next/versioned_docs/version-2.3.1/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.3.1/concepts-architecture-overview.md
index 24493c277b..0d96b59f8a 100644
--- a/site2/website-next/versioned_docs/version-2.3.1/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.3.1/concepts-architecture-overview.md
@@ -45,7 +45,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
> Pulsar also supports more metadata backend services, including [ETCD](https://etcd.io/) and [RocksDB](http://rocksdb.org/) (for standalone Pulsar only).
diff --git a/site2/website/versioned_docs/version-2.3.1/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.3.1/getting-started-standalone.md
similarity index 84%
copy from site2/website/versioned_docs/version-2.3.1/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.3.1/getting-started-standalone.md
index 7bdeeb8ea5..73fc69b7eb 100644
--- a/site2/website/versioned_docs/version-2.3.1/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.3.1/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.3.1-standalone
+id: getting-started-standalone
title: Setting up a local standalone cluster
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For the purposes of local development and testing, you can run Pulsar in standalone mode on your own machine. Standalone mode includes a Pulsar broker as well as the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Run Pulsar Standalone Manually
@@ -23,21 +23,25 @@ To get started running Pulsar, download a binary tarball release in one of the f
* by clicking the link below and downloading the release from an Apache mirror:
- * <a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>
+ * <a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>
* from the Pulsar [downloads page](pulsar:download_page_url)
* from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest)
* using [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
Once the tarball is downloaded, untar it and `cd` into the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
### What your package contains
@@ -46,9 +50,9 @@ The Pulsar binary package initially contains the following directories:
Directory | Contains
:---------|:--------
-`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin.md)
+`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin)
`conf` | Configuration files for Pulsar, including for [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more
-`examples` | A Java JAR file containing example [Pulsar Functions](functions-overview.md)
+`examples` | A Java JAR file containing example [Pulsar Functions](functions-overview)
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar
`licenses` | License files, in `.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar)
@@ -57,7 +61,7 @@ These directories will be created once you begin running Pulsar:
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md)
+`instances` | Artifacts created for [Pulsar Functions](functions-overview)
`logs` | Logs created by the installation
@@ -68,26 +72,30 @@ If you would like to enable those `builtin` connectors, you can download the con
* by clicking the link below and downloading the release from an Apache mirror:
- * <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+ * <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* from the Pulsar [downloads page](pulsar:download_page_url)
* from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest)
* using [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
Once the nar file is downloaded, copy the file to directory `connectors` in the pulsar directory,
-for example, if the connector file `pulsar-io-aerospike-{{pulsar:version}}.nar` is downloaded:
+for example, if the connector file `pulsar-io-aerospike-@pulsar:version@.nar` is downloaded:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
> #### NOTES
@@ -95,7 +103,7 @@ pulsar-io-aerospike-{{pulsar:version}}.nar
> If you are running Pulsar in a bare metal cluster, you need to make sure `connectors` tarball is unzipped in every broker's pulsar directory
> (or in every function-worker's pulsar directory if you are running a separate worker cluster for Pulsar functions).
>
-> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
+> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
> you can use `apachepulsar/pulsar-all` image instead of `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
## Installing Tiered Storage Offloaders (optional)
@@ -104,43 +112,47 @@ pulsar-io-aerospike-{{pulsar:version}}.nar
> If you would like to enable tiered storage feature, you can follow the instructions as below; otherwise you can
> skip this section for now.
-To get started using [tiered storage offloaders](concepts-tiered-storage.md), you'll need to download the offloaders tarball release on every broker node in
+To get started using [tiered storage offloaders](concepts-tiered-storage), you'll need to download the offloaders tarball release on every broker node in
one of the following ways:
* by clicking the link below and downloading the release from an Apache mirror:
- * <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+ * <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* from the Pulsar [downloads page](pulsar:download_page_url)
* from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest)
* using [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
Once the tarball is downloaded, in the pulsar directory, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more details of how to configure tiered storage feature, you could reference this [Tiered storage cookbook](cookbooks-tiered-storage.md)
+For more details of how to configure tiered storage feature, you could reference this [Tiered storage cookbook](cookbooks-tiered-storage)
> #### NOTES
>
> If you are running Pulsar in a bare metal cluster, you need to make sure `offloaders` tarball is unzipped in every broker's pulsar directory
>
-> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
+> If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
> you can use `apachepulsar/pulsar-all` image instead of `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
@@ -149,15 +161,19 @@ For more details of how to configure tiered storage feature, you could reference
Once you have an up-to-date local copy of the release, you can start up a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start up Pulsar in standalone mode:
```bash
+
$ bin/pulsar standalone
+
```
If Pulsar has been successfully started, you should see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
> #### Automatically created namespace
@@ -168,7 +184,9 @@ If Pulsar has been successfully started, you should see `INFO`-level log message
Alternatively, you can run pulsar standalone locally in docker.
```bash
+
docker run -it -p 80:80 -p 8080:8080 -p 6650:6650 apachepulsar/pulsar-standalone
+
```
The command forwards following port to localhost:
@@ -184,47 +202,55 @@ After the docker container is running, you can access the dashboard under http:/
Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsar-client) that enables you to do things like send messages to a Pulsar topic in a running cluster. This command will send a simple message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you should see a confirmation like this in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
-```
+```
> #### No need to explicitly create new topics
> You may have noticed that we did not explicitly create the `my-topic` topic to which we sent the `hello-pulsar` message. If you attempt to write a message to a topic that does not yet exist, Pulsar will automatically create that topic for you.
## Using Pulsar clients locally
-Pulsar currently offers client libraries for [Java](client-libraries-java.md), [Go](client-libraries-go.md), [Python](client-libraries-python.md) and [C++](client-libraries-cpp.md). If you're running a local standalone cluster, you can use one of these root URLs for interacting with your cluster:
+Pulsar currently offers client libraries for [Java](client-libraries-java.md), [Go](client-libraries-go.md), [Python](client-libraries-python.md) and [C++](client-libraries-cpp). If you're running a local standalone cluster, you can use one of these root URLs for interacting with your cluster:
* `http://localhost:8080`
* `pulsar://localhost:6650`
-Here's an example producer for a Pulsar topic using the [Java](client-libraries-java.md) client:
+Here's an example producer for a Pulsar topic using the [Java](client-libraries-java) client:
```java
+
String localClusterUrl = "pulsar://localhost:6650";
PulsarClient client = PulsarClient.builder().serviceUrl(localClusterUrl).build();
Producer<byte[]> producer = client.newProducer().topic("my-topic").create();
+
```
-Here's an example [Python](client-libraries-python.md) producer:
+Here's an example [Python](client-libraries-python) producer:
```python
+
import pulsar
client = pulsar.Client('pulsar://localhost:6650')
producer = client.create_producer('my-topic')
+
```
-Finally, here's an example [C++](client-libraries-cpp.md) producer:
+Finally, here's an example [C++](client-libraries-cpp) producer:
```cpp
+
Client client("pulsar://localhost:6650");
Producer producer;
Result result = client.createProducer("my-topic", producer);
@@ -232,4 +258,6 @@ if (result != ResultOk) {
LOG_ERROR("Error creating producer: " << result);
return -1;
}
+
```
+
diff --git a/site2/website-next/versioned_docs/version-2.3.2/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.3.2/concepts-architecture-overview.md
index 24493c277b..0d96b59f8a 100644
--- a/site2/website-next/versioned_docs/version-2.3.2/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.3.2/concepts-architecture-overview.md
@@ -45,7 +45,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
> Pulsar also supports more metadata backend services, including [ETCD](https://etcd.io/) and [RocksDB](http://rocksdb.org/) (for standalone Pulsar only).
diff --git a/site2/website/versioned_docs/version-2.3.2/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.3.2/getting-started-standalone.md
similarity index 61%
copy from site2/website/versioned_docs/version-2.3.2/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.3.2/getting-started-standalone.md
index 1404a2ea5b..36a36150ca 100644
--- a/site2/website/versioned_docs/version-2.3.2/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.3.2/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.3.2-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -20,7 +20,7 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -29,14 +29,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -45,9 +49,9 @@ The Pulsar binary package initially contains the following directories:
Directory | Contains
:---------|:--------
-`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin.md).
+`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -56,25 +60,26 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
#### Install other optional components
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
##### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -83,39 +88,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
##### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+:::
+
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -124,52 +136,64 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -183,39 +207,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.4.0/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.4.0/concepts-architecture-overview.md
index 24493c277b..0d96b59f8a 100644
--- a/site2/website-next/versioned_docs/version-2.4.0/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.4.0/concepts-architecture-overview.md
@@ -45,7 +45,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
> Pulsar also supports more metadata backend services, including [ETCD](https://etcd.io/) and [RocksDB](http://rocksdb.org/) (for standalone Pulsar only).
diff --git a/site2/website/versioned_docs/version-2.4.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.4.0/getting-started-standalone.md
similarity index 61%
copy from site2/website/versioned_docs/version-2.4.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.4.0/getting-started-standalone.md
index 485d3bebd9..13ac662b6b 100644
--- a/site2/website/versioned_docs/version-2.4.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.4.0/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.4.0-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -22,7 +22,7 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -31,14 +31,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -47,9 +51,9 @@ The Pulsar binary package initially contains the following directories:
Directory | Contains
:---------|:--------
-`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin.md).
+`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -58,23 +62,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -83,39 +88,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+:::
+
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -124,52 +136,64 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -183,39 +207,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.4.1/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.4.1/concepts-architecture-overview.md
index 24493c277b..0d96b59f8a 100644
--- a/site2/website-next/versioned_docs/version-2.4.1/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.4.1/concepts-architecture-overview.md
@@ -45,7 +45,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
> Pulsar also supports more metadata backend services, including [ETCD](https://etcd.io/) and [RocksDB](http://rocksdb.org/) (for standalone Pulsar only).
diff --git a/site2/website/versioned_docs/version-2.4.1/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.4.1/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.4.1/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.4.1/getting-started-standalone.md
index a80f443844..b517e118df 100644
--- a/site2/website/versioned_docs/version-2.4.1/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.4.1/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.4.1-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,14 +18,17 @@ This tutorial guides you through every step of the installation process.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions.
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
+
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -34,14 +37,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -50,9 +57,9 @@ The Pulsar binary package initially contains the following directories:
Directory | Contains
:---------|:--------
-`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin.md).
+`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -61,23 +68,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -86,39 +94,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -127,55 +142,67 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -188,39 +215,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.4.2/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.4.2/concepts-architecture-overview.md
index 24493c277b..0d96b59f8a 100644
--- a/site2/website-next/versioned_docs/version-2.4.2/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.4.2/concepts-architecture-overview.md
@@ -45,7 +45,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
> Pulsar also supports more metadata backend services, including [ETCD](https://etcd.io/) and [RocksDB](http://rocksdb.org/) (for standalone Pulsar only).
diff --git a/site2/website/versioned_docs/version-2.4.1/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.4.2/getting-started-standalone.md
similarity index 59%
copy from site2/website/versioned_docs/version-2.4.1/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.4.2/getting-started-standalone.md
index a80f443844..13619ef486 100644
--- a/site2/website/versioned_docs/version-2.4.1/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.4.2/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.4.1-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,14 +18,17 @@ This tutorial guides you through every step of the installation process.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions.
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
+
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -34,14 +37,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -50,9 +57,9 @@ The Pulsar binary package initially contains the following directories:
Directory | Contains
:---------|:--------
-`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin.md).
+`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -61,23 +68,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -86,39 +94,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -127,55 +142,68 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* Before starting the Pulsar standalone, you may need to config the advertisedAddress to avoid startup errors. Actually, you can modify the default value of advertisedAddress in "conf/standalone.conf" or use command "bin/pulsar standalone -a 127.0.0.1" to assign the advertisedAddress.
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -188,39 +216,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.5.0/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.5.0/concepts-architecture-overview.md
index 24493c277b..0d96b59f8a 100644
--- a/site2/website-next/versioned_docs/version-2.5.0/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.5.0/concepts-architecture-overview.md
@@ -45,7 +45,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
> Pulsar also supports more metadata backend services, including [ETCD](https://etcd.io/) and [RocksDB](http://rocksdb.org/) (for standalone Pulsar only).
diff --git a/site2/website/versioned_docs/version-2.4.1/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.5.0/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.4.1/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.5.0/getting-started-standalone.md
index a80f443844..b517e118df 100644
--- a/site2/website/versioned_docs/version-2.4.1/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.5.0/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.4.1-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,14 +18,17 @@ This tutorial guides you through every step of the installation process.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions.
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
+
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -34,14 +37,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -50,9 +57,9 @@ The Pulsar binary package initially contains the following directories:
Directory | Contains
:---------|:--------
-`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin.md).
+`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](reference-pulsar-admin).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -61,23 +68,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -86,39 +94,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -127,55 +142,67 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -188,39 +215,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.5.1/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.5.1/concepts-architecture-overview.md
index 6a501d2127..0c7d44260d 100644
--- a/site2/website-next/versioned_docs/version-2.5.1/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.5.1/concepts-architecture-overview.md
@@ -46,7 +46,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
In a Pulsar instance:
diff --git a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.5.1/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.5.1/getting-started-standalone.md
index 76abd7d04e..5ffb6424f0 100644
--- a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.5.1/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.6.0-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,14 +18,23 @@ This tutorial guides you through every step of the installation process.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions.
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
+
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
+
+:::note
+
+Broker is only supported on 64-bit JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -34,14 +43,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -52,7 +65,7 @@ Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -61,23 +74,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -86,39 +100,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -127,55 +148,67 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -188,39 +221,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.5.2/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.5.2/concepts-architecture-overview.md
index 24493c277b..0d96b59f8a 100644
--- a/site2/website-next/versioned_docs/version-2.5.2/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.5.2/concepts-architecture-overview.md
@@ -45,7 +45,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
> Pulsar also supports more metadata backend services, including [ETCD](https://etcd.io/) and [RocksDB](http://rocksdb.org/) (for standalone Pulsar only).
diff --git a/site2/docs/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.5.2/getting-started-standalone.md
similarity index 59%
copy from site2/docs/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.5.2/getting-started-standalone.md
index 2d0e760f37..9357c9e2ad 100644
--- a/site2/docs/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.5.2/getting-started-standalone.md
@@ -1,13 +1,13 @@
---
-id: standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
+sidebar_label: "Run Pulsar locally"
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary [RocksDB](http://rocksdb.org/) and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> **Pulsar in production?**
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -17,17 +17,23 @@ This tutorial guides you through every step of installing Pulsar locally.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions
-> **Tip**
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
-> **Note**
-> Broker is only supported on 64-bit JVM.
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
+
+:::note
+
+Broker is only supported on 64-bit JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -36,14 +42,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -53,9 +63,9 @@ The Pulsar binary package initially contains the following directories:
Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
-`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker) and more.<br />**Note:** Pulsar standalone uses RocksDB as the local metadata store and its configuration file path [`metadataStoreConfigPath`](reference-configuration.md) is configurable in the `standalone.conf` file. For more information about the configurations of RocksDB, see [here](https://github.com/facebook/rocksdb/blob/main/examples/rocksdb_option_file_example.ini) and rel [...]
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker) and more.<br />**Note:** Pulsar standalone uses RocksDB as the local metadata store and its configuration file path [`metadataStoreConfigPath`](reference-configuration) is configurable in the `standalone.conf` file. For more information about the configurations of RocksDB, see [here](https://github.com/facebook/rocksdb/blob/main/examples/rocksdb_option_file_example.ini) and relate [...]
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -66,20 +76,21 @@ Directory | Contains
`data` | The data storage directory used by RocksDB and BookKeeper.
`logs` | Logs created by the installation.
-> **Tip**
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -88,35 +99,44 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> **Note**
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/), you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/), you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> **Tip**
-> - Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> - To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+- Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+- To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+:::
+
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -125,52 +145,66 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> **Note**
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or DC/OS), you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or DC/OS), you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
21:59:29.327 [DLM-/stream/storage-OrderedScheduler-3-0] INFO org.apache.bookkeeper.stream.storage.impl.sc.StorageContainerImpl - Successfully started storage container (0).
21:59:34.576 [main] INFO org.apache.pulsar.broker.authentication.AuthenticationService - Authentication is disabled
21:59:34.576 [main] INFO org.apache.pulsar.websocket.WebSocketService - Pulsar WebSocket Service started
+
```
-> **Tip**
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `bin/pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -183,37 +217,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
22:17:16.781 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully consumed
+
```
-> **Tip**
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
22:21:08.693 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> **Tip**
-> If the service runs as a background process using the `bin/pulsar-daemon start standalone` command, then use the `bin/pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `bin/pulsar-daemon start standalone` command, then use the `bin/pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.6.0/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.6.0/getting-started-standalone.md
index 76abd7d04e..0db73dda6a 100644
--- a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.6.0/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.6.0-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,14 +18,17 @@ This tutorial guides you through every step of the installation process.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions.
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
+
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -34,14 +37,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -52,7 +59,7 @@ Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -61,23 +68,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -86,39 +94,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -127,55 +142,67 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -188,39 +215,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.6.1/concepts-proxy-sni-routing.md b/site2/website-next/versioned_docs/version-2.6.1/concepts-proxy-sni-routing.md
index 329959e886..46e4313025 100644
--- a/site2/website-next/versioned_docs/version-2.6.1/concepts-proxy-sni-routing.md
+++ b/site2/website-next/versioned_docs/version-2.6.1/concepts-proxy-sni-routing.md
@@ -47,7 +47,7 @@ CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.6.1/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.6.1/getting-started-standalone.md
index 76abd7d04e..0db73dda6a 100644
--- a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.6.1/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.6.0-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,14 +18,17 @@ This tutorial guides you through every step of the installation process.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions.
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
+
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -34,14 +37,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -52,7 +59,7 @@ Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -61,23 +68,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -86,39 +94,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -127,55 +142,67 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -188,39 +215,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.6.2/concepts-proxy-sni-routing.md b/site2/website-next/versioned_docs/version-2.6.2/concepts-proxy-sni-routing.md
index 329959e886..46e4313025 100644
--- a/site2/website-next/versioned_docs/version-2.6.2/concepts-proxy-sni-routing.md
+++ b/site2/website-next/versioned_docs/version-2.6.2/concepts-proxy-sni-routing.md
@@ -47,7 +47,7 @@ CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.6.2/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.6.2/getting-started-standalone.md
index 76abd7d04e..0db73dda6a 100644
--- a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.6.2/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.6.0-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,14 +18,17 @@ This tutorial guides you through every step of the installation process.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions.
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
+
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -34,14 +37,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -52,7 +59,7 @@ Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -61,23 +68,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -86,39 +94,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -127,55 +142,67 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -188,39 +215,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.6.3/concepts-proxy-sni-routing.md b/site2/website-next/versioned_docs/version-2.6.3/concepts-proxy-sni-routing.md
index 329959e886..46e4313025 100644
--- a/site2/website-next/versioned_docs/version-2.6.3/concepts-proxy-sni-routing.md
+++ b/site2/website-next/versioned_docs/version-2.6.3/concepts-proxy-sni-routing.md
@@ -47,7 +47,7 @@ CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.6.3/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.6.3/getting-started-standalone.md
index 76abd7d04e..0db73dda6a 100644
--- a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.6.3/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.6.0-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,14 +18,17 @@ This tutorial guides you through every step of the installation process.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions.
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
+
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -34,14 +37,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -52,7 +59,7 @@ Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -61,23 +68,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -86,39 +94,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -127,55 +142,67 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -188,39 +215,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.6.4/concepts-proxy-sni-routing.md b/site2/website-next/versioned_docs/version-2.6.4/concepts-proxy-sni-routing.md
index 329959e886..46e4313025 100644
--- a/site2/website-next/versioned_docs/version-2.6.4/concepts-proxy-sni-routing.md
+++ b/site2/website-next/versioned_docs/version-2.6.4/concepts-proxy-sni-routing.md
@@ -47,7 +47,7 @@ CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.6.4/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.6.4/getting-started-standalone.md
index 76abd7d04e..0db73dda6a 100644
--- a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.6.4/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.6.0-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,14 +18,17 @@ This tutorial guides you through every step of the installation process.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions.
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
+
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -34,14 +37,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -52,7 +59,7 @@ Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -61,23 +68,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -86,39 +94,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -127,55 +142,67 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -188,39 +215,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.7.0/concepts-proxy-sni-routing.md b/site2/website-next/versioned_docs/version-2.7.0/concepts-proxy-sni-routing.md
index 329959e886..46e4313025 100644
--- a/site2/website-next/versioned_docs/version-2.7.0/concepts-proxy-sni-routing.md
+++ b/site2/website-next/versioned_docs/version-2.7.0/concepts-proxy-sni-routing.md
@@ -47,7 +47,7 @@ CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.7.0/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.7.0/getting-started-standalone.md
index 76abd7d04e..0db73dda6a 100644
--- a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.7.0/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.6.0-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,14 +18,17 @@ This tutorial guides you through every step of the installation process.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions.
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
+
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -34,14 +37,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -52,7 +59,7 @@ Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -61,23 +68,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -86,39 +94,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -127,55 +142,67 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -188,39 +215,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.7.1/concepts-proxy-sni-routing.md b/site2/website-next/versioned_docs/version-2.7.1/concepts-proxy-sni-routing.md
index 329959e886..46e4313025 100644
--- a/site2/website-next/versioned_docs/version-2.7.1/concepts-proxy-sni-routing.md
+++ b/site2/website-next/versioned_docs/version-2.7.1/concepts-proxy-sni-routing.md
@@ -47,7 +47,7 @@ CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.7.1/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.7.1/getting-started-standalone.md
index 76abd7d04e..0db73dda6a 100644
--- a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.7.1/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.6.0-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,14 +18,17 @@ This tutorial guides you through every step of the installation process.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions.
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
+
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -34,14 +37,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -52,7 +59,7 @@ Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -61,23 +68,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -86,39 +94,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -127,55 +142,67 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -188,39 +215,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.7.2/concepts-proxy-sni-routing.md b/site2/website-next/versioned_docs/version-2.7.2/concepts-proxy-sni-routing.md
index 329959e886..46e4313025 100644
--- a/site2/website-next/versioned_docs/version-2.7.2/concepts-proxy-sni-routing.md
+++ b/site2/website-next/versioned_docs/version-2.7.2/concepts-proxy-sni-routing.md
@@ -47,7 +47,7 @@ CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.7.2/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.7.2/getting-started-standalone.md
index 76abd7d04e..5ffb6424f0 100644
--- a/site2/website/versioned_docs/version-2.6.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.7.2/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.6.0-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,14 +18,23 @@ This tutorial guides you through every step of the installation process.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions.
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
+
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
+
+:::note
+
+Broker is only supported on 64-bit JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -34,14 +43,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -52,7 +65,7 @@ Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -61,23 +74,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -86,39 +100,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -127,55 +148,67 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -188,39 +221,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.7.3/concepts-proxy-sni-routing.md b/site2/website-next/versioned_docs/version-2.7.3/concepts-proxy-sni-routing.md
index 329959e886..46e4313025 100644
--- a/site2/website-next/versioned_docs/version-2.7.3/concepts-proxy-sni-routing.md
+++ b/site2/website-next/versioned_docs/version-2.7.3/concepts-proxy-sni-routing.md
@@ -47,7 +47,7 @@ CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/website/versioned_docs/version-2.7.3/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.7.3/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.7.3/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.7.3/getting-started-standalone.md
index d5f789f3ec..8a5cd8e92f 100644
--- a/site2/website/versioned_docs/version-2.7.3/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.7.3/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.7.3-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,14 +18,17 @@ This tutorial guides you through every step of the installation process.
Pulsar is currently available for **MacOS** and **Linux**. To use Pulsar, you need to install Java 8 from [Oracle download center](http://www.oracle.com/).
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
+
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -34,14 +37,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -52,7 +59,7 @@ Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -61,23 +68,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -86,39 +94,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -127,55 +142,67 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -188,39 +215,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.7.4/concepts-proxy-sni-routing.md b/site2/website-next/versioned_docs/version-2.7.4/concepts-proxy-sni-routing.md
index 329959e886..46e4313025 100644
--- a/site2/website-next/versioned_docs/version-2.7.4/concepts-proxy-sni-routing.md
+++ b/site2/website-next/versioned_docs/version-2.7.4/concepts-proxy-sni-routing.md
@@ -47,7 +47,7 @@ CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/website/versioned_docs/version-2.7.3/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.7.4/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.7.3/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.7.4/getting-started-standalone.md
index d5f789f3ec..8a5cd8e92f 100644
--- a/site2/website/versioned_docs/version-2.7.3/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.7.4/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.7.3-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,14 +18,17 @@ This tutorial guides you through every step of the installation process.
Pulsar is currently available for **MacOS** and **Linux**. To use Pulsar, you need to install Java 8 from [Oracle download center](http://www.oracle.com/).
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
+
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -34,14 +37,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -52,7 +59,7 @@ Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -61,23 +68,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -86,39 +94,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -127,55 +142,67 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -188,39 +215,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.8.0/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.8.0/concepts-architecture-overview.md
index 6a501d2127..0c7d44260d 100644
--- a/site2/website-next/versioned_docs/version-2.8.0/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.8.0/concepts-architecture-overview.md
@@ -46,7 +46,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
In a Pulsar instance:
diff --git a/site2/website-next/versioned_docs/version-2.8.0/concepts-proxy-sni-routing.md b/site2/website-next/versioned_docs/version-2.8.0/concepts-proxy-sni-routing.md
index 7a683b8395..7eee6df551 100644
--- a/site2/website-next/versioned_docs/version-2.8.0/concepts-proxy-sni-routing.md
+++ b/site2/website-next/versioned_docs/version-2.8.0/concepts-proxy-sni-routing.md
@@ -52,7 +52,7 @@ CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/website/versioned_docs/version-2.8.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.8.0/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.8.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.8.0/getting-started-standalone.md
index 01889306c4..c9475dd1c9 100644
--- a/site2/website/versioned_docs/version-2.8.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.8.0/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.8.0-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,18 +18,23 @@ This tutorial guides you through every step of the installation process.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions, JRE/JDK 11 is recommended.
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
-> **Note**
->
-> Broker is only supported on 64-bit JVM.
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
+
+:::note
+
+Broker is only supported on 64-bit JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -38,14 +43,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -56,7 +65,7 @@ Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -65,23 +74,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -90,39 +100,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -131,55 +148,67 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -192,39 +221,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.8.1/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.8.1/concepts-architecture-overview.md
index 6a501d2127..0c7d44260d 100644
--- a/site2/website-next/versioned_docs/version-2.8.1/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.8.1/concepts-architecture-overview.md
@@ -46,7 +46,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
In a Pulsar instance:
diff --git a/site2/website-next/versioned_docs/version-2.8.1/concepts-proxy-sni-routing.md b/site2/website-next/versioned_docs/version-2.8.1/concepts-proxy-sni-routing.md
index 7a683b8395..7eee6df551 100644
--- a/site2/website-next/versioned_docs/version-2.8.1/concepts-proxy-sni-routing.md
+++ b/site2/website-next/versioned_docs/version-2.8.1/concepts-proxy-sni-routing.md
@@ -52,7 +52,7 @@ CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/website/versioned_docs/version-2.8.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.8.1/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.8.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.8.1/getting-started-standalone.md
index 01889306c4..c9475dd1c9 100644
--- a/site2/website/versioned_docs/version-2.8.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.8.1/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.8.0-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,18 +18,23 @@ This tutorial guides you through every step of the installation process.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions, JRE/JDK 11 is recommended.
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
-> **Note**
->
-> Broker is only supported on 64-bit JVM.
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
+
+:::note
+
+Broker is only supported on 64-bit JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -38,14 +43,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -56,7 +65,7 @@ Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -65,23 +74,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -90,39 +100,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -131,55 +148,67 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -192,39 +221,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.8.2/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.8.2/concepts-architecture-overview.md
index 6a501d2127..0c7d44260d 100644
--- a/site2/website-next/versioned_docs/version-2.8.2/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.8.2/concepts-architecture-overview.md
@@ -46,7 +46,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
In a Pulsar instance:
diff --git a/site2/website-next/versioned_docs/version-2.8.2/concepts-proxy-sni-routing.md b/site2/website-next/versioned_docs/version-2.8.2/concepts-proxy-sni-routing.md
index 7a683b8395..7eee6df551 100644
--- a/site2/website-next/versioned_docs/version-2.8.2/concepts-proxy-sni-routing.md
+++ b/site2/website-next/versioned_docs/version-2.8.2/concepts-proxy-sni-routing.md
@@ -52,7 +52,7 @@ CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/website/versioned_docs/version-2.8.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.8.2/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.8.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.8.2/getting-started-standalone.md
index 01889306c4..c9475dd1c9 100644
--- a/site2/website/versioned_docs/version-2.8.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.8.2/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.8.0-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,18 +18,23 @@ This tutorial guides you through every step of the installation process.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions, JRE/JDK 11 is recommended.
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
-> **Note**
->
-> Broker is only supported on 64-bit JVM.
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
+
+:::note
+
+Broker is only supported on 64-bit JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -38,14 +43,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -56,7 +65,7 @@ Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -65,23 +74,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -90,39 +100,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -131,55 +148,67 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -192,39 +221,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.8.3/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.8.3/concepts-architecture-overview.md
index 6a501d2127..0c7d44260d 100644
--- a/site2/website-next/versioned_docs/version-2.8.3/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.8.3/concepts-architecture-overview.md
@@ -46,7 +46,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
In a Pulsar instance:
diff --git a/site2/website-next/versioned_docs/version-2.8.3/concepts-proxy-sni-routing.md b/site2/website-next/versioned_docs/version-2.8.3/concepts-proxy-sni-routing.md
index 7a683b8395..7eee6df551 100644
--- a/site2/website-next/versioned_docs/version-2.8.3/concepts-proxy-sni-routing.md
+++ b/site2/website-next/versioned_docs/version-2.8.3/concepts-proxy-sni-routing.md
@@ -52,7 +52,7 @@ CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/website/versioned_docs/version-2.8.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.8.3/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.8.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.8.3/getting-started-standalone.md
index 01889306c4..c9475dd1c9 100644
--- a/site2/website/versioned_docs/version-2.8.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.8.3/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.8.0-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> #### Pulsar in production?
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,18 +18,23 @@ This tutorial guides you through every step of the installation process.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions, JRE/JDK 11 is recommended.
-> #### Tip
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
-> **Note**
->
-> Broker is only supported on 64-bit JVM.
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
+
+:::note
+
+Broker is only supported on 64-bit JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -38,14 +43,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -56,7 +65,7 @@ Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -65,23 +74,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> #### Tip
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -90,39 +100,46 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
-> (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker
+(or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> #### Tip
->
-> Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
+
+Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+:::
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -131,55 +148,67 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> #### Note
->
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)),
-> you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)),
+you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@95] - Configuration Store cache started
2017-06-01 14:46:29,192 - INFO - [main:AuthenticationService@61] - Authentication is disabled
2017-06-01 14:46:29,192 - INFO - [main:WebSocketService@108] - Pulsar WebSocket Service started
+
```
-> #### Tip
->
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -192,39 +221,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
09:56:55.566 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.MultiTopicsConsumerImpl - [TopicsConsumerFakeTopicNamee2df9] [first-subscription] Success subscribe new topic my-topic in topics consumer, partitions: 4, allTopicPartitionsNumber: 4
+
```
-> #### Tip
->
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> #### Tip
->
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.9.0/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.9.0/concepts-architecture-overview.md
index ec34b93004..95cf02eac1 100644
--- a/site2/website-next/versioned_docs/version-2.9.0/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.9.0/concepts-architecture-overview.md
@@ -46,7 +46,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
In a Pulsar instance:
diff --git a/site2/website-next/versioned_docs/version-2.9.0/concepts-proxy-sni-routing.md b/site2/website-next/versioned_docs/version-2.9.0/concepts-proxy-sni-routing.md
index 7a683b8395..7eee6df551 100644
--- a/site2/website-next/versioned_docs/version-2.9.0/concepts-proxy-sni-routing.md
+++ b/site2/website-next/versioned_docs/version-2.9.0/concepts-proxy-sni-routing.md
@@ -52,7 +52,7 @@ CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/website/versioned_docs/version-2.9.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.9.0/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.9.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.9.0/getting-started-standalone.md
index 6209f307cc..712b2fd214 100644
--- a/site2/website/versioned_docs/version-2.9.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.9.0/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.9.0-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary ZooKeeper and BookKeeper components running inside of a single Java Virtual Machine (JVM) process.
> **Pulsar in production?**
-> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide.
+> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal) guide.
## Install Pulsar standalone
@@ -18,17 +18,23 @@ This tutorial guides you through every step of installing Pulsar locally.
Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK 8 or later versions, JRE/JDK 11 is recommended.
-> **Tip**
-> By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+:::tip
-> **Note**
-> Broker is only supported on 64-bit JVM.
+By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is extra options passed into JVM.
+
+:::
+
+:::note
+
+Broker is only supported on 64-bit JVM.
+
+:::
### Install Pulsar using binary release
To get started with Pulsar, download a binary tarball release in one of the following ways:
-* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar {{pulsar:version}} binary release</a>)
+* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>)
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -37,14 +43,18 @@ To get started with Pulsar, download a binary tarball release in one of the foll
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:binary_release_url
+
```
After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory:
```bash
-$ tar xvfz apache-pulsar-{{pulsar:version}}-bin.tar.gz
-$ cd apache-pulsar-{{pulsar:version}}
+
+$ tar xvfz apache-pulsar-@pulsar:version@-bin.tar.gz
+$ cd apache-pulsar-@pulsar:version@
+
```
#### What your package contains
@@ -55,7 +65,7 @@ Directory | Contains
:---------|:--------
`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/).
`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker), [ZooKeeper configuration](reference-configuration.md#zookeeper), and more.
-`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example.
+`examples` | A Java JAR file containing [Pulsar Functions](functions-overview) example.
`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar.
`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar).
@@ -64,23 +74,24 @@ These directories are created once you begin running Pulsar.
Directory | Contains
:---------|:--------
`data` | The data storage directory used by ZooKeeper and BookKeeper.
-`instances` | Artifacts created for [Pulsar Functions](functions-overview.md).
+`instances` | Artifacts created for [Pulsar Functions](functions-overview).
`logs` | Logs created by the installation.
-> **Tip**
-> If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
->
-> * [Install builtin connectors (optional)](#install-builtin-connectors-optional)
-> * [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
->
-> Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+:::tip
+
+If you want to use builtin connectors and tiered storage offloaders, you can install them according to the following instructions：
+* [Install builtin connectors (optional)](#install-builtin-connectors-optional)
+* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional)
+Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing bulitin connectors and tiered storage offloaders.
+
+:::
### Install builtin connectors (optional)
Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `builtin` connectors.
To enable those `builtin` connectors, you can download the connectors tarball release in one of the following ways:
-* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors {{pulsar:version}} release</a>
+* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -89,35 +100,44 @@ To enable those `builtin` connectors, you can download the connectors tarball re
* use [wget](https://www.gnu.org/software/wget):
```shell
- $ wget pulsar:connector_release_url/{connector}-{{pulsar:version}}.nar
+
+ $ wget pulsar:connector_release_url/{connector}-@pulsar:version@.nar
+
```
After you download the nar file, copy the file to the `connectors` directory in the pulsar directory.
-For example, if you download the `pulsar-io-aerospike-{{pulsar:version}}.nar` connector file, enter the following commands:
+For example, if you download the `pulsar-io-aerospike-@pulsar:version@.nar` connector file, enter the following commands:
```bash
+
$ mkdir connectors
-$ mv pulsar-io-aerospike-{{pulsar:version}}.nar connectors
+$ mv pulsar-io-aerospike-@pulsar:version@.nar connectors
$ ls connectors
-pulsar-io-aerospike-{{pulsar:version}}.nar
+pulsar-io-aerospike-@pulsar:version@.nar
...
+
```
-> **Note**
-> * If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)), you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure `connectors` tarball is unzipped in every pulsar directory of the broker (or in every pulsar directory of function-worker if you are running a separate worker cluster for Pulsar Functions).
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)), you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled [all builtin connectors](io-overview.md#working-with-connectors).
+
+:::
### Install tiered storage offloaders (optional)
-> **Tip**
-> - Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
-> - To enable tiered storage feature, follow the instructions below; otherwise skip this section.
+:::tip
-To get started with [tiered storage offloaders](concepts-tiered-storage.md), you need to download the offloaders tarball release on every broker node in one of the following ways:
+- Since `2.2.0` release, Pulsar releases a separate binary distribution, containing the tiered storage offloaders.
+- To enable tiered storage feature, follow the instructions below; otherwise skip this section.
-* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders {{pulsar:version}} release</a>
+:::
+
+To get started with [tiered storage offloaders](concepts-tiered-storage), you need to download the offloaders tarball release on every broker node in one of the following ways:
+
+* download from the Apache mirror <a href="pulsar:offloader_release_url" download>Pulsar Tiered Storage Offloaders @pulsar:version@ release</a>
* download from the Pulsar [downloads page](pulsar:download_page_url)
@@ -126,52 +146,66 @@ To get started with [tiered storage offloaders](concepts-tiered-storage.md), you
* use [wget](https://www.gnu.org/software/wget):
```shell
+
$ wget pulsar:offloader_release_url
+
```
After you download the tarball, untar the offloaders package and copy the offloaders as `offloaders`
in the pulsar directory:
```bash
-$ tar xvfz apache-pulsar-offloaders-{{pulsar:version}}-bin.tar.gz
-// you will find a directory named `apache-pulsar-offloaders-{{pulsar:version}}` in the pulsar directory
+$ tar xvfz apache-pulsar-offloaders-@pulsar:version@-bin.tar.gz
+
+// you will find a directory named `apache-pulsar-offloaders-@pulsar:version@` in the pulsar directory
// then copy the offloaders
-$ mv apache-pulsar-offloaders-{{pulsar:version}}/offloaders offloaders
+$ mv apache-pulsar-offloaders-@pulsar:version@/offloaders offloaders
$ ls offloaders
-tiered-storage-jcloud-{{pulsar:version}}.nar
+tiered-storage-jcloud-@pulsar:version@.nar
+
```
-For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage.md).
+For more information on how to configure tiered storage, see [Tiered storage cookbook](cookbooks-tiered-storage).
-> **Note**
-> * If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
->
-> * If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes.md) or [DC/OS](https://dcos.io/)), you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+:::note
+
+* If you are running Pulsar in a bare metal cluster, make sure that `offloaders` tarball is unzipped in every broker's pulsar directory.
+* If you are [running Pulsar in Docker](getting-started-docker.md) or deploying Pulsar using a docker image (e.g. [K8S](deploy-kubernetes) or [DC/OS](https://dcos.io/)), you can use the `apachepulsar/pulsar-all` image instead of the `apachepulsar/pulsar` image. `apachepulsar/pulsar-all` image has already bundled tiered storage offloaders.
+
+:::
## Start Pulsar standalone
Once you have an up-to-date local copy of the release, you can start a local cluster using the [`pulsar`](reference-cli-tools.md#pulsar) command, which is stored in the `bin` directory, and specifying that you want to start Pulsar in standalone mode.
```bash
+
$ bin/pulsar standalone
+
```
If you have started Pulsar successfully, you will see `INFO`-level log messages like this:
```bash
+
21:59:29.327 [DLM-/stream/storage-OrderedScheduler-3-0] INFO org.apache.bookkeeper.stream.storage.impl.sc.StorageContainerImpl - Successfully started storage container (0).
21:59:34.576 [main] INFO org.apache.pulsar.broker.authentication.AuthenticationService - Authentication is disabled
21:59:34.576 [main] INFO org.apache.pulsar.websocket.WebSocketService - Pulsar WebSocket Service started
+
```
-> **Tip**
-> * The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+:::tip
+
+* The service is running on your terminal, which is under your direct control. If you need to run other commands, open a new terminal window.
+
+:::
+
You can also run the service as a background process using the `pulsar-daemon start standalone` command. For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
>
-> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview.md) document to secure your deployment.
+> * By default, there is no encryption, authentication, or authorization configured. Apache Pulsar can be accessed from remote server without any authorization. Please do check [Security Overview](security-overview) document to secure your deployment.
>
> * When you start a local standalone cluster, a `public/default` [namespace](concepts-messaging.md#namespaces) is created automatically. The namespace is used for development purposes. All Pulsar topics are managed within namespaces. For more information, see [Topics](concepts-messaging.md#topics).
@@ -184,37 +218,51 @@ Pulsar provides a CLI tool called [`pulsar-client`](reference-cli-tools.md#pulsa
The following command consumes a message with the subscription name `first-subscription` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client consume my-topic -s "first-subscription"
+
```
If the message has been successfully consumed, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
22:17:16.781 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully consumed
+
```
-> **Tip**
-> As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+:::tip
+
+As you have noticed that we do not explicitly create the `my-topic` topic, to which we consume the message. When you consume a message to a topic that does not yet exist, Pulsar creates that topic for you automatically. Producing a message to a topic that does not exist will automatically create that topic for you as well.
+
+:::
### Produce a message
The following command produces a message saying `hello-pulsar` to the `my-topic` topic:
```bash
+
$ bin/pulsar-client produce my-topic --messages "hello-pulsar"
+
```
If the message has been successfully published to the topic, you will see a confirmation like the following in the `pulsar-client` logs:
```
+
22:21:08.693 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
+
```
## Stop Pulsar standalone
Press `Ctrl+C` to stop a local standalone Pulsar.
-> **Tip**
-> If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
->
-> For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+:::tip
+
+If the service runs as a background process using the `pulsar-daemon start standalone` command, then use the `pulsar-daemon stop standalone` command to stop the service.
+For more information, see [pulsar-daemon](https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-daemon).
+
+:::
+
diff --git a/site2/website-next/versioned_docs/version-2.9.1/concepts-architecture-overview.md b/site2/website-next/versioned_docs/version-2.9.1/concepts-architecture-overview.md
index ec34b93004..95cf02eac1 100644
--- a/site2/website-next/versioned_docs/version-2.9.1/concepts-architecture-overview.md
+++ b/site2/website-next/versioned_docs/version-2.9.1/concepts-architecture-overview.md
@@ -46,7 +46,7 @@ Clusters can replicate amongst themselves using [geo-replication](concepts-repli
## Metadata store
-The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and [BookKeeper metadata store](https://bookkee [...]
+The Pulsar metadata store maintains all the metadata of a Pulsar cluster, such as topic metadata, schema, broker load data, and so on. Pulsar uses [Apache ZooKeeper](https://zookeeper.apache.org/) for metadata storage, cluster configuration, and coordination. The Pulsar metadata store can be deployed on a separate ZooKeeper cluster or deployed on an existing ZooKeeper cluster. You can use one ZooKeeper cluster for both Pulsar metadata store and BookKeeper metadata store. If you want to d [...]
In a Pulsar instance:
diff --git a/site2/website-next/versioned_docs/version-2.9.1/concepts-proxy-sni-routing.md b/site2/website-next/versioned_docs/version-2.9.1/concepts-proxy-sni-routing.md
index 7a683b8395..7eee6df551 100644
--- a/site2/website-next/versioned_docs/version-2.9.1/concepts-proxy-sni-routing.md
+++ b/site2/website-next/versioned_docs/version-2.9.1/concepts-proxy-sni-routing.md
@@ -52,7 +52,7 @@ CONFIG proxy.config.http.connect_ports STRING 4443 6651
```
-The [ssl_server_name](https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/ssl_server_name.yaml.en.html) file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the it [...]
+The `ssl_server_name` file is used to configure TLS connection handling for inbound and outbound connections. The configuration is determined by the SNI values provided by the inbound connection. The file consists of a set of configuration items, and each is identified by an SNI value (`fqdn`). When an inbound TLS connection is made, the SNI value from the TLS negotiation is matched with the items specified in this file. If the values match, the values specified in that item override the [...]
The following example shows mapping of the inbound SNI hostname coming from the client, and the actual broker service URL where request should be redirected. For example, if the client sends the SNI header `pulsar-broker1`, the proxy creates a TLS tunnel by redirecting request to the `pulsar-broker1:6651` service URL.
diff --git a/site2/website/versioned_docs/version-2.9.0/getting-started-standalone.md b/site2/website-next/versioned_docs/version-2.9.1/getting-started-standalone.md
similarity index 60%
copy from site2/website/versioned_docs/version-2.9.0/getting-started-standalone.md
copy to site2/website-next/versioned_docs/version-2.9.1/getting-started-standalone.md
index 6209f307cc..712b2fd214 100644
--- a/site2/website/versioned_docs/version-2.9.0/getting-started-standalone.md
+++ b/site2/website-next/versioned_docs/version-2.9.1/getting-started-standalone.md
@@ -1,14 +1,14 @@
---
-id: version-2.9.0-standalone
+id: getting-started-standalone
title: Set up a standalone Pulsar locally
-sidebar_label: Run Pulsar locally
-original_id: standalone
+sidebar_label: "Run Pulsar locally"
+original_id: getting-started-standalone
---
... 2309 lines suppressed ...