[yunikorn-site] branch master updated: [YUNIKORN-1500] Mark periodic state dump as deprecated (#242)

[wi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

wilfreds pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/yunikorn-site.git


The following commit(s) were added to refs/heads/master by this push:
     new e803a879d [YUNIKORN-1500] Mark periodic state dump as deprecated (#242)
e803a879d is described below

commit e803a879dde53bf773e6d08e2bdc54a9876e7ef5
Author: Craig Condit <cc...@apache.org>
AuthorDate: Wed Dec 28 14:49:10 2022 +1100

    [YUNIKORN-1500] Mark periodic state dump as deprecated (#242)
    
    Closes: #242
    
    Signed-off-by: Wilfred Spiegelenburg <wi...@apache.org>
---
 docs/api/scheduler.md           | 18 +++---------------
 docs/user_guide/queue_config.md | 11 ++---------
 2 files changed, 5 insertions(+), 24 deletions(-)

diff --git a/docs/api/scheduler.md b/docs/api/scheduler.md
index 254c91cd2..c230240fb 100644
--- a/docs/api/scheduler.md
+++ b/docs/api/scheduler.md
@@ -1454,9 +1454,9 @@ The output of this REST query can be rather large and it is a combination of tho
 
 ## Enable or disable periodic state dump
 
-Endpoint to enable a state dump to be written periodically. By default, it is 60 seconds. The output goes to a file called `yunikorn-state.txt`. In the current version, the file is located in the current working directory of Yunikorn and it is not configurable.
+Endpoint to enable a state dump to be written periodically.
 
-Trying to enable or disable this feature more than once in a row results in an error.
+**Status** : Deprecated and ignored since v1.2.0, no replacement.
 
 **URL** : `/ws/v1/periodicstatedump/{switch}/{periodSeconds}`
 
@@ -1464,22 +1464,10 @@ Trying to enable or disable this feature more than once in a row results in an e
 
 **Auth required** : NO
 
-The value `{switch}` can be either `disable` or `enable`. The `{periodSeconds}` defines how often state snapshots should be taken. It is expected to be a positive integer and only interpreted in case of `enable`.
-
 ### Success response
 
-**Code** : `200 OK`
+None
 
 ### Error response
 
 **Code**: `400 Bad Request`
-
-**Content examples**
-
-```json
-{
-    "status_code": 400,
-    "message": "required parameter enabled/disabled is missing",
-    "description": "required parameter enabled/disabled is missing"
-}
-```
diff --git a/docs/user_guide/queue_config.md b/docs/user_guide/queue_config.md
index 31a0005f2..8d2196fbf 100644
--- a/docs/user_guide/queue_config.md
+++ b/docs/user_guide/queue_config.md
@@ -62,7 +62,7 @@ The queues configuration is explained below.
 
 Optionally the following keys can be defined for a partition:
 * [placementrules](#placement-rules)
-* [statedumpfilepath](#statedump-filepath)
+* [statedumpfilepath](#statedump-filepath) (deprecated since v1.2.0)
 * [limits](#limits)
 * nodesortpolicy
 * preemption
@@ -206,18 +206,11 @@ If no rules are defined the placement manager is not started and each applicatio
 
 ### Statedump filepath
 
-The statedump filepath defines the output file for YuniKorn statedumps. It is optionally set on the partition level. If set,
-the value of this field can be either a relative (to working directory) or absolute path. YuniKorn scheduler will be unable
-to start if it does not have sufficient permissions to create the statedump file at the specified path.
+**Status** : Deprecated and ignored since v1.2.0, no replacement.
 
 ```yaml
 statedumpfilepath: <path/to/statedump/file>
 ```
-If the above key is not specified in the partition config, its value will default to `yunikorn-state.txt`. If the key is specified
-in multiple partitions, the value of its first occurrence will take precedence.
-
-The statedump file also has a fixed rotation policy. Currently, each statedump file has a capacity of 10MB and there can be a maximum
-of 10 such files. The statedump file currently being written to will always be the configured value above or default `yunikorn-state.txt`. When the file size limit is reached, the log rotator (`lumberjack`) will modify the file by prefixing it with a timestamp and create a new file with the same non-prefixed name to write statedumps to. If the maximum number of statedump files are reached, the oldest file timestamped as per the rotation policy will be deleted.
 
 ### Limits
 Limits define a set of limit objects for a partition or queue.