Skip to content

Commit

Permalink
persistence/redis: add how-to for deletion
Browse files Browse the repository at this point in the history
  • Loading branch information
tronghn committed Nov 11, 2024
1 parent a3b4818 commit 048b171
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/persistence/redis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@ for caching.
:dart: [Create Redis via Application](how-to/create-application.md)

:dart: [Create Redis as a standalone instance](how-to/create-explicit.md).

:dart: [Delete Redis](how-to/delete.md)
56 changes: 56 additions & 0 deletions docs/persistence/redis/how-to/delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
tags: [redis, how-to]
---

# Delete Redis

This page guides you through the steps required to delete a Redis instance.

## Prerequisites

- [You are a member of a NAIS team](../../../explanations/team.md)
- [You have set up command-line access](../../../operate/how-to/command-line-access.md)

## Steps

Before you delete a Redis instance, ensure that no applications are using it.
If you delete a Redis instance in use, the applications will lose access to the data stored in the instance.

### List Redis instances

To list all Redis instances belonging to your team:

1. Open [NAIS Console](https://console.<<tenant()>>.cloud.nais.io) in your browser and select your team.
2. Select the `Redis` tab
3. Find the name of the Redis instance you want to delete

### Disable termination protection

Before your can delete a specific Redis instance, you must first disable termination protection.

To disable termination protection, run the following command:

```shell
kubectl patch redis <REDIS-NAME> \
--type json \
-p='[{"op": "replace", "path": "/spec/terminationProtection", "value": false}]'
```

### Delete Redis instance

To delete the Redis instance, run the following command:

```shell
kubectl delete redis <REDIS-NAME>
```

### Remove references from application manifests

Ensure that all references to the Redis instance are removed from your application manifests:

```diff title="app.yaml"
spec:
- redis:
- - instance: <REDIS-INSTANCE-NAME>
- access: <ACCESS-LEVEL>
```

0 comments on commit 048b171

Please sign in to comment.