RStudio Team AWS CloudFormation template#
The RStudio Team AWS CloudFormation template provides a push-button deployment that ensures that you can quickly and easily spin up all of RStudio’s Professional products using AWS for a 45-day evaluation or as a permanent deployment after activating a valid license.
The RStudio Team AWS CloudFormation template spins up the necessary infrastructure that is required for a minimal working RStudio Team deployment. The template uses AWS Amazon Machine Images (AMIs) that already have the products installed.
The created infrastructure consists of one EC2 Instance and one Security Group for:
- RStudio Server Pro
- RStudio Connect
- RStudio Package Manager
The AWS AMIs provide RStudio Professional products, two versions of R, two versions of Python, and the RStudio Professional Drivers that are ready to be used. This can be customized and extended just like any other regular installation of RStudio products.
Prerequisites#
- AWS account
- AWS Virtual Private Cloud (VPC)
- Subnet inside the selected VPC (If the subnet that you select is not in the VPC that is selected, then your deployment will fail)
- AWS Key pair
- Permissions to create security groups
- Permissions to create EC2 instances
Note
The CloudFormation template requires a public VPC and a subnet with an Internet Gateway attached.
Step 1: Select Template#
-
Navigate to the RStudio AWS CloudFormation template on the AWS CloudFormation website by clicking the Launch Stack
button. -
If you are not currently logged into AWS, then use your AWS credentials to sign into AWS.
Note
Currently, the AWS Cloudformation template is available in all US and EU regions.
-
From the Create stack page, in the Specify template section, do the following:
- Verify that the Specify an Amazon S3 template URL radio button is selected.
- Verify that the Specify an Amazon S3 template URL is: https://rstudio-cloud-tools.s3.amazonaws.com/rstudio-standalone.yml
-
Click Next. The Specify Details page displays.
Step 2: Specify Details#
- In the Stack name section, assign a name to the stack. By default, the stack name is “RStudioTeam”.
-
In the Parameters section, refer to the tables below to specify the parameters for the RStudio cluster and the AWS resource configuration.
Note
You can use or change the default parameter values that are defined in the AWS CloudFormation template.
Global Network configuration
| Parameter | Description |
|---|---|
| Deploy to VPC | required - VPC for the RStudio cluster deployment. |
| Deploy to Subnet | required - Subnet for the RStudio cluster deployment. The subnet must be in the selected VPC. |
| Security group CIDR Range for HTTP/HTTPS | CIDR Range for ports 80 and 443 for all security groups (default: 0.0.0.0/0). |
| Security group CIDR Range for SSH | CIDR Range for ports 22 for all security groups (default: 0.0.0.0/0). |
Global EC2 resource configuration
| Parameter | Description |
|---|---|
| AWS key pair | required - The AWS key pair used for the RStudio EC2 instances |
Product specific parameters
Specify parameters that are specific to RStudio Server Pro, RStudio Connect, and RStudio Package Manager.
| Parameter | Description |
|---|---|
| Instance Type | EC2 Instance type (default: m5.large) |
| Disk Size | Root Volume Size (default and minimum: 50 GB or 120 GB for RSPM) |
Note
The default parameters provided are the minimum that RStudio recommends for more permanent deployments.
- After you have confirmed and specified the parameters, click Next. The Options page displays.
Step 3: Options#
-
Make the to the changes Options page changes that you require for your stack and click Next. The Review page displays.
Info
The Options page allows you to specify the stack’s:
- Tags
- Permissions
- Rollback Triggers
- Advanced options
All of the options available for configuration are optional.
Step 4: Review and create#
- Review the stack’s configuration and do one of the following:
- If the configuration requires additional updates, then make the required updates and click Create.
- If the configuration does not require additional updates, click Create.
Connect to RStudio products#
-
From the AWS CloudFormation page:
- Locate and select your stack’s corresponding check box.
- Verify that your deployment is complete from the Status column.
- Once your deployment is complete, select the Outputs tab.
- Click the RStudio UI link to open the RStudio Professional products in the browser.
Outputs
| Parameter | Description |
|---|---|
| RSP | Public IP for RStudio Server Pro |
| RSPUser | RStudio Server Pro default user (rstudio-user) |
| RSPUserPass | RStudio Server Pro default user password (Instance ID for RSP) |
| RSC | Public IP for RStudio Connect |
| RSCUser | RStudio Connect default user (admin) |
| RSCUserPass | RStudio Connect default user password (Instance ID for RSC) |
| RSPM | Public IP for RStudio Package Manager |
Getting Started with RStudio Professional products#
For more information on using RStudio products, see RStudio Tutorials.
Default passwords#
The default RStudio Server Pro and RStudio Connect passwords are the EC2 instance ID. We recommend changing this after the initial deployment of the AWS CloudFormation template to a unique password.
Licensing#
After your 45-day evaluation period, you can activate your products with production licenses at any time without the need to reinstall or reconfigure anything.
Follow the documentation for each product:
Additional configuration#
To define additional configurations for options such as Authentication, SSL certificates and, etc., refer to the following RStudio Documentation:
Product versions#
To check what are the latest product versions included in the CloudFormation template see this page.
We update the CloudFormation template with new version of RStudio Pro Products.
Support#
If you find any issues launching the CloudFormation template you can contact RStudio support.
-
File a Support ticket:
- In your support ticket please included the following files from the EC2 instance that failed to create:
/var/log/first-boot.log/var/log/user-data.log
- In order to get the log files of the EC2 instances, navigate to Advanced options > Stack creation options and disable Rollback on failure.
- In your support ticket please included the following files from the EC2 instance that failed to create: