diff --git a/_docs/developer/troubleshooting/installation_troubleshooting.md b/_docs/developer/troubleshooting/installation_troubleshooting.md index 396f235d..b17f51e6 100644 --- a/_docs/developer/troubleshooting/installation_troubleshooting.md +++ b/_docs/developer/troubleshooting/installation_troubleshooting.md @@ -289,3 +289,57 @@ Some things to check: rm -rf /Users/MY_HOME_DIRECTORY/.vagrant.d/ rm -rf /Users/MY_HOME_DIRECTORY/.gem/specs/rubygems.org%443/quick/Marshal.4.8/vagrant-vbguest-0.31.0.gemspec ``` +___ + +## Troubleshooting Pre-Packaged VM + +Some issues with the pre-packaged VM can be fixed by installing a different version. Once you've installed a pre-packaged VM, it does not recieve version updates, so it can also be a good idea to update the pre-packaged version periodically. To see your current VM version, run `vagrant box list` and look at the output. You should see something like `SubmittyBot/ubuntu22-dev (virtualbox, 26.06.00.2606070357, (amd64))`. In this case, `26.06.00.2606070357` is the version number. + +After running `vagrant box list`, you may see multiple versions of the VM. If you want to know what version the VM is using when you run `vagrant up`, follow these steps: + +1. Run `vagrant up` and look at the output. +2. You should see something like `==> ubuntu-22.04: Checking if box 'SubmittyBot/ubuntu22-dev' version '26.06.00.2606070357' is up to date...`. + +In this case, `26.06.00.2606070357` is the version number. + +If you have multiple versions of the VM, you can also run `vagrant box prune` to remove the old versions. + +### Instructions for Updating the Pre-Packaged VM Version +From your main Submitty repository, e.g. `/GIT_CHECKOUT/Submitty/`, run: + +``` +vagrant box update +``` + +This will download the newest version of the VM. It will take approximately 30 minutes to download. + +### Instructions for Specifying the Pre-Packaged VM Version + +These steps may be useful if you wish to roll your VM back or to upgrade to a version besides the newest available. + +From your main Submitty repository, e.g. `/GIT_CHECKOUT/Submitty/`, run: + +``` +vagrant destroy +``` + +This will destroy your current VM and reset the Vagrant environment. + +*Note: If you have more than one VM (perhaps by accident), you can see a list of VMs with the command* `vagrant global-status`. *VMs listed will be given a unique id. You can then run* `vagrant destroy 1a2b3c4d`. *Replace* `1a2b3c4d` *with the id of the VM you wish to destroy.* + +Then, on Linux/MacOS, type: +``` +PREBUILT_VERSION={version} vagrant up --provider=virtualbox +``` + +or on Windows, type: +``` +SET PREBUILT_VERSION={version} +vagrant up --provider=virtualbox +``` + +If you are importing a new version, it will take approximately 30 minutes to download. + +*The version must be only the numbers, not including the* `v` *in front, for example* `26.06.00.2606070357` *not* `v26.06.00.2606070357`. + +*Note: You can find pre-packaged Submitty VM versions on the [Hashicorp Vagrant Box Catalog](https://portal.cloud.hashicorp.com/vagrant/discover/SubmittyBot/ubuntu22-dev) by navigating to the 'Versions' tab in the sidebar. Make sure to follow the [Submitty installation instructions](/developer/getting_started/vm_install_using_vagrant) when setting up your development environment. A complete list of Vagrant commands can be found here: [Hashicorp Vagrant CLI Docs](https://developer.hashicorp.com/vagrant/docs/cli).*