Skip to main content

Manage VM expiration and deletion

Project description

Manage VM expiration and auto-deletion in an Openstack cloud.

This project is an unofficial Openstack project, but follows Openstack projects architecture, with a Horizon plugin and associated services.

The Openstack VmExpiration Management service adds an expiration to VMs. After expiration, VM is deleted. User can extend the VM lifetime via API or Horizon. Expiration extend is not limited, user can always extend a VM, but it will be extended only for a configured duration. User cannot extend it more than configured duration. Example:

  • date A: VM is created, VM will expire at A + N days
  • some days before expiration user is notified
  • user extend VM to today + M days (M is configuration based, user cannot specify it)
  • if user tries to extend VM again, it will be extend again to today + M days


Nova notifications need to be enabled to get VM start and end messages.

Software has been tested on Pike and Otaca, and in single and multi domain configuration. It should work from Newton.


  • On VM creation, add an expiration date
  • On near-expiration date, send an email to user
  • Horizon plugin to view VM expiration and extend expiration time
  • On expiration date, delete the VM and send an email to user
  • CLI commands to extend a VM or remove expiration from a VM (admin only)


Configuration files are expected in directory /etc/os-vm-expire/ :

  • osvmexpire.conf
  • policy.json
  • osvmexpire-api-paste.ini (for wsgi server)

Main configuration file can be specified via environment variable OSVMEXPIRE_CONFIG.


Start API server

For dev (port 8000)

export OSVMEXPIRE_PORT=9411 # optional

For prod

uwsgi --master --die-on-term --emperor /etc/os-vm-expire/vassals --logto /var/log/os-vm-expire/osvmexpire-api.log --stats localhost:9314

Start worker

Manage nova notifications on instance creation and deletion to create/delete expiration objects.

osvmexpire-worker --config-file /etc/os-vm-expire/osvmexpire.conf

Start cleaner

Checks expiration time of VMs and sends notifications before expiration to let use extend the VM if necessary. Once expiration is reached (and if user could be notified of expiration), deletes the VM.

osvmexpire-cleaner --config-file /etc/os-vm-expire/osvmexpire.conf

CLI usage

Those command-line tools need access to configuration file, so are dedicated to administer the tool, not for end user.

osvmexpire-manage vm list
osvmexpire-manage vm extend -h
osvmexpire-manage vm remove -h


Code is mostly inspired (code base coming from) the Barbican Openstack project, code was more or less updated to manage different objects. This project takes the same license and kept original file headers.

This project was developed by the GenOuest core facility, IRISA, France.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for os-vm-expire, version 0.9.12
Filename, size File type Python version Upload date Hashes
Filename, size os_vm_expire-0.9.12-py2-none-any.whl (85.9 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size os_vm_expire-0.9.12-py3-none-any.whl (85.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size os-vm-expire-0.9.12.tar.gz (92.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page