Skip to content
OSX-REIMS
Documentation: Reims vGPU version

Documentation · Using OSX-REIMS

Reims vGPU version

Tested or latest version: how to choose, update and go back.

Alpha

This documentation covers OSX-REIMS 0.3.0, alpha software. Commands and options may change between versions; when in doubt, check osx-reims --help on the installed version.

OSX-REIMS uses Reims vGPU (opens in a new tab), downloaded from its original repository into /opt/reims-vgpu and built on your computer. Each OSX-REIMS version is tested with a specific Reims vGPU commit, but you can choose which version to follow.

Tested or latest

Version What it is
Tested The commit tested with your OSX-REIMS version. It is the default and the recommended choice
Latest The newest commit of the Reims vGPU master branch, not yet tested with OSX-REIMS

In OSX-REIMS 0.3.0, the tested version is commit 69a57dd6, the same as in 0.2.0.

The choice is made on the first run of osx-reims setup and is saved. osx-reims doctor shows which version the computer follows.

Warning

The latest version may bring fixes and new features, but it may also fail to build or keep the VMs from starting. If that happens, go back to the tested one.

Changing version or updating

With all VMs shut down, run:

osx-reims update-reims

Or, in the console, choose Maintenance › Update Reims vGPU. The command:

  1. asks which version to follow, offering your current choice;
  2. shows the current commit, the new one, how many commits change and the version followed;
  3. asks for confirmation; for an untested version, the default answer is no;
  4. checks out the new commit and builds Reims vGPU. The build takes a few minutes, and the VMs cannot start until it finishes.

If Reims vGPU is already at the chosen commit, nothing is built. To build it again anyway, use osx-reims setup --rebuild.

Following the latest version does not bring in new commits by itself: run osx-reims update-reims again to fetch the newest commit of master. setup keeps the commit that is already built.

If the new version fails

If the new commit fails to build or to pass the checks, update-reims goes back to the commit that worked and builds it again, so the VMs start as before. The log shows what failed.

If the new version builds but the VMs do not start with it, go back to the tested one:

osx-reims update-reims --tested

When installing a new OSX-REIMS version

A new OSX-REIMS version may be tested with a different Reims vGPU commit. If the computer follows the tested version and it changed, the package installation tells you to run osx-reims update-reims, with the VMs shut down. If it follows the latest version or a chosen commit, the installation reminds you that updating is up to you.

A specific commit (advanced)

The --reims-ref <ref> option of setup and update-reims accepts a Reims vGPU commit, tag or branch. That choice is not tested and stays saved until you choose --tested or --latest.

Note

Local changes in /opt/reims-vgpu stop setup and update-reims: nothing is cleaned or reset automatically.