Skip to content

Commit

Permalink
fix typo follwing (apache#7170)
Browse files Browse the repository at this point in the history
fix typo: follwing => following
  • Loading branch information
jiazhai authored Jun 5, 2020
1 parent 7add930 commit 49287fa
Show file tree
Hide file tree
Showing 26 changed files with 42 additions and 42 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ public void start() {

/**
* Get current assignments
* @return a map of current assignments in the follwing format
* @return a map of current assignments in the following format
* {workerId : {FullyQualifiedInstanceId : Assignment}}
*/
public synchronized Map<String, Map<String, Assignment>> getCurrentAssignments() {
Expand Down
2 changes: 1 addition & 1 deletion site2/docs/deploy-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ id_rsa id_rsa.pub

## Create AWS resources using Terraform

To start building AWS resources with Terraform, you need to install all Terraform dependencies. Enter the follwing command:
To start building AWS resources with Terraform, you need to install all Terraform dependencies. Enter the following command:

```bash
$ terraform init
Expand Down
4 changes: 2 additions & 2 deletions site2/docs/security-athenz.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ To begin, you need to set up Athenz service access control. You need to create d

### Create the tenant domain and service

On the [tenant](reference-terminology.md#tenant) side, you need to do the follwing things:
On the [tenant](reference-terminology.md#tenant) side, you need to do the following things:

1. Create a domain, such as `shopping`
2. Generate a private/public key pair
Expand All @@ -26,7 +26,7 @@ For more specific steps involving the Athenz UI, refer to [Example Service Acces

### Create the provider domain and add the tenant service to some role members

On the provider side, you need to do the follwing things:
On the provider side, you need to do the following things:

1. Create a domain, such as `pulsar`
2. Create a role
Expand Down
2 changes: 1 addition & 1 deletion site2/docs/security-extending.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ public interface AuthenticationProvider extends Closeable {
}
```

The follwing is the example for Broker authentication plugins:
The following is the example for Broker authentication plugins:

* Mutual TLS -- https://github.com/apache/pulsar/blob/master/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/authentication/AuthenticationProviderTls.java
* Athenz -- https://github.com/apache/pulsar/blob/master/pulsar-broker-auth-athenz/src/main/java/org/apache/pulsar/broker/authentication/AuthenticationProviderAthenz.java
Expand Down
2 changes: 1 addition & 1 deletion site2/docs/security-jwt.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ is permitted to do some actions (eg: publish to a topic or consume from a topic)

A user typically gets a token string from the administrator (or some automated service).

The compact representation of a signed JWT is a string that looks like as the follwing:
The compact representation of a signed JWT is a string that looks like as the following:

```
eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJKb2UifQ.ipevRNuRP6HflG8cFKnmUPtypruRC4fb1DWtoLL62SY
Expand Down
4 changes: 2 additions & 2 deletions site2/docs/security-tls-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ Client certificates are generated using the certificate authority. Server certif

The biggest difference between client certs and server certs is that the **common name** for the client certificate is the **role token** which that client is authenticated as.

First, you need to enter the follwing command to generate the key :
First, you need to enter the following command to generate the key :

```bash
$ openssl genrsa -out admin.key.pem 2048
```

Similar to the broker, the client expects the key to be in [PKCS 8](https://en.wikipedia.org/wiki/PKCS_8) format, so you need to convert it by entering the follwing command:
Similar to the broker, the client expects the key to be in [PKCS 8](https://en.wikipedia.org/wiki/PKCS_8) format, so you need to convert it by entering the following command:

```bash
$ openssl pkcs8 -topk8 -inform PEM -outform PEM \
Expand Down
6 changes: 3 additions & 3 deletions site2/docs/security-tls-transport.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Follow the guide below to set up a certificate authority. You can also refer to

1. Create the certificate for the CA. You can use CA to sign both the broker and client certificates. This ensures that each party will trust the others. You should store CA in a very secure location (ideally completely disconnected from networks, air gapped, and fully encrypted).

2. Entering the follwing command to create a directory for your CA, and place [this openssl configuration file](https://github.com/apache/pulsar/tree/master/site2/website/static/examples/openssl.cnf) in the directory. You may want to modify the default answers for company name and department in the configuration file. Export the location of the CA directory to the environment variable, CA_HOME. The configuration file uses this environment variable to find the rest of the files and directories that the CA needs.
2. Entering the following command to create a directory for your CA, and place [this openssl configuration file](https://github.com/apache/pulsar/tree/master/site2/website/static/examples/openssl.cnf) in the directory. You may want to modify the default answers for company name and department in the configuration file. Export the location of the CA directory to the environment variable, CA_HOME. The configuration file uses this environment variable to find the rest of the files and directories that the CA needs.

```bash
mkdir my-ca
Expand Down Expand Up @@ -96,7 +96,7 @@ openssl pkcs8 -topk8 -inform PEM -outform PEM \
-in broker.key.pem -out broker.key-pk8.pem -nocrypt
```

2. Enter the follwing command to generate the certificate request.
2. Enter the following command to generate the certificate request.

```bash
openssl req -config openssl.cnf \
Expand Down Expand Up @@ -253,4 +253,4 @@ var client = PulsarClient.Builder()
.VerifyCertificateAuthority(true) //Default is 'true'
.VerifyCertificateName(false) //Default is 'false'
.Build();
```
```
2 changes: 1 addition & 1 deletion site2/website/versioned_docs/version-2.4.0/security-jwt.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ is permitted to do some actions (eg: publish to a topic or consume from a topic)

A user typically gets a token string from the administrator (or some automated service).

The compact representation of a signed JWT is a string that looks like as the follwing:
The compact representation of a signed JWT is a string that looks like as the following:

```
eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJKb2UifQ.ipevRNuRP6HflG8cFKnmUPtypruRC4fb1DWtoLL62SY
Expand Down
4 changes: 2 additions & 2 deletions site2/website/versioned_docs/version-2.4.1/security-athenz.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To begin, you need to set up Athenz service access control. You need to create d

### Create the tenant domain and service

On the [tenant](reference-terminology.md#tenant) side, you need to do the follwing things:
On the [tenant](reference-terminology.md#tenant) side, you need to do the following things:

1. Create a domain, such as `shopping`
2. Generate a private/public key pair
Expand All @@ -27,7 +27,7 @@ For more specific steps involving the Athenz UI, refer to [Example Service Acces

### Create the provider domain and add the tenant service to some role members

On the provider side, you need to do the follwing things:
On the provider side, you need to do the following things:

1. Create a domain, such as `pulsar`
2. Create a role
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ Client certificates are generated using the certificate authority. Server certif

The biggest difference between client certs and server certs is that the **common name** for the client certificate is the **role token** which that client is authenticated as.

First, you need to enter the follwing command to generate the key :
First, you need to enter the following command to generate the key :

```bash
$ openssl genrsa -out admin.key.pem 2048
```

Similar to the broker, the client expects the key to be in [PKCS 8](https://en.wikipedia.org/wiki/PKCS_8) format, so you need to convert it by entering the follwing command:
Similar to the broker, the client expects the key to be in [PKCS 8](https://en.wikipedia.org/wiki/PKCS_8) format, so you need to convert it by entering the following command:

```bash
$ openssl pkcs8 -topk8 -inform PEM -outform PEM \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Follow the guide below to set up a certificate authority. You can also refer to

1. Create the certificate for the CA. You can use CA to sign both the broker and client certificates. This ensures that each party will trust the others. You should store CA in a very secure location (ideally completely disconnected from networks, air gapped, and fully encrypted).

2. Entering the follwing command to create a directory for your CA, and place [this openssl configuration file](https://github.com/apache/pulsar/tree/master/site2/website/static/examples/openssl.cnf) in the directory. You may want to modify the default answers for company name and department in the configuration file. Export the location of the CA directory to the environment variable, CA_HOME. The configuration file uses this environment variable to find the rest of the files and directories that the CA needs.
2. Entering the following command to create a directory for your CA, and place [this openssl configuration file](https://github.com/apache/pulsar/tree/master/site2/website/static/examples/openssl.cnf) in the directory. You may want to modify the default answers for company name and department in the configuration file. Export the location of the CA directory to the environment variable, CA_HOME. The configuration file uses this environment variable to find the rest of the files and directories that the CA needs.

```bash
mkdir my-ca
Expand Down Expand Up @@ -95,7 +95,7 @@ openssl pkcs8 -topk8 -inform PEM -outform PEM \
-in broker.key.pem -out broker.key-pk8.pem -nocrypt
```

2. Enter the follwing command to generate the certificate request.
2. Enter the following command to generate the certificate request.

```bash
openssl req -config openssl.cnf \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ is permitted to do some actions (for example, publish messages to a topic or con

The administrator (or some automated service) typically gives a user a token string.

The compact representation of a signed JWT is a string that looks like as the follwing:
The compact representation of a signed JWT is a string that looks like as the following:

```
eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJKb2UifQ.ipevRNuRP6HflG8cFKnmUPtypruRC4fb1DWtoLL62SY
Expand Down
4 changes: 2 additions & 2 deletions site2/website/versioned_docs/version-2.4.2/security-athenz.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To begin, you need to set up Athenz service access control. You need to create d

### Create the tenant domain and service

On the [tenant](reference-terminology.md#tenant) side, you need to do the follwing things:
On the [tenant](reference-terminology.md#tenant) side, you need to do the following things:

1. Create a domain, such as `shopping`
2. Generate a private/public key pair
Expand All @@ -27,7 +27,7 @@ For more specific steps involving the Athenz UI, refer to [Example Service Acces

### Create the provider domain and add the tenant service to some role members

On the provider side, you need to do the follwing things:
On the provider side, you need to do the following things:

1. Create a domain, such as `pulsar`
2. Create a role
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ Client certificates are generated using the certificate authority. Server certif

The biggest difference between client certs and server certs is that the **common name** for the client certificate is the **role token** which that client is authenticated as.

First, you need to enter the follwing command to generate the key :
First, you need to enter the following command to generate the key :

```bash
$ openssl genrsa -out admin.key.pem 2048
```

Similar to the broker, the client expects the key to be in [PKCS 8](https://en.wikipedia.org/wiki/PKCS_8) format, so you need to convert it by entering the follwing command:
Similar to the broker, the client expects the key to be in [PKCS 8](https://en.wikipedia.org/wiki/PKCS_8) format, so you need to convert it by entering the following command:

```bash
$ openssl pkcs8 -topk8 -inform PEM -outform PEM \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Follow the guide below to set up a certificate authority. You can also refer to

1. Create the certificate for the CA. You can use CA to sign both the broker and client certificates. This ensures that each party will trust the others. You should store CA in a very secure location (ideally completely disconnected from networks, air gapped, and fully encrypted).

2. Entering the follwing command to create a directory for your CA, and place [this openssl configuration file](https://github.com/apache/pulsar/tree/master/site2/website/static/examples/openssl.cnf) in the directory. You may want to modify the default answers for company name and department in the configuration file. Export the location of the CA directory to the environment variable, CA_HOME. The configuration file uses this environment variable to find the rest of the files and directories that the CA needs.
2. Entering the following command to create a directory for your CA, and place [this openssl configuration file](https://github.com/apache/pulsar/tree/master/site2/website/static/examples/openssl.cnf) in the directory. You may want to modify the default answers for company name and department in the configuration file. Export the location of the CA directory to the environment variable, CA_HOME. The configuration file uses this environment variable to find the rest of the files and directories that the CA needs.

```bash
mkdir my-ca
Expand Down Expand Up @@ -95,7 +95,7 @@ openssl pkcs8 -topk8 -inform PEM -outform PEM \
-in broker.key.pem -out broker.key-pk8.pem -nocrypt
```

2. Enter the follwing command to generate the certificate request.
2. Enter the following command to generate the certificate request.

```bash
openssl req -config openssl.cnf \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ is permitted to do some actions (for example, publish messages to a topic or con

The administrator (or some automated service) typically gives a user a token string.

The compact representation of a signed JWT is a string that looks like as the follwing:
The compact representation of a signed JWT is a string that looks like as the following:

```
eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJKb2UifQ.ipevRNuRP6HflG8cFKnmUPtypruRC4fb1DWtoLL62SY
Expand Down
2 changes: 1 addition & 1 deletion site2/website/versioned_docs/version-2.5.0/deploy-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ id_rsa id_rsa.pub

## Create AWS resources using Terraform

To start building AWS resources with Terraform, you need to install all Terraform dependencies. Enter the follwing command:
To start building AWS resources with Terraform, you need to install all Terraform dependencies. Enter the following command:

```bash
$ terraform init
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public interface AuthenticationProvider extends Closeable {
}
```

The follwing is the example for Broker authentication plugins:
The following is the example for Broker authentication plugins:

* Mutual TLS -- https://github.com/apache/pulsar/blob/master/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/authentication/AuthenticationProviderTls.java
* Athenz -- https://github.com/apache/pulsar/blob/master/pulsar-broker-auth-athenz/src/main/java/org/apache/pulsar/broker/authentication/AuthenticationProviderAthenz.java
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ Client certificates are generated using the certificate authority. Server certif

The biggest difference between client certs and server certs is that the **common name** for the client certificate is the **role token** which that client is authenticated as.

First, you need to enter the follwing command to generate the key :
First, you need to enter the following command to generate the key :

```bash
$ openssl genrsa -out admin.key.pem 2048
```

Similar to the broker, the client expects the key to be in [PKCS 8](https://en.wikipedia.org/wiki/PKCS_8) format, so you need to convert it by entering the follwing command:
Similar to the broker, the client expects the key to be in [PKCS 8](https://en.wikipedia.org/wiki/PKCS_8) format, so you need to convert it by entering the following command:

```bash
$ openssl pkcs8 -topk8 -inform PEM -outform PEM \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Follow the guide below to set up a certificate authority. You can also refer to

1. Create the certificate for the CA. You can use CA to sign both the broker and client certificates. This ensures that each party will trust the others. You should store CA in a very secure location (ideally completely disconnected from networks, air gapped, and fully encrypted).

2. Entering the follwing command to create a directory for your CA, and place [this openssl configuration file](https://github.com/apache/pulsar/tree/master/site2/website/static/examples/openssl.cnf) in the directory. You may want to modify the default answers for company name and department in the configuration file. Export the location of the CA directory to the environment variable, CA_HOME. The configuration file uses this environment variable to find the rest of the files and directories that the CA needs.
2. Entering the following command to create a directory for your CA, and place [this openssl configuration file](https://github.com/apache/pulsar/tree/master/site2/website/static/examples/openssl.cnf) in the directory. You may want to modify the default answers for company name and department in the configuration file. Export the location of the CA directory to the environment variable, CA_HOME. The configuration file uses this environment variable to find the rest of the files and directories that the CA needs.

```bash
mkdir my-ca
Expand Down Expand Up @@ -95,7 +95,7 @@ openssl pkcs8 -topk8 -inform PEM -outform PEM \
-in broker.key.pem -out broker.key-pk8.pem -nocrypt
```

2. Enter the follwing command to generate the certificate request.
2. Enter the following command to generate the certificate request.

```bash
openssl req -config openssl.cnf \
Expand Down
2 changes: 1 addition & 1 deletion site2/website/versioned_docs/version-2.5.1/security-jwt.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ is permitted to do some actions (eg: publish to a topic or consume from a topic)

A user typically gets a token string from the administrator (or some automated service).

The compact representation of a signed JWT is a string that looks like as the follwing:
The compact representation of a signed JWT is a string that looks like as the following:

```
eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJKb2UifQ.ipevRNuRP6HflG8cFKnmUPtypruRC4fb1DWtoLL62SY
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ Client certificates are generated using the certificate authority. Server certif

The biggest difference between client certs and server certs is that the **common name** for the client certificate is the **role token** which that client is authenticated as.

First, you need to enter the follwing command to generate the key :
First, you need to enter the following command to generate the key :

```bash
$ openssl genrsa -out admin.key.pem 2048
```

Similar to the broker, the client expects the key to be in [PKCS 8](https://en.wikipedia.org/wiki/PKCS_8) format, so you need to convert it by entering the follwing command:
Similar to the broker, the client expects the key to be in [PKCS 8](https://en.wikipedia.org/wiki/PKCS_8) format, so you need to convert it by entering the following command:

```bash
$ openssl pkcs8 -topk8 -inform PEM -outform PEM \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Follow the guide below to set up a certificate authority. You can also refer to

1. Create the certificate for the CA. You can use CA to sign both the broker and client certificates. This ensures that each party will trust the others. You should store CA in a very secure location (ideally completely disconnected from networks, air gapped, and fully encrypted).

2. Entering the follwing command to create a directory for your CA, and place [this openssl configuration file](https://github.com/apache/pulsar/tree/master/site2/website/static/examples/openssl.cnf) in the directory. You may want to modify the default answers for company name and department in the configuration file. Export the location of the CA directory to the environment variable, CA_HOME. The configuration file uses this environment variable to find the rest of the files and directories that the CA needs.
2. Entering the following command to create a directory for your CA, and place [this openssl configuration file](https://github.com/apache/pulsar/tree/master/site2/website/static/examples/openssl.cnf) in the directory. You may want to modify the default answers for company name and department in the configuration file. Export the location of the CA directory to the environment variable, CA_HOME. The configuration file uses this environment variable to find the rest of the files and directories that the CA needs.

```bash
mkdir my-ca
Expand Down Expand Up @@ -97,7 +97,7 @@ openssl pkcs8 -topk8 -inform PEM -outform PEM \
-in broker.key.pem -out broker.key-pk8.pem -nocrypt
```

2. Enter the follwing command to generate the certificate request.
2. Enter the following command to generate the certificate request.

```bash
openssl req -config openssl.cnf \
Expand Down
Loading

0 comments on commit 49287fa

Please sign in to comment.