Difference between revisions of "How To ResVault"

From UFRC
Jump to navigation Jump to search
 
(42 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:ResVault]]
+
[[Category:Essentials]]
__TOC__
+
{|align=right
 
+
  |__TOC__
 
+
  |}
 +
==Getting Started==
 +
===tiCrypt manual===
 +
The full documentation for tiCrypt software can be found at [https://ticrypt.com/docs/frontend2/getting-started tiCrypt.com].
 +
This page contains some specifics to use tiCrypt the way it runs at the University of Florida.
  
 
===tiCrypt Connect Client Install/Update===
 
===tiCrypt Connect Client Install/Update===
1. Before getting started, ensure there are no instances of tiCrypt currently running by opening tiCryptConnect and selecting the "Shut down Connect" button, to the right of the screen.
+
#If the client is already installed, ensure there are no instances of tiCrypt currently running by opening tiCryptConnect and selecting the "Shut down Connect" button to the right of the screen. If the client is not yet installed, proceed to Step 3.
[[File:Rv-update-1.png|frameless|left]]
+
#*[[File:Rv-update2.png|frameless]]
 
+
#If the client isn't starting or responding, you might need to stop the process manually.
 
+
#*[[File:ProcessKill.png|frameless]]
 
+
# Download the appropriate launcher for your operating system from the [https://www.rc.ufl.edu/documentation/hipergator-rv/hipergator-rv-download/ HiPerGator-RV Download page].
 
+
# Run the installer software for the tiCrypt Connect client and follow the prompts.
 
+
# Once the installation is finished, run the client and check that the version number corresponds to the updated version. We recommend always using the latest deployment version, which is circled in the first image.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
*If the client isn't starting or responding, you might need to stop the process manually.
 
[[File:ProcessKill.png|frameless|left]]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2. Navigate to the [https://www.rc.ufl.edu/documentation/hipergator-rv/hipergator-rv-download/ HiPerGator-RV Download page] and download the appropriate launcher for your operating system.
 
 
 
3. Run the installer software for the tiCrypt Connect client and follow the prompts.
 
 
 
4. Once the install is finished, run the client and check that the version number corresponds to the updated version. We recommend always using the latest deployment version.
 
[[File:Rv-update2.png|frameless|left]]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  
 
===ResVault Login===
 
===ResVault Login===
1. Launch the tiCrypt Connect client. This will open a new tab on your Internet browser (http://127.0.0.1:8080/connect).
+
# Launch the tiCrypt Connect client, which will open a new tab on your Internet browser (http://127.0.0.1:8080/connect).
 +
# Click on the latest HyperGatorRV deployment or add a new deployment using the downloaded deployment file from Step 2 above. We recommend always using the latest deployment version.
 +
# If you see a message saying "You have no keys loaded.", click on "LOAD KEY" and select the <filename>.key.json key file.
 +
# Enter your RV password (not your GatorLinkID password).
 +
# Setup or access your virtual machine (VM) as described in the [https://www.rc.ufl.edu/documentation/hipergator-rv/hipergator-rv-training/ training sessions].
  
2. Click on the latest HyperGatorRV deployment or add a new deployment, using the downloaded deployment file from Step 2 above. We recommend always using the latest deployment version.
+
==VM Setup==
 +
<div style="column-count:2">
 +
Data stored in My Vault can be processed with the RV VM. Windows and Linux options are available. <br>
 +
[[File:RV INST 1.png|right|frameless|]]
 +
Follow these steps to set up a VM:
  
3. If you see a message saying "You have no keys loaded.", click on "LOAD KEY" and select the <filename>.key.json key file.
+
===Setup Drives===
 +
# Click on the Virtual Machines main tab and then click on Drives.
 +
# Add a drive and set up two drives: a Home and a Data drive. Users should specify which drives need backup.
 +
# Setup the Home data. It should be at least 10 GB.
 +
# Select the Team, Production Realm, and "Default".<br><br><br><br><br><br>
  
4. Enter your RV password (not your GatorLinkID password).
+
===Setup VM===
 +
# Navigate to the Virtual Machines management tab and click on the "+" button next to the search bar.
 +
# Select the appropriate type of VM, including the operating system, under Basic Info.
 +
# Select the Drive.
 +
#* Only Read-Only drives can share data with the share function.
 +
#* You can save data in the default C:\ drive, but it will be wiped out at the end of every session. Therefore, creating a "Data" drive for storage in addition to the Vault is recommended.
 +
# Confirm the VM settings.
 +
# Launch the VM, if needed prompt to format the disk (fist time launch).
 +
# You can monitor a process with the progress bar on the bottom right corner of the screen.
 +
# You can share the VM with other users and give manager or user labels. This is only for users within the teams.
 +
# Access directory management is used to grant permissions to specific drives/folders. Only VM owners can manage it.
 +
# Connect by clicking on the Open button and follow the prompts.
 +
</div>
  
5. Setup or access your virtual machine (VM) as described in the [https://www.rc.ufl.edu/documentation/hipergator-rv/hipergator-rv-training/ training sessions].
+
==Transfer Data from/to RV==
 +
For file management help, please visit the following resources:
  
 +
[https://ticrypt.com/docs/frontend2/tiCrypt-frontend/user-role/vault/v-inbox-and-sftp Inbox and SFTP]
  
===How to Transfer Data from/to RV===
+
[https://ticrypt.com/docs/frontend2/tiCrypt-frontend/user-role/vault/v-file-directories/ ResVault Files Directories]
====Move data into RV====
 
1. My Vault
 
* Click on transfer files button.
 
2. SFTP
 
* Click on Launch SFTP and copy the host and port, then copy password.
 
* Use a terminal
 
3. Inboxes
 
* Allows incoming data from users outside of ResVault.
 
* The inbox function can be assigned to different folders in the My Files and it creates a URL and command lines for external users.
 
* The inboxes can be edited.
 
* The current upload speed for inboxes is about 50mbps.
 
====Move data out of RV====
 
1. My Vault
 
*Click on transfer files button.
 
2. File Sharing. 
 
* Allows file sharing to other team members.
 
3. Transfer button
 
* Allows inbound and outbound transfer from a selected VM to the Vault.
 
  
a. Click on the transfer button
+
==Software in ResVault==
 +
As of April 2022, all HiPerGator software is available on Linux VMs under the /apps/ directory. You can load modules from a command line using the command <code>$ module load (AppName)</code>, or search for modules using <code>$ module spider (AppName)</code>. For a full list of available HiPerGator apps, please see [https://help.rc.ufl.edu/doc/Applications this page].
  
b. Select the file
+
===Using RStudio in ResVault===
 +
To launch RStudio on ResVault use the command <code>$ rstudio --no-sandbox</code> and if you have additional drives linked to your VM, bind mount those drives with the flag <code> -B /drives/drive_name</code>
  
c. Click on transfer.
+
If you have a specific software installation request, please contact our support team via the [http://www.my.it.ufl.edu Helpdesk].
  
====[[ResVault-How to encrypt a file for download|How to encrypt a file for download]]====
+
===[[How to run Jupyter on Linux VMs in ResVault|How to run Jupyter on Linux VMs in ResVault]]===
* For more information about data management, please visit [https://www.rc.ufl.edu/documentation/hipergator-rv/hipergator-rv-data-management/ HiPerGator-RV Data Management]
+
You can use the same kernels that are available on HiPerGator within ResVault VMs by following the steps outlined in [[How to run Jupyter on Linux VMs in ResVault|this guide]].
 
 
 
 
===How to Setup a VM===
 
Data stored into My Vault can be processed with the RV VM. Windows and Linux options are available.
 
 
 
[[File:RV INST 1.png|right]]
 
====Setup Drives====
 
1. Click on Virtual Machines main tab
 
 
 
2. Click on Drives
 
 
 
3. Add a drive and setup 2 drives: we recommend a Home and Data.
 
 
 
4. Users need to specify to us what drives need backup.
 
 
 
5. Setup the Home data. It should be at least 10 GB.
 
 
 
6. Select Team
 
 
 
7. Select Production Realm
 
 
 
8. Select "Default"
 
 
 
====Setup VM====
 
1. Navigate to the Virtual Machines management tab and select the "+" button next to the search bar.
 
 
 
2. Select the appropriate type of VM under Basic Info.
 
 
 
3. Select the Drive. Only Read-Only drives can share data with the share function.
 
 
 
4. Confirm
 
 
 
5. Launch the VM, if needed prompt to format the disk (fist time launch)
 
 
 
6. Look at the progress bar on the bottom right corner
 
 
 
7. You can share the VM with other users and give manager or user labels. This is only for users within the teams.
 
 
 
8. Access directory management is used to grant permissions to specific drives/folders. You need to setup yourself as owner to manage it.
 
  
9. Connect by clicking on the Open button and follow the prompts
+
==Drive Mangement==
  
10. You can save data in C drive, you can save data there, but it will be wiped out at the end of every session, so saving to the created drives is recommended.
+
===Transfer drive ownership from one user to another===
  
===Install Software into ResVault===
+
Transferring drive ownership allows a different user to be the VM owner. VMs cannot be transferred, but the drives mounted in the VMs can be. The process requires assistance from the ResVault administrators and cannot be completed by users alone.
  
 +
# Shut down any VMs with the drive(s) to be transferred mounted.
 +
# In the Virtual Machine, Drives sub-panel, select the drive and click the Share icon.
 +
# You need to share the drive with '''Read-Write Access'''. Start typing the name of the user you want to transfer the drive to and select the user from the list.
 +
# Click Accept.
 +
# Once the drive has been shared with the desired new owner, '''contact Research Computing support''' and request that drive ownership be transferred.
 +
# Staff will transfer ownership, and the new owner can configure a VM using the drives that they now own and will be the owner of the VM.
 +
# Old user will still have access to the drives.
  
Since April 2022, Linux VMs have access to all HiPerGator software under the /apps/ directory. [https://help.rc.ufl.edu/doc/Applications Full list of HiPerGator Apps]
+
==Troubleshooting Issues==
 
+
To address technical issues regarding ResVault, please review our [https://help.rc.ufl.edu/doc/ResVault_Troubleshooting Troubleshooting Page] or contact our support team via the [http://www.my.it.ufl.edu Helpdesk].
For specific software install requests, please contact support via the [http://www.my.it.ufl.edu Helpdesk].
 
 
 
 
 
===[[How to run Jupyter on Linux VMs in ResVault|How to run Jupyter on Linux VMs in ResVault]]===
 
* You can get the same kernels available on HiPerGator within ResVault VMs [[How to run Jupyter on Linux VMs in ResVault|using these steps]].
 

Latest revision as of 20:23, 3 July 2024

Getting Started

tiCrypt manual

The full documentation for tiCrypt software can be found at tiCrypt.com. This page contains some specifics to use tiCrypt the way it runs at the University of Florida.

tiCrypt Connect Client Install/Update

  1. If the client is already installed, ensure there are no instances of tiCrypt currently running by opening tiCryptConnect and selecting the "Shut down Connect" button to the right of the screen. If the client is not yet installed, proceed to Step 3.
    • Rv-update2.png
  2. If the client isn't starting or responding, you might need to stop the process manually.
    • ProcessKill.png
  3. Download the appropriate launcher for your operating system from the HiPerGator-RV Download page.
  4. Run the installer software for the tiCrypt Connect client and follow the prompts.
  5. Once the installation is finished, run the client and check that the version number corresponds to the updated version. We recommend always using the latest deployment version, which is circled in the first image.

ResVault Login

  1. Launch the tiCrypt Connect client, which will open a new tab on your Internet browser (http://127.0.0.1:8080/connect).
  2. Click on the latest HyperGatorRV deployment or add a new deployment using the downloaded deployment file from Step 2 above. We recommend always using the latest deployment version.
  3. If you see a message saying "You have no keys loaded.", click on "LOAD KEY" and select the <filename>.key.json key file.
  4. Enter your RV password (not your GatorLinkID password).
  5. Setup or access your virtual machine (VM) as described in the training sessions.

VM Setup

Data stored in My Vault can be processed with the RV VM. Windows and Linux options are available.

RV INST 1.png

Follow these steps to set up a VM:

Setup Drives

  1. Click on the Virtual Machines main tab and then click on Drives.
  2. Add a drive and set up two drives: a Home and a Data drive. Users should specify which drives need backup.
  3. Setup the Home data. It should be at least 10 GB.
  4. Select the Team, Production Realm, and "Default".





Setup VM

  1. Navigate to the Virtual Machines management tab and click on the "+" button next to the search bar.
  2. Select the appropriate type of VM, including the operating system, under Basic Info.
  3. Select the Drive.
    • Only Read-Only drives can share data with the share function.
    • You can save data in the default C:\ drive, but it will be wiped out at the end of every session. Therefore, creating a "Data" drive for storage in addition to the Vault is recommended.
  4. Confirm the VM settings.
  5. Launch the VM, if needed prompt to format the disk (fist time launch).
  6. You can monitor a process with the progress bar on the bottom right corner of the screen.
  7. You can share the VM with other users and give manager or user labels. This is only for users within the teams.
  8. Access directory management is used to grant permissions to specific drives/folders. Only VM owners can manage it.
  9. Connect by clicking on the Open button and follow the prompts.

Transfer Data from/to RV

For file management help, please visit the following resources:

Inbox and SFTP

ResVault Files Directories

Software in ResVault

As of April 2022, all HiPerGator software is available on Linux VMs under the /apps/ directory. You can load modules from a command line using the command $ module load (AppName), or search for modules using $ module spider (AppName). For a full list of available HiPerGator apps, please see this page.

Using RStudio in ResVault

To launch RStudio on ResVault use the command $ rstudio --no-sandbox and if you have additional drives linked to your VM, bind mount those drives with the flag -B /drives/drive_name

If you have a specific software installation request, please contact our support team via the Helpdesk.

How to run Jupyter on Linux VMs in ResVault

You can use the same kernels that are available on HiPerGator within ResVault VMs by following the steps outlined in this guide.

Drive Mangement

Transfer drive ownership from one user to another

Transferring drive ownership allows a different user to be the VM owner. VMs cannot be transferred, but the drives mounted in the VMs can be. The process requires assistance from the ResVault administrators and cannot be completed by users alone.

  1. Shut down any VMs with the drive(s) to be transferred mounted.
  2. In the Virtual Machine, Drives sub-panel, select the drive and click the Share icon.
  3. You need to share the drive with Read-Write Access. Start typing the name of the user you want to transfer the drive to and select the user from the list.
  4. Click Accept.
  5. Once the drive has been shared with the desired new owner, contact Research Computing support and request that drive ownership be transferred.
  6. Staff will transfer ownership, and the new owner can configure a VM using the drives that they now own and will be the owner of the VM.
  7. Old user will still have access to the drives.

Troubleshooting Issues

To address technical issues regarding ResVault, please review our Troubleshooting Page or contact our support team via the Helpdesk.