Update docs and NEWS.txt; config docs are reachable now on the website

patch by Ekaterina Dimitrova; reviewed by Caleb Rackliffe for CASSANDRA-17778
This commit is contained in:
Ekaterina Dimitrova 2022-08-11 15:31:47 -04:00
parent 590de42a06
commit 43036ecadd
4 changed files with 20 additions and 3 deletions

View File

@ -45,6 +45,7 @@ Merged from 4.0:
* Fix Setting Virtual Table - update after startup config properties gc_log_threshold_in_ms, gc_warn_threshold_in_ms,
conf.index_summary_capacity_in_mb, prepared_statements_cache_size_mb, key_cache_size_in_mb, counter_cache_size_in_mb
(CASSANDRA-17737)
* Fix Settings Virtual Table - index_summary_resize_interval and index_summary_capacity were not updated after startup (CASSANDRA-17735)
* Clean up ScheduledExecutors, CommitLog, and MessagingService shutdown for in-JVM dtests (CASSANDRA-17731)
* Remove extra write to system table for prepared statements (CASSANDRA-17764)
Merged from 3.11:

View File

@ -186,8 +186,8 @@ Upgrading
`setRepairSessionSpaceInMebibytes(int sizeInMebibytes)` and `getRepairSessionSpaceInMebibytes`. They replace the now
deprecated methods `setRepairSessionSpaceInMegabytes(int sizeInMegabytes)` and `getRepairSessionSpaceInMegabytes`, which
will be removed in a future major release.
- There is a new cassandra.yaml version 2. Units suffixes should be provided for all rates(B/s|MiB/s|KiB/s|MiB/s),
memory (KiB|MiB|GiB|B) and duration(d|h|s|ms|us|µs|ns|m)
- There is a new cassandra.yaml version 2. Units suffixes should be provided for all rates(B/s|KiB/s|MiB/s),
memory (B|KiB|MiB|GiB) and duration(d|h|m|s|ms|us|µs|ns)
parameters. List of changed parameters and details to consider during configuration setup can be
found at https://cassandra.apache.org/doc/latest/cassandra/new/configuration.html. (CASSANDRA-15234)
Backward compatibility with the old cassandra.yaml file will be in place until at least the next major version.
@ -242,7 +242,10 @@ Deprecation
deprecate getter method `getCompactionThroughputMbPerSec` in favor of getter methods `getCompactionThroughtputMibPerSecAsDouble`
and `getCompactionThroughtputBytesPerSec`; deprecate setter methods `setStreamThroughputMbPerSec` and `setStreamThroughputMbitPerSec`
in favor of `setStreamThroughputMebibytesPerSec`; deprecate setter methods `setInterDCStreamThroughputMbitPerSec` and
`setInterDCStreamThroughputMbPerSec` in favor of `setInterDCStreamThroughputMebibytesPerSec`. See CASSANDRA-17725 for further details.
`setInterDCStreamThroughputMbPerSec` in favor of `setInterDCStreamThroughputMebibytesPerSec`. The deprecated JMX methods
may return a rounded value so if precision is important, you want to use the new getters. While those deprecated JMX getters
will return a rounded number, the nodetool commands `getstreamthroughput` and `getinterdcstreamthroughput`
will throw Runtime Exceptions advising to use the new -d flag in case an integer cannot be returned. See CASSANDRA-17725 for further details.
- Deprecate public method `setRate(final double throughputMbPerSec)` in `Compaction Manager` in favor of
`setRateInBytes(final double throughputBytesPerSec)`
- `withBufferSizeInMB(int size)` in `StressCQLSSTableWriter.Builder` class is deprecated in favor of `withBufferSizeInMiB(int size)`

View File

@ -15,6 +15,15 @@ Three big things happened as part of https://issues.apache.org/jira/browse/CASSA
The community has decided to allow operators to specify units for Cassandra parameters of types duration, data storage, and data rate.
All parameters which had a particular unit (most of the time added as a suffix to their name) can be now set by using the format [value][unit]. The unit suffix has been removed from their names.
Supported units:
[cols=",",options="header",]
|===
|Parameter Type |Units Supported
|Duration | d, h, m, s, ms, us, µs, ns
|Data Storage | B, KiB, MiB, GiB
|Data Rate | B/s, MiB/s, KiB/s
|===
*Example*:
@ -188,6 +197,9 @@ Currently, if we try to use the new config for a newer version, that will be sil
the latest occasion will be the one to load in Config during Cassandra startup. In order to make upgrades as less disruptive as possible,
we continue supporting that behavior also with adding old and new names of a parameter into `cassandra.yaml`.
- Please ensure that any JMX setters/getters update the Config class properties and not some local copies. Settings Virtual Table
reports the configuration loaded at any time from the Config class.
*Example*:
If you add the following to `cassandra.yaml`:

View File

@ -9,3 +9,4 @@ This section covers the new features in Apache Cassandra 4.0.
* xref:new/messaging.adoc[Messaging]
* xref:new/streaming.adoc[Streaming]
* xref:new/transientreplication.adoc[Transient replication]
* xref:configuration/configuration.adoc[Configuration]