Skip to content

Commit

Permalink
[Doc] add explanations for permissions (apache#12920)
Browse files Browse the repository at this point in the history
* [Doc] add explanations for permissions

* update
  • Loading branch information
Anonymitaet authored Nov 23, 2021
1 parent af1a82d commit c22192f
Show file tree
Hide file tree
Showing 10 changed files with 109 additions and 8 deletions.
9 changes: 7 additions & 2 deletions site2/docs/admin-api-permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,13 @@ sidebar_label: Permissions
>
> - For the latest and complete information about `Java admin API`, including classes, methods, descriptions, and more, see [Java admin API doc](https://pulsar.apache.org/api/admin/).
Permissions in Pulsar are managed at the [namespace](reference-terminology.md#namespace) level
(that is, within [tenants](reference-terminology.md#tenant) and [clusters](reference-terminology.md#cluster)).
Pulsar allows you to grant namespace-level or topic-level permission to users.

- If you grant a namespace-level permission to a user, then the user can access all the topics under the namespace.

- If you grant a topic-level permission to a user, then the user can access only the topic.

The chapters below demonstrate how to grant namespace-level permissions to users. For how to grant topic-level permissions to users, see [manage topics](admin-api-topics.md/#grant-permission).

## Grant permissions

Expand Down
10 changes: 10 additions & 0 deletions site2/website/versioned_docs/version-2.8.2/admin-api-brokers.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ sidebar_label: Brokers
original_id: admin-api-brokers
---

> **Important**
>
> This page only shows **some frequently used operations**.
>
> - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more, see [Pulsar admin doc](https://pulsar.apache.org/tools/pulsar-admin/).
>
> - For the latest and complete information about `REST API`, including parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.
>
> - For the latest and complete information about `Java admin API`, including classes, methods, descriptions, and more, see [Java admin API doc](https://pulsar.apache.org/api/admin/).
Pulsar brokers consist of two components:

1. An HTTP server exposing a {@inject: rest:REST:/} interface administration and [topic](reference-terminology.md#topic) lookup.
Expand Down
10 changes: 10 additions & 0 deletions site2/website/versioned_docs/version-2.8.2/admin-api-clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ sidebar_label: Clusters
original_id: admin-api-clusters
---

> **Important**
>
> This page only shows **some frequently used operations**.
>
> - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more, see [Pulsar admin doc](https://pulsar.apache.org/tools/pulsar-admin/).
>
> - For the latest and complete information about `REST API`, including parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.
>
> - For the latest and complete information about `Java admin API`, including classes, methods, descriptions, and more, see [Java admin API doc](https://pulsar.apache.org/api/admin/).
Pulsar clusters consist of one or more Pulsar [brokers](reference-terminology.md#broker), one or more [BookKeeper](reference-terminology.md#bookkeeper)
servers (aka [bookies](reference-terminology.md#bookie)), and a [ZooKeeper](https://zookeeper.apache.org) cluster that provides configuration and coordination management.

Expand Down
10 changes: 10 additions & 0 deletions site2/website/versioned_docs/version-2.8.2/admin-api-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ sidebar_label: Functions
original_id: admin-api-functions
---

> **Important**
>
> This page only shows **some frequently used operations**.
>
> - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more, see [Pulsar admin doc](https://pulsar.apache.org/tools/pulsar-admin/).
>
> - For the latest and complete information about `REST API`, including parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.
>
> - For the latest and complete information about `Java admin API`, including classes, methods, descriptions, and more, see [Java admin API doc](https://pulsar.apache.org/api/admin/).
**Pulsar Functions** are lightweight compute processes that

* consume messages from one or more Pulsar topics
Expand Down
10 changes: 10 additions & 0 deletions site2/website/versioned_docs/version-2.8.2/admin-api-namespaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ sidebar_label: Namespaces
original_id: admin-api-namespaces
---

> **Important**
>
> This page only shows **some frequently used operations**.
>
> - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more, see [Pulsar admin doc](https://pulsar.apache.org/tools/pulsar-admin/).
>
> - For the latest and complete information about `REST API`, including parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.
>
> - For the latest and complete information about `Java admin API`, including classes, methods, descriptions, and more, see [Java admin API doc](https://pulsar.apache.org/api/admin/).
Pulsar [namespaces](reference-terminology.md#namespace) are logical groupings of [topics](reference-terminology.md#topic).

Namespaces can be managed via:
Expand Down
19 changes: 15 additions & 4 deletions site2/website/versioned_docs/version-2.8.2/admin-api-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,27 @@ The Pulsar admin interface enables you to manage all important entities in a Pul

You can interact with the admin interface via:

- HTTP calls, which are made against the admin {@inject: rest:REST:/} API provided by Pulsar brokers. For some RESTful APIs, they might be redirected to the owner brokers for serving with [`307 Temporary Redirect`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/307), hence the HTTP callers should handle `307 Temporary Redirect`. If you use `curl` commands, you should specify `-L` to handle redirections.
- A Java client interface.
- The `pulsar-admin` CLI tool, which is available in the `bin` folder of your Pulsar installation:

```shell
$ bin/pulsar-admin
bin/pulsar-admin
```

For complete commands of `pulsar-admin` tool, see [Pulsar admin snapshot](https://pulsar.apache.org/tools/pulsar-admin/).
> **Important**
>
> For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more, see [Pulsar admin doc](https://pulsar.apache.org/tools/pulsar-admin/).

- HTTP calls, which are made against the admin {@inject: rest:REST:/} API provided by Pulsar brokers. For some RESTful APIs, they might be redirected to the owner brokers for serving with [`307 Temporary Redirect`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/307), hence the HTTP callers should handle `307 Temporary Redirect`. If you use `curl` commands, you should specify `-L` to handle redirections.

> **Important**
>
> For the latest and complete information about `REST API`, including parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.

- A Java client interface.

> **Important**
>
> For the latest and complete information about `Java admin API`, including classes, methods, descriptions, and more, see [Java admin API doc](https://pulsar.apache.org/api/admin/).

> **The REST API is the admin interface**. Both the `pulsar-admin` CLI tool and the Java client use the REST API. If you implement your own admin interface client, you should use the REST API.

Expand Down
10 changes: 10 additions & 0 deletions site2/website/versioned_docs/version-2.8.2/admin-api-packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ sidebar_label: Packages
original_id: admin-api-packages
---

> **Important**
>
> This page only shows **some frequently used operations**.
>
> - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more, see [Pulsar admin doc](https://pulsar.apache.org/tools/pulsar-admin/).
>
> - For the latest and complete information about `REST API`, including parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.
>
> - For the latest and complete information about `Java admin API`, including classes, methods, descriptions, and more, see [Java admin API doc](https://pulsar.apache.org/api/admin/).
Package management enables version management and simplifies the upgrade and rollback processes for Functions, Sinks, and Sources. When you use the same function, sink and source in different namespaces, you can upload them to a common package management system.

## Package name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,23 @@ sidebar_label: Permissions
original_id: admin-api-permissions
---

Permissions in Pulsar are managed at the [namespace](reference-terminology.md#namespace) level
(that is, within [tenants](reference-terminology.md#tenant) and [clusters](reference-terminology.md#cluster)).
> **Important**
>
> This page only shows **some frequently used operations**.
>
> - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more, see [Pulsar admin doc](https://pulsar.apache.org/tools/pulsar-admin/).
>
> - For the latest and complete information about `REST API`, including parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.
>
> - For the latest and complete information about `Java admin API`, including classes, methods, descriptions, and more, see [Java admin API doc](https://pulsar.apache.org/api/admin/).
Pulsar allows you to grant namespace-level or topic-level permission to users.

- If you grant a namespace-level permission to a user, then the user can access all the topics under the namespace.

- If you grant a topic-level permission to a user, then the user can access only the topic.

The chapters below demonstrate how to grant namespace-level permissions to users. For how to grant topic-level permissions to users, see [manage topics](admin-api-topics.md/#grant-permission).

## Grant permissions

Expand Down
10 changes: 10 additions & 0 deletions site2/website/versioned_docs/version-2.8.2/admin-api-tenants.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ sidebar_label: Tenants
original_id: admin-api-tenants
---

> **Important**
>
> This page only shows **some frequently used operations**.
>
> - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more, see [Pulsar admin doc](https://pulsar.apache.org/tools/pulsar-admin/).
>
> - For the latest and complete information about `REST API`, including parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.
>
> - For the latest and complete information about `Java admin API`, including classes, methods, descriptions, and more, see [Java admin API doc](https://pulsar.apache.org/api/admin/).
Tenants, like namespaces, can be managed using the [admin API](admin-api-overview.md). There are currently two configurable aspects of tenants:

* Admin roles
Expand Down
10 changes: 10 additions & 0 deletions site2/website/versioned_docs/version-2.8.2/admin-api-topics.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ sidebar_label: Topics
original_id: admin-api-topics
---

> **Important**
>
> This page only shows **some frequently used operations**.
>
> - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more, see [Pulsar admin doc](https://pulsar.apache.org/tools/pulsar-admin/).
>
> - For the latest and complete information about `REST API`, including parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.
>
> - For the latest and complete information about `Java admin API`, including classes, methods, descriptions, and more, see [Java admin API doc](https://pulsar.apache.org/api/admin/).
Pulsar has persistent and non-persistent topics. Persistent topic is a logical endpoint for publishing and consuming messages. The topic name structure for persistent topics is:

```shell
Expand Down

0 comments on commit c22192f

Please sign in to comment.