Skip to content

Commit

Permalink
[improve][doc] Update some auth settings in worker service (apache#14843
Browse files Browse the repository at this point in the history
)

Master Issue: apache#7314 

### Motivation

apache#7424 has renamed some settings to make those broker-client TLS settings clearer. But some doc hasn't been updated. This PR updates these settings in the worker service. We need to update this doc in and after version 2.7.0.
### Modifications

* Replace `clientAuthenticationParameters` with `brokerClientAuthenticationParameters`
* Replace `clientAuthenticationPlugin` with `brokerClientAuthenticationPlugin`
  • Loading branch information
RobertIndie authored May 25, 2022
1 parent 6560bb0 commit edd712c
Show file tree
Hide file tree
Showing 12 changed files with 36 additions and 24 deletions.
5 changes: 3 additions & 2 deletions site2/docs/functions-worker.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,9 @@ To run function-worker separately, you have to configure the following parameter

If authentication is enabled for your broker cluster, you *should* configure the authentication plugin and parameters for the functions worker to communicate with the brokers.

- `clientAuthenticationPlugin`
- `clientAuthenticationParameters`
- `brokerClientAuthenticationEnabled`: Whether to enable the broker client authentication used by function workers to talk to brokers.
- `clientAuthenticationPlugin`: The authentication plugin to be used by the Pulsar client used in worker service.
- `clientAuthenticationParameters`: The authentication parameter to be used by the Pulsar client used in worker service.

#### Customize Java runtime options

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,9 @@ To run function-worker separately, you have to configure the following parameter

If authentication is enabled for your broker cluster, you *should* configure the authentication plugin and parameters for the functions worker to communicate with the brokers.

- `clientAuthenticationPlugin`
- `clientAuthenticationParameters`
- `brokerClientAuthenticationEnabled`: Whether to enable the broker client authentication used by function workers to talk to brokers.
- `clientAuthenticationPlugin`: The authentication plugin to be used by the Pulsar client used in worker service.
- `clientAuthenticationParameters`: The authentication parameter to be used by the Pulsar client used in worker service.

#### Security settings

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,9 @@ To run function-worker separately, you have to configure the following parameter

If authentication is enabled for your broker cluster, you *should* configure the authentication plugin and parameters for the functions worker to communicate with the brokers.

- `clientAuthenticationPlugin`
- `clientAuthenticationParameters`
- `brokerClientAuthenticationEnabled`: Whether to enable the broker client authentication used by function workers to talk to brokers.
- `clientAuthenticationPlugin`: The authentication plugin to be used by the Pulsar client used in worker service.
- `clientAuthenticationParameters`: The authentication parameter to be used by the Pulsar client used in worker service.

#### Security settings

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,9 @@ To run function-worker separately, you have to configure the following parameter

If authentication is enabled for your broker cluster, you *should* configure the authentication plugin and parameters for the functions worker to communicate with the brokers.

- `clientAuthenticationPlugin`
- `clientAuthenticationParameters`
- `brokerClientAuthenticationEnabled`: Whether to enable the broker client authentication used by function workers to talk to brokers.
- `clientAuthenticationPlugin`: The authentication plugin to be used by the Pulsar client used in worker service.
- `clientAuthenticationParameters`: The authentication parameter to be used by the Pulsar client used in worker service.

#### Security settings

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,9 @@ To run function-worker separately, you have to configure the following parameter

If authentication is enabled for your broker cluster, you *should* configure the authentication plugin and parameters for the functions worker to communicate with the brokers.

- `clientAuthenticationPlugin`
- `clientAuthenticationParameters`
- `brokerClientAuthenticationEnabled`: Whether to enable the broker client authentication used by function workers to talk to brokers.
- `clientAuthenticationPlugin`: The authentication plugin to be used by the Pulsar client used in worker service.
- `clientAuthenticationParameters`: The authentication parameter to be used by the Pulsar client used in worker service.

#### Security settings

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,9 @@ To run function-worker separately, you have to configure the following parameter

If authentication is enabled for your broker cluster, you *should* configure the authentication plugin and parameters for the functions worker to communicate with the brokers.

- `clientAuthenticationPlugin`
- `clientAuthenticationParameters`
- `brokerClientAuthenticationEnabled`: Whether to enable the broker client authentication used by function workers to talk to brokers.
- `clientAuthenticationPlugin`: The authentication plugin to be used by the Pulsar client used in worker service.
- `clientAuthenticationParameters`: The authentication parameter to be used by the Pulsar client used in worker service.

#### Security settings

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,9 @@ To run function-worker separately, you have to configure the following parameter

If authentication is enabled for your broker cluster, you *should* configure the authentication plugin and parameters for the functions worker to communicate with the brokers.

- `clientAuthenticationPlugin`
- `clientAuthenticationParameters`
- `brokerClientAuthenticationEnabled`: Whether to enable the broker client authentication used by function workers to talk to brokers.
- `clientAuthenticationPlugin`: The authentication plugin to be used by the Pulsar client used in worker service.
- `clientAuthenticationParameters`: The authentication parameter to be used by the Pulsar client used in worker service.

#### Security settings

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,9 @@ To run function-worker separately, you have to configure the following parameter

If authentication is enabled for your broker cluster, you *should* configure the authentication plugin and parameters for the functions worker to communicate with the brokers.

- `clientAuthenticationPlugin`
- `clientAuthenticationParameters`
- `brokerClientAuthenticationEnabled`: Whether to enable the broker client authentication used by function workers to talk to brokers.
- `clientAuthenticationPlugin`: The authentication plugin to be used by the Pulsar client used in worker service.
- `clientAuthenticationParameters`: The authentication parameter to be used by the Pulsar client used in worker service.

#### Security settings

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,9 @@ To run function-worker separately, you have to configure the following parameter

If authentication is enabled for your broker cluster, you *should* configure the authentication plugin and parameters for the functions worker to communicate with the brokers.

- `clientAuthenticationPlugin`
- `clientAuthenticationParameters`
- `brokerClientAuthenticationEnabled`: Whether to enable the broker client authentication used by function workers to talk to brokers.
- `clientAuthenticationPlugin`: The authentication plugin to be used by the Pulsar client used in worker service.
- `clientAuthenticationParameters`: The authentication parameter to be used by the Pulsar client used in worker service.

#### Security settings

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,9 @@ To run function-worker separately, you have to configure the following parameter

If authentication is enabled for your broker cluster, you *should* configure the authentication plugin and parameters for the functions worker to communicate with the brokers.

- `clientAuthenticationPlugin`
- `clientAuthenticationParameters`
- `brokerClientAuthenticationEnabled`: Whether to enable the broker client authentication used by function workers to talk to brokers.
- `clientAuthenticationPlugin`: The authentication plugin to be used by the Pulsar client used in worker service.
- `clientAuthenticationParameters`: The authentication parameter to be used by the Pulsar client used in worker service.

#### Security settings

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,9 @@ To run function-worker separately, you have to configure the following parameter

If authentication is enabled for your broker cluster, you *should* configure the authentication plugin and parameters for the functions worker to communicate with the brokers.

- `clientAuthenticationPlugin`
- `clientAuthenticationParameters`
- `brokerClientAuthenticationEnabled`: Whether to enable the broker client authentication used by function workers to talk to brokers.
- `clientAuthenticationPlugin`: The authentication plugin to be used by the Pulsar client used in worker service.
- `clientAuthenticationParameters`: The authentication parameter to be used by the Pulsar client used in worker service.

#### Security settings

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,9 @@ To run function-worker separately, you have to configure the following parameter

If authentication is enabled for your broker cluster, you *should* configure the authentication plugin and parameters for the functions worker to communicate with the brokers.

- `clientAuthenticationPlugin`
- `clientAuthenticationParameters`
- `brokerClientAuthenticationEnabled`: Whether to enable the broker client authentication used by function workers to talk to brokers.
- `clientAuthenticationPlugin`: The authentication plugin to be used by the Pulsar client used in worker service.
- `clientAuthenticationParameters`: The authentication parameter to be used by the Pulsar client used in worker service.

#### Security settings

Expand Down

0 comments on commit edd712c

Please sign in to comment.