diff --git a/README.md b/README.md index 88298353e6..faeba1fb96 100644 --- a/README.md +++ b/README.md @@ -228,7 +228,7 @@ Pre-requisites: Before creating a workspace, you must setup Service Catalog. Ref 4. Your workspace may take some time to launch. Once it is up and running, you can connect to it by choosing Connect. For more details, see the following documentation pages: + AWS SageMaker: Service Workbench takes care of provisioning the workspace for you, so you can jump straight to working with SageMaker Notebooks. For more information, see the [SageMaker Getting Started Guide](https://docs.aws.amazon.com/sagemaker/latest/dg/gs-console.html) (you can jump straight to Step 4). + AWS ElasticMapReduce (EMR): Service Workbench takes care of setting up the EMR instance for you, so you can jump straight to working with EMR Notebooks. For more information on using EMR Notebooks, see [Using EMR Notebooks](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-managed-notebooks.html). **Note:** A password may be required to access the EMR Notebooks. By default, this password is 'go-research-on-aws' (without the quotes). - + RStudio: See the [RStudio Server Documentation](https://support.rstudio.com/hc/en-us/sections/200150693-RStudio-Server) for assistance. + + RStudio: You can connect to RStudio workspace type by using the template and AMI provided in AWS partner's [repository](https://github.com/RLOpenCatalyst/Service_Workbench_Templates). For more information, refer to the [Create RStudio ALB workspace](/deployment/post_deployment/aws_accounts#creating-rstudio-alb-workspace) section of *Service Workbench Post Deployment Guide*. + AWS Elastic Compute Cloud (EC2): EC2 instances are essentially Virtual Machines in the cloud. For more information, see the [EC2 Documentation](https://aws.amazon.com/ec2/). ## Create a Study diff --git a/docs/Service_Workbench_Post_Deployment_Guide.pdf b/docs/Service_Workbench_Post_Deployment_Guide.pdf index 85c493bb2e..6c69b45370 100644 Binary files a/docs/Service_Workbench_Post_Deployment_Guide.pdf and b/docs/Service_Workbench_Post_Deployment_Guide.pdf differ diff --git a/docs/Service_Workbench_User_Guide.pdf b/docs/Service_Workbench_User_Guide.pdf index 1c2933718d..46d1a0f3e7 100644 Binary files a/docs/Service_Workbench_User_Guide.pdf and b/docs/Service_Workbench_User_Guide.pdf differ diff --git a/docs/docs/deployment/post_deployment/aws_accounts.md b/docs/docs/deployment/post_deployment/aws_accounts.md index 2954810f1f..fce7f1cf4a 100644 --- a/docs/docs/deployment/post_deployment/aws_accounts.md +++ b/docs/docs/deployment/post_deployment/aws_accounts.md @@ -210,3 +210,24 @@ _**Figure: Create an AppStream image**_ ``` 6. At this point, the Image builder builds your image and the `Failed to reserve a session` message is displayed. 7. Log in to AppStream on the console and wait till the AppStream image is built. + +## Creating RStudio ALB workspace + +### Accessing RStudio workspace + +You can access the RStudio workspace type by using the template and AMI provided in AWS partner's [repository](https://github.com/RLOpenCatalyst/Service_Workbench_Templates). RStudio legacy and RStudio ALB both use custom domain names. You can define custom domain name in `/main/config/settings/`. + +**Important**: The legacy RStudio workspace type will be deprecated soon in a future release. + +### Application load balancing for RStudio ALB workspace + +When you create RStudio Application Load Balancer (ALB) workspace, an ALB is created that can host upto 100 workspaces per hosting account. Per workspace, you can have upto 4 CIDR blocks (IP ranges) for port 443 only. This is updated in the hosting accounts. If there are no ALBs for that hosting account and you have created the very first workspace, then ALB will be created for the first time and it will be common for every workspace that you create subsequently. Once you terminate all the workspaces and you terminate the last workspace for that hosting account, the ALB is deleted. An ALB is created for minimum one active workspace. + + + +Each workspace type corresponds to one listener rule and there can be 100 such rules. In each rule, users can specify the IP ranges that user wants to allowlist. You can specify only upto 4 IP ranges per listener rule. For more information about ALB, refer to [Application Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/introduction.html). + +### Limitations + +1. With RStudio ALB implementation, you can create only upto 100 workspaces per hosting account. +2. Per workspace, you can specify only upto 4 CIDR blocks for port 443. diff --git a/docs/docs/user_guide/sidebar/common/workspaces/accessing_a_workspace.md b/docs/docs/user_guide/sidebar/common/workspaces/accessing_a_workspace.md index 49f35eb115..649912c299 100644 --- a/docs/docs/user_guide/sidebar/common/workspaces/accessing_a_workspace.md +++ b/docs/docs/user_guide/sidebar/common/workspaces/accessing_a_workspace.md @@ -67,27 +67,8 @@ Please be aware of the following limitations specific to EC2 Windows Workspace T ### Connect to RStudio -Since RStudio currently requires a custom domain name, please configure the same by following the steps in `main/solution/machine-images/README.md`. - -1. The EC2 instance backing this workspace must be in the **Ready** state. Also make sure its security group allows your IP HTTPS access to it. -2. Click on the connections button and hit **Connect**. -3. The selected studies will show up as mounted directories in the RStudio. These study directories will contain files uploaded to the corresponding study. Any files uploaded to the study from the Service Workbench will automatically appear in the mounted study directories after a short delay. - -> Notes: -> -> 1. If you're provisioning an RStudio instance with studies selected, these studies will only get mounted on your instance once you click on the RStudio workspace's "Terminal" tab. -> 2. If you started a previously stopped RStudio instance (manually or automatically) and connect to it, you might see an error dialog box saying the session closed abruptly. Although this typically does not affect your data, it is recommended to quit your session from within your RStudio workspace before stopping the instance through SWB. -> 3. The auto-stop feature is enabled by default and configured to 1 hour. For configuring a different auto-stop timeout, please assign the MAX_IDLE_MINUTES value accordingly in `main/solution/machine-images/config/infra/files/rstudio/check-idle` and redeploy the machine-images SDC. -> 4. To disable auto-stop, assign the value 0 to MAX_IDLE_MINUTES and redploy machine-images SDC. - -> The username for RStudio url access was changed as of 08/26/20 -> If you're experiencing difficulty accessing previously provisioned RStudio instance, -> the steps to perform for backwards compatibility are: -> 1. Redeploy machine-images SDC (this will update the RStudio AMIs to have the new username) -> 2. For already provisioned RStudio instances, get sudo/root access on the box and add the user -> as a linux user using the command `sudo useradd -m rstudio-user` -> 3. Update the username in boot script `set-password` (found in `/usr/local/bin/`) -> 4. Reboot the box +You can connect to RStudio workspace type by using the template and AMI provided in AWS [partner’s repository](https://github.com/RLOpenCatalyst/Service_Workbench_Templates). For more information about new RStudio enhancements, refer to the [Create RStudio ALB workspace](/deployment/post_deployment/aws_accounts#creating-rstudio-alb-workspace) section of *Service Workbench Post Deployment Guide*. + ### Start and Stop workspace EC2 Windows, EC2 Linux, RStudio and SageMaker workspaces can be stopped when not in use. Click the stop button to stop the workspace, and click the start button to start the workspace again. diff --git a/docs/static/img/deployment/post_deployment/ALB-1.png b/docs/static/img/deployment/post_deployment/ALB-1.png new file mode 100644 index 0000000000..c1633094da Binary files /dev/null and b/docs/static/img/deployment/post_deployment/ALB-1.png differ