davidradl commented on code in PR #26107:
URL: https://github.com/apache/flink/pull/26107#discussion_r1945007505


##########
docs/layouts/shortcodes/generated/forst_configuration.html:
##########
@@ -0,0 +1,120 @@
+<table class="configuration table table-bordered">
+    <thead>
+        <tr>
+            <th class="text-left" style="width: 20%">Key</th>
+            <th class="text-left" style="width: 15%">Default</th>
+            <th class="text-left" style="width: 10%">Type</th>
+            <th class="text-left" style="width: 55%">Description</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td><h5>state.backend.forst.cache.dir</h5></td>
+            <td style="word-wrap: break-word;">(none)</td>
+            <td>String</td>
+            <td>The directory where ForSt caches its SST files, fallback to 
state.backend.forst.local-dir/cache if not configured.</td>
+        </tr>
+        <tr>
+            <td><h5>state.backend.forst.cache.reserve-size</h5></td>
+            <td style="word-wrap: break-word;">-1</td>
+            <td>Long</td>
+            <td>The reserved size of cache, when set to a positive number, 
dynamic space checking will be leveraged. This option and the 
state.backend.forst.cache.size-based-limitoption can be set simultaneously, the 
smaller cache limit will be used as the upper limit.</td>
+        </tr>
+        <tr>
+            <td><h5>state.backend.forst.cache.size-based-limit</h5></td>
+            <td style="word-wrap: break-word;">-1</td>
+            <td>Long</td>
+            <td>The size-based capacity limit of cache, a non-positive number 
indicates that there is no limit.</td>
+        </tr>
+        <tr>
+            <td><h5>state.backend.forst.executor.inline-coordinator</h5></td>
+            <td style="word-wrap: break-word;">false</td>
+            <td>Boolean</td>
+            <td>Whether to let the task thread be the coordinator thread 
responsible for distributing requests.</td>
+        </tr>
+        <tr>
+            <td><h5>state.backend.forst.executor.inline-write</h5></td>
+            <td style="word-wrap: break-word;">true</td>
+            <td>Boolean</td>
+            <td>Whether to let write requests executed within the coordinator 
thread.</td>
+        </tr>
+        <tr>
+            <td><h5>state.backend.forst.executor.read-io-parallelism</h5></td>
+            <td style="word-wrap: break-word;">3</td>
+            <td>Integer</td>
+            <td>The number of threads used for read IO operations in the 
executor.</td>
+        </tr>
+        <tr>
+            <td><h5>state.backend.forst.executor.write-io-parallelism</h5></td>
+            <td style="word-wrap: break-word;">1</td>
+            <td>Integer</td>
+            <td>The number of threads used for write IO operations in the 
executor. Only valid when 'state.backend.forst.executor.inline-write' is 
false.</td>
+        </tr>
+        <tr>
+            <td><h5>state.backend.forst.local-dir</h5></td>
+            <td style="word-wrap: break-word;">(none)</td>
+            <td>String</td>
+            <td>The local directory (on the TaskManager) where ForSt puts some 
meta files. Per default, it will be &lt;WORKING_DIR&gt;/tmp. See <code 
class="highlighter-rouge">process.taskmanager.working-dir</code> for more 
details.</td>
+        </tr>
+        <tr>
+            <td><h5>state.backend.forst.memory.fixed-per-slot</h5></td>
+            <td style="word-wrap: break-word;">(none)</td>
+            <td>MemorySize</td>
+            <td>The fixed total amount of memory, shared among all ForSt 
instances per slot. This option overrides the 
'state.backend.forst.memory.managed' option when configured.</td>
+        </tr>
+        <tr>
+            <td><h5>state.backend.forst.memory.fixed-per-tm</h5></td>
+            <td style="word-wrap: break-word;">(none)</td>
+            <td>MemorySize</td>
+            <td>The fixed total amount of memory, shared among all ForSt 
instances per Task Manager (cluster-level option). This option only takes 
effect if neither 'state.backend.forst.memory.managed' nor 
'state.backend.forst.memory.fixed-per-slot' are not configured. If none is 
configured then each ForSt column family state has its own memory caches (as 
controlled by the column family options). The relevant options for the shared 
resources (e.g. write-buffer-ratio) can be set on the same level 
(config.yaml).Note, that this feature breaks resource isolation between the 
slots</td>
+        </tr>
+        <tr>
+            <td><h5>state.backend.forst.memory.high-prio-pool-ratio</h5></td>
+            <td style="word-wrap: break-word;">0.1</td>
+            <td>Double</td>
+            <td>The fraction of cache memory that is reserved for 
high-priority data like index, filter, and compression dictionary blocks. This 
option only has an effect when 'state.backend.forst.memory.managed' or 
'state.backend.forst.memory.fixed-per-slot' are configured.</td>

Review Comment:
   I assume the valid values are between 0 and 1. what does 0 and 1 mean? 
Should 0 and 1 not be used?



-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to