You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@accumulo.apache.org by GitBox <gi...@apache.org> on 2021/07/06 14:54:31 UTC
[GitHub] [accumulo] foster33 opened a new pull request #2190: Add since information to properties
foster33 opened a new pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190
Fixes #1117
In this PR the following has been added:
- A new enum constructor parameter in `Property.java` that provides `since` information about when the property was first introduced
- Updated the information provided in `server-properties.md`
- Added `deprecated since` information where applicable
- Added `replaced by` information where applicable
- Added `available since` information where applicable
- Provided all existing properties with their `availableSince` information
- Removed redundant information within existing property descriptions that are now found elsewhere
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] Manno15 commented on a change in pull request #2190: Add since information to properties
Posted by GitBox <gi...@apache.org>.
Manno15 commented on a change in pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190#discussion_r664665315
##########
File path: core/src/main/java/org/apache/accumulo/core/conf/Property.java
##########
@@ -49,49 +49,56 @@
// across all nodes in an instance)
RPC_PREFIX("rpc.", null, PropertyType.PREFIX,
"Properties in this category related to the configuration of SSL keys for"
- + " RPC. See also instance.ssl.enabled"),
+ + " RPC. See also instance.ssl.enabled",
+ "1.6.0"),
RPC_SSL_KEYSTORE_PATH("rpc.javax.net.ssl.keyStore", "", PropertyType.PATH,
- "Path of the keystore file for the server's private SSL key"),
+ "Path of the keystore file for the server's private SSL key", "1.6.0"),
@Sensitive
RPC_SSL_KEYSTORE_PASSWORD("rpc.javax.net.ssl.keyStorePassword", "", PropertyType.STRING,
"Password used to encrypt the SSL private keystore. "
- + "Leave blank to use the Accumulo instance secret"),
+ + "Leave blank to use the Accumulo instance secret",
+ "1.6.0"),
RPC_SSL_KEYSTORE_TYPE("rpc.javax.net.ssl.keyStoreType", "jks", PropertyType.STRING,
- "Type of SSL keystore"),
+ "Type of SSL keystore", "1.6.0"),
RPC_SSL_TRUSTSTORE_PATH("rpc.javax.net.ssl.trustStore", "", PropertyType.PATH,
- "Path of the truststore file for the root cert"),
+ "Path of the truststore file for the root cert", "1.6.0"),
@Sensitive
RPC_SSL_TRUSTSTORE_PASSWORD("rpc.javax.net.ssl.trustStorePassword", "", PropertyType.STRING,
- "Password used to encrypt the SSL truststore. Leave blank to use no password"),
+ "Password used to encrypt the SSL truststore. Leave blank to use no password", "1.6.0"),
RPC_SSL_TRUSTSTORE_TYPE("rpc.javax.net.ssl.trustStoreType", "jks", PropertyType.STRING,
- "Type of SSL truststore"),
+ "Type of SSL truststore", "1.6.0"),
RPC_USE_JSSE("rpc.useJsse", "false", PropertyType.BOOLEAN,
"Use JSSE system properties to configure SSL rather than the " + RPC_PREFIX.getKey()
- + "javax.net.ssl.* Accumulo properties"),
+ + "javax.net.ssl.* Accumulo properties",
+ "1.6.0"),
RPC_SSL_CIPHER_SUITES("rpc.ssl.cipher.suites", "", PropertyType.STRING,
- "Comma separated list of cipher suites that can be used by accepted connections"),
+ "Comma separated list of cipher suites that can be used by accepted connections", "1.6.1"),
RPC_SSL_ENABLED_PROTOCOLS("rpc.ssl.server.enabled.protocols", "TLSv1.2", PropertyType.STRING,
- "Comma separated list of protocols that can be used to accept connections"),
+ "Comma separated list of protocols that can be used to accept connections", "1.6.2"),
RPC_SSL_CLIENT_PROTOCOL("rpc.ssl.client.protocol", "TLSv1.2", PropertyType.STRING,
"The protocol used to connect to a secure server, must be in the list of enabled protocols "
- + "on the server side (rpc.ssl.server.enabled.protocols)"),
+ + "on the server side (rpc.ssl.server.enabled.protocols)",
+ "1.6.2"),
/**
* @since 1.7.0
Review comment:
This comment is probably unnecessary now with the since info below.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] DomGarguilo commented on pull request #2190: Add since information to properties
Posted by GitBox <gi...@apache.org>.
DomGarguilo commented on pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190#issuecomment-878586928
I'm almost done double checking the since tags. Should be finished early tomorrow.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] foster33 commented on pull request #2190: Add since information to properties
Posted by GitBox <gi...@apache.org>.
foster33 commented on pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190#issuecomment-875531840
> Code changes look good to me, though I did not check if the since dates were accurate or not.
I did make some decisions on some versions that the properties have. For example, for the `manager` properties, I decided to use the version number of the property before the name change. I thought this would be more useful than simply putting 2.1.0 for all of them. If this was wrong to think let me know and I can go back through them and change the version number.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] DomGarguilo edited a comment on pull request #2190: Add since information to properties
Posted by GitBox <gi...@apache.org>.
DomGarguilo edited a comment on pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190#issuecomment-879076708
I went through and double checked that the correct since tags were present. Below are my findings. Please double check what I found before making changes.
MANAGER_RECOVERY_DELAY seen at 1.5.0 2db5ce6186e32c451328154b024951cc5090505f originally 'MASTER_RECOVERY_DELAY'
GENERAL_KERBEROS_RENEWAL_PERIOD marked 1.6.5 seen at 1.7.1 3aa9d307d7405d8d98c02dcc11c94cfe07ea2a14
TSERV_UPDATE_SESSION_MAXIDLE marked 1.6.6 seen at 1.6.5 46ad8368e160c56c03571b467f8ae603c50992f6
TABLE_FILE_SUMMARY_MAX_SIZE marked at 1.4.0 seen at 2.0.0 94cdcc4d3f0a8ccf95894f206cb71e6117f4e51d
MANAGER_RENAME_THREADS marked as 1.8.0 seen at 1.7.0 5cbcffbb4ce08325af6451eb2941ece6c3886598
MANAGER_BULK_THREADPOOL_TIMEOUT marked 1.4.3 seen at (2.1.0?) 352d2cd050411233148fd476531d93297b98d308 originally 'MASTER_BULK_THREADPOOL_ALLOW_TIMEOUT'
TSERV_UPDATE_SESSION_MAXIDLE marked 1.6.6 seen at 1.6.5 46ad8368e160c56c03571b467f8ae603c50992f6
TSERV_MINTHREADS_TIMEOUT marked 1.4.3 seen at 2.1.0? 352d2cd050411233148fd476531d93297b98d308 originally 'MASTER_MINTHREADS_ALLOW_TIMEOUT'
TABLE_FILE_SUMMARY_MAX_SIZE marked 1.4.0 seen at 2.0.0 94cdcc4d3f0a8ccf95894f206cb71e6117f4e51d
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] foster33 commented on pull request #2190: Add since information to properties
Posted by GitBox <gi...@apache.org>.
foster33 commented on pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190#issuecomment-875813442
Here is an example of what some of the changes may look like.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] DomGarguilo commented on pull request #2190: Add since information to properties
Posted by GitBox <gi...@apache.org>.
DomGarguilo commented on pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190#issuecomment-879119574
> GENERAL_KERBEROS_RENEWAL_PERIOD -- found in rel/1.6.5 not 1.7.1
> MANAGER_RENAME_THREADS -- we are both incorrect. After looking into it further, it was first seen in 2.1.0
Looks like you are correct here.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] foster33 commented on pull request #2190: Add since information to properties
Posted by GitBox <gi...@apache.org>.
foster33 commented on pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190#issuecomment-875797179
I had also thought of another addition that may be useful. When it mentions that a property is "replaced by X" it may be useful to link to the property that is replacing the old one. I went ahead and made the changes for this and will wait for feedback as to if this would be useful / if I made the changes correctly.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] DomGarguilo commented on pull request #2190: Add since information to properties
Posted by GitBox <gi...@apache.org>.
DomGarguilo commented on pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190#issuecomment-879076708
I went through and double checked that the correct since tags were present. Below are my findings. Please double check what I found before making changes.
MASTER_RECOVERY_DELAY seen at 1.5.0 2db5ce6186e32c451328154b024951cc5090505f
GENERAL_KERBEROS_RENEWAL_PERIOD marked 1.6.5 seen at 1.7.1 3aa9d307d7405d8d98c02dcc11c94cfe07ea2a14
TSERV_UPDATE_SESSION_MAXIDLE marked 1.6.6 seen at 1.6.5 46ad8368e160c56c03571b467f8ae603c50992f6
TABLE_FILE_SUMMARY_MAX_SIZE marked at 1.4.0 seen at 2.0.0 94cdcc4d3f0a8ccf95894f206cb71e6117f4e51d
MANAGER_RENAME_THREADS marked as 1.8.0 seen at 1.7.0 5cbcffbb4ce08325af6451eb2941ece6c3886598
MANAGER_BULK_THREADPOOL_TIMEOUT marked 1.4.3 seen at (2.1.0?) 352d2cd050411233148fd476531d93297b98d308 originally 'MASTER_BULK_THREADPOOL_ALLOW_TIMEOUT'
TSERV_UPDATE_SESSION_MAXIDLE marked 1.6.6 seen at 1.6.5 46ad8368e160c56c03571b467f8ae603c50992f6
TSERV_MINTHREADS_TIMEOUT marked 1.4.3 seen at 2.1.0? 352d2cd050411233148fd476531d93297b98d308 originally 'MASTER_MINTHREADS_ALLOW_TIMEOUT'
TABLE_FILE_SUMMARY_MAX_SIZE marked 1.4.0 seen at 2.0.0 94cdcc4d3f0a8ccf95894f206cb71e6117f4e51d
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] ctubbsii commented on a change in pull request #2190: Add since information to properties
Posted by GitBox <gi...@apache.org>.
ctubbsii commented on a change in pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190#discussion_r665658539
##########
File path: core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java
##########
@@ -80,16 +80,28 @@ void prefixSection(Property prefix) {
+ prefix.getKey() + "*** | ");
doc.print(prefix.isExperimental() ? "**Experimental.** " : "");
doc.println(
- (depr ? "**Deprecated.** " : "") + strike(sanitize(prefix.getDescription()), depr) + " |");
+ (depr
+ ? "**Deprecated since " + prefix.deprecatedSince() + ".** "
+ + (prefix.isReplaced() ? "**Replaced by " + "<a href=\"#"
+ + prefix.replacedBy().getKey().replace(".", "_") + "prefix\">"
+ + prefix.replacedBy() + "" + "</a>.** " : "")
+ : "**Available since " + prefix.availableSince() + ".** ")
+ + strike(sanitize(prefix.getDescription()), depr) + " |");
Review comment:
This code looks good, but I think we want to show "Available since" regardless of if it's deprecated. The above logic will only show it if it is not deprecated.
Also, can you work in line breaks (`<br>`), so that "Available since", "Deprecated since", and "Replaced by" show up on separate lines, above the description?
##########
File path: core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java
##########
@@ -80,16 +80,28 @@ void prefixSection(Property prefix) {
+ prefix.getKey() + "*** | ");
doc.print(prefix.isExperimental() ? "**Experimental.** " : "");
doc.println(
- (depr ? "**Deprecated.** " : "") + strike(sanitize(prefix.getDescription()), depr) + " |");
+ (depr
+ ? "**Deprecated since " + prefix.deprecatedSince() + ".** "
+ + (prefix.isReplaced() ? "**Replaced by " + "<a href=\"#"
+ + prefix.replacedBy().getKey().replace(".", "_") + "prefix\">"
+ + prefix.replacedBy() + "" + "</a>.** " : "")
+ : "**Available since " + prefix.availableSince() + ".** ")
+ + strike(sanitize(prefix.getDescription()), depr) + " |");
}
void property(Property prop) {
boolean depr = prop.isDeprecated();
doc.print("| <a name=\"" + prop.getKey().replace(".", "_") + "\" class=\"prop\"></a> "
+ prop.getKey() + " | ");
doc.print(prop.isExperimental() ? "**Experimental.** " : "");
- doc.print(
- (depr ? "**Deprecated.** " : "") + strike(sanitize(prop.getDescription()), depr) + "<br>");
+ doc.print((depr
+ ? "**Deprecated since " + prop.deprecatedSince() + ".** "
+ + (prop.isReplaced()
+ ? "**Replaced by " + "<a href=\"#" + prop.replacedBy().getKey().replace(".", "_")
+ + "\">" + prop.replacedBy() + "" + "</a>.** "
+ : "")
+ : "**Available since " + prop.availableSince() + ".** ")
+ + strike(sanitize(prop.getDescription()), depr) + "<br>");
Review comment:
Same comment here as above for the prefix types.
##########
File path: core/src/main/java/org/apache/accumulo/core/conf/Property.java
##########
@@ -49,49 +49,56 @@
// across all nodes in an instance)
RPC_PREFIX("rpc.", null, PropertyType.PREFIX,
"Properties in this category related to the configuration of SSL keys for"
- + " RPC. See also instance.ssl.enabled"),
+ + " RPC. See also instance.ssl.enabled",
+ "1.6.0"),
RPC_SSL_KEYSTORE_PATH("rpc.javax.net.ssl.keyStore", "", PropertyType.PATH,
- "Path of the keystore file for the server's private SSL key"),
+ "Path of the keystore file for the server's private SSL key", "1.6.0"),
@Sensitive
RPC_SSL_KEYSTORE_PASSWORD("rpc.javax.net.ssl.keyStorePassword", "", PropertyType.STRING,
"Password used to encrypt the SSL private keystore. "
- + "Leave blank to use the Accumulo instance secret"),
+ + "Leave blank to use the Accumulo instance secret",
+ "1.6.0"),
RPC_SSL_KEYSTORE_TYPE("rpc.javax.net.ssl.keyStoreType", "jks", PropertyType.STRING,
- "Type of SSL keystore"),
+ "Type of SSL keystore", "1.6.0"),
RPC_SSL_TRUSTSTORE_PATH("rpc.javax.net.ssl.trustStore", "", PropertyType.PATH,
- "Path of the truststore file for the root cert"),
+ "Path of the truststore file for the root cert", "1.6.0"),
@Sensitive
RPC_SSL_TRUSTSTORE_PASSWORD("rpc.javax.net.ssl.trustStorePassword", "", PropertyType.STRING,
- "Password used to encrypt the SSL truststore. Leave blank to use no password"),
+ "Password used to encrypt the SSL truststore. Leave blank to use no password", "1.6.0"),
RPC_SSL_TRUSTSTORE_TYPE("rpc.javax.net.ssl.trustStoreType", "jks", PropertyType.STRING,
- "Type of SSL truststore"),
+ "Type of SSL truststore", "1.6.0"),
RPC_USE_JSSE("rpc.useJsse", "false", PropertyType.BOOLEAN,
"Use JSSE system properties to configure SSL rather than the " + RPC_PREFIX.getKey()
- + "javax.net.ssl.* Accumulo properties"),
+ + "javax.net.ssl.* Accumulo properties",
+ "1.6.0"),
RPC_SSL_CIPHER_SUITES("rpc.ssl.cipher.suites", "", PropertyType.STRING,
- "Comma separated list of cipher suites that can be used by accepted connections"),
+ "Comma separated list of cipher suites that can be used by accepted connections", "1.6.1"),
RPC_SSL_ENABLED_PROTOCOLS("rpc.ssl.server.enabled.protocols", "TLSv1.2", PropertyType.STRING,
- "Comma separated list of protocols that can be used to accept connections"),
+ "Comma separated list of protocols that can be used to accept connections", "1.6.2"),
RPC_SSL_CLIENT_PROTOCOL("rpc.ssl.client.protocol", "TLSv1.2", PropertyType.STRING,
"The protocol used to connect to a secure server, must be in the list of enabled protocols "
- + "on the server side (rpc.ssl.server.enabled.protocols)"),
+ + "on the server side (rpc.ssl.server.enabled.protocols)",
+ "1.6.2"),
/**
* @since 1.7.0
Review comment:
Feel free to get rid of them.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] ctubbsii commented on pull request #2190: Add since information to properties
Posted by GitBox <gi...@apache.org>.
ctubbsii commented on pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190#issuecomment-876789996
> I had gone through each of the tags available on github starting at 1.3.5
Wow, thanks for being so thorough! The output looks nice, too. I'm going to take a look at the overall result in the generated output to see if I have any additional feedback, but as far as I can tell, this looks great! I think these will be very useful to users.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] foster33 commented on pull request #2190: Add since information to properties
Posted by GitBox <gi...@apache.org>.
foster33 commented on pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190#issuecomment-878999458
> With these additional changes, I'm ready to merge this in, but since I added two new commits, I wanted to double check back with you, to see if you're okay with these changes, or had any other proposed changes, before merging.
These changes look good to me!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] ctubbsii merged pull request #2190: Add since information to properties
Posted by GitBox <gi...@apache.org>.
ctubbsii merged pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] foster33 commented on pull request #2190: Add since information to properties
Posted by GitBox <gi...@apache.org>.
foster33 commented on pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190#issuecomment-876356001
> I haven't checked all the values for the "availableSince", and I'm curious how you populated those, but trust that they're correct. Perhaps somebody will be able to verify before merging.
I had gone through each of the tags available on github starting at 1.3.5 and continued until the current state. I looked at `Property.java` each time and compared the file to the previous version tag and would mark down the version number of any new properties.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] foster33 commented on pull request #2190: Add since information to properties
Posted by GitBox <gi...@apache.org>.
foster33 commented on pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190#issuecomment-876434997
Here is an updated example of the output after the recent commit.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] foster33 commented on pull request #2190: Add since information to properties
Posted by GitBox <gi...@apache.org>.
foster33 commented on pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190#issuecomment-879117710
> Please double check what I found before making changes.
I went through and checked your proposed corrections and everything looked good besides:
GENERAL_KERBEROS_RENEWAL_PERIOD -- found in rel/1.6.5 not 1.7.1
MANAGER_RENAME_THREADS -- we are both incorrect. After looking into it further, it was first seen in 2.1.0
I will go ahead and make these corrections in my next commit. Thank you for double checking!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] foster33 commented on a change in pull request #2190: Add since information to properties
Posted by GitBox <gi...@apache.org>.
foster33 commented on a change in pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190#discussion_r664667604
##########
File path: core/src/main/java/org/apache/accumulo/core/conf/Property.java
##########
@@ -49,49 +49,56 @@
// across all nodes in an instance)
RPC_PREFIX("rpc.", null, PropertyType.PREFIX,
"Properties in this category related to the configuration of SSL keys for"
- + " RPC. See also instance.ssl.enabled"),
+ + " RPC. See also instance.ssl.enabled",
+ "1.6.0"),
RPC_SSL_KEYSTORE_PATH("rpc.javax.net.ssl.keyStore", "", PropertyType.PATH,
- "Path of the keystore file for the server's private SSL key"),
+ "Path of the keystore file for the server's private SSL key", "1.6.0"),
@Sensitive
RPC_SSL_KEYSTORE_PASSWORD("rpc.javax.net.ssl.keyStorePassword", "", PropertyType.STRING,
"Password used to encrypt the SSL private keystore. "
- + "Leave blank to use the Accumulo instance secret"),
+ + "Leave blank to use the Accumulo instance secret",
+ "1.6.0"),
RPC_SSL_KEYSTORE_TYPE("rpc.javax.net.ssl.keyStoreType", "jks", PropertyType.STRING,
- "Type of SSL keystore"),
+ "Type of SSL keystore", "1.6.0"),
RPC_SSL_TRUSTSTORE_PATH("rpc.javax.net.ssl.trustStore", "", PropertyType.PATH,
- "Path of the truststore file for the root cert"),
+ "Path of the truststore file for the root cert", "1.6.0"),
@Sensitive
RPC_SSL_TRUSTSTORE_PASSWORD("rpc.javax.net.ssl.trustStorePassword", "", PropertyType.STRING,
- "Password used to encrypt the SSL truststore. Leave blank to use no password"),
+ "Password used to encrypt the SSL truststore. Leave blank to use no password", "1.6.0"),
RPC_SSL_TRUSTSTORE_TYPE("rpc.javax.net.ssl.trustStoreType", "jks", PropertyType.STRING,
- "Type of SSL truststore"),
+ "Type of SSL truststore", "1.6.0"),
RPC_USE_JSSE("rpc.useJsse", "false", PropertyType.BOOLEAN,
"Use JSSE system properties to configure SSL rather than the " + RPC_PREFIX.getKey()
- + "javax.net.ssl.* Accumulo properties"),
+ + "javax.net.ssl.* Accumulo properties",
+ "1.6.0"),
RPC_SSL_CIPHER_SUITES("rpc.ssl.cipher.suites", "", PropertyType.STRING,
- "Comma separated list of cipher suites that can be used by accepted connections"),
+ "Comma separated list of cipher suites that can be used by accepted connections", "1.6.1"),
RPC_SSL_ENABLED_PROTOCOLS("rpc.ssl.server.enabled.protocols", "TLSv1.2", PropertyType.STRING,
- "Comma separated list of protocols that can be used to accept connections"),
+ "Comma separated list of protocols that can be used to accept connections", "1.6.2"),
RPC_SSL_CLIENT_PROTOCOL("rpc.ssl.client.protocol", "TLSv1.2", PropertyType.STRING,
"The protocol used to connect to a secure server, must be in the list of enabled protocols "
- + "on the server side (rpc.ssl.server.enabled.protocols)"),
+ + "on the server side (rpc.ssl.server.enabled.protocols)",
+ "1.6.2"),
/**
* @since 1.7.0
Review comment:
I did notice that in a couple places. I left it alone because I did not know if it was important / useful to keep it in the javadoc. I will remove this if it is not needed anymore.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] DomGarguilo commented on a change in pull request #2190: Add since information to properties
Posted by GitBox <gi...@apache.org>.
DomGarguilo commented on a change in pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190#discussion_r665617203
##########
File path: core/src/main/java/org/apache/accumulo/core/conf/Property.java
##########
@@ -1008,183 +1149,206 @@
+ " in a subdirectory, `accumulo-vfs-cache-<jvmProcessName>-${user.name}`, where"
+ " `<jvmProcessName>` is determined by the JVM's internal management engine."
+ " The cache will keep a soft reference to all of the classes loaded in the VM."
- + " This should be on local disk on each node with sufficient space."),
+ + " This should be on local disk on each node with sufficient space.",
+ "1.5.0"),
// General properties for configuring replication
REPLICATION_PREFIX("replication.", null, PropertyType.PREFIX,
- "Properties in this category affect the replication of data to other Accumulo instances."),
+ "Properties in this category affect the replication of data to other Accumulo instances.",
+ "1.7.0"),
REPLICATION_PEERS("replication.peer.", null, PropertyType.PREFIX,
- "Properties in this category control what systems data can be replicated to"),
+ "Properties in this category control what systems data can be replicated to", "1.7.0"),
REPLICATION_PEER_USER("replication.peer.user.", null, PropertyType.PREFIX,
- "The username to provide when authenticating with the given peer"),
+ "The username to provide when authenticating with the given peer", "1.7.0"),
@Sensitive
REPLICATION_PEER_PASSWORD("replication.peer.password.", null, PropertyType.PREFIX,
- "The password to provide when authenticating with the given peer"),
+ "The password to provide when authenticating with the given peer", "1.7.0"),
REPLICATION_PEER_KEYTAB("replication.peer.keytab.", null, PropertyType.PREFIX,
- "The keytab to use when authenticating with the given peer"),
+ "The keytab to use when authenticating with the given peer", "1.7.0"),
REPLICATION_NAME("replication.name", "", PropertyType.STRING,
"Name of this cluster with respect to replication. Used to identify this"
- + " instance from other peers"),
+ + " instance from other peers",
+ "1.7.0"),
REPLICATION_MAX_WORK_QUEUE("replication.max.work.queue", "1000", PropertyType.COUNT,
- "Upper bound of the number of files queued for replication"),
+ "Upper bound of the number of files queued for replication", "1.7.0"),
REPLICATION_WORK_ASSIGNMENT_SLEEP("replication.work.assignment.sleep", "30s",
- PropertyType.TIMEDURATION, "Amount of time to sleep between replication work assignment"),
+ PropertyType.TIMEDURATION, "Amount of time to sleep between replication work assignment",
+ "1.7.0"),
REPLICATION_WORKER_THREADS("replication.worker.threads", "4", PropertyType.COUNT,
- "Size of the threadpool that each tabletserver devotes to replicating data"),
+ "Size of the threadpool that each tabletserver devotes to replicating data", "1.7.0"),
REPLICATION_RECEIPT_SERVICE_PORT("replication.receipt.service.port", "10002", PropertyType.PORT,
- "Listen port used by thrift service in tserver listening for replication"),
+ "Listen port used by thrift service in tserver listening for replication", "1.7.0"),
REPLICATION_WORK_ATTEMPTS("replication.work.attempts", "10", PropertyType.COUNT,
"Number of attempts to try to replicate some data before giving up and"
- + " letting it naturally be retried later"),
+ + " letting it naturally be retried later",
+ "1.7.0"),
REPLICATION_MIN_THREADS("replication.receiver.min.threads", "1", PropertyType.COUNT,
- "Minimum number of threads for replication"),
+ "Minimum number of threads for replication", "1.7.0"),
REPLICATION_THREADCHECK("replication.receiver.threadcheck.time", "30s", PropertyType.TIMEDURATION,
- "The time between adjustments of the replication thread pool."),
+ "The time between adjustments of the replication thread pool.", "1.7.0"),
REPLICATION_MAX_UNIT_SIZE("replication.max.unit.size", "64M", PropertyType.BYTES,
- "Maximum size of data to send in a replication message"),
+ "Maximum size of data to send in a replication message", "1.7.0"),
REPLICATION_WORK_ASSIGNER("replication.work.assigner",
"org.apache.accumulo.manager.replication.UnorderedWorkAssigner", PropertyType.CLASSNAME,
- "Replication WorkAssigner implementation to use"),
+ "Replication WorkAssigner implementation to use", "1.7.0"),
REPLICATION_DRIVER_DELAY("replication.driver.delay", "0s", PropertyType.TIMEDURATION,
- "Amount of time to wait before the replication work loop begins in the manager."),
+ "Amount of time to wait before the replication work loop begins in the manager.", "1.7.0"),
REPLICATION_WORK_PROCESSOR_DELAY("replication.work.processor.delay", "0s",
PropertyType.TIMEDURATION,
"Amount of time to wait before first checking for replication work, not"
- + " useful outside of tests"),
+ + " useful outside of tests",
+ "1.7.0"),
REPLICATION_WORK_PROCESSOR_PERIOD("replication.work.processor.period", "0s",
PropertyType.TIMEDURATION,
"Amount of time to wait before re-checking for replication work, not"
- + " useful outside of tests"),
+ + " useful outside of tests",
+ "1.7.0"),
REPLICATION_TRACE_PERCENT("replication.trace.percent", "0.1", PropertyType.FRACTION,
- "The sampling percentage to use for replication traces"),
+ "The sampling percentage to use for replication traces", "1.7.0"),
REPLICATION_RPC_TIMEOUT("replication.rpc.timeout", "2m", PropertyType.TIMEDURATION,
"Amount of time for a single replication RPC call to last before failing"
- + " the attempt. See replication.work.attempts."),
+ + " the attempt. See replication.work.attempts.",
+ "1.7.4"),
// Compactor properties
@Experimental
COMPACTOR_PREFIX("compactor.", null, PropertyType.PREFIX,
- "Properties in this category affect the behavior of the accumulo compactor server."),
+ "Properties in this category affect the behavior of the accumulo compactor server.", "2.1.0"),
@Experimental
COMPACTOR_PORTSEARCH("compactor.port.search", "false", PropertyType.BOOLEAN,
- "If the compactor.port.client is in use, search higher ports until one is available"),
+ "If the compactor.port.client is in use, search higher ports until one is available",
+ "2.1.0"),
@Experimental
COMPACTOR_CLIENTPORT("compactor.port.client", "9133", PropertyType.PORT,
- "The port used for handling client connections on the compactor servers"),
+ "The port used for handling client connections on the compactor servers", "2.1.0"),
@Experimental
COMPACTOR_MINTHREADS("compactor.threads.minimum", "1", PropertyType.COUNT,
- "The minimum number of threads to use to handle incoming requests."),
+ "The minimum number of threads to use to handle incoming requests.", "2.1.0"),
@Experimental
COMPACTOR_MINTHREADS_TIMEOUT("compactor.threads.timeout", "0s", PropertyType.TIMEDURATION,
- "The time after which incoming request threads terminate with no work available. Zero (0) will keep the threads alive indefinitely."),
+ "The time after which incoming request threads terminate with no work available. Zero (0) will keep the threads alive indefinitely.",
+ "2.1.0"),
@Experimental
COMPACTOR_THREADCHECK("compactor.threadcheck.time", "1s", PropertyType.TIMEDURATION,
- "The time between adjustments of the server thread pool."),
+ "The time between adjustments of the server thread pool.", "2.1.0"),
@Experimental
COMPACTOR_MAX_MESSAGE_SIZE("compactor.message.size.max", "10M", PropertyType.BYTES,
- "The maximum size of a message that can be sent to a tablet server."),
+ "The maximum size of a message that can be sent to a tablet server.", "2.1.0"),
// CompactionCoordinator properties
@Experimental
COMPACTION_COORDINATOR_PREFIX("compaction.coordinator.", null, PropertyType.PREFIX,
- "Properties in this category affect the behavior of the accumulo compaction coordinator server."),
+ "Properties in this category affect the behavior of the accumulo compaction coordinator server.",
+ "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_THRIFTCLIENT_PORTSEARCH("compaction.coordinator.port.search", "false",
PropertyType.BOOLEAN,
- "If the ports above are in use, search higher ports until one is available"),
+ "If the ports above are in use, search higher ports until one is available", "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_CLIENTPORT("compaction.coordinator.port.client", "9132", PropertyType.PORT,
- "The port used for handling Thrift client connections on the compaction coordinator server"),
+ "The port used for handling Thrift client connections on the compaction coordinator server",
+ "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_MINTHREADS("compaction.coordinator.threads.minimum", "1",
- PropertyType.COUNT, "The minimum number of threads to use to handle incoming requests."),
+ PropertyType.COUNT, "The minimum number of threads to use to handle incoming requests.",
+ "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_MINTHREADS_TIMEOUT("compaction.coordinator.threads.timeout", "0s",
PropertyType.TIMEDURATION,
- "The time after which incoming request threads terminate with no work available. Zero (0) will keep the threads alive indefinitely."),
+ "The time after which incoming request threads terminate with no work available. Zero (0) will keep the threads alive indefinitely.",
+ "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_THREADCHECK("compaction.coordinator.threadcheck.time", "1s",
- PropertyType.TIMEDURATION, "The time between adjustments of the server thread pool."),
+ PropertyType.TIMEDURATION, "The time between adjustments of the server thread pool.",
+ "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_MAX_MESSAGE_SIZE("compaction.coordinator.message.size.max", "10M",
- PropertyType.BYTES, "The maximum size of a message that can be sent to a tablet server."),
+ PropertyType.BYTES, "The maximum size of a message that can be sent to a tablet server.",
+ "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_DEAD_COMPACTOR_CHECK_INTERVAL(
"compaction.coordinator.compactor.dead.check.interval", "5m", PropertyType.TIMEDURATION,
- "The interval at which to check for dead compactors."),
+ "The interval at which to check for dead compactors.", "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_FINALIZER_TSERVER_NOTIFIER_MAXTHREADS(
"compaction.coordinator.compaction.finalizer.threads.maximum", "5", PropertyType.COUNT,
- "The maximum number of threads to use for notifying tablet servers that an external compaction has completed."),
+ "The maximum number of threads to use for notifying tablet servers that an external compaction has completed.",
+ "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_FINALIZER_COMPLETION_CHECK_INTERVAL(
"compaction.coordinator.compaction.finalizer.check.interval", "60s",
PropertyType.TIMEDURATION,
- "The interval at which to check for external compaction final state markers in the metadata table."),
+ "The interval at which to check for external compaction final state markers in the metadata table.",
+ "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_TSERVER_COMPACTION_CHECK_INTERVAL(
"compaction.coordinator.tserver.check.interval", "1m", PropertyType.TIMEDURATION,
- "The interval at which to check the tservers for external compactions."),
+ "The interval at which to check the tservers for external compactions.", "2.1.0"),
// deprecated properties grouped at the end to reference property that replaces them
@Deprecated(since = "1.6.0")
@ReplacedBy(property = INSTANCE_VOLUMES)
INSTANCE_DFS_URI("instance.dfs.uri", "", PropertyType.URI,
- "This property is deprecated since 1.6.0. "
- + "A url accumulo should use to connect to DFS. If this is empty, accumulo"
+ "A url accumulo should use to connect to DFS. If this is empty, accumulo"
+ " will obtain this information from the hadoop configuration. This property"
+ " will only be used when creating new files if instance.volumes is empty."
+ " After an upgrade to 1.6.0 Accumulo will start using absolute paths to"
+ " reference files. Files created before a 1.6.0 upgrade are referenced via"
+ " relative paths. Relative paths will always be resolved using this config"
- + " (if empty using the hadoop config)."),
+ + " (if empty using the hadoop config).",
+ "1.4.0"),
@Deprecated(since = "1.6.0")
@ReplacedBy(property = INSTANCE_VOLUMES)
INSTANCE_DFS_DIR("instance.dfs.dir", "/accumulo", PropertyType.ABSOLUTEPATH,
- "This property is deprecated since 1.6.0. "
- + "HDFS directory in which accumulo instance will run. "
- + "Do not change after accumulo is initialized."),
+ "HDFS directory in which accumulo instance will run. "
+ + "Do not change after accumulo is initialized.",
+ "1.3.5"),
@Deprecated(since = "2.0.0")
GENERAL_CLASSPATHS(org.apache.accumulo.start.classloader.AccumuloClassLoader.GENERAL_CLASSPATHS,
"", PropertyType.STRING,
- "This property is deprecated since 2.0.0. The class path should instead be configured"
+ "The class path should instead be configured"
+ " by the launch environment (for example, accumulo-env.sh). A list of all"
+ " of the places to look for a class. Order does matter, as it will look for"
+ " the jar starting in the first location to the last. Supports full regex"
- + " on filename alone."),
+ + " on filename alone.",
+ "1.3.5"),
@Deprecated(since = "1.7.0")
@ReplacedBy(property = TABLE_DURABILITY)
TSERV_WAL_SYNC_METHOD("tserver.wal.sync.method", "hsync", PropertyType.STRING,
- "This property is deprecated since 1.7.0. Use table.durability instead."),
+ "Use table.durability instead.", "1.5.2"),
@Deprecated(since = "1.7.0")
@ReplacedBy(property = TABLE_DURABILITY)
TABLE_WALOG_ENABLED("table.walog.enabled", "true", PropertyType.BOOLEAN,
- "This setting is deprecated since 1.7.0. Use table.durability=none instead."),
+ "Use table.durability=none instead.", "1.3.5"),
@Deprecated(since = "2.0.0")
@ReplacedBy(property = TSERV_SCAN_EXECUTORS_DEFAULT_THREADS)
TSERV_READ_AHEAD_MAXCONCURRENT("tserver.readahead.concurrent.max", "16", PropertyType.COUNT,
- "This property is deprecated since 2.0.0, use tserver.scan.executors.default.threads "
- + "instead. The maximum number of concurrent read ahead that will execute. This "
+ "The maximum number of concurrent read ahead that will execute. This "
+ "effectively limits the number of long running scans that can run concurrently "
- + "per tserver.\""),
+ + "per tserver.\"",
+ "1.3.5"),
@Deprecated(since = "2.0.0")
@ReplacedBy(property = TSERV_SCAN_EXECUTORS_META_THREADS)
TSERV_METADATA_READ_AHEAD_MAXCONCURRENT("tserver.metadata.readahead.concurrent.max", "8",
- PropertyType.COUNT,
- "This property is deprecated since 2.0.0, use tserver.scan.executors.meta.threads instead. "
- + "The maximum number of concurrent metadata read ahead that will execute.");
+ PropertyType.COUNT, "The maximum number of concurrent metadata read ahead that will execute.",
+ "1.3.5");
private final String key;
private final String defaultValue;
private final String description;
+ private final String deprecatedSince;
Review comment:
I think this is causing the test failure
```suggestion
private String deprecatedSince;
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org