Upgrade RStudio Workbench
These instructions describe how to upgrade RStudio Workbench, formerly RStudio Server Pro.
RStudio Workbench, formerly RStudio Server Pro
We have renamed RStudio Server Pro to RStudio Workbench. This change reflects the product’s growing support for a wide range of different development environments. RStudio Workbench enables R and Python data scientists to use their preferred IDE in a secure, scalable, and collaborative environment -- whether that is the RStudio IDE, JupyterLab, Jupyter Notebooks, or VS Code. We want RStudio Workbench to be the best single platform to support open source, code-first data science, whether your team is using R or Python.
If you perform an upgrade of RStudio Workbench, and an existing version of the
server is currently running, then the upgrade process will also ensure that
active sessions are immediately migrated to the new version.
This includes the following behavior:
- Running R sessions are suspended so that future interactions with the server automatically launch the updated R session binary
- Currently connected browser clients are notified that a new version is available and automatically refresh themselves.
- The core server binary is restarted
For more information about upgrading RStudio Workbench, navigate to section 2.1.6 Upgrading to a New
of the Admin Guide.
For addition information about Upgrading to a later version of RStudio Server, please reference this
Upgrading to Version 1.4+
If you are running an RStudio Server Pro version prior to 1.4 and would like to
upgrade to RStudio Server Pro or RStudio Workbench version 1.4 or greater, there may be
additional configuration for your upgrade.
You have no added administrative requirements and do not need to read the sections below if you:
- Have only one RStudio Server Pro/RStudio Workbench node (including integration with with Kubernetes or Slurm via the Launcher)
- Do not wish to configure VS Code as an IDE for RStudio Workbench
- Are ok with RStudio Workbench's default locations for saving server state (true in most cases)
- Do not wish to use RStudio Workbench's project sharing feature
If you do not meet one of the requirements above, relevant details are provided in the sections below.
Database: Required if Load-Balancing
Starting in RStudio Workbench version 1.4, a database is required. The product
comes with a SQLite database out-of-the-box. If you are running a single-node
installation of RStudio Workbench, then no further configuration is required.
If you are load-balancing multiple RStudio Workbench instances, a separate Postgres database is required.
The minimum supported PostgreSQL version is 9.5.
|Single Node, RStudio Sessions Only
|Single Node, Jupyter + VS Code Sessions (Launcher)
|Single Node, External Resource Manager (K8S, Slurm)
|Multiple Nodes Load Balanced/HA (w/ or w/o External Resource Manager)
RStudio Workbench uses the database to manage and maintain the server state. If using a Postgres database, an administrator must create the database and properly configure RStudio Workbench; no further database administration is required.
Understanding the RStudio Product Databases includes details on how RStudio professional products use their databases.
To update a load-balanced RStudio Workbench cluster to 1.4 or greater, you will need to:
- Stop all nodes in the cluster.
- Create the Postgres database.
- Edit the config files for all nodes to use the Postgres database.
- Install the new version of RStudio Workbench.
- Start the RStudio Workbench nodes.
Detailed instructions can be found in the RStudio Workbench Professional Edition - Admin guide.
VS Code: Optional IDE Available
RStudio Workbench 1.4 allows users to launch VS Code sessions in addition to RStudio, JupyterLab, and Jupyter Notebook sessions. This configuration must be enabled by an administrator.
Enabling VS Code sessions is a two step process:
- Install the VS Code executable.
- Configure RStudio Workbench to use the VS Code executable.
If RStudio Workbench is configured to run sessions locally, there is an installation utility provided by RStudio Workbench for a one-line install, including R and Python extensions.
If RStudio Workbench is configured to use an external resource manager like Kubernetes or Slurm, the VS Code executable must be installed into the relevant containers or Slurm nodes. The r-session-complete container provided by RStudio already has the VS Code executable installed.
For more details on installing and configuring VS Code in RStudio Workbench,
please see the RStudio Workbench Professional Edition Admin
Default Data Directory: New Default, Now Optionally Configurable
RStudio Workbench maintains state in the user’s home directory. In versions of RStudio below 1.4, this state was maintained in the
~/.rstudio folder, with no ability to alter the location. Starting in RStudio Workbench 1.4, this data now lives in the
~/.local/share/rstudio directory, and this location is configurable.
We strongly recommend that the data in this folder be used by the IDE alone and not manually accessed.
For most RStudio Workbench installations, the migration will be automatic and invisible to users and administrators.
In some configurations, RStudio Workbench administrators may wish to move this data somewhere else if space is limited on the drive with user home directories.
If you wish to return the data to its prior location, or to move the data location somewhere else, the
RSTUDIO_DATA_HOME environment variables in the service definition can be configured.
See the RStudio Workbench Professional Edition - Admin guide for more details on configuring this setting.
Project Sharing: Optional, Newly Enabled in Launcher Configurations
Prior to RStudio Workbench version 1.4, using the Launcher feature to enable an External Resource Manager and/or JupyterLab, Jupyter Notebook, and VS Code sessions required disabling the real-time project sharing feature of RStudio sessions. This is no longer the case as of version 1.4!
Please see the RStudio Workbench Professional Edition - Admin guide for details on enabling project sharing.