virt-ninja / safekeeping

Safekeeping is proof of concept backup application specifically designed to be used as reference during the development of a backup solution.

safekeeping

Overview

Safekeeping is an online backup tool for VMware vSphere. Features:

1. Generation base repository
2. Command-line Interface, Interactive mode, and batch mode.
3. Support for Virtual Machine, Improved Virtual Disk, vApp and K8s (experimental).
4. vCenter Tag support and management.
5. Archive Compression.
6. Different repository target support (AWS S3, File System, NFS and more to come).
7. Restore to a New Virtual Machine new vApp or a new Improved Virtual Disk.
8. Recovery of a Virtual Machine.
9. Support VM vApp property.
10. Support for encrypted VM and IVD.
11. Support for Storage Profile.
12. Support for VM implementing Microsoft VBS.
13. VMware Cloud on AWS and FedRamp support.
14. Kubernetes backup support.

Try it out

Prerequisites

CentOS 7.x with the following packages:

• open-vm-tools
• wget
• java-1.8.0-openjdk
• ant
• gcc
• zip
• gcc-c++

Note: Other distributions should work fine

Build

• Extract the Safekeeping source tar file
• Download the Virtual Disk Development Kit
• copy or link the VMware-vix-disklib-6.x.y-zzzzz.x86_64.tar.gz to the folder safekeeping-1.x.y/packages
• The following steps will work on most recent Linux distributions:

ant configure
ant install

Run

To run in interactive mode

safekeeping
or 
/opt/vmware/safekeeping/safekeeping

To execute a command

safekeeping <command> <options>

For example to run a backup

safekeeping backup vm:myTestVM

Help

If you are looking for help, the following configure command will display a list of help options:

safekeeping --help

Documentation

Check the wiki

Blogs Articles

Cormac Hogan Blog

Directory Contents

Directories

• vmbk
  • Virtual machine backup tool library written with Java using VMware vSphere SDK 6.7.0 U2
• vmbk-cmd
  • CLI to manage Safekeeping
• jdisklib
  • Native interface for VDDK written with C++ using VDDK library.
• jvix
  • Java wrapper for jdisklib native library
• nfs-client
  • Modified EMC NFS Java Client library
• jopt-simple
  • Modified jopt-simple parsing command line library
• support
  • Support files
• jar
  • Java jar files required by Safekeeping
• doc
  • Documentation.
• sample_scripts
  • Sample scripts to be used with Safekeeping

Files

• LICENSE.txt
  • BSD-2 License file.
• open_source_licenses.txt
  • Open source License file.
• README.md
  • This file.
• VERSION
  • Safekeeping version number

Contributing

The safekeeping project team welcomes contributions from the community. Before you start working with safekeeping, please read our Developer Certificate of Origin. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. For more detailed information, refer to CONTRIBUTING.md.

License

BSD-2 License