Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ottomatica/node-virtualbox
📦🚀A lightweight tool/module for provisioning and configuring VirtualBox virtual machines.
https://github.com/ottomatica/node-virtualbox
nodejs vagrant virtualbox
Last synced: 2 months ago
JSON representation
📦🚀A lightweight tool/module for provisioning and configuring VirtualBox virtual machines.
- Host: GitHub
- URL: https://github.com/ottomatica/node-virtualbox
- Owner: ottomatica
- Created: 2018-07-18T20:23:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T17:13:34.000Z (about 2 years ago)
- Last Synced: 2024-11-01T07:41:27.319Z (2 months ago)
- Topics: nodejs, vagrant, virtualbox
- Language: JavaScript
- Homepage: https://getbaker.io
- Size: 409 KB
- Stars: 14
- Watchers: 4
- Forks: 1
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# node-virtualbox | [](https://david-dm.org/ottomatica/node-virtualbox)
This is a simple tool that helps provision basic VirtualBox virtual machines with sane defaults.
### Installation and Usage
Requires node >= 8.X
```
npm install node-virtualbox [--save] [-g]
```
Example run:
``` bash
node bin.js --provision --vmname "hello" --ip 172.168.0.55 --verbose
```
ssh into instance.
```
ssh -i config/resources/insecure_private_key -p 2002 -o StrictHostKeyChecking=no -o IdentitiesOnly=yes [email protected]
```
### Default setup
The default VM will have 2 cpus and 1G memory. The default image is based on the latest [ubuntu/xenial64](https://cloud-images.ubuntu.com/xenial/current/) image. The VM has two NICs. The first nic uses NAT to forward incoming and outgoing traffic. The second nic is assigned a private host only network address. After creation, you can login with vagrant/vagrant or ssh with the default insecure_private_key located in `config/resources/`.
### Commands
`--list` return a list of vm names and uuids.
```
node bin.js --list
```
`--stop` Stop vm with save state.
```
node bin.js --stop --vmname
```
`--delete` Unregister vm and delete all its contents.
```
node bin.js --delete --vmname
```
`--info` Provide information about a vm. This will print out a json string with properties of the specified vm.
For example, running `node .\bin.js --info --vmname "vm3"` will print the following, which can be used to retrieve properties such as the port that can be used for ssh access:
```
{ name: '"vm3"',
...
'Forwarding(0)': '"guestssh,tcp,,2002,,22"',
}
```
### Provision options
`--cpus` Set the number of cpus for VM. Default is 2 (or 1 for micro).
`--mem` Set the size of ram in MB(e.g., 512 or 1024). Default is 1024 (or 512 for micro).
`--ovf` Set the box to import when creating vm. If this is omitted, the latest ubuntu-xenial image is downloaded and used.
`--ssh_port` Set the local port used to forward ssh connections to vm. If this is omitted, then a freely available port between 2002 and 2999 is automatically assigned.
`--forward_ports` Set the port forwarding rules. Format: `":"` or `""`. `""` translates to `":"`.
`--sync` Set a shared folder. Format: `";"`. You can provide multiple of these options.
`--add_ssh_key` Add public ssh key to ~/.ssh/authorized_keys of the vm.
```
node bin.js --provision --vmname "shared_folders_vm" --ip 172.16.1.45 --ssh_port 2095 --verbose --sync "C:\Users\chris;/chris" --sync "C:\Users\chris\projects;/projects" --add_ssh_key ~/.ssh/id_rsa.pub
```
### Micro VM
This is for booting micro kernels (custom initramfs inside of an iso)
Example micro VMs (iso):
``` bash
node bin.js --micro --vmname "micro" --attach_iso
```
If you don't specify path to an iso it will download and use an Alpine linux iso.