or directly with Maven, if you have it installed already.
mvn clean install
The build compiles, tests and builds all packages.
If you want to run OneOps after a build, you can use the vagrant profile
during a build. It creates all necessary configuration for Vagrant to spin up
the newly built OneOps in a VirtualBox virtual machine.
mvn install -P vagrant
After a successful build with the profile you can find the necessary files for
starting a VM with OneOps running in the ~/.oneops/vagrant directory and start
the VM from there.
Subsequently you can suspend or halt the VM with vagrant or use the
VirtualBox user interface as desired.
Suspend the VM
and subsequently start it again with
Alternatively you can use halt and up for a clean shutdown:
and later a reboot:
In order to inspect the VM content itself, you can connect via SSH with vagrant.
Find further information about the vagrant command with vagrant help as well
as in the Vagrant documentation.
The VirtualBox user interface can be used alternatively.
By default the Vagrant instance automatically includes all configuration of
packs and more from
If you want to make this Oneops instance use a modified circuit code on your
host machine then you need to create shared folders and set up the inductor
component to use it instead. You also need to install the circuit to update the
CMS database. Below is a modified vagrant file to setup inductor to use our
circuit-oneops-1 code and to install the circuit. A similar approach can be
taken with other, potentially additional circuits.
$script = <<SCRIPT
echo "configuring inductor to use circuit-oneops-1"
echo "removing existing circuit-oneops-1 and shared symlinks"
sudo unlink circuit-oneops-1
sudo rm -Rf shared
echo "creating symlinks to shared folders"
sudo ln -s /Some/Path/On/Vagrant/circuit-oneops-1 circuit-oneops-1
echo "circuit-oneops-1: circuit install"
echo "script completed successfully"
Vagrant.configure(2) do |config|
config.vm.box = "oneops"
# Use the vagrant-cachier plugin, if installed, to cache downloaded packages
config.cache.scope = :box
config.vm.network "forwarded_port", guest: 3001, host: 3003
config.vm.network "forwarded_port", guest: 3000, host: 9090
config.vm.network "forwarded_port", guest: 8080, host: 9091
config.vm.network "forwarded_port", guest: 8161, host: 8166
config.vm.provider "virtualbox" do |vb|
vb.gui = false
vb.memory = 6144
vb.customize ["modifyvm", :id, "--cpuexecutioncap", "70"]
config.vm.synced_folder "/Some/Path/On/Host/circuit-oneops-1", "/Some/Path/On/Vagrant/circuit-oneops-1",owner: "root",group: "root"
config.vm.provision "shell", inline: $script
OneOps uses a PostgreSQL database for model storage. Some information about the
model is available in the relations documentation.
Versioning And Releasing
The OneOps project uses a version scheme of yy.mm.dd-enumerator, e.g.
17.08.02-01 and in development 17.08.02-01-SNAPSHOT.
The version can be manually updated to a new value such as