SteNicholas commented on code in PR #2554:
URL: https://github.com/apache/celeborn/pull/2554#discussion_r1635781733


##########
docs/decommission.md:
##########
@@ -0,0 +1,73 @@
+---
+license: |
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements. See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License. You may obtain a copy of the License at
+    
+          https://www.apache.org/licenses/LICENSE-2.0
+    
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+---
+
+# Decommission Worker
+
+Celeborn provides support for decommissioning workers via a RESTful API, which 
enables administrators to
+efficiently manage cluster resizing and the removal of unhealthy worker nodes 
without disrupting ongoing jobs.
+
+Here's a detailed breakdown of how the decommissioning process works:
+
+- Decommissioning Request: Administrators can send a decommission request 
through the RESTful API
+to initiate the process for one or more worker nodes.
+
+- Handling New Requests: Once the decommissioning process starts, the affected 
worker nodes will no longer
+accept new shuffle slot requests or new data. This ensures that no new tasks 
are assigned to
+the workers that are set to be decommissioned.
+
+- Existing Data Handling: The worker nodes will continue to handle their 
existing shuffle partitions
+until all the partitions have expired. This mechanism ensures that current 
jobs running on these nodes
+can complete their data shuffle operations without interruption.
+
+- Worker Exit: After all existing shuffle partitions on the worker nodes have 
expired,
+the workers will gracefully exit. This ensures that the node is safely removed 
from the cluster
+without causing data loss or job failures.
+
+This decommissioning process is essential for maintaining cluster health and 
efficiency,
+as it allows for the smooth removal of unhealthy nodes and enables dynamic 
resizing of the cluster
+to meet varying workload demands.
+
+
+## Worker settings

Review Comment:
   ```suggestion
   ## Decommission Configuration
   ```



-- 
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