Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add default TTL value #9395

Merged
merged 5 commits into from
Feb 3, 2021
Merged

[docs] Add default TTL value #9395

merged 5 commits into from
Feb 3, 2021

Conversation

Jennifer88huang-zz
Copy link
Contributor

@Jennifer88huang-zz Jennifer88huang-zz commented Feb 1, 2021

Fixes #9415

Motivation

It's not clear to users whether setting ttlDurationDefaultInSeconds=0 means disabling TTL.

Modifications

Make the default setting and values much clearer

@Jennifer88huang-zz Jennifer88huang-zz self-assigned this Feb 1, 2021
@Jennifer88huang-zz Jennifer88huang-zz added area/config doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. labels Feb 1, 2021
@@ -215,7 +215,7 @@ internalListenerName|Specify the internal listener name for the broker.<br><br>*
|brokerClientTlsTrustStorePassword| TLS TrustStore password for internal client, used by the internal client to authenticate with Pulsar brokers ||
|brokerClientTlsCiphers| Specify the tls cipher the internal client will use to negotiate during TLS Handshake. (a comma-separated list of ciphers) e.g. [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]||
|brokerClientTlsProtocols|Specify the tls protocols the broker will use to negotiate during TLS handshake. (a comma-separated list of protocol names). e.g. [TLSv1.2, TLSv1.1, TLSv1] ||
|ttlDurationDefaultInSeconds| The default ttl for namespaces if ttl is not configured at namespace policies. |0|
|ttlDurationDefaultInSeconds| The default TTL for namespaces if TTL is not configured at namespace policies. TTL(time to live) is disabled by default and the value is set to `0`. |0|
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jennifer88huang should we call out that setting it to 0 is disabling TTL and the default value is 0.

Also, shall we update the documentation of other releases?

Copy link
Contributor Author

@Jennifer88huang-zz Jennifer88huang-zz Feb 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sijie you're so fast, I've just updated it to be more clear. Please check the latest update above

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we will apply changes to other versions if it should.
Usually, we update in the master and finalize the change first, and then apply the final version content to other versions. Thank you for your reminder.

@Anonymitaet
Copy link
Member

Need to update the admin doc as well?

@@ -215,7 +215,7 @@ internalListenerName|Specify the internal listener name for the broker.<br><br>*
|brokerClientTlsTrustStorePassword| TLS TrustStore password for internal client, used by the internal client to authenticate with Pulsar brokers ||
|brokerClientTlsCiphers| Specify the tls cipher the internal client will use to negotiate during TLS Handshake. (a comma-separated list of ciphers) e.g. [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]||
|brokerClientTlsProtocols|Specify the tls protocols the broker will use to negotiate during TLS handshake. (a comma-separated list of protocol names). e.g. [TLSv1.2, TLSv1.1, TLSv1] ||
|ttlDurationDefaultInSeconds| The default ttl for namespaces if ttl is not configured at namespace policies. |0|
|ttlDurationDefaultInSeconds|The default TTL(time to live) for namespaces if TTL is not configured at namespace policies. When the value is set to `0`, TTL is disabled. It is disabled by default. |0|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|ttlDurationDefaultInSeconds|The default TTL(time to live) for namespaces if TTL is not configured at namespace policies. When the value is set to `0`, TTL is disabled. It is disabled by default. |0|
|ttlDurationDefaultInSeconds|The default Time to Live (TTL) for namespaces if the TTL is not configured at namespace policies. When the value is set to `0`, TTL is disabled. By default, TTL is disabled. |0|

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Huanli-Meng Thank you for your suggestion, updated, PTAL again.

@Jennifer88huang-zz
Copy link
Contributor Author

Need to update the admin doc as well?

Thanks for your reminder. Is this written manually or generated automatically?

@Anonymitaet
Copy link
Member

Need to update the admin doc as well?

Thanks for your reminder. Is this written manually or generated automatically?

Descriptions are added manually.

@Jennifer88huang-zz
Copy link
Contributor Author

Confirmed with eng, the default value for set-message-ttl and ttlDurationDefaultInSeconds is 0. Update the default value and description for different versions.

@Jennifer88huang-zz
Copy link
Contributor Author

/pulsarbot run-failure-checks

@Jennifer88huang-zz
Copy link
Contributor Author

@sijie @codelipenghui PTAL again, thank you.

@sijie sijie merged commit 4fddb91 into apache:master Feb 3, 2021
Anonymitaet pushed a commit that referenced this pull request Feb 3, 2021
Fixes #9415 

### Motivation
It's not clear to users whether setting `ttlDurationDefaultInSeconds=0` means disabling TTL.

### Modifications
Make the default setting and values much clearer
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/config doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

What's the default value for TTL
5 participants