summaryrefslogtreecommitdiffstats
path: root/nixos
diff options
context:
space:
mode:
authorDaniel Schaefer <git@danielschaefer.me>2019-04-26 01:13:09 +0200
committerDaniel Schaefer <git@danielschaefer.me>2019-06-13 04:36:41 +0200
commit79f7f89442d9132c35b6417187cb1567eca2b910 (patch)
tree930433e3027ffcf14d52ee80f0f36c97a3b04d71 /nixos
parent9ecd58478595dab0270c20309e0b0399711b3a0f (diff)
nixos/cassandra: Use docbook instead of markdown style
Diffstat (limited to 'nixos')
-rw-r--r--nixos/modules/services/databases/cassandra.nix13
1 files changed, 8 insertions, 5 deletions
diff --git a/nixos/modules/services/databases/cassandra.nix b/nixos/modules/services/databases/cassandra.nix
index d6071b6ee675..452691e42322 100644
--- a/nixos/modules/services/databases/cassandra.nix
+++ b/nixos/modules/services/databases/cassandra.nix
@@ -229,11 +229,11 @@ in {
example = literalExample "null";
description = ''
Set the interval how often full repairs are run, i.e.
- `nodetool repair --full` is executed. See
+ <literal>nodetool repair --full</literal> is executed. See
https://cassandra.apache.org/doc/latest/operating/repair.html
for more information.
- Set to `null` to disable full repairs.
+ Set to <literal>null</literal> to disable full repairs.
'';
};
fullRepairOptions = mkOption {
@@ -250,11 +250,11 @@ in {
example = literalExample "null";
description = ''
Set the interval how often incremental repairs are run, i.e.
- `nodetool repair` is executed. See
+ <literal>nodetool repair<literal> is executed. See
https://cassandra.apache.org/doc/latest/operating/repair.html
for more information.
- Set to `null` to disable incremental repairs.
+ Set to <literal>null</literal> to disable incremental repairs.
'';
};
incrementalRepairOptions = mkOption {
@@ -342,6 +342,8 @@ in {
description = ''
Roles that are allowed to access the JMX (e.g. nodetool)
BEWARE: The passwords will be stored world readable in the nix-store.
+ It's recommended to use your own protected file using
+ <literal>jmxRolesFile</literal>
Doesn't work in versions older than 3.11 because they don't like that
it's world readable.
@@ -388,7 +390,8 @@ in {
{ assertion = cfg.remoteJmx -> cfg.jmxRolesFile != null;
message = ''
If you want JMX available remotely you need to set a password using
- `jmxRoles` or `jmxRolesFile` if using Cassandra older than v3.11.
+ <literal>jmxRoles</literal> or <literal>jmxRolesFile</literal> if
+ using Cassandra older than v3.11.
'';
}
];