Skip to content

docs: Add delete locks documentation#64

Open
JeromeJaggi wants to merge 1 commit intoprod-stagingfrom
docs/delete-locks
Open

docs: Add delete locks documentation#64
JeromeJaggi wants to merge 1 commit intoprod-stagingfrom
docs/delete-locks

Conversation

@JeromeJaggi
Copy link
Member

@JeromeJaggi JeromeJaggi commented Mar 13, 2026

Summary

Adds a new page documenting the delete locks feature for Unikraft Cloud instances and volumes.

What's included

  • Overview of what a delete lock is and what it prevents
  • How to set and remove locks via the CLI and REST API
  • Lock behaviour on service groups and volumes
  • Interaction with other platform operations (stop, autokill, cron jobs)

Source

Verified against unikraft-cloud/platform source — the lock enforcement is implemented in the HTTP API handlers and propagated through the vmdb layer.

Checklist

  • Content sourced from platform repo — no hallucination
  • No internal implementation details exposed
  • Links to related pages verified

navigation_icon: lock
---

Delete locks prevent accidental deletion of instances and volumes. When a delete lock is set on a resource, any attempt to delete it returns an error until the lock is removed.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Unikraft.NoSentenceBreaks] Only use one sentence per line.

navigation_icon: lock
---

Delete locks prevent accidental deletion of instances and volumes. When a delete lock is set on a resource, any attempt to delete it returns an error until the lock is removed.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[write-good.Passive] 'is set' may be passive voice. Use active voice if you can.

navigation_icon: lock
---

Delete locks prevent accidental deletion of instances and volumes. When a delete lock is set on a resource, any attempt to delete it returns an error until the lock is removed.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[write-good.Passive] 'is removed' may be passive voice. Use active voice if you can.

- Volumes
- Volume templates

## Enabling a Delete Lock

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Headings] 'Enabling a Delete Lock' should use sentence-style capitalization.


## Enabling a Delete Lock

Set a delete lock on an instance via the PATCH endpoint:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'PATCH' has no definition.

kraft cloud volume update <volume-name> --delete-lock
```

## Removing a Delete Lock

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Headings] 'Removing a Delete Lock' should use sentence-style capitalization.

kraft cloud volume update <volume-name> --no-delete-lock
```

## Checking the Delete Lock Status

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Headings] 'Checking the Delete Lock Status' should use sentence-style capitalization.


## Checking the Delete Lock Status

The `delete_lock` field is returned in the instance and volume status responses:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[write-good.Passive] 'is returned' may be passive voice. Use active voice if you can.

## Behaviour

- **Deletion blocked**: Any DELETE request on a locked resource returns an error.
- **Autokill skipped**: The autokill subsystem skips instances and service groups that have a delete lock set. The autokill timer does not fire while the lock is active.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.


- **Deletion blocked**: Any DELETE request on a locked resource returns an error.
- **Autokill skipped**: The autokill subsystem skips instances and service groups that have a delete lock set. The autokill timer does not fire while the lock is active.
- **Templates**: Delete locks are independently configurable on instance templates and volume templates via their respective PATCH endpoints.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'PATCH' has no definition.

Signed-off-by: Jerome Jaggi <jerome@unikraft.io>
@JeromeJaggi
Copy link
Member Author

@marcrittinghaus

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants