Skip to content

docs: Add autokill documentation#66

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

docs: Add autokill documentation#66
JeromeJaggi wants to merge 1 commit intoprod-stagingfrom
docs/autokill

Conversation

@JeromeJaggi
Copy link
Member

Summary

Adds a new page documenting the autokill feature for instances, instance templates, and service groups.

What's included

  • Kill after time (instance stopped for N ms)
  • Kill after N requests served
  • Updating autokill on a running instance
  • Service group autokill (empty for N ms)
  • Instance template autokill (not cloned within N ms)
  • Interaction with delete locks
  • Autokill inheritance when cloning from a template

Source

Verified against unikraft-cloud/platform source — autokill is implemented in the vmdb schedops layer.

navigation_icon: timer-off
---

Autokill automatically terminates instances or service groups after a specified condition is met.

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 met' may be passive voice. Use active voice if you can.

Autokill automatically terminates instances or service groups after a specified condition is met.
It helps avoid unnecessary resource usage when instances or groups are no longer needed.

Autokill can be configured on:

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] 'be configured' may be passive voice. Use active voice if you can.

It helps avoid unnecessary resource usage when instances or groups are no longer needed.

Autokill can be configured on:
- **Instances**: killed after a time or after a number of requests served

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.TooWordy] 'a number of' is too wordy.


### Kill after a time

Automatically kill an instance after it has been stopped for a given number of milliseconds:

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] 'been stopped' may be passive voice. Use active voice if you can.


This example kills the instance 1 hour after it stops.

### Kill after a number of requests

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.TooWordy] 'a number of' is too wordy.

}
```

This example kills the service group 5 minutes after its last instance 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.


## Instance template autokill

Automatically kill an instance template if it has not been cloned within a given number of milliseconds:

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 'hasn't' instead of 'has not'.


## Instance template autokill

Automatically kill an instance template if it has not been cloned within a given number of milliseconds:

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] 'been cloned' may be passive voice. Use active voice if you can.

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