Skip to content

Commit

Permalink
[website] Fix security page links and includes (apache#2237)
Browse files Browse the repository at this point in the history
### Motivation

There is a duplication in the security pages. That was introduced because security pages were relocated
when developing new site.

And a couple of includes links are not working.

 ### Changes

- Fix all the security related links and removed unneeded `docs/administration-auth.md` page
- Expanding the includes

additionally fixing some anchors when modifying the pages
  • Loading branch information
sijie authored and merlimat committed Jul 26, 2018
1 parent 20c97a8 commit 1632708
Show file tree
Hide file tree
Showing 27 changed files with 105 additions and 590 deletions.
4 changes: 2 additions & 2 deletions site2/docs/adaptors-kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Then include this dependency for the Pulsar Kafka wrapper:
<dependency>
<groupId>org.apache.pulsar</groupId>
<artifactId>pulsar-client-kafka</artifactId>
<version>pulsar:version</version>
<version>{{pulsar:version}}</version>
</dependency>
```

Expand All @@ -44,7 +44,7 @@ unshaded pulsar kafka client wrapper.
<dependency>
<groupId>org.apache.pulsar</groupId>
<artifactId>pulsar-client-kafka-original</artifactId>
<version>pulsar:version</version>
<version>{{pulsar:version}}</version>
</dependency>
```

Expand Down
4 changes: 2 additions & 2 deletions site2/docs/adaptors-spark.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you're using Maven, add this to your `pom.xml`:

```xml
<!-- in your <properties> block -->
<pulsar.version>pulsar:version</pulsar.version>
<pulsar.version>{{pulsar:version}}</pulsar.version>

<!-- in your <dependencies> block -->
<dependency>
Expand All @@ -33,7 +33,7 @@ If you're using Maven, add this to your `pom.xml`:
If you're using Gradle, add this to your `build.gradle` file:

```groovy
def pulsarVersion = "pulsar:version"
def pulsarVersion = "{{pulsar:version}}"
dependencies {
compile group: 'org.apache.pulsar', name: 'pulsar-spark', version: pulsarVersion
Expand Down
4 changes: 1 addition & 3 deletions site2/docs/admin-api-brokers.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@ Pulsar brokers consist of two components:

In addition to being configurable when you start them up, brokers can also be [dynamically configured](#dynamic-broker-configuration).

{% include admonition.html type="info" content="
See the [Configuration](reference-configuration.md#broker) page for a full listing of broker-specific configuration parameters.
" %}
> See the [Configuration](reference-configuration.md#broker) page for a full listing of broker-specific configuration parameters.
## Brokers resources

Expand Down
13 changes: 7 additions & 6 deletions site2/docs/admin-api-clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ New clusters can be provisioned using the admin interface.

> Please note that this operation requires superuser privileges.
{% include message.html id="superuser" %}

#### pulsar-admin

You can provision a new cluster using the [`create`](reference-pulsar-admin.md#clusters-create) subcommand. Here's an example:
Expand Down Expand Up @@ -62,9 +60,12 @@ When provision a new cluster, you need to initialize that cluster's [metadata](g

You must initialize cluster metadata *before* starting up any [brokers](admin-api-brokers.md) that will belong to the cluster.

{% include admonition.html type="warning" title="No cluster metadata initialization through the REST API or the Java admin API" content='
Unlike most other admin functions in Pulsar, cluster metadata initialization cannot be performed via the admin REST API or the admin Java client, as metadata initialization involves communicating with ZooKeeper directly. Instead, you can use the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool, in particular the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command.
' %}
> #### No cluster metadata initialization through the REST API or the Java admin API
>
> Unlike most other admin functions in Pulsar, cluster metadata initialization cannot be performed via the admin REST API
> or the admin Java client, as metadata initialization involves communicating with ZooKeeper directly.
> Instead, you can use the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool, in particular
> the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command.
Here's an example cluster metadata initialization command:

Expand All @@ -79,7 +80,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](administration-auth.md#tls-client-auth) in your instance.
You'll need to use `--*-tls` flags only if you're using [TLS authentication](security-tls.md) in your instance.

### Get configuration

Expand Down
4 changes: 3 additions & 1 deletion site2/docs/admin-api-non-persistent-topics.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ persisting messages.

In all of the instructions and commands below, the topic name structure is:

{% include topic.html ten="tenant" n="namespace" t="topic" %}
```shell
persistent://tenant/namespace/topic
```

## Non-persistent topics resources

Expand Down
20 changes: 12 additions & 8 deletions site2/docs/admin-api-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,25 @@ Full documentation for this tool can be found in the [Pulsar command-line tools]
> #### The REST API is the admin interface
> Under the hood, both the `pulsar-admin` CLI tool and the Java client both use the REST API. If you’d like to implement your own admin interface client, you should use the REST API as well. Full documentation can be found here.
{% include message.html id="admin_rest_api" %}

In this document, examples from each of the three available interfaces will be shown.

## Admin setup

{% include explanations/admin-setup.md %}

Each of Pulsar's three admin interfaces---the [`pulsar-admin`](reference-pulsar-admin.md) CLI tool, the [Java admin API](/api/admin), and the [REST API](reference-rest-api.md)---requires some special setup if you have [authentication](administration-auth.md#authentication-providers) enabled in your Pulsar {% popover instance %}.
Each of Pulsar's three admin interfaces---the [`pulsar-admin`](reference-pulsar-admin.md) CLI tool, the [Java admin API](/api/admin), and the [REST API](reference-rest-api.md)---requires some special setup if you have [authentication](security-overview.md#authentication-providers) enabled in your Pulsar {% popover instance %}.

### pulsar-admin

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

{% include config.html id="client" %}
If you have [authentication](security-overview.md#authentication-providers) enabled, you will need to provide an auth configuration to use the [`pulsar-admin`](reference-pulsar-admin.md) tool. By default, the configuration for the `pulsar-admin` tool is found in the [`conf/client.conf`](reference-configuration.md#client) file. Here are the available parameters:

|Name|Description|Default|
|----|-----------|-------|
|webServiceUrl|The web URL for the cluster.|http://localhost:8080/|
|brokerServiceUrl|The Pulsar protocol URL for the cluster.|pulsar://localhost:6650/|
|authPlugin|The authentication plugin.| |
|authParams|The authentication parameters for the cluster, as a comma-separated string.| |
|useTls|Whether or not TLS authentication will be enforced in the cluster.|false|
|tlsAllowInsecureConnection|Accept untrusted TLS certificate from client.|false|
|tlsTrustCertsFilePath|Path for the trusted TLS certificate file.| |

### REST API

Expand Down
5 changes: 4 additions & 1 deletion site2/docs/admin-api-persistent-topics.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ Persistent helps to access topic which is a logical endpoint for publishing and

In all of the instructions and commands below, the topic name structure is:

{% include topic.html ten="tenant" n="namespace" t="topic" %}

```shell
persistent://tenant/namespace/topic
```

## Persistent topics resources

Expand Down
Loading

0 comments on commit 1632708

Please sign in to comment.