Skip to content

Commit

Permalink
Move Security related documentation to a top-level category (apache#2051
Browse files Browse the repository at this point in the history
)



*Motivation*

Security is one of the most important features that Apache Pulsar offers.
It is making sense to have a top-level cateory to hold all the documentation related to security.

e.g.

- tls encryption and authentication
- authenz authentication
- authorization
- end-to-end encryption

*Solution*

All security documentation are now in `Security` category.
  • Loading branch information
sijie authored Jul 7, 2018
1 parent 027f535 commit 5402d21
Show file tree
Hide file tree
Showing 20 changed files with 661 additions and 353 deletions.
2 changes: 1 addition & 1 deletion site/_data/messages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ shared_mode_limitations:
2. You cannot use [cumulative acknowledgment](#acknowledgement) with shared mode.
superuser:
type: warning
content: Please note that this operation requires [superuser](../../admin/Authz#superusers) privileges.
content: Please note that this operation requires [superuser](../../security/authorization#superusers) privileges.
mark_delete:
type: info
content: TODO
20 changes: 16 additions & 4 deletions site/_data/sidebar.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,6 @@ groups:
endpoint: ZooKeeperBookKeeper
- title: Geo-replication
endpoint: GeoReplication
- title: Authentication and authorization
endpoint: Authz
- title: Dashboard
endpoint: Dashboard
- title: Pulsar statistics
Expand All @@ -96,6 +94,22 @@ groups:
- title: Pulsar proxy
endpoint: Proxy

- title: Security
dir: security
docs:
- title: Overview
endpoint: overview
- title: Encryption and Authentication using TLS
endpoint: tls
- title: Authentication using Athenz
endpoint: athenz
- title: Authorization and ACLs
endpoint: authorization
- title: End-to-End Encryption
endpoint: encryption
- title: Extending Authentication and Authorization
endpoint: extending

- title: Client libraries
dir: clients
docs:
Expand Down Expand Up @@ -187,5 +201,3 @@ groups:
endpoint: CliTools
- title: Pulsar configuration
endpoint: Configuration
- title: Authn & Authz plugins
endpoint: CustomAuth
4 changes: 2 additions & 2 deletions site/_includes/explanations/admin-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@
-->

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 %}.
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](../../security/overview#authentication-providers) enabled in your Pulsar {% popover instance %}.

### pulsar-admin

If you have [authentication](../../admin/Authz#authentication-providers) enabled, you will need to provide an auth configuration to use the [`pulsar-admin`](../../reference/CliTools#pulsar-admin) tool. By default, the configuration for the `pulsar-admin` tool is found in the [`conf/client.conf`](../../reference/Configuration#client) file. Here are the available parameters:
If you have [authentication](../../security/overview#authentication-providers) enabled, you will need to provide an auth configuration to use the [`pulsar-admin`](../../reference/CliTools#pulsar-admin) tool. By default, the configuration for the `pulsar-admin` tool is found in the [`conf/client.conf`](../../reference/Configuration#client) file. Here are the available parameters:

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

Expand Down
2 changes: 1 addition & 1 deletion site/_includes/explanations/client-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ A URL for a production Pulsar cluster may look something like this:
pulsar://pulsar.us-west.example.com:6650
```

If you're using [TLS](../../admin/Authz#tls-client-auth) authentication, the URL will look like something like this:
If you're using [TLS](../../security/tls) authentication, the URL will look like something like this:

```
pulsar+ssl://pulsar.us-west.example.com:6651
Expand Down
2 changes: 1 addition & 1 deletion site/_includes/explanations/tenants-namespaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Pulsar was designed from the ground up to be a {% popover multi-tenant %} system

To each property in a Pulsar instance you can assign:

* An [authorization](../../admin/Authz#authorization) scheme
* An [authorization](../../security/authorization) scheme
* The set of {% popover clusters %} to which the tenant's configuration applies

### Namespaces
Expand Down
2 changes: 1 addition & 1 deletion site/docs/latest/admin-api/clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ bin/pulsar initialize-cluster-metadata \
--broker-service-url-tls pulsar+ssl://pulsar.us-west.example.com:6651/
```

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

### Get configuration

Expand Down
Loading

0 comments on commit 5402d21

Please sign in to comment.