[DO NOT MERGE][Doc] Rename two parameters about metadatastore (ZK free) and add a comprehensive list for deprecated parameters of broker #13758

momo-jun · 2022-01-14T09:25:41Z

As per #13077, the following changes were implemented in the docs:

Add a comprehensive list of deprecated parameters under Broker configurations.
Change the following two parameter names in .md files except “puslar-perf managed-ledger zookeeperServers”.
- Replace zookeeperServers with metadataStoreUrl.
- Replace configurationStoreServers with configurationMetadataStoreUrl.
Add a prefix my- to ZK node name as well as client port number 2181.

doc

1. Add a comprehensive list of deprecated parameters under Broker configurations. 2. Change the following two parameter names in .md files except “puslar-perf managed-ledger zookeeperServers”. * Replace “zookeeperServers” with “metadataStoreUrl”. * Replace “configurationStoreServers” with “configurationMetadataStoreUrl” 3. Add “my-” prefix to ZK node name and port number 2181.

github-actions · 2022-01-14T09:49:00Z

@momo-jun:Thanks for your contribution. For this PR, do we need to update docs?
(The PR template contains info about doc, which helps others know more about the changes. Can you provide doc-related info in this and future PR descriptions? Thanks)

github-actions · 2022-01-14T09:50:00Z

@momo-jun:Thanks for providing doc info!

Anonymitaet

@momo-jun thanks for your contribution!

can you modify the PR title? It should be the summary of your PR changes, thanks
can you @ related engineers to review this PR?

Anonymitaet · 2022-01-17T02:33:19Z

site2/docs/reference-configuration.md

+|tlsEnabled|  Use `webServicePortTls` and `brokerServicePortTls` instead. |false|
+|replicationTlsEnabled| Enable TLS when talking with other clusters to replicate messages |false|
+|subscriptionKeySharedEnable|  Whether to enable the Key_Shared subscription.|true|
+|zookeeperServers|  Zookeeper quorum connection string. Use `metadataStoreUrl` instead.  ||


Suggested change

|zookeeperServers| Zookeeper quorum connection string. Use `metadataStoreUrl` instead. ||

|zookeeperServers| Zookeeper quorum connection string. Use `metadataStoreUrl` instead. |N/A|

If no default value, does it make sense to add "N/A" to tell users it does not have a default value rather than empty (tells nothing)?

Thanks Yu. Updated.

Anonymitaet · 2022-01-17T02:33:28Z

site2/docs/reference-configuration.md

+|replicationTlsEnabled| Enable TLS when talking with other clusters to replicate messages |false|
+|subscriptionKeySharedEnable|  Whether to enable the Key_Shared subscription.|true|
+|zookeeperServers|  Zookeeper quorum connection string. Use `metadataStoreUrl` instead.  ||
+|configurationStoreServers| Configuration store connection string (as a comma-separated list). Use `configurationMetadataStoreUrl` instead. ||


same comment

Thanks Yu. Updated.

momo-jun · 2022-01-17T12:56:26Z

@momo-jun thanks for your contribution!

can you modify the PR title? It should be the summary of your PR changes, thanks

can you @ related engineers to review this PR?

Thanks Yu. Will do that.

momo-jun · 2022-01-17T12:57:43Z

Hi @merlimat @nodece, can you please help review this PR for doc updates? Thanks a lot.

nodece · 2022-01-20T14:22:48Z

site2/docs/administration-proxy.md

-zookeeperServers=zk-0,zk-1,zk-2
-configurationStoreServers=zk-0:2184,zk-remote:2184
+metadataStoreUrl=my-zk-0:2181,my-zk-1:2181,my-zk-2:2181
+configurationMetadataStoreUrl=my-zk-0:2184,my-zk-remote:2184


No need to update this file.

Once #13777 will be merged to master, you can ignore this review.

Once #13777 will be merged to master, you can ignore this review.

Agree. Thanks for pointing this out.

nodece · 2022-01-20T14:28:55Z

site2/docs/functions-runtime.md

 ```Yaml
 clientAuthenticationPlugin: org.apache.pulsar.client.impl.auth.AuthenticationToken
 clientAuthenticationParameters: file:///etc/pulsar/token/admin-token.txt
-configurationStoreServers: zookeeper-cluster:2181 # auth requires a connection to zookeeper


No need to update this file.

Once #13782 will be merged to master, you can ignore this review.

Once #13782 will be merged to master, you can ignore this review.

Agree. Thanks for pointing this out.

nodece · 2022-01-20T14:31:15Z

site2/docs/functions-worker.md

 authorizationEnabled: true
 authorizationProvider: org.apache.pulsar.broker.authorization.PulsarAuthorizationProvider
-configurationStoreServers: <configuration-store-servers>
+configurationMetadataStoreUrl: <configuration-store-servers>


No need to update this file.

Once #13782 will be merged to master, you can ignore this review.

Once #13782 will be merged to master, you can ignore this review.

Agree. Thanks for pointing this out.

nodece · 2022-01-20T14:33:46Z

site2/docs/reference-configuration.md

 The [Pulsar proxy](concepts-architecture-overview.md#pulsar-proxy) can be configured in the `conf/proxy.conf` file.


 |Name|Description|Default|


This section does not need to be updated.

Once #13777 will be merged to master, you can ignore this review.

Once #13777 will be merged to master, you can ignore this review.

Agree. Thanks for pointing this out.

Anonymitaet · 2022-02-07T06:24:49Z

@momo-jun can you resolve the conflicts in this PR?

momo-jun · 2022-02-07T08:00:26Z

@momo-jun can you resolve the conflicts in this PR?

@Anonymitaet I've resolved the conflicts with PR#14081.
Hi @RobertIndie, can you pls help review the modifications? Thanks.

site2/docs/reference-configuration.md

Co-authored-by: Zike Yang <zkyang@streamnative.io>

momo-jun

Add a description to explain the replacement for subscriptionKeySharedEnable as follows.
Use subscriptionTypesEnabled instead.

site2/docs/reference-configuration.md

…omprehensive list for deprecated parameters of broker (apache#13758)

github-actions bot assigned momo-jun Jan 14, 2022

github-actions bot added doc-label-missing and removed doc-label-missing labels Jan 14, 2022

github-actions bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Jan 14, 2022

momo-jun mentioned this pull request Jan 14, 2022

Possible code changes required for #13077 #13760

Closed

sijie mentioned this pull request Jan 14, 2022

ISSUE-13760: Possible code changes required for #13077 streamnative/pulsar-archived#3568

Open

HQebupt approved these changes Jan 16, 2022

View reviewed changes

Anonymitaet reviewed Jan 17, 2022

View reviewed changes

RobertIndie mentioned this pull request Jan 17, 2022

[WebSocket] Add configuration metadata store url setting in websocket #13786

Merged

1 task

Add "N/A" for parameters without default values.

84fd157

momo-jun changed the title ~~Doc update for PR#13077~~ Rename two parameters about ZK and add a comprehensive list for deprecated parameters of broker Jan 17, 2022

Anonymitaet mentioned this pull request Jan 18, 2022

Allow to configure metadata store URL in proxy.conf #13777

Merged

3 tasks

momo-jun changed the title ~~Rename two parameters about ZK and add a comprehensive list for deprecated parameters of broker~~ Rename two parameters about metadatastore (ZK free) and add a comprehensive list for deprecated parameters of broker Jan 18, 2022

momo-jun changed the title ~~Rename two parameters about metadatastore (ZK free) and add a comprehensive list for deprecated parameters of broker~~ [Doc] Rename two parameters about metadatastore (ZK free) and add a comprehensive list for deprecated parameters of broker Jan 18, 2022

nodece reviewed Jan 20, 2022

View reviewed changes

Anonymitaet added this to the 2.10.0 milestone Jan 24, 2022

Merge branch 'master' into 2022-1-14

e5a46dd

Merge branch 'master' into 2022-1-14

f6c67c4

RobertIndie reviewed Feb 7, 2022

View reviewed changes

site2/docs/reference-configuration.md Outdated Show resolved Hide resolved

site2/docs/reference-configuration.md Outdated Show resolved Hide resolved

Update site2/docs/reference-configuration.md

d0be451

Co-authored-by: Zike Yang <zkyang@streamnative.io>

RobertIndie approved these changes Feb 8, 2022

View reviewed changes

momo-jun commented Feb 8, 2022

View reviewed changes

site2/docs/reference-configuration.md Outdated Show resolved Hide resolved

Update site2/docs/reference-configuration.md

5b3562a

Anonymitaet approved these changes Feb 8, 2022

View reviewed changes

Anonymitaet merged commit 32700c9 into apache:master Feb 8, 2022

Nicklee007 pushed a commit to Nicklee007/pulsar that referenced this pull request Apr 20, 2022

[Doc] Rename two parameters about metadatastore (ZK free) and add a c…

f2b29f3

…omprehensive list for deprecated parameters of broker (apache#13758)

	\|zookeeperServers\| Zookeeper quorum connection string. Use `metadataStoreUrl` instead. \|\|
	\|zookeeperServers\| Zookeeper quorum connection string. Use `metadataStoreUrl` instead. \|N/A\|

		The [Pulsar proxy](concepts-architecture-overview.md#pulsar-proxy) can be configured in the `conf/proxy.conf` file.


		\|Name\|Description\|Default\|

[DO NOT MERGE][Doc] Rename two parameters about metadatastore (ZK free) and add a comprehensive list for deprecated parameters of broker #13758

[DO NOT MERGE][Doc] Rename two parameters about metadatastore (ZK free) and add a comprehensive list for deprecated parameters of broker #13758

Uh oh!

Conversation

momo-jun commented Jan 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jan 14, 2022

Uh oh!

github-actions bot commented Jan 14, 2022

Uh oh!

Anonymitaet left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

momo-jun commented Jan 17, 2022

Uh oh!

momo-jun commented Jan 17, 2022

Uh oh!

nodece Jan 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nodece Jan 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Anonymitaet commented Feb 7, 2022

Uh oh!

momo-jun commented Feb 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

momo-jun left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

momo-jun commented Jan 14, 2022 •

edited

Loading

nodece Jan 20, 2022 •

edited

Loading

nodece Jan 20, 2022 •

edited

Loading

momo-jun commented Feb 7, 2022 •

edited

Loading

momo-jun left a comment •

edited

Loading