From 9e3f390c8637c9804c234b01b8b396945a363af1 Mon Sep 17 00:00:00 2001 From: massakam Date: Wed, 18 Oct 2017 07:20:49 +0900 Subject: [PATCH] Add ASF headers to Markdown documentation files (#823) --- .gitignore.swp | Bin 0 -> 12288 bytes CONTRIBUTORS.md | 20 +++++++++++ README.md | 21 ++++++++++++ build/docker/README.md | 19 +++++++++++ dashboard/README.md | 20 +++++++++++ kubernetes/README.md | 20 +++++++++++ pom.xml | 31 +++++++++++++++--- protobuf/README.md | 20 +++++++++++ pulsar-client-cpp/README.md | 20 +++++++++++ pulsar-client-cpp/docs/MainPage.md | 21 ++++++++++++ pulsar-discovery-service/readme.md | 21 ++++++++++++ site/Gemfile | 19 +++++++++++ site/README.md | 21 ++++++++++++ site/_includes/explanations/admin-setup.md | 21 ++++++++++++ site/_includes/explanations/client-url.md | 23 ++++++++++++- site/_includes/explanations/deploying-bk.md | 21 ++++++++++++ site/_includes/explanations/deploying-zk.md | 21 ++++++++++++ .../_includes/explanations/install-package.md | 20 +++++++++++ site/_includes/explanations/ja/admin-setup.md | 21 ++++++++++++ .../_includes/explanations/ja/broker-admin.md | 21 ++++++++++++ site/_includes/explanations/ja/client-url.md | 21 ++++++++++++ .../explanations/ja/cluster-admin.md | 21 ++++++++++++ .../_includes/explanations/ja/deploying-bk.md | 21 ++++++++++++ .../_includes/explanations/ja/deploying-zk.md | 21 ++++++++++++ .../explanations/ja/install-package.md | 21 ++++++++++++ .../explanations/ja/instance-admin.md | 21 ++++++++++++ .../explanations/ja/namespace-admin.md | 21 ++++++++++++ .../ja/non-persistent-topic-admin.md | 21 ++++++++++++ .../explanations/ja/non-persistent-topics.md | 21 ++++++++++++ .../ja/partitioned-topic-admin.md | 21 ++++++++++++ .../explanations/ja/partitioned-topics.md | 21 ++++++++++++ site/_includes/explanations/ja/permissions.md | 21 ++++++++++++ .../explanations/ja/persistent-topic-admin.md | 21 ++++++++++++ .../explanations/ja/properties-namespaces.md | 21 ++++++++++++ .../explanations/ja/property-admin.md | 21 ++++++++++++ .../ja/service-discovery-setup.md | 21 ++++++++++++ .../explanations/non-persistent-topics.md | 21 ++++++++++++ .../explanations/partitioned-topic-admin.md | 21 ++++++++++++ .../explanations/partitioned-topics.md | 21 ++++++++++++ site/_includes/explanations/permissions.md | 21 ++++++++++++ .../explanations/properties-namespaces.md | 21 ++++++++++++ .../explanations/service-discovery-setup.md | 21 ++++++++++++ site/_sass/_admonition.scss | 18 ++++++++++ site/_sass/_cli.scss | 18 ++++++++++ site/_sass/_docs.scss | 18 ++++++++++ site/_sass/_mixins.scss | 18 ++++++++++ site/_sass/_navbar.scss | 20 ++++++++++- site/_sass/_popover.scss | 18 ++++++++++ site/_sass/_protobuf.scss | 18 ++++++++++ site/_sass/_sidebar.scss | 20 ++++++++++- site/_sass/_swagger.scss | 18 ++++++++++ site/_sass/_syntax.scss | 18 ++++++++++ site/_sass/_toc.scss | 18 ++++++++++ site/_sass/_variables.scss | 18 ++++++++++ site/contact.md | 20 +++++++++++ site/css/style.scss | 19 +++++++++++ site/docs/latest/adaptors/KafkaWrapper.md | 21 ++++++++++++ site/docs/latest/adaptors/PulsarSpark.md | 21 ++++++++++++ site/docs/latest/adaptors/PulsarStorm.md | 21 ++++++++++++ site/docs/latest/admin-api/brokers.md | 21 ++++++++++++ site/docs/latest/admin-api/clusters.md | 21 ++++++++++++ site/docs/latest/admin-api/namespaces.md | 21 ++++++++++++ .../latest/admin-api/non-persistent-topics.md | 21 ++++++++++++ site/docs/latest/admin-api/overview.md | 21 ++++++++++++ .../latest/admin-api/partitioned-topics.md | 21 ++++++++++++ site/docs/latest/admin-api/permissions.md | 21 ++++++++++++ .../latest/admin-api/persistent-topics.md | 21 ++++++++++++ site/docs/latest/admin-api/properties.md | 21 ++++++++++++ site/docs/latest/admin/Authz.md | 21 ++++++++++++ site/docs/latest/admin/Dashboard.md | 21 ++++++++++++ site/docs/latest/admin/GeoReplication.md | 21 ++++++++++++ site/docs/latest/admin/ModularLoadManager.md | 21 ++++++++++++ site/docs/latest/admin/Stats.md | 21 ++++++++++++ site/docs/latest/admin/ZooKeeperBookKeeper.md | 23 ++++++++++++- site/docs/latest/advanced/Encryption.md | 21 ++++++++++++ .../docs/latest/advanced/PartitionedTopics.md | 21 ++++++++++++ site/docs/latest/advanced/RetentionExpiry.md | 21 ++++++++++++ site/docs/latest/clients/Cpp.md | 21 ++++++++++++ site/docs/latest/clients/Java.md | 21 ++++++++++++ site/docs/latest/clients/Python.md | 21 ++++++++++++ site/docs/latest/clients/WebSocket.md | 21 ++++++++++++ site/docs/latest/deployment/InstanceSetup.md | 21 ++++++++++++ site/docs/latest/deployment/Kubernetes.md | 21 ++++++++++++ site/docs/latest/deployment/Monitoring.md | 21 ++++++++++++ site/docs/latest/getting-started/Clients.md | 21 ++++++++++++ .../ConceptsAndArchitecture.md | 21 ++++++++++++ .../latest/getting-started/LocalCluster.md | 23 ++++++++++++- site/docs/latest/getting-started/docker.md | 20 +++++++++++ site/docs/latest/project/BinaryProtocol.md | 21 ++++++++++++ site/docs/latest/project/Codebase.md | 23 ++++++++++++- site/docs/latest/project/SimulationTools.md | 21 ++++++++++++ site/docs/latest/reference/CliTools.md | 21 ++++++++++++ site/docs/latest/reference/Configuration.md | 21 ++++++++++++ site/docs/latest/reference/RestApi.md | 21 ++++++++++++ site/download.md | 21 ++++++++++++ site/ja/adaptors/PulsarSpark.md | 21 ++++++++++++ site/ja/adaptors/PulsarStorm.md | 21 ++++++++++++ site/ja/admin/AdminInterface.md | 21 ++++++++++++ site/ja/admin/Authz.md | 21 ++++++++++++ site/ja/admin/ClustersBrokers.md | 21 ++++++++++++ site/ja/admin/Dashboard.md | 21 ++++++++++++ site/ja/admin/GeoReplication.md | 21 ++++++++++++ site/ja/admin/ModularLoadManager.md | 21 ++++++++++++ site/ja/admin/PropertiesNamespaces.md | 21 ++++++++++++ site/ja/admin/Stats.md | 21 ++++++++++++ site/ja/admin/ZooKeeperBookKeeper.md | 21 ++++++++++++ site/ja/advanced/PartitionedTopics.md | 21 ++++++++++++ site/ja/advanced/RetentionExpiry.md | 21 ++++++++++++ site/ja/clients/Cpp.md | 21 ++++++++++++ site/ja/clients/Java.md | 21 ++++++++++++ site/ja/clients/Python.md | 21 ++++++++++++ site/ja/clients/WebSocket.md | 21 ++++++++++++ site/ja/deployment/InstanceSetup.md | 21 ++++++++++++ site/ja/deployment/Kubernetes.md | 21 ++++++++++++ site/ja/deployment/Monitoring.md | 21 ++++++++++++ site/ja/getting-started/Clients.md | 21 ++++++++++++ .../ConceptsAndArchitecture.md | 21 ++++++++++++ site/ja/getting-started/LocalCluster.md | 21 ++++++++++++ site/ja/project/BinaryProtocol.md | 21 ++++++++++++ site/ja/project/Codebase.md | 21 ++++++++++++ site/ja/project/SimulationTools.md | 21 ++++++++++++ site/ja/reference/CliTools.md | 21 ++++++++++++ site/ja/reference/Configuration.md | 21 ++++++++++++ site/ja/reference/RestApi.md | 21 ++++++++++++ site/presentations.md | 21 ++++++++++++ site/team.md | 21 ++++++++++++ 126 files changed, 2586 insertions(+), 11 deletions(-) create mode 100644 .gitignore.swp diff --git a/.gitignore.swp b/.gitignore.swp new file mode 100644 index 0000000000000000000000000000000000000000..692019ee73fc8b10821d12118be7ce461c6b7c66 GIT binary patch literal 12288 zcmeI2v2PPG6o+3s(}G|I1-hW3_*$sM!h|SQhe}8lNGw#&-Rs54-Py8z4G|Lj2{6G< zH<(y}i4{f|7^xT$16^QZ;pes)VCd3?O7EmEj-Q{O-+fyY_ZIG~u63@eCBk!x=v?>f z-Q5$jw6aB1>k#x%*Jc>y*6OM6N0`K)&bP z)-^W;`;d_e9HVK<^woJg;5?GbD_o0rI`*-1Ij@WhsqL(18r0pwK4Y73UFX9Vm)_?U z8lwGs?%kfZL-twlc@{au%yY1<&pBjBS{kGy9Q$bS(tq!O3^h+#p`%VO7^q;EdTjD> p*K^V4aO!NW?&GaeWduW8#jroIZFDUfuQ}?y5+Ul?2Gx&9{{xuR%v%5e literal 0 HcmV?d00001 diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index a4b9d060721dc..6b0264a059d34 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -1,3 +1,23 @@ + #### Initial contributors diff --git a/README.md b/README.md index 379f86c771031..a7d76b3e532f4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,24 @@ + + ![logo](site/img/pulsar.png) Pulsar is a distributed pub-sub messaging platform with a very diff --git a/build/docker/README.md b/build/docker/README.md index d7b180cca76c7..7a01d2ccebb7d 100644 --- a/build/docker/README.md +++ b/build/docker/README.md @@ -1,4 +1,23 @@ + This folder contains a Docker image that can used to compile the Pulsar C++ client library and website in a reproducible environment. diff --git a/dashboard/README.md b/dashboard/README.md index 09fb52d58237f..679044f12e81c 100644 --- a/dashboard/README.md +++ b/dashboard/README.md @@ -1,3 +1,23 @@ + # Pulsar Dashboard diff --git a/kubernetes/README.md b/kubernetes/README.md index 10aa4701ca758..d190c90262e98 100644 --- a/kubernetes/README.md +++ b/kubernetes/README.md @@ -1,3 +1,23 @@ + This directory contains the Kubernetes services definitions for all the components required to do a complete Pulsar deployment. diff --git a/pom.xml b/pom.xml index c7f3c6b014555..89739acf31b24 100644 --- a/pom.xml +++ b/pom.xml @@ -608,7 +608,10 @@ flexible messaging model and an intuitive client API. LICENSE NOTICE **/*.txt - **/*.md + **/*.pem + **/*.crt + **/*.key + **/*.csr **/proto/*.java bin/proto/* **/*.patch @@ -635,11 +638,18 @@ flexible messaging model and an intuitive client API. site/vendor/** site/scripts/doxygen/** site/api/** - site/api/** site/.sass-cache/** site/generated/** site/js/jquery.tocify.min.js site/js/jquery.scrollTo.min.js + site/Gemfile.lock + site/VERSIONS + site/_sass/bootstrap-sass/** + site/_sass/font-awesome/** + site/fonts/** + site/img/** + generated-site/** + .github/*.md JAVADOC_STYLE @@ -647,6 +657,8 @@ flexible messaging model and an intuitive client API. SCRIPT_STYLE SCRIPT_STYLE JAVADOC_STYLE + XML_STYLE + JAVADOC_STYLE @@ -682,11 +694,20 @@ flexible messaging model and an intuitive client API. licenses/LICENSE-*.txt src/assemble/README.bin.txt - - **/site/** + + site/Gemfile.lock + site/VERSIONS + site/_sass/bootstrap-sass/** + site/_sass/font-awesome/** + site/.sass-cache/** + site/fonts/** + site/img/** + site/js/jquery.scrollTo.min.js + site/js/jquery.tocify.min.js + generated-site/** **/*.patch - **/*.md + .github/*.md src/assemble/LICENSE.bin.txt src/assemble/NOTICE.bin.txt diff --git a/protobuf/README.md b/protobuf/README.md index dd698ef6d604f..b96bf9470d77c 100644 --- a/protobuf/README.md +++ b/protobuf/README.md @@ -1,3 +1,23 @@ + ## Protocol Buffer code generation diff --git a/pulsar-client-cpp/README.md b/pulsar-client-cpp/README.md index 83a3fdaf32aab..5b4ee5bd6c45f 100644 --- a/pulsar-client-cpp/README.md +++ b/pulsar-client-cpp/README.md @@ -1,3 +1,23 @@ + # Pulsar C++ client library diff --git a/pulsar-client-cpp/docs/MainPage.md b/pulsar-client-cpp/docs/MainPage.md index 2087cffeccd57..fa2720b1eb331 100644 --- a/pulsar-client-cpp/docs/MainPage.md +++ b/pulsar-client-cpp/docs/MainPage.md @@ -1,3 +1,24 @@ + + # The Pulsar C++ client Welcome to the Doxygen documentation for [Pulsar](https://pulsar.incubator.apache.org/). diff --git a/pulsar-discovery-service/readme.md b/pulsar-discovery-service/readme.md index 3d2f52869e6e2..67297a2bdb301 100644 --- a/pulsar-discovery-service/readme.md +++ b/pulsar-discovery-service/readme.md @@ -1,3 +1,24 @@ + + # Discovery service It keeps list of active available brokers and redirects all incoming requests to one of the broker in round-robin manner. diff --git a/site/Gemfile b/site/Gemfile index 1d5646585761f..145b078b369d2 100644 --- a/site/Gemfile +++ b/site/Gemfile @@ -1,3 +1,22 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# + source 'https://rubygems.org' ruby '2.4.1' diff --git a/site/README.md b/site/README.md index 70497542789fe..d7fcfe976ce83 100644 --- a/site/README.md +++ b/site/README.md @@ -1,3 +1,24 @@ + + # The Pulsar website and documentation This `README` is basically the meta-documentation for the Pulsar website and documentation. Here you'll find instructions on running the site locally diff --git a/site/_includes/explanations/admin-setup.md b/site/_includes/explanations/admin-setup.md index 6710782d31f96..44f6117ab2579 100644 --- a/site/_includes/explanations/admin-setup.md +++ b/site/_includes/explanations/admin-setup.md @@ -1,3 +1,24 @@ + + Each of Pulsar's three admin interfaces---the [`pulsar-admin`](../../reference/CliTools#pulsar-admin) CLI tool, the [Java admin API](/api/admin), and the [REST API](../../reference/RestApi)---requires some special setup if you have [authentication](../../admin/Authz#authentication-providers) enabled in your Pulsar {% popover instance %}. ### pulsar-admin diff --git a/site/_includes/explanations/client-url.md b/site/_includes/explanations/client-url.md index 54956f4f2d7ed..3f7641994421a 100644 --- a/site/_includes/explanations/client-url.md +++ b/site/_includes/explanations/client-url.md @@ -1,3 +1,24 @@ + + To connect to Pulsar using client libraries, you need to specify a [Pulsar protocol](../../project/BinaryProtocol) URL. Pulsar protocol URLs are assigned to specific {% popover clusters %}, use the `pulsar` scheme and have a default port of 6650. Here's an example for `localhost`: @@ -30,4 +51,4 @@ If the topic is global, however, the URL for the topic will look like this: {% include topic.html p="property" c="global" n="namespace" t="topic" %} -In that case, your client can use the broker service URL for *any* cluster in the {% popover instance %} and Pulsar's internal service discovery system will handle the rest. \ No newline at end of file +In that case, your client can use the broker service URL for *any* cluster in the {% popover instance %} and Pulsar's internal service discovery system will handle the rest. diff --git a/site/_includes/explanations/deploying-bk.md b/site/_includes/explanations/deploying-bk.md index c5ecae24ff851..49b3a77d6c0a0 100644 --- a/site/_includes/explanations/deploying-bk.md +++ b/site/_includes/explanations/deploying-bk.md @@ -1,3 +1,24 @@ + + {% popover BookKeeper %} provides [persistent message storage](../../getting-started/ConceptsAndArchitecture#persistent-storage) for Pulsar. Each Pulsar {% popover broker %} needs to have its own cluster of {% popover bookies %}. The BookKeeper cluster shares a local ZooKeeper quorum with the Pulsar cluster. diff --git a/site/_includes/explanations/deploying-zk.md b/site/_includes/explanations/deploying-zk.md index 57c7f2d320aac..917f45efeeca1 100644 --- a/site/_includes/explanations/deploying-zk.md +++ b/site/_includes/explanations/deploying-zk.md @@ -1,3 +1,24 @@ + + Each Pulsar {% popover instance %} relies on two separate ZooKeeper quorums. * [Local ZooKeeper](#deploying-local-zookeeper) operates at the {% popover cluster %} level and provides cluster-specific configuration management and coordination. Each Pulsar cluster needs to have a dedicated ZooKeeper cluster. diff --git a/site/_includes/explanations/install-package.md b/site/_includes/explanations/install-package.md index 6af20a4f099f1..ada8f2fdc1f65 100644 --- a/site/_includes/explanations/install-package.md +++ b/site/_includes/explanations/install-package.md @@ -1,3 +1,23 @@ + {% capture binary_release_url %}http://www.apache.org/dyn/closer.cgi/incubator/pulsar/pulsar-{{ site.current_version }}/apache-pulsar-{{ site.current_version }}-bin.tar.gz{% endcapture %} {% capture source_release_url %}http://www.apache.org/dyn/closer.cgi/incubator/pulsar/pulsar-{{ site.current_version }}/apache-pulsar-{{ site.current_version }}-src.tar.gz{% endcapture %} diff --git a/site/_includes/explanations/ja/admin-setup.md b/site/_includes/explanations/ja/admin-setup.md index e10d8e880f1b9..9e254d16d0673 100644 --- a/site/_includes/explanations/ja/admin-setup.md +++ b/site/_includes/explanations/ja/admin-setup.md @@ -1,3 +1,24 @@ + + Pulsarの3つのadminインターフェース---[`pulsar-admin`](../../reference/CliTools#pulsar-admin)CLIツール, [Java admin API](/api/admin), [REST API](../../reference/RestApi)---は、Pulsar{% popover_ja インスタンス %}で[認証](../../admin/Authz#認証プロバイダ)を有効にしている場合にいくつかの特別なセットアップを必要とします。 ### pulsar-admin diff --git a/site/_includes/explanations/ja/broker-admin.md b/site/_includes/explanations/ja/broker-admin.md index 0a2a701d504ba..2bda039547dff 100644 --- a/site/_includes/explanations/ja/broker-admin.md +++ b/site/_includes/explanations/ja/broker-admin.md @@ -1,3 +1,24 @@ + + Pulsar Brokerは2つのコンポーネントから構成されます: 1. 管理操作と{% popover_ja トピック %}ルックアップのための[RESTインターフェース](../../reference/RestApi)を提供するHTTPサーバ diff --git a/site/_includes/explanations/ja/client-url.md b/site/_includes/explanations/ja/client-url.md index c496c9af63db1..5d9fca6cc184f 100644 --- a/site/_includes/explanations/ja/client-url.md +++ b/site/_includes/explanations/ja/client-url.md @@ -1,3 +1,24 @@ + + クライアントライブラリを使ってPulsarに接続するには、[Pulsarプロトコル](../../project/BinaryProtocol)URLを指定する必要があります。 PulsarプロトコルURLは特定の{% popover_ja クラスタ %}に割り当てられており、`pulsar`スキームを使ってアクセスされます。ここでデフォルトのポート番号は6650になっています。以下は`localhost`の例です： diff --git a/site/_includes/explanations/ja/cluster-admin.md b/site/_includes/explanations/ja/cluster-admin.md index 935beec008fe7..448d8812ec4b4 100644 --- a/site/_includes/explanations/ja/cluster-admin.md +++ b/site/_includes/explanations/ja/cluster-admin.md @@ -1,3 +1,24 @@ + + Pulsarのクラスタは1つ以上のPulsar {% popover_ja Broker %}、1つ以上の{% popover_ja BookKeeper %}サーバ ({% popover_ja Bookie %}) 、設定と調整管理の機能を提供する{% popover_ja ZooKeeper %}クラスタから構成されます。 クラスタは次の方法で管理できます: diff --git a/site/_includes/explanations/ja/deploying-bk.md b/site/_includes/explanations/ja/deploying-bk.md index 1ea1ab6efa6e0..9597b7988783b 100644 --- a/site/_includes/explanations/ja/deploying-bk.md +++ b/site/_includes/explanations/ja/deploying-bk.md @@ -1,3 +1,24 @@ + + {% popover_ja BookKeeper %}はPulsarの[永続メッセージストレージ](../../getting-started/ConceptsAndArchitecture#永続ストレージ)です。 Pulsarの各{% popover_ja Broker %}は専用の{% popover_ja Bookie %}クラスタが必要です。BookKeeperのクラスタはPulsarクラスタとLocal ZooKeeperのクォーラムを共有します。 diff --git a/site/_includes/explanations/ja/deploying-zk.md b/site/_includes/explanations/ja/deploying-zk.md index 0022a6c50e505..2c07a2b79d9c4 100644 --- a/site/_includes/explanations/ja/deploying-zk.md +++ b/site/_includes/explanations/ja/deploying-zk.md @@ -1,3 +1,24 @@ + + 各Pulsar{% popover_ja インスタンス %}は2つの別々のZooKeeperクォーラムに依存します。 * [Local ZooKeeper](#local-zookeeperのデプロイ)は{% popover_ja クラスタ %}レベルで動作し、クラスタ固有の設定管理や協調のための機能を提供します。各Pulsarクラスタには専用のZooKeeperクラスタが必要となります。 diff --git a/site/_includes/explanations/ja/install-package.md b/site/_includes/explanations/ja/install-package.md index 5db47021df74e..67107ef2cf5dc 100644 --- a/site/_includes/explanations/ja/install-package.md +++ b/site/_includes/explanations/ja/install-package.md @@ -1,3 +1,24 @@ + + {% capture binary_release_url %}http://www.apache.org/dyn/closer.cgi/incubator/pulsar/pulsar-{{ site.current_version }}/apache-pulsar-{{ site.current_version }}-bin.tar.gz{% endcapture %} {% capture source_release_url %}http://www.apache.org/dyn/closer.cgi/incubator/pulsar/pulsar-{{ site.current_version }}/apache-pulsar-{{ site.current_version }}-src.tar.gz{% endcapture %} diff --git a/site/_includes/explanations/ja/instance-admin.md b/site/_includes/explanations/ja/instance-admin.md index 6256d8b4fe1e8..559c81d8eef57 100644 --- a/site/_includes/explanations/ja/instance-admin.md +++ b/site/_includes/explanations/ja/instance-admin.md @@ -1 +1,22 @@ + + ## インスタンスの管理 diff --git a/site/_includes/explanations/ja/namespace-admin.md b/site/_includes/explanations/ja/namespace-admin.md index 6fcaf23bb190f..089785353bc65 100644 --- a/site/_includes/explanations/ja/namespace-admin.md +++ b/site/_includes/explanations/ja/namespace-admin.md @@ -1,3 +1,24 @@ + + Pulsarの{% popover_ja ネームスペース %}は{% popover_ja トピック %}の論理的なグループです。 ネームスペースは以下のように管理されます: diff --git a/site/_includes/explanations/ja/non-persistent-topic-admin.md b/site/_includes/explanations/ja/non-persistent-topic-admin.md index 679f5ceca9ba6..74db8a46e1550 100644 --- a/site/_includes/explanations/ja/non-persistent-topic-admin.md +++ b/site/_includes/explanations/ja/non-persistent-topic-admin.md @@ -1,3 +1,24 @@ + + `non-persistent`は発行されたメッセージをリアルタイムでのみconsumeを行いたく、永続的な保証が不要なアプリケーションで利用することができます。`non-persistent`はメッセージを永続化するオーバーヘッドをなくすことでメッセージの発行レイテンシを抑えることができます。 以下の全ての例において、トピック名の構造は次の通りです: diff --git a/site/_includes/explanations/ja/non-persistent-topics.md b/site/_includes/explanations/ja/non-persistent-topics.md index 18f996160daee..768413f4d249f 100644 --- a/site/_includes/explanations/ja/non-persistent-topics.md +++ b/site/_includes/explanations/ja/non-persistent-topics.md @@ -1,3 +1,24 @@ + + {% include admonition.html type="success" title='注意' content=" この機能はまだ実験モードであり、実装の詳細は将来のリリースで変更される可能性があります。 " %} diff --git a/site/_includes/explanations/ja/partitioned-topic-admin.md b/site/_includes/explanations/ja/partitioned-topic-admin.md index 1d11452c88021..7a9efe5840a06 100644 --- a/site/_includes/explanations/ja/partitioned-topic-admin.md +++ b/site/_includes/explanations/ja/partitioned-topic-admin.md @@ -1,3 +1,24 @@ + + Pulsarの[admin API](../../admin/AdminInterface)を使用する事で、パーティションドトピックの作成と管理が可能です。 以下の全ての例において、トピック名の構造は次の通りです: diff --git a/site/_includes/explanations/ja/partitioned-topics.md b/site/_includes/explanations/ja/partitioned-topics.md index 887a33f1f4659..8f98396faccab 100644 --- a/site/_includes/explanations/ja/partitioned-topics.md +++ b/site/_includes/explanations/ja/partitioned-topics.md @@ -1,3 +1,24 @@ + + 通常のトピックは単一の{% popover_ja Broker %}によってのみ提供されるため、トピックの最大スループットが制限されます。*パーティションドトピック*は複数のBrokerによって処理される特殊なトピックであり、より高いスループットの実現を可能にします。 裏側では、パーティションドトピックはN個の内部トピックとして実装されます。ここでのNはパーティションの数です。パーティションドトピックにメッセージを発行すると、それぞれのメッセージは複数のBrokerの内のいずれかにルーティングされます。Broker間のパーティションの分散はPulsarによって自動的に処理されます。 diff --git a/site/_includes/explanations/ja/permissions.md b/site/_includes/explanations/ja/permissions.md index 7c7adeabe85b5..17d76bd8f7538 100644 --- a/site/_includes/explanations/ja/permissions.md +++ b/site/_includes/explanations/ja/permissions.md @@ -1,3 +1,24 @@ + + Pulsarにおけるパーミッションは{% popover_ja ネームスペース %}レベル (つまり{% popover_ja プロパティ %}および{% popover_ja クラスタ %}内) で管理されます。 ### パーミッションの付与 diff --git a/site/_includes/explanations/ja/persistent-topic-admin.md b/site/_includes/explanations/ja/persistent-topic-admin.md index 139d7dd49a508..d8635a61dcfbb 100644 --- a/site/_includes/explanations/ja/persistent-topic-admin.md +++ b/site/_includes/explanations/ja/persistent-topic-admin.md @@ -1,3 +1,24 @@ + + `persistent`は、メッセージを発行してconsumeするための論理的なエンドポイントであるトピックにアクセスするのに役立ちます。Producerはトピックにメッセージを発行し、Consumerはトピックを購読してトピックに発行されたメッセージをconsumeします。 以下のすべての手順とコマンドで、トピック名の構造は次のとおりです diff --git a/site/_includes/explanations/ja/properties-namespaces.md b/site/_includes/explanations/ja/properties-namespaces.md index ae4352535ce92..6ad2adcfd81bc 100644 --- a/site/_includes/explanations/ja/properties-namespaces.md +++ b/site/_includes/explanations/ja/properties-namespaces.md @@ -1,3 +1,24 @@ + + Pulsarは{% popover_ja マルチテナント %}のシステムとして新規にデザインされました。Pulsarでは{% popover_ja テナント %}は[プロパティ](#プロパティ)によって識別されます。プロパティはPulsar{% popover_ja インスタンス %}内の最も上位の管理単位です。 ### プロパティ diff --git a/site/_includes/explanations/ja/property-admin.md b/site/_includes/explanations/ja/property-admin.md index ab977e85d21f8..c43bfb00f76bb 100644 --- a/site/_includes/explanations/ja/property-admin.md +++ b/site/_includes/explanations/ja/property-admin.md @@ -1,3 +1,24 @@ + + プロパティはネームスペースと同様に[admin API](../../admin/AdminInterface)を使用して管理できます。現在、プロパティの設定可能な要素は次の2つです: * adminロール diff --git a/site/_includes/explanations/ja/service-discovery-setup.md b/site/_includes/explanations/ja/service-discovery-setup.md index a2f622d8778fc..cd036c713f0dc 100644 --- a/site/_includes/explanations/ja/service-discovery-setup.md +++ b/site/_includes/explanations/ja/service-discovery-setup.md @@ -1,3 +1,24 @@ + + Pulsar {% popover_ja Broker %}と接続する[クライアント](../../getting-started/Clients)は単一のURLを使用してPulsar{% popover_ja インスタンス %}全体と通信できる必要があります。Pulsarには[すぐ下にある](#サービスディスカバリのセットアップ)手順に従って設定できる組み込みのサービスディスカバリ機構が用意されています。 必要に応じて、独自のサービスディスカバリシステムを使用することもできます。独自のシステムを使用する場合、クライアントが`http://pulsar.us-west.example.com:8080`のようなPulsar{% popover_ja クラスタ %}の[エンドポイント](../../reference/Configuration)にHTTPリクエストを送る際に、DNS, HTTP, IPリダイレクト、その他の手段を介して目的のクラスタ内のアクティブなBrokerの*どれか1つ*にリダイレクトされる必要があります。 diff --git a/site/_includes/explanations/non-persistent-topics.md b/site/_includes/explanations/non-persistent-topics.md index a2cc5ae659ec5..74ff6631cf6d1 100644 --- a/site/_includes/explanations/non-persistent-topics.md +++ b/site/_includes/explanations/non-persistent-topics.md @@ -1,3 +1,24 @@ + + {% include admonition.html type="success" title='Notice' content=" This feature is still in experimental mode and implementation details may change in future release. " %} diff --git a/site/_includes/explanations/partitioned-topic-admin.md b/site/_includes/explanations/partitioned-topic-admin.md index 348c13eea8bad..5575e57b559e5 100644 --- a/site/_includes/explanations/partitioned-topic-admin.md +++ b/site/_includes/explanations/partitioned-topic-admin.md @@ -1,3 +1,24 @@ + + You can use Pulsar's [admin API](../../admin-api/overview) to create and manage partitioned topics. In all of the instructions and commands below, the topic name structure is: diff --git a/site/_includes/explanations/partitioned-topics.md b/site/_includes/explanations/partitioned-topics.md index 3606e7ba4e104..c0d4e210a245c 100644 --- a/site/_includes/explanations/partitioned-topics.md +++ b/site/_includes/explanations/partitioned-topics.md @@ -1,3 +1,24 @@ + + Normal topics can be served only by a single {% popover broker %}, which limits the topic's maximum throughput. *Partitioned topics* are a special type of topic that be handled by multiple brokers, which allows for much higher throughput. Behind the scenes, a partitioned topic is actually implemented as N internal topics, where N is the number of partitions. When publishing messages to a partitioned topic, each message is routed to one of several brokers. The distribution of partitions across brokers is handled automatically by Pulsar. diff --git a/site/_includes/explanations/permissions.md b/site/_includes/explanations/permissions.md index c87e9aae243a4..4e2cfe5551d62 100644 --- a/site/_includes/explanations/permissions.md +++ b/site/_includes/explanations/permissions.md @@ -1,3 +1,24 @@ + + Permissions in Pulsar are managed at the {% popover namespace %} level (that is, within {% popover properties %} and {% popover clusters %}). ### Grant permissions diff --git a/site/_includes/explanations/properties-namespaces.md b/site/_includes/explanations/properties-namespaces.md index 6795293c342c2..e2260d87e79d5 100644 --- a/site/_includes/explanations/properties-namespaces.md +++ b/site/_includes/explanations/properties-namespaces.md @@ -1,3 +1,24 @@ + + Pulsar was designed from the ground up to be a {% popover multi-tenant %} system. In Pulsar, {% popover tenants %} are identified by [properties](#properties). Properties are the highest administrative unit within a Pulsar {% popover instance %}. Within properties ### Properties diff --git a/site/_includes/explanations/service-discovery-setup.md b/site/_includes/explanations/service-discovery-setup.md index 90d8cfce2fbfc..9284c1fe4974b 100644 --- a/site/_includes/explanations/service-discovery-setup.md +++ b/site/_includes/explanations/service-discovery-setup.md @@ -1,3 +1,24 @@ + + [Clients](../../getting-started/Clients) connecting to Pulsar {% popover brokers %} need to be able to communicate with an entire Pulsar {% popover instance %} using a single URL. Pulsar provides a built-in service discovery mechanism that you can set up using the instructions [immediately below](#service-discovery-setup). You can also use your own service discovery system if you'd like. If you use your own system, there is just one requirement: when a client performs an HTTP request to an [endpoint](../../reference/Configuration) for a Pulsar {% popover cluster %}, such as `http://pulsar.us-west.example.com:8080`, the client needs to be redirected to *some* active broker in the desired cluster, whether via DNS, an HTTP or IP redirect, or some other means. diff --git a/site/_sass/_admonition.scss b/site/_sass/_admonition.scss index 72b00723e5780..30144e68808df 100644 --- a/site/_sass/_admonition.scss +++ b/site/_sass/_admonition.scss @@ -1,3 +1,21 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ @mixin admon($main-color) { background-color: lighten($main-color, 25%); color: darken($main-color, 30%); diff --git a/site/_sass/_cli.scss b/site/_sass/_cli.scss index 2f0caddd847bf..ff1e8334a6f6c 100644 --- a/site/_sass/_cli.scss +++ b/site/_sass/_cli.scss @@ -1,3 +1,21 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ @import "variables"; $padding-base: 18px; diff --git a/site/_sass/_docs.scss b/site/_sass/_docs.scss index 065b622d59e7c..3723ef7f71e9f 100644 --- a/site/_sass/_docs.scss +++ b/site/_sass/_docs.scss @@ -1,3 +1,21 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ @media screen and (min-width: 769px) { .rest-api-container, .docs-container { article { diff --git a/site/_sass/_mixins.scss b/site/_sass/_mixins.scss index 036b3e67d813c..43e0f9d57e5a1 100644 --- a/site/_sass/_mixins.scss +++ b/site/_sass/_mixins.scss @@ -1,3 +1,21 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ @mixin shadow($length) { -webkit-box-shadow: 2px 2px $length 0px rgba(221,221,221,1); -moz-box-shadow: 2px 2px $length 0px rgba(221,221,221,1); diff --git a/site/_sass/_navbar.scss b/site/_sass/_navbar.scss index 2d35b232be98c..89492d232aa02 100644 --- a/site/_sass/_navbar.scss +++ b/site/_sass/_navbar.scss @@ -1,3 +1,21 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ nav.navbar { background-color: white; @@ -56,4 +74,4 @@ nav.navbar { } } */ -} \ No newline at end of file +} diff --git a/site/_sass/_popover.scss b/site/_sass/_popover.scss index 4d620221ab099..8ec0a93298791 100644 --- a/site/_sass/_popover.scss +++ b/site/_sass/_popover.scss @@ -1,3 +1,21 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ @import "variables"; span.popover-term { diff --git a/site/_sass/_protobuf.scss b/site/_sass/_protobuf.scss index 9c9daf628a687..e6a7c0c738614 100644 --- a/site/_sass/_protobuf.scss +++ b/site/_sass/_protobuf.scss @@ -1,3 +1,21 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ @import "variables"; .protobuf { diff --git a/site/_sass/_sidebar.scss b/site/_sass/_sidebar.scss index 7ab4cafc44eab..ac48a35e5307d 100644 --- a/site/_sass/_sidebar.scss +++ b/site/_sass/_sidebar.scss @@ -1,3 +1,21 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ aside.sidebar-nav { position: fixed; overflow-y: scroll; @@ -63,4 +81,4 @@ aside.sidebar-nav { } } } -} \ No newline at end of file +} diff --git a/site/_sass/_swagger.scss b/site/_sass/_swagger.scss index d53ede3553784..1f0ce2f399bc5 100644 --- a/site/_sass/_swagger.scss +++ b/site/_sass/_swagger.scss @@ -1,3 +1,21 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ @import "variables"; @mixin swagger-method($color) {} diff --git a/site/_sass/_syntax.scss b/site/_sass/_syntax.scss index 115865226f221..45bc7b9f888cc 100644 --- a/site/_sass/_syntax.scss +++ b/site/_sass/_syntax.scss @@ -1,3 +1,21 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ @import "variables"; p code { diff --git a/site/_sass/_toc.scss b/site/_sass/_toc.scss index 5efe3d03c0f56..ea14926f0b857 100644 --- a/site/_sass/_toc.scss +++ b/site/_sass/_toc.scss @@ -1,3 +1,21 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ @import "variables"; .tocify { diff --git a/site/_sass/_variables.scss b/site/_sass/_variables.scss index d3f6339bce34d..51e037fb57355 100644 --- a/site/_sass/_variables.scss +++ b/site/_sass/_variables.scss @@ -1,3 +1,21 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ // Dimensions $top-margin: 50px; //$navbar-height: 77px; diff --git a/site/contact.md b/site/contact.md index 8cfd5586620a5..fc4db42ccd042 100644 --- a/site/contact.md +++ b/site/contact.md @@ -3,6 +3,26 @@ title: Contact layout: content --- + There are many ways to get help from the Apache Pulsar community. The mailing lists are the primary place where all Pulsar committers are present. Bugs and feature requests can either be discussed on the dev mailing list or by opening an issue on [GitHub]({{ site.pulsar_repo }}). diff --git a/site/css/style.scss b/site/css/style.scss index 42289bff8084a..6a667bba28658 100644 --- a/site/css/style.scss +++ b/site/css/style.scss @@ -1,6 +1,25 @@ --- --- +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + @charset "utf-8"; @import "variables"; diff --git a/site/docs/latest/adaptors/KafkaWrapper.md b/site/docs/latest/adaptors/KafkaWrapper.md index f0b2f79b97530..37b3fadff2c41 100644 --- a/site/docs/latest/adaptors/KafkaWrapper.md +++ b/site/docs/latest/adaptors/KafkaWrapper.md @@ -3,6 +3,27 @@ title: Pulsar adaptor for Apache Kafka tags: [apache, kafka, wrapper] --- + + Pulsar provides an easy option for applications that are currently written using the [Apache Kafka](http://kafka.apache.org) Java client API. diff --git a/site/docs/latest/adaptors/PulsarSpark.md b/site/docs/latest/adaptors/PulsarSpark.md index 8a42cec768776..2c0bbcf25336d 100644 --- a/site/docs/latest/adaptors/PulsarSpark.md +++ b/site/docs/latest/adaptors/PulsarSpark.md @@ -3,6 +3,27 @@ title: Spark Streaming Pulsar receiver tags: [spark, streaming, java] --- + + The Spark Streaming receiver for Pulsar is a custom receiver that enables Apache [Spark Streaming](https://spark.apache.org/streaming/) to receive data from Pulsar. An application can receive data in [Resilient Distributed Dataset](https://spark.apache.org/docs/latest/programming-guide.html#resilient-distributed-datasets-rdds) (RDD) format via the Spark Streaming Pulsar receiver and can process it in a variety of ways. diff --git a/site/docs/latest/adaptors/PulsarStorm.md b/site/docs/latest/adaptors/PulsarStorm.md index 5cca885ab5ff3..d52828dbcbf95 100644 --- a/site/docs/latest/adaptors/PulsarStorm.md +++ b/site/docs/latest/adaptors/PulsarStorm.md @@ -3,6 +3,27 @@ title: Pulsar adaptor for Apache Storm tags: [storm, java] --- + + Pulsar Storm is an adaptor for integrating with [Apache Storm](http://storm.apache.org/) topologies. It provides core Storm implementations for sending and receiving data. An application can inject data into a Storm topology via a generic Pulsar spout, as well as consume data from a Storm topology via a generic Pulsar bolt. diff --git a/site/docs/latest/admin-api/brokers.md b/site/docs/latest/admin-api/brokers.md index 9e645edac8fe5..55bbe80cf365b 100644 --- a/site/docs/latest/admin-api/brokers.md +++ b/site/docs/latest/admin-api/brokers.md @@ -2,6 +2,27 @@ title: Managing brokers --- + + Pulsar brokers consist of two components: 1. An HTTP server exposing a [REST interface](../../reference/RestApi) administration and {% popover topic %} lookup. diff --git a/site/docs/latest/admin-api/clusters.md b/site/docs/latest/admin-api/clusters.md index 2fe9c1026b9eb..c9f9e5d43ffed 100644 --- a/site/docs/latest/admin-api/clusters.md +++ b/site/docs/latest/admin-api/clusters.md @@ -2,6 +2,27 @@ title: Managing Clusters --- + + Pulsar clusters consist of one or more Pulsar {% popover brokers %}, one or more {% popover BookKeeper %} servers (aka {% popover bookies %}), and a {% popover ZooKeeper %} cluster that provides configuration and coordination management. Clusters can be managed via: diff --git a/site/docs/latest/admin-api/namespaces.md b/site/docs/latest/admin-api/namespaces.md index 4327bac80e708..9f0911b8ea13f 100644 --- a/site/docs/latest/admin-api/namespaces.md +++ b/site/docs/latest/admin-api/namespaces.md @@ -2,6 +2,27 @@ title: Managing namespaces --- + + Pulsar {% popover namespaces %} are logical groupings of {% popover topics %}. Namespaces can be managed via: diff --git a/site/docs/latest/admin-api/non-persistent-topics.md b/site/docs/latest/admin-api/non-persistent-topics.md index f5c73710460f7..23eae5cc2075c 100644 --- a/site/docs/latest/admin-api/non-persistent-topics.md +++ b/site/docs/latest/admin-api/non-persistent-topics.md @@ -2,6 +2,27 @@ title: Managing non-persistent topics --- + + Non-persistent can be used in applications that only want to consume real time published messages and do not need persistent guarantee that can also reduce message-publish latency by removing overhead of persisting messages. diff --git a/site/docs/latest/admin-api/overview.md b/site/docs/latest/admin-api/overview.md index 1dacb0ed7ca35..670401a16c46e 100644 --- a/site/docs/latest/admin-api/overview.md +++ b/site/docs/latest/admin-api/overview.md @@ -3,6 +3,27 @@ title: The Pulsar admin interface tags: [admin, cli, rest, java] --- + + The Pulsar admin interface enables you to manage all of the important entities in a Pulsar {% popover instance %}, such as {% popover properties %}, {% popover topics %}, and {% popover namespaces %}. You can currently interact with the admin interface via: diff --git a/site/docs/latest/admin-api/partitioned-topics.md b/site/docs/latest/admin-api/partitioned-topics.md index 8bbc020cd9246..0d79cbfa37f9d 100644 --- a/site/docs/latest/admin-api/partitioned-topics.md +++ b/site/docs/latest/admin-api/partitioned-topics.md @@ -2,6 +2,27 @@ title: Managing partitioned topics --- + + You can use Pulsar's [admin API](../../admin-api/overview) to create and manage partitioned topics. In all of the instructions and commands below, the topic name structure is: diff --git a/site/docs/latest/admin-api/permissions.md b/site/docs/latest/admin-api/permissions.md index 2b142e694905f..d68670897b6b6 100644 --- a/site/docs/latest/admin-api/permissions.md +++ b/site/docs/latest/admin-api/permissions.md @@ -2,6 +2,27 @@ title: Managing permissions --- + + ## Permissions resources {% include explanations/permissions.md %} diff --git a/site/docs/latest/admin-api/persistent-topics.md b/site/docs/latest/admin-api/persistent-topics.md index 7ead29b469fc3..1b2b403e79eac 100644 --- a/site/docs/latest/admin-api/persistent-topics.md +++ b/site/docs/latest/admin-api/persistent-topics.md @@ -2,6 +2,27 @@ title: Managing persistent topics --- + + Persistent helps to access topic which is a logical endpoint for publishing and consuming messages. Producers publish messages to the topic and consumers subscribe to the topic, to consume messages published to the topic. In all of the instructions and commands below, the topic name structure is: diff --git a/site/docs/latest/admin-api/properties.md b/site/docs/latest/admin-api/properties.md index 6e5def2f73afa..7c1dde1cf4491 100644 --- a/site/docs/latest/admin-api/properties.md +++ b/site/docs/latest/admin-api/properties.md @@ -2,6 +2,27 @@ title: Managing properties --- + + Properties, like namespaces, can be managed using the [admin API](../../admin-api/overview). There are currently two configurable aspects of properties: * Admin roles diff --git a/site/docs/latest/admin/Authz.md b/site/docs/latest/admin/Authz.md index 63eb1ce035e78..ccb7da8466094 100644 --- a/site/docs/latest/admin/Authz.md +++ b/site/docs/latest/admin/Authz.md @@ -3,6 +3,27 @@ title: Authentication and authorization in Pulsar tags: [admin, authentication, authorization, athenz, tls, java, cpp] --- + + Pulsar supports a pluggable authentication mechanism that Pulsar clients can use to authenticate with {% popover brokers %}. Pulsar can also be configured to support multiple authentication sources. ## Role tokens diff --git a/site/docs/latest/admin/Dashboard.md b/site/docs/latest/admin/Dashboard.md index 9d90c1c392362..e521cc30488e4 100644 --- a/site/docs/latest/admin/Dashboard.md +++ b/site/docs/latest/admin/Dashboard.md @@ -2,6 +2,27 @@ title: The Pulsar dashboard --- + + The Pulsar dashboard is a web application that enables users to monitor current stats for all {% popover topics %} in tabular form. The dashboard is a data collector that polls stats from all the {% popover brokers %} in a Pulsar {% popover instance %} (across multiple {% popover clusters %}) and stores all the information in a [PostgreSQL](https://www.postgresql.org/) database. diff --git a/site/docs/latest/admin/GeoReplication.md b/site/docs/latest/admin/GeoReplication.md index bb439d96c91d3..dc344fa95738d 100644 --- a/site/docs/latest/admin/GeoReplication.md +++ b/site/docs/latest/admin/GeoReplication.md @@ -2,6 +2,27 @@ title: Pulsar geo-replication --- + + *Geo-replication* is the replication of persistently stored message data across multiple {% popover clusters %} of a Pulsar {% popover instance %}. ## How it works diff --git a/site/docs/latest/admin/ModularLoadManager.md b/site/docs/latest/admin/ModularLoadManager.md index eab338f195fed..ca484db472e56 100644 --- a/site/docs/latest/admin/ModularLoadManager.md +++ b/site/docs/latest/admin/ModularLoadManager.md @@ -2,6 +2,27 @@ title: Modular load manager --- + + The *modular load manager*, implemented in {% javadoc ModularLoadManagerImpl broker org.apache.pulsar.broker.loadbalance.impl.ModularLoadManagerImpl %}, is a flexible alternative to the previously implemented load manager, {% javadoc SimpleLoadManagerImpl broker org.apache.pulsar.broker.loadbalance.impl.SimpleLoadManagerImpl %}, which attempts to simplify how load is managed while also providing abstractions so that complex load management strategies may be implemented. ## Usage diff --git a/site/docs/latest/admin/Stats.md b/site/docs/latest/admin/Stats.md index fbb9ee20a9d6f..8358f696883e7 100644 --- a/site/docs/latest/admin/Stats.md +++ b/site/docs/latest/admin/Stats.md @@ -2,6 +2,27 @@ title: Pulsar stats --- + + ## Partitioned topics {% include stats.html id="partitioned_topics" %} diff --git a/site/docs/latest/admin/ZooKeeperBookKeeper.md b/site/docs/latest/admin/ZooKeeperBookKeeper.md index 07a985fdf9287..e7467aa0216ff 100644 --- a/site/docs/latest/admin/ZooKeeperBookKeeper.md +++ b/site/docs/latest/admin/ZooKeeperBookKeeper.md @@ -2,6 +2,27 @@ title: ZooKeeper and BookKeeper administration --- + + Pulsar relies on two external systems for essential tasks: * [ZooKeeper](https://zookeeper.apache.org/) is responsible for a wide variety of configuration- and coordination-related tasks. @@ -155,4 +176,4 @@ This diagram illustrates the role of ZooKeeper and BookKeeper in a Pulsar cluste ![ZooKeeper and BookKeeper](/img/pulsar_system_architecture.png) -Each Pulsar {% popover cluster %} consists of one or more message {% popover brokers %}. Each broker relies on an ensemble of {% popover bookies %} \ No newline at end of file +Each Pulsar {% popover cluster %} consists of one or more message {% popover brokers %}. Each broker relies on an ensemble of {% popover bookies %} diff --git a/site/docs/latest/advanced/Encryption.md b/site/docs/latest/advanced/Encryption.md index 12b95e39beea5..da6e5bb2323a8 100644 --- a/site/docs/latest/advanced/Encryption.md +++ b/site/docs/latest/advanced/Encryption.md @@ -7,6 +7,27 @@ tags: - clients --- + + # Pulsar Encryption Pulsar encryption allows applications to encrypt messages at the producer and decrypt at the consumer. Encryption is performed using the public/private key pair configured by the application. Encrypted messages can only be decrypted by consumers with a valid key. diff --git a/site/docs/latest/advanced/PartitionedTopics.md b/site/docs/latest/advanced/PartitionedTopics.md index 1e0ef4b0b9e8a..aa6004d903cdd 100644 --- a/site/docs/latest/advanced/PartitionedTopics.md +++ b/site/docs/latest/advanced/PartitionedTopics.md @@ -8,6 +8,27 @@ tags: - clients --- + + By default, Pulsar {% popover topics %} are served by a single {% popover broker %}. Using only a single broker, however, limits a topic's maximum throughput. *Partitioned topics* are a special type of topic that can span multiple brokers and thus allow for much higher throughput. For an explanation of how partitioned topics work, see the [Concepts](#concepts) section below. You can [publish](#publishing-to-partitioned-topics) to partitioned topics using Pulsar's client libraries and you can [create and manage](#managing-partitioned-topics) partitioned topics using Pulsar's [admin API](../../admin-api/overview). diff --git a/site/docs/latest/advanced/RetentionExpiry.md b/site/docs/latest/advanced/RetentionExpiry.md index 7ef1e0b7409dc..1df5ac3b9a095 100644 --- a/site/docs/latest/advanced/RetentionExpiry.md +++ b/site/docs/latest/advanced/RetentionExpiry.md @@ -4,6 +4,27 @@ lead: Manage how long messages remain stored in your Pulsar instance tags: [admin, expiry, retention, backlog] --- + + Pulsar {% popover brokers %} are responsible for handling messages that pass through Pulsar, including [persistent storage](../../getting-started/ConceptsAndArchitecture#persistent-storage) of messages. By default, brokers: * immediately delete all messages that have been {% popover acknowledged %} by a {% popover consumer %}, and diff --git a/site/docs/latest/clients/Cpp.md b/site/docs/latest/clients/Cpp.md index 06e0e7021edad..bec201a492ca1 100644 --- a/site/docs/latest/clients/Cpp.md +++ b/site/docs/latest/clients/Cpp.md @@ -3,6 +3,27 @@ title: The Pulsar C++ client tags: [client, cpp] --- + + {% include admonition.html type='info' content=" diff --git a/site/docs/latest/clients/Java.md b/site/docs/latest/clients/Java.md index 209a9c5b3079a..b6e7f46cafb23 100644 --- a/site/docs/latest/clients/Java.md +++ b/site/docs/latest/clients/Java.md @@ -3,6 +3,27 @@ title: The Pulsar Java client tags: [client, java] --- + + The Pulsar Java client can be used both to create Java {% popover producers %} and {% popover consumers %} of messages but also to perform [administrative tasks](../../admin-api/overview). The current version of the Java client is **{{ site.current_version }}**. diff --git a/site/docs/latest/clients/Python.md b/site/docs/latest/clients/Python.md index 90b689af8e3b4..fb3bdbb7298ce 100644 --- a/site/docs/latest/clients/Python.md +++ b/site/docs/latest/clients/Python.md @@ -5,6 +5,27 @@ tags: - python --- + + The Pulsar Python client library is a wrapper over the existing [C++ client library](../Cpp) and exposes all of the [same features](../../../../api/cpp). You can find the code in the [`python` subdirectory]({{ site.pulsar_repo }}/pulsar-client-cpp/python) of the C++ client code. diff --git a/site/docs/latest/clients/WebSocket.md b/site/docs/latest/clients/WebSocket.md index 6fcae35705c81..97a97886a26ad 100644 --- a/site/docs/latest/clients/WebSocket.md +++ b/site/docs/latest/clients/WebSocket.md @@ -3,6 +3,27 @@ title: Pulsar's WebSocket API tags: [websocket, nodejs, python] --- + + Pulsar's [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) API is meant to provide a simple way to interact with Pulsar using languages that do not have an official [client library](../../getting-started/Clients). Through WebSockets you can publish and consume messages and use all the features available in the [Java](../Java), [Python](../Python), and [C++](../Cpp) client libraries. {% include admonition.html type="success" content="You can use Pulsar's WebSocket API with any WebSocket client library. See examples for Python and Node.js [below](#client-examples)." %} diff --git a/site/docs/latest/deployment/InstanceSetup.md b/site/docs/latest/deployment/InstanceSetup.md index d3caddaf953c5..ba552fe89b310 100644 --- a/site/docs/latest/deployment/InstanceSetup.md +++ b/site/docs/latest/deployment/InstanceSetup.md @@ -3,6 +3,27 @@ title: Deploying a Pulsar instance tags: [admin, instance] --- + + A Pulsar *instance* consists of multiple Pulsar {% popover clusters %} working in unison. Clusters can be distributed across data centers or geographical regions and can replicate amongst themselves using [geo-replication](../../admin/GeoReplication). Deploying a multi-cluster Pulsar instance involves the following basic steps: * Deploying two separate [ZooKeeper](#deploying-zookeeper) quorums: a [local](#deploying-local-zookeeper) quorum for each cluster in the instance and a [global](#deploying-global-zookeeper) quorum for instance-wide tasks diff --git a/site/docs/latest/deployment/Kubernetes.md b/site/docs/latest/deployment/Kubernetes.md index d1c46578effa8..d880412e85f54 100644 --- a/site/docs/latest/deployment/Kubernetes.md +++ b/site/docs/latest/deployment/Kubernetes.md @@ -3,6 +3,27 @@ title: Deploying Pulsar on Kubernetes tags: [Kubernetes, Google Container Engine] --- + + Pulsar can be easily deployed in [Kubernetes](https://kubernetes.io/) clusters, either in managed clusters on [Google Container Engine](#pulsar-on-google-container-engine) or [Amazon Web Services](https://aws.amazon.com/) or in [custom clusters](#pulsar-on-a-custom-kubernetes-cluster). The deployment method shown in this guide relies on [YAML](http://yaml.org/) definitions for Kubernetes [resources](https://kubernetes.io/docs/resources-reference/v1.6/). The [`kubernetes`]({{ site.pulsar_repo }}/kubernetes) subdirectory of the [Pulsar package](/download) holds resource definitions for: diff --git a/site/docs/latest/deployment/Monitoring.md b/site/docs/latest/deployment/Monitoring.md index d47dc22ad92c5..61079ffdfe607 100644 --- a/site/docs/latest/deployment/Monitoring.md +++ b/site/docs/latest/deployment/Monitoring.md @@ -2,6 +2,27 @@ title: Monitoring --- + + There are different ways to monitor a Pulsar cluster, exposing both metrics relative to the usage of topics and the overall health of the individual components of the cluster. diff --git a/site/docs/latest/getting-started/Clients.md b/site/docs/latest/getting-started/Clients.md index 5759de21c0555..eb90335ae3dd9 100644 --- a/site/docs/latest/getting-started/Clients.md +++ b/site/docs/latest/getting-started/Clients.md @@ -3,6 +3,27 @@ title: Pulsar client libraries layout: docs --- + + Pulsar currently has client libraries available for three languages: * [Java](#java-client) diff --git a/site/docs/latest/getting-started/ConceptsAndArchitecture.md b/site/docs/latest/getting-started/ConceptsAndArchitecture.md index fe93dcf52f584..1958af8d8fd06 100644 --- a/site/docs/latest/getting-started/ConceptsAndArchitecture.md +++ b/site/docs/latest/getting-started/ConceptsAndArchitecture.md @@ -5,6 +5,27 @@ tags: - architecture --- + + {% popover Pulsar %} is a multi-tenant, high-performance solution for server-to-server messaging originally developed by [Yahoo](http://yahoo.github.io/) and now under the stewardship of the [Apache Software Foundation](https://www.apache.org/). Pulsar's key features include: diff --git a/site/docs/latest/getting-started/LocalCluster.md b/site/docs/latest/getting-started/LocalCluster.md index 2e3858190c69c..7dfdbc577e712 100644 --- a/site/docs/latest/getting-started/LocalCluster.md +++ b/site/docs/latest/getting-started/LocalCluster.md @@ -7,6 +7,27 @@ tags: next: ../ConceptsAndArchitecture --- + + For the purposes of local development and testing, you can run Pulsar in {% popover standalone %} mode on your own machine. Standalone mode includes a Pulsar {% popover broker %} as well as the necessary {% popover ZooKeeper %} and {% popover BookKeeper %} components running inside of a single Java Virtual Machine (JVM) process. @@ -93,4 +114,4 @@ if (result != ResultOk) { LOG_ERROR("Error creating producer: " << result); return -1; } -``` \ No newline at end of file +``` diff --git a/site/docs/latest/getting-started/docker.md b/site/docs/latest/getting-started/docker.md index 42cd7c5bf8864..6fbe405eff357 100644 --- a/site/docs/latest/getting-started/docker.md +++ b/site/docs/latest/getting-started/docker.md @@ -8,6 +8,26 @@ tags: next: ../Clients --- + For the purposes of local development and testing, you can run Pulsar in {% popover standalone %} mode on your own machine within a Docker container. diff --git a/site/docs/latest/project/BinaryProtocol.md b/site/docs/latest/project/BinaryProtocol.md index 4304f1c587f11..b250ab319d1b5 100644 --- a/site/docs/latest/project/BinaryProtocol.md +++ b/site/docs/latest/project/BinaryProtocol.md @@ -6,6 +6,27 @@ tags: - binary protocol --- + + Pulsar uses a custom binary protocol for communications between {% popover producers %}/{% popover consumers %} and {% popover brokers %}. This protocol is designed to support required features, such as {% popover acknowledgements %} and flow control, while ensuring maximum transport and implementation efficiency. Clients and brokers exchange *commands* with each other. Commands are formatted as binary [protocol buffer](https://developers.google.com/protocol-buffers/) (aka *protobuf*) messages. The format of protobuf commands is specified in the [`PulsarApi.proto`](https://github.com/apache/incubator-pulsar/blob/master/pulsar-common/src/main/proto/PulsarApi.proto) file and also documented in the [Protobuf interface](#protobuf-interface) section below. diff --git a/site/docs/latest/project/Codebase.md b/site/docs/latest/project/Codebase.md index 65969668913cd..6ae29ba3f5ba4 100644 --- a/site/docs/latest/project/Codebase.md +++ b/site/docs/latest/project/Codebase.md @@ -3,6 +3,27 @@ title: The Pulsar codebase lead: If you want to contribute to Pulsar, here's an overview of what lives where in the repo --- + + The panels below describe some of the core directories in the [Pulsar codebase]({{ site.pulsar_repo }}). -{% include codebase.html %} \ No newline at end of file +{% include codebase.html %} diff --git a/site/docs/latest/project/SimulationTools.md b/site/docs/latest/project/SimulationTools.md index 17ee91388511f..093725c13e22d 100644 --- a/site/docs/latest/project/SimulationTools.md +++ b/site/docs/latest/project/SimulationTools.md @@ -3,6 +3,27 @@ title: Simulation tools tags: [simulation] --- + + It is sometimes necessary create an test environment and incur artificial load to observe how well load managers handle the load. The load simulation controller, the load simulation client, and the broker monitor were created as an effort to make create this load and observe the effects on the managers more easily. diff --git a/site/docs/latest/reference/CliTools.md b/site/docs/latest/reference/CliTools.md index da43dcc8d30bf..7c7c574e54459 100644 --- a/site/docs/latest/reference/CliTools.md +++ b/site/docs/latest/reference/CliTools.md @@ -9,6 +9,27 @@ tags: - bookkeeper --- + + Pulsar offers several command-line tools that you can use for managing Pulsar installations, performance testing, using command-line {% popover producers %} and {% popover consumers %}, and more. All Pulsar command-line tools can be run from the `bin` directory of your [installed Pulsar package](../../getting-started/LocalCluster#installing-pulsar). The following tools are currently documented: diff --git a/site/docs/latest/reference/Configuration.md b/site/docs/latest/reference/Configuration.md index c349de8151098..91da1213446fc 100644 --- a/site/docs/latest/reference/Configuration.md +++ b/site/docs/latest/reference/Configuration.md @@ -2,6 +2,27 @@ title: Pulsar configuration --- + + Pulsar configuration can be managed either via a series of configuration files contained in the [`conf`]({{ site.pulsar_repo }}/conf) directory of a Pulsar [installation](../../getting-started/LocalCluster) * [BookKeeper](#bookkeeper) diff --git a/site/docs/latest/reference/RestApi.md b/site/docs/latest/reference/RestApi.md index 563bd5bf65738..2f80e1d5eb4b2 100644 --- a/site/docs/latest/reference/RestApi.md +++ b/site/docs/latest/reference/RestApi.md @@ -3,6 +3,27 @@ title: Pulsar REST API layout: rest-api --- + + The REST API for the Pulsar {% popover broker %}. {% include swagger.html api="admin-rest-api-swagger" %} diff --git a/site/download.md b/site/download.md index 5a49cc628e98d..d61c1584a81fb 100644 --- a/site/download.md +++ b/site/download.md @@ -3,6 +3,27 @@ title: Apache Pulsar downloads layout: content --- + + Download Pulsar from the [releases page](https://github.com/apache/incubator-pulsar/releases) on GitHub or here: ### Version {{ site.current_version }} diff --git a/site/ja/adaptors/PulsarSpark.md b/site/ja/adaptors/PulsarSpark.md index eac0b25b38d93..8a06d0a164074 100644 --- a/site/ja/adaptors/PulsarSpark.md +++ b/site/ja/adaptors/PulsarSpark.md @@ -3,6 +3,27 @@ title: Spark Streaming Pulsar Receiver tags_ja: [spark, streaming, java] --- + + Spark Streaming Pulsar ReceiverはApache [Spark Streaming](https://spark.apache.org/streaming/)がPulsarからデータを受け取るためのCustom Receiverです。 アプリケーションはSpark Streaming Pulsar Receiverを通して[Resilient Distributed Dataset](https://spark.apache.org/docs/latest/programming-guide.html#resilient-distributed-datasets-rdds) (RDD)形式のデータを受け取り、様々な処理を行うことができます。 diff --git a/site/ja/adaptors/PulsarStorm.md b/site/ja/adaptors/PulsarStorm.md index 690a323799cdd..53b69f3564773 100644 --- a/site/ja/adaptors/PulsarStorm.md +++ b/site/ja/adaptors/PulsarStorm.md @@ -3,6 +3,27 @@ title: Apache StormのためのPulsarアダプタ tags_ja: [storm, java] --- + + Pulsar Stormは[Apache Storm](http://storm.apache.org/) Topologyと連携するためのアダプタであり、データの送受信を行うためのStormの実装を提供します。 アプリケーションはPulsar Spoutを通してStorm Topologyにデータを注入したり、Pulsar Boltを通してStorm Topologyからデータを取り出すことができます。 diff --git a/site/ja/admin/AdminInterface.md b/site/ja/admin/AdminInterface.md index c08f533b85ee0..032656d774153 100644 --- a/site/ja/admin/AdminInterface.md +++ b/site/ja/admin/AdminInterface.md @@ -3,6 +3,27 @@ title: Pulsar adminインターフェース tags_ja: [admin, cli, rest, java] --- + + Pulsar adminインターフェースは、{% popover_ja プロパティ %}、{% popover_ja ネームスペース %}、{% popover_ja トピック %}のようなPulsar{% popover_ja インスタンス %}における重要なエンティティの管理を可能にします。 現在、以下の方法でadminインターフェースを利用できます: diff --git a/site/ja/admin/Authz.md b/site/ja/admin/Authz.md index 266556f5bb608..0f58ccddbfdf1 100644 --- a/site/ja/admin/Authz.md +++ b/site/ja/admin/Authz.md @@ -3,6 +3,27 @@ title: Pulsarにおける認証と認可 tags_ja: [admin, authentication, authorization, athenz, tls, java, cpp] --- + + Pulsarは、クライアントが{% popover_ja Broker %}との認証で使用できるプラガブルな認証機構をサポートしています。また、Pulsarは複数の認証ソースをサポートするように設定する事も可能です。 ## ロールトークン diff --git a/site/ja/admin/ClustersBrokers.md b/site/ja/admin/ClustersBrokers.md index f4e111eb4a90f..06bcf62de4c5b 100644 --- a/site/ja/admin/ClustersBrokers.md +++ b/site/ja/admin/ClustersBrokers.md @@ -3,6 +3,27 @@ title: PulsarクラスタとBrokerの管理 tags_ja: [admin, cluster, broker, pulsar-admin, REST API, Java] --- + + Pulsar {% popover_ja クラスタ %}と{% popover_ja Broker %}はPulsarの[adminインターフェース](../AdminInterface)を用いて管理できます。 ## adminセットアップ diff --git a/site/ja/admin/Dashboard.md b/site/ja/admin/Dashboard.md index 87a42acdc30e0..ad5186906287b 100644 --- a/site/ja/admin/Dashboard.md +++ b/site/ja/admin/Dashboard.md @@ -2,6 +2,27 @@ title: Pulsarダッシュボード --- + + Pulsarダッシュボードは、ユーザが全ての{% popover_ja トピック %}の現在の統計情報を表形式で閲覧できるウェブアプリケーションです。 ダッシュボードはPulsar{% popover_ja インスタンス %} (複数の{% popover_ja クラスタ %}に跨る) 内の全ての{% popover_ja Broker %}から統計情報をポーリングし、全ての情報を[PostgreSQL](https://www.postgresql.org/)データベースに保存するデータコレクタです。 diff --git a/site/ja/admin/GeoReplication.md b/site/ja/admin/GeoReplication.md index 24e7d3289d133..271ef484a0018 100644 --- a/site/ja/admin/GeoReplication.md +++ b/site/ja/admin/GeoReplication.md @@ -2,6 +2,27 @@ title: Pulsarのジオレプリケーション --- + + *ジオレプリケーション*とは、Pulsar{% popover_ja インスタンス %}の複数の{% popover_ja クラスタ %}を横断して永続的に保存されたメッセージをレプリケーションすることです。 ## どのように動作するか diff --git a/site/ja/admin/ModularLoadManager.md b/site/ja/admin/ModularLoadManager.md index c091dc9f0a0f1..edd3399d4cd63 100644 --- a/site/ja/admin/ModularLoadManager.md +++ b/site/ja/admin/ModularLoadManager.md @@ -2,6 +2,27 @@ title: モジュラロードマネージャ --- + + {% javadoc ModularLoadManagerImpl broker org.apache.pulsar.broker.loadbalance.impl.ModularLoadManagerImpl %}として実装されている*モジュラロードマネージャ*は、これまでに実装されていたロードマネージャ{% javadoc SimpleLoadManagerImpl broker org.apache.pulsar.broker.loadbalance.impl.SimpleLoadManagerImpl %}のより柔軟な代替手段です。これは複雑な負荷管理戦略を実装できるように抽象化を提供しつつ、負荷管理の方法をより簡単にしようと試みています。 ## 使用方法 diff --git a/site/ja/admin/PropertiesNamespaces.md b/site/ja/admin/PropertiesNamespaces.md index 2febe4ab3f653..a127406d1dbe2 100644 --- a/site/ja/admin/PropertiesNamespaces.md +++ b/site/ja/admin/PropertiesNamespaces.md @@ -6,6 +6,27 @@ tags_ja: - admin --- + + Pulsar{% popover_ja インスタンス %}内で[プロパティ](#プロパティ)は最も上位の管理単位です。各プロパティは複数の[ネームスペース](#ネームスペース)で構成されています。 {% include explanations/ja/admin-setup.md %} diff --git a/site/ja/admin/Stats.md b/site/ja/admin/Stats.md index 9a2c4fa5c5638..d069dd320971f 100644 --- a/site/ja/admin/Stats.md +++ b/site/ja/admin/Stats.md @@ -2,6 +2,27 @@ title: Pulsarの統計情報 --- + + ## パーティションドトピック {% include stats-ja.html id="partitioned_topics" %} diff --git a/site/ja/admin/ZooKeeperBookKeeper.md b/site/ja/admin/ZooKeeperBookKeeper.md index 5f093e5207b01..cd21d4c4cbcc4 100644 --- a/site/ja/admin/ZooKeeperBookKeeper.md +++ b/site/ja/admin/ZooKeeperBookKeeper.md @@ -2,6 +2,27 @@ title: ZooKeeperとBookKeeperの管理 --- + + Pulsarは2つの外部システムを使って根本的なタスクを行っています： * [ZooKeeper](https://zookeeper.apache.org/)は様々な構成や調整に関わるタスクを行う役割を持ちます。 diff --git a/site/ja/advanced/PartitionedTopics.md b/site/ja/advanced/PartitionedTopics.md index 075652764482e..0bd006a180c4f 100644 --- a/site/ja/advanced/PartitionedTopics.md +++ b/site/ja/advanced/PartitionedTopics.md @@ -8,6 +8,27 @@ tags_ja: - clients --- + + デフォルトでは、Pulsarの{% popover_ja トピック %}は単一の{% popover_ja Broker %}によって提供されます。しかし単一のBrokerを使用すると、トピックの最大スループットが制限されてしまいます。*パーティションドトピック*は複数のBrokerに跨らせる事のできる特殊なトピックであり、より高いスループットの実現を可能にします。パーティションドトピックがどのように動作するかの説明は下記の[コンセプト](#コンセプト)のセクションを参照してください。 Pulsarのクライアントライブラリを使用する事でパーティションドトピックにメッセージを[発行](#パーティションドトピックへのメッセージの発行)できます。また、Pulsarの[admin API](../../admin/AdminInterface)を使用する事でパーティションドトピックの[作成と管理](#パーティションドトピックの管理)ができます。 diff --git a/site/ja/advanced/RetentionExpiry.md b/site/ja/advanced/RetentionExpiry.md index 070c821f4996c..1dec6bf882c8e 100644 --- a/site/ja/advanced/RetentionExpiry.md +++ b/site/ja/advanced/RetentionExpiry.md @@ -4,6 +4,27 @@ lead: Pulsarインスタンスに保存されているメッセージの保存 tags_ja: [admin, expiry, retention, backlog] --- + + Pulsar {% popover_ja Broker %}は、メッセージの[永続ストレージ](../../getting-started/ConceptsAndArchitecture#永続ストレージ)を含むPulsarインスタンスを通過するメッセージを処理する責任を持ちます。デフォルトでは、Brokerは: * {% popover_ja Consumer %}によって{% popover_ja Ack %} (確認応答) の返された全てのメッセージを直ちに削除します。 diff --git a/site/ja/clients/Cpp.md b/site/ja/clients/Cpp.md index f12d61ba63970..58485234c0f51 100644 --- a/site/ja/clients/Cpp.md +++ b/site/ja/clients/Cpp.md @@ -3,6 +3,27 @@ title: Pulsar C++クライアント tags_ja: [client, cpp] --- + + {% include admonition.html type='info' content="オープンソースコミュニティからの貢献を歓迎します。変更はgcc-4.4.7およびBoost 1.41と下位互換性を持たせてください。" %} diff --git a/site/ja/clients/Java.md b/site/ja/clients/Java.md index efed7bdb87836..e4e6454626832 100644 --- a/site/ja/clients/Java.md +++ b/site/ja/clients/Java.md @@ -3,6 +3,27 @@ title: Pulsar Javaクライアント tags_ja: [client, java] --- + + PulsarのJavaクライアントでは{% popover_ja Producer %}と{% popover_ja Consumer %}の両方が利用可能であるだけでなく、[管理タスク](../../admin/AdminInterface)も実行可能です。 Javaクライアントの現在のバージョンは **{{ site.current_version }}** です。 diff --git a/site/ja/clients/Python.md b/site/ja/clients/Python.md index 941772e8fb8e1..b1780ffa94ddc 100644 --- a/site/ja/clients/Python.md +++ b/site/ja/clients/Python.md @@ -5,6 +5,27 @@ tags_ja: - python --- + + Pythonクライアントライブラリは[C++クライアントライブラリ](../Cpp)のラッパーで全ての[同じ機能](../../../../api/cpp)を公開しています。C++クライアントコードの[`python`サブディレクトリ]({{ site.pulsar_repo }}/pulsar-client-cpp/python)内にコードがあります。 ## インストール diff --git a/site/ja/clients/WebSocket.md b/site/ja/clients/WebSocket.md index 84485d1fd34cc..92af88a5442f5 100644 --- a/site/ja/clients/WebSocket.md +++ b/site/ja/clients/WebSocket.md @@ -3,6 +3,27 @@ title: PulsarにおけるWebSocket API tags_ja: [websocket, nodejs, python] --- + + Pulsarにおける[WebSocket](https://developer.mozilla.org/ja/docs/Web/API/WebSockets_API) APIは公式の[クライアントライブラリ](../../getting-started/Clients)のない言語からもPulsarとメッセージをやり取りする簡単な方法を提供することを意味します。WebSocketを通してメッセージの送受信と[Java](../Java), [Python](../Python), [C++](../Cpp)クライアントライブラリから利用可能な全機能を利用できます。 {% include admonition.html type="success" content="PulsarのWebSocket APIはどのWebSocketクライアントライブラリからでも利用できます。PythonとNode.jsのサンプルは[こちら](#クライアントの実装例)にあります。" %} diff --git a/site/ja/deployment/InstanceSetup.md b/site/ja/deployment/InstanceSetup.md index c7320299bb79a..810f70c49ee95 100644 --- a/site/ja/deployment/InstanceSetup.md +++ b/site/ja/deployment/InstanceSetup.md @@ -3,6 +3,27 @@ title: Pulsarインスタンスのデプロイ tags_ja: [admin, instance] --- + + Pulsar*インスタンス*は協調して動作する複数のPulsar{% popover_ja クラスタ %}から構成されます。クラスタは複数のデータセンターや地理的地域に分散させる事ができ、[ジオレプリケーション](../../admin/GeoReplication)を使用してそれらの間での複製が可能です。マルチクラスタのPulsarインスタンスをデプロイするには、以下の基本的な手順を踏む必要があります: * 2つの異なる[ZooKeeper](#zookeeperのデプロイ)クォーラムのデプロイ: インスタンス内の個別のクラスタのための[Local ZooKeeper](#local-zookeeperのデプロイ)クォーラムとインスタンス全体のタスクのための[Global ZooKeeper](#global-zookeeperのデプロイ)クォーラム diff --git a/site/ja/deployment/Kubernetes.md b/site/ja/deployment/Kubernetes.md index 394f84a039d98..2b0638a1830fb 100644 --- a/site/ja/deployment/Kubernetes.md +++ b/site/ja/deployment/Kubernetes.md @@ -3,6 +3,27 @@ title: Kubernetes上でのPulsarのデプロイ tags_ja: [Kubernetes, Google Container Engine] --- + + Pulsarは[Google Container Engine](#google-container-engine), [Amazon Web Services](https://aws.amazon.com/)の管理クラスタ、[カスタムクラスタ](#カスタムkubernetesクラスタ)の[Kubernetes](https://kubernetes.io/)クラスタに簡単にデプロイできます。 このガイドのデプロイ方法はKubernetesの[リソース](https://kubernetes.io/docs/resources-reference/v1.6/)の[YAML](http://yaml.org/)定義に依存しています。[Pulsarパッケージ](/download)の[`kubernetes`]({{ site.pulsar_repo }}/kubernetes)サブディレクトリは以下のリソース定義を保持します: diff --git a/site/ja/deployment/Monitoring.md b/site/ja/deployment/Monitoring.md index d6e92fd67497a..eca52f4276318 100644 --- a/site/ja/deployment/Monitoring.md +++ b/site/ja/deployment/Monitoring.md @@ -2,6 +2,27 @@ title: 監視 --- + + Pulsarクラスタを監視する方法はいくつか存在し、トピックの利用状況とクラスタの個々のコンポーネントの総合的な健康状態に関するメトリクスを公開しています。 ## メトリクスの収集 diff --git a/site/ja/getting-started/Clients.md b/site/ja/getting-started/Clients.md index 9711ab7001d7b..50360db74692f 100644 --- a/site/ja/getting-started/Clients.md +++ b/site/ja/getting-started/Clients.md @@ -2,6 +2,27 @@ title: Pulsarクライアントライブラリ --- + + Pulsarのクライアントライブラリは現在3つの言語に対応しています: * [Java](#javaクライアント) diff --git a/site/ja/getting-started/ConceptsAndArchitecture.md b/site/ja/getting-started/ConceptsAndArchitecture.md index e55e344cb880c..e58c15358e300 100644 --- a/site/ja/getting-started/ConceptsAndArchitecture.md +++ b/site/ja/getting-started/ConceptsAndArchitecture.md @@ -5,6 +5,27 @@ tags_ja: - architecture --- + + {% popover_ja Pulsar %}は[Yahoo](http://yahoo.github.io/)で開発され、現在は[Apache Software Foundation](https://www.apache.org/)の管理下にある、サーバからサーバへメッセージングを行うためのマルチテナント、ハイパフォーマンスなソリューションです。 Pulsarの主要な特徴: diff --git a/site/ja/getting-started/LocalCluster.md b/site/ja/getting-started/LocalCluster.md index 63f4fcfae0e3a..d2d745210efe9 100644 --- a/site/ja/getting-started/LocalCluster.md +++ b/site/ja/getting-started/LocalCluster.md @@ -7,6 +7,27 @@ tags_ja: next: ../ConceptsAndArchitecture --- + + ローカル環境での開発やテストのために、 Pulsarの{% popover_ja スタンドアローン %}モードを使用する事ができます。 このモードでは、{% popover_ja Broker %}, {% popover_ja ZooKeeper %}, {% popover_ja BookKeeper %}の3コンポーネントを単一のJVMプロセスで起動します。 diff --git a/site/ja/project/BinaryProtocol.md b/site/ja/project/BinaryProtocol.md index 8d314d84e6818..5de3e9bba9ad0 100644 --- a/site/ja/project/BinaryProtocol.md +++ b/site/ja/project/BinaryProtocol.md @@ -6,6 +6,27 @@ tags_ja: - binary protocol --- + + Pulsarは{% popover_ja Producer %}/{% popover_ja Consumer %}と{% popover_ja Broker %}の通信に独自バイナリプロトコルを利用しています。プロトコルは転送と実装の最大効率を保証しながら、{% popover_ja Ack %} (確認応答) やフロー制御のような要求される全ての機能をサポートするようにデザインされています。 クライアントとBrokerは互いに*コマンド*を交換します。コマンドは[Protocol Buffers](https://developers.google.com/protocol-buffers/) (*protobuf*) によるバイナリメッセージの形式です。protobufによるコマンドの仕様は[`PulsarApi.proto`](https://github.com/apache/incubator-pulsar/blob/master/pulsar-common/src/main/proto/PulsarApi.proto) に記述されています。また、本ドキュメントの[Protobufインターフェース](#protobufインターフェース)セクションにも記述されています。 diff --git a/site/ja/project/Codebase.md b/site/ja/project/Codebase.md index f1290fae339c4..6b3f73367ea83 100644 --- a/site/ja/project/Codebase.md +++ b/site/ja/project/Codebase.md @@ -3,6 +3,27 @@ title: Pulsarのコードベース lead: Pulsarへの貢献をお望みの場合は、こちらにリポジトリ構成の概要があります --- + + 以下のパネルでは[Pulsarのコードベース]({{ site.pulsar_repo }})の中のいくつかのコアディレクトリについて説明します。 {% include codebase-ja.html %} diff --git a/site/ja/project/SimulationTools.md b/site/ja/project/SimulationTools.md index 1028a87669923..952c0c6a6c66a 100644 --- a/site/ja/project/SimulationTools.md +++ b/site/ja/project/SimulationTools.md @@ -3,6 +3,27 @@ title: シミュレーションツール tags_ja: [simulation] --- + + 時折、ロードマネージャがうまく負荷を制御できるか観察するために、テスト環境を作成し、人工的に負荷を生じさせる必要があります。負荷シミュレーションコントローラ、負荷シミュレーションクライアント、Brokerモニタはこの負荷を作成し、マネージャへの影響をより簡単に観察するために作成されました。 ## シミュレーションクライアント diff --git a/site/ja/reference/CliTools.md b/site/ja/reference/CliTools.md index bba4eca4a3a87..8cc819fbddb4d 100644 --- a/site/ja/reference/CliTools.md +++ b/site/ja/reference/CliTools.md @@ -9,6 +9,27 @@ tags_ja: - bookkeeper --- + + PulsarはいくつかのPulsarのインストールやパフォーマンステスト、コマンドライン上での{% popover_ja Producer %}や{% popover_ja Consumer %}の生成などに使えるコマンドラインツールを提供しています。 Pulsarの全てのコマンドラインツールは、[インストールされたPulsarパッケージ](../../getting-started/LocalCluster#pulsarのインストール)の`bin`ディレクトリから起動できます。現在、以下のツールがドキュメント化されています: diff --git a/site/ja/reference/Configuration.md b/site/ja/reference/Configuration.md index d5980d1adf201..677e984b50c37 100644 --- a/site/ja/reference/Configuration.md +++ b/site/ja/reference/Configuration.md @@ -2,6 +2,27 @@ title: Pulsarの設定 --- + + Pulsarの設定は[インストール](../../getting-started/LocalCluster)される[`conf`]({{ site.pulsar_repo }}/conf)ディレクトリ内の一連の設定ファイルにより管理することができます。 * [BookKeeper](#bookkeeper) diff --git a/site/ja/reference/RestApi.md b/site/ja/reference/RestApi.md index acc5b0774150f..c91200326a608 100644 --- a/site/ja/reference/RestApi.md +++ b/site/ja/reference/RestApi.md @@ -3,6 +3,27 @@ title: Pulsar REST API layout: rest-api-ja --- + + Pulsar {% popover_ja Broker %}のREST APIです。 {% include swagger.html api="admin-rest-api-swagger" %} diff --git a/site/presentations.md b/site/presentations.md index 5856c65d3d429..a6cd94f99a469 100644 --- a/site/presentations.md +++ b/site/presentations.md @@ -3,6 +3,27 @@ title: Presentations layout: content --- + + ## Articles * Yahoo Engineering blog post --- [Open-sourcing Pulsar, Pub-sub Messaging at Scale](https://yahooeng.tumblr.com/post/150078336821/open-sourcing-pulsar-pub-sub-messaging-at-scale) diff --git a/site/team.md b/site/team.md index 10f3be8a6d89f..8896c8963aaa8 100644 --- a/site/team.md +++ b/site/team.md @@ -3,6 +3,27 @@ title: Apache Pulsar Team layout: content --- + + A successful project requires many people to play many roles. Some members write code or documentation, while others are valuable as testers, submitting patches and suggestions.