Skip to content

Commit

Permalink
Merge pull request #500 from Qovery/chore/updates_2025_01_02
Browse files Browse the repository at this point in the history
Add cluster lock CLI command
  • Loading branch information
jul-dan authored Jan 2, 2025
2 parents 40d7920 + 9130ee6 commit 765180d
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 1 deletion.
28 changes: 27 additions & 1 deletion website/docs/using-qovery/interface/cli.md
Original file line number Diff line number Diff line change
@@ -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)
---
Expand Down Expand Up @@ -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.
Expand Down
26 changes: 26 additions & 0 deletions website/docs/using-qovery/interface/cli.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 765180d

Please sign in to comment.