From 9130ee6440a5b4ee415138729dd164fbb6355f40 Mon Sep 17 00:00:00 2001
From: Julien Dan <jdan@qovery.com>
Date: Thu, 2 Jan 2025 09:55:34 +0100
Subject: [PATCH] Add cluster lock CLI command

---
 website/docs/using-qovery/interface/cli.md    | 28 ++++++++++++++++++-
 .../docs/using-qovery/interface/cli.md.erb    | 26 +++++++++++++++++
 2 files changed, 53 insertions(+), 1 deletion(-)

diff --git a/website/docs/using-qovery/interface/cli.md b/website/docs/using-qovery/interface/cli.md
index 6ec935fdb0..dc74326a87 100644
--- a/website/docs/using-qovery/interface/cli.md
+++ b/website/docs/using-qovery/interface/cli.md
@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2024-11-01"
+last_modified_on: "2025-01-02"
 title: CLI
 description: How to use the Qovery CLI (Command Line Interface)
 ---
@@ -670,6 +670,32 @@ kubectl get pods #List all pods in the default namespace
 kubectl describe pod <pod_name> #Get detailed information about a specific pod
 ```
 
+## Lock cluster updates
+
+The lock cluster command prevents any update or deployment from being initiated on a cluster while it is locked. Once a cluster is locked, no new updates can be processed until it is unlocked.
+
+**Lock cluster**
+
+```bash
+qovery cluster lock --cluster-id <your-cluster_id> --reason <reason> --ttl-in-days <days>
+```
+
+Note that the TTL can not be greater than 5 days.
+
+**Unlock cluster**
+
+```bash
+qovery cluster unlock --cluster-id <your-cluster_id>
+```
+
+**List clusters locked**
+
+You can list all the cluster locked withing an organization by running this comamnd:
+
+```bash
+qovery cluster locked --organization-id <org-id>
+```
+
 ## Managing the Deployment Pipeline
 
 In the following sections we will describe how to modify the Deployment Pipeline. 
diff --git a/website/docs/using-qovery/interface/cli.md.erb b/website/docs/using-qovery/interface/cli.md.erb
index 0b1b791403..f78d03558e 100644
--- a/website/docs/using-qovery/interface/cli.md.erb
+++ b/website/docs/using-qovery/interface/cli.md.erb
@@ -505,6 +505,32 @@ kubectl get pods #List all pods in the default namespace
 kubectl describe pod <pod_name> #Get detailed information about a specific pod
 ```
 
+## Lock cluster updates
+
+The lock cluster command prevents any update or deployment from being initiated on a cluster while it is locked. Once a cluster is locked, no new updates can be processed until it is unlocked.
+
+**Lock cluster**
+
+```bash
+qovery cluster lock --cluster-id <your-cluster_id> --reason <reason> --ttl-in-days <days>
+```
+
+Note that the TTL can not be greater than 5 days.
+
+**Unlock cluster**
+
+```bash
+qovery cluster unlock --cluster-id <your-cluster_id>
+```
+
+**List clusters locked**
+
+You can list all the cluster locked withing an organization by running this comamnd:
+
+```bash
+qovery cluster locked --organization-id <org-id>
+```
+
 ## Managing the Deployment Pipeline
 
 In the following sections we will describe how to modify the Deployment Pipeline.