cb8e9e
From 6f86287aac50f0bddb1bd64ee12031289ab08ca6 Mon Sep 17 00:00:00 2001
cb8e9e
From: Mohammed Rafi KC <rkavunga@redhat.com>
cb8e9e
Date: Tue, 12 May 2015 14:50:33 +0530
cb8e9e
Subject: [PATCH 127/129] tier/glusterd: Add description for volume set options
cb8e9e
cb8e9e
Backport of http://review.gluster.org/#/c/10757/
cb8e9e
cb8e9e
>>Change-Id: Idc2eed77f8d841b6628183867e84601ce605d610
cb8e9e
>>BUG: 1215571
cb8e9e
>>Signed-off-by: Mohammed Rafi KC <rkavunga@redhat.com>
cb8e9e
>>Signed-off-by: Joseph Fernandes <josferna@redhat.com>
cb8e9e
>>Reviewed-on: http://review.gluster.org/10757
cb8e9e
>>Tested-by: NetBSD Build System <jenkins@build.gluster.org>
cb8e9e
>>Reviewed-by: Dan Lambright <dlambrig@redhat.com>
cb8e9e
Signed-off-by: Joseph Fernandes <josferna@redhat.com>
cb8e9e
cb8e9e
Change-Id: Id25ff82bc84c4c8c60f568ecf5846930fe86bd21
cb8e9e
BUG: 1229260
cb8e9e
Reviewed-on: https://code.engineering.redhat.com/gerrit/51204
cb8e9e
Reviewed-by: Dan Lambright <dlambrig@redhat.com>
cb8e9e
Tested-by: Dan Lambright <dlambrig@redhat.com>
cb8e9e
---
cb8e9e
 xlators/mgmt/glusterd/src/glusterd-volume-set.c |   38 ++++++++++++++++++----
cb8e9e
 1 files changed, 31 insertions(+), 7 deletions(-)
cb8e9e
cb8e9e
diff --git a/xlators/mgmt/glusterd/src/glusterd-volume-set.c b/xlators/mgmt/glusterd/src/glusterd-volume-set.c
cb8e9e
index 83256c4..af26584 100644
cb8e9e
--- a/xlators/mgmt/glusterd/src/glusterd-volume-set.c
cb8e9e
+++ b/xlators/mgmt/glusterd/src/glusterd-volume-set.c
cb8e9e
@@ -1840,46 +1840,70 @@ struct volopt_map_entry glusterd_volopt_map[] = {
cb8e9e
           .option      = "write-freq-threshold",
cb8e9e
           .op_version  = GD_OP_VERSION_3_7_0,
cb8e9e
           .flags       = OPT_FLAG_CLIENT_OPT,
cb8e9e
-          .validate_fn = validate_tier
cb8e9e
+          .validate_fn = validate_tier,
cb8e9e
+          .description = "Defines the number of writes, in a promotion/demotion"
cb8e9e
+                         " cycle, that would mark a file HOT for promotion. Any"
cb8e9e
+                         " file that has write hits less than this value will "
cb8e9e
+                         "be considered as COLD and will be demoted."
cb8e9e
         },
cb8e9e
         { .key         = "cluster.read-freq-threshold",
cb8e9e
           .voltype     = "cluster/tier",
cb8e9e
           .option      = "read-freq-threshold",
cb8e9e
           .op_version  = GD_OP_VERSION_3_7_0,
cb8e9e
           .flags       = OPT_FLAG_CLIENT_OPT,
cb8e9e
-          .validate_fn = validate_tier
cb8e9e
+          .validate_fn = validate_tier,
cb8e9e
+          .description = "Defines the number of reads, in a promotion/demotion "
cb8e9e
+                         "cycle, that would mark a file HOT for promotion. Any "
cb8e9e
+                         "file that has read hits less than this value will be "
cb8e9e
+                         "considered as COLD and will be demoted."
cb8e9e
         },
cb8e9e
         { .key         = "cluster.tier-promote-frequency",
cb8e9e
           .voltype     = "cluster/tier",
cb8e9e
           .option      = "tier-promote-frequency",
cb8e9e
           .op_version  = GD_OP_VERSION_3_7_0,
cb8e9e
           .flags       = OPT_FLAG_CLIENT_OPT,
cb8e9e
-          .validate_fn = validate_tier
cb8e9e
+          .validate_fn = validate_tier,
cb8e9e
+          .description = "Defines how often the promotion should be triggered "
cb8e9e
+                         "i.e. periodicity of promotion cycles. The value is in "
cb8e9e
+                         "secs."
cb8e9e
         },
cb8e9e
         { .key         = "cluster.tier-demote-frequency",
cb8e9e
           .voltype     = "cluster/tier",
cb8e9e
           .option      = "tier-demote-frequency",
cb8e9e
           .op_version  = GD_OP_VERSION_3_7_0,
cb8e9e
           .flags       = OPT_FLAG_CLIENT_OPT,
cb8e9e
-          .validate_fn = validate_tier
cb8e9e
+          .validate_fn = validate_tier,
cb8e9e
+          .description = "Defines how often the demotion should be triggered "
cb8e9e
+                         "i.e. periodicity of demotion cycles. The value is in "
cb8e9e
+                         "secs."
cb8e9e
         },
cb8e9e
         { .key         = "features.ctr-enabled",
cb8e9e
           .voltype     = "features/changetimerecorder",
cb8e9e
           .value       = "off",
cb8e9e
           .option      = "ctr-enabled",
cb8e9e
-          .op_version  = GD_OP_VERSION_3_7_0
cb8e9e
+          .op_version  = GD_OP_VERSION_3_7_0,
cb8e9e
+          .description = "Enable CTR xlator"
cb8e9e
         },
cb8e9e
         { .key         = "features.record-counters",
cb8e9e
           .voltype     = "features/changetimerecorder",
cb8e9e
           .value       = "off",
cb8e9e
           .option      = "record-counters",
cb8e9e
-          .op_version  = GD_OP_VERSION_3_7_0
cb8e9e
+          .op_version  = GD_OP_VERSION_3_7_0,
cb8e9e
+          .description = "Its a Change Time Recorder Xlator option to enable recording write "
cb8e9e
+                         "and read heat counters. The default is disabled. "
cb8e9e
+                         "If enabled, \"cluster.write-freq-threshold\" and "
cb8e9e
+                         "\"cluster.read-freq-threshold\" defined the number "
cb8e9e
+                         "of writes (or reads) to a given file are needed "
cb8e9e
+                         "before triggering migration."
cb8e9e
         },
cb8e9e
         { .key         = "features.ctr_link_consistency",
cb8e9e
           .voltype     = "features/changetimerecorder",
cb8e9e
           .value       = "off",
cb8e9e
           .option      = "ctr_link_consistency",
cb8e9e
-          .op_version  = GD_OP_VERSION_3_7_0
cb8e9e
+          .op_version  = GD_OP_VERSION_3_7_0,
cb8e9e
+          .description = "Enable a crash consistent way of recording hardlink "
cb8e9e
+                         "updates by Change Time Recorder Xlator. When recording in a crash "
cb8e9e
+                         "consistent way the data operations will experience more latency."
cb8e9e
         },
cb8e9e
 #endif /* USE_GFDB */
cb8e9e
         { .key         = "locks.trace",
cb8e9e
-- 
cb8e9e
1.7.1
cb8e9e