nixos/hbase: add examples for options

This commit is contained in:
illustris 2023-03-02 15:03:10 +05:30
parent 1035e52191
commit 653d1f0534
No known key found for this signature in database
GPG Key ID: 56C8FC0B899FEFA3

View File

@ -24,12 +24,18 @@ let
extraFlags = mkOption {
type = with types; listOf str;
default = [];
example = literalExpression ''[ "--backup" ]'';
description = mdDoc "Extra flags for the ${name} service.";
};
environment = mkOption {
type = with types; attrsOf str;
default = {};
example = literalExpression ''
{
HBASE_MASTER_OPTS = "-Dcom.sun.management.jmxremote.ssl=true";
}
'';
description = mdDoc "Environment variables passed to ${name}.";
};
} // extraOpts;
@ -107,6 +113,10 @@ in
default = {};
type = with types; attrsOf anything;
example = literalExpression ''
{
"hbase.hregion.max.filesize" = 20*1024*1024*1024;
"hbase.table.normalization.enabled" = "true";
}
'';
description = mdDoc ''
Additional options and overrides for hbase-site.xml