Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/subpop/vm
a command line utility that provides a high-level interface to create and manage virtual machines
https://github.com/subpop/vm
golang libvirt management snapshot virsh
Last synced: about 2 months ago
JSON representation
a command line utility that provides a high-level interface to create and manage virtual machines
- Host: GitHub
- URL: https://github.com/subpop/vm
- Owner: subpop
- License: mit
- Created: 2019-10-04T19:38:34.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-06T16:31:16.000Z (8 months ago)
- Last Synced: 2024-06-20T12:07:31.732Z (7 months ago)
- Topics: golang, libvirt, management, snapshot, virsh
- Language: Go
- Homepage:
- Size: 115 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# About #
`vm` is a command line utility that provides a high-level interface to create
and manage virtual machines through libvirt.
It supports creation and deletion of domains and snapshots, connecting to serial
and SSH terminals, downloading and converting templates from vagrantup.com and
builder.libguestfs.org, and importing locally downloading images.
# Installation #
```bash
go get -u github.com/subpop/vm/cmd/vm
```
# Distribution #
`vm` includes a `Makefile` to aid distributions in packaging. The default target
will build `vm` along with shell completion data and a man page. The `Makefile`
includes an `install` target to install the binary and data into distribution-appropriate
locations. To override the installation directory (commonly referred to as the
`DESTDIR`), set the `DESTDIR` variable when running the `install` target:
```bash
[link@localhost vm]$ make
go build ./cmd/vm
go run ./cmd/vm --generate-fish-completion > vm.fish
go run ./cmd/vm --generate-bash-completion > vm.bash
go run ./cmd/vm --generate-man-page > vm.1
gzip -k vm.1
[link@localhost vm]$ make DESTDIR=_inst install
install -D -m755 -t _inst//usr/local/bin vm
install -D -m644 -t _inst//usr/local/share/man/man1 vm.1.gz
install -D -m644 -t _inst//usr/local/share/fish/completions vm.fish
install -d _inst//usr/local/share/bash-completion/completions
install -m644 -T vm.bash _inst//usr/local/share/bash-completion/completions/vm
[link@localhost vm]$
```
# Usage #
Download a base image:
```bash
vm image get https://dl.fedoraproject.org/pub/fedora/linux/releases/31/Cloud/x86_64/images/Fedora-Cloud-Base-31-1.9.x86_64.qcow2
```
Download and convert a Vagrant ".box":
```bash
vm image get https://dl.fedoraproject.org/pub/fedora/linux/releases/31/Cloud/x86_64/images/Fedora-Cloud-Base-Vagrant-31-1.9.x86_64.vagrant-libvirt.box
```
Create a domain backed by that image:
```bash
vm create Fedora-Cloud-Base-31-1.9.x86_64 --name my-f31
```
Create a domain without defining it:
```bash
vm create Fedora-Cloud-Base-31-1.9.x86_64 --transient
```
List active domains:
```bash
vm list
```
Start a created domain:
```bash
vm up my-f31
```
Connect to an existing domain over SSH:
```bash
vm connect -m ssh -u vagrant my-f31 -i ~/.ssh/cloud_user_rsa
```
Connect to an existing domain over VirtIO PTY:
```bash
vm connect -m console my-f31
```
Take a snapshot:
```bash
vm snapshot create my-f31 --name fresh_install
```
Revert to snapshot:
```bash
vm snapshot revert my-f31 --snapshot fresh_install
```