Installing RStudio Server Runtimes

An instance administrator can install RStudio Server Runtimes on IBM Cloud Pak® for Data Version 4.7.

Who needs to complete this task?

Instance administrator To install RStudio Server Runtimes, you must be an instance administrator. An instance administrator has permission to install software in the following projects:

The operators project for the instance

The operators for this instance of Cloud Pak for Data are installed in the operators project.

In the installation commands, the ${PROJECT_CPD_INST_OPERATORS} environment variable refers to the operators project.

The operands project for the instance

The Cloud Pak for Data control plane and the services for this instance of Cloud Pak for Data are installed in the operands project.

In the installation commands, the ${PROJECT_CPD_INST_OPERANDS} environment variable refers to the operands project.

When do you need to complete this task?

Review the following options to determine whether you need to complete this task:

  • If you want to install the Cloud Pak for Data control plane and one or more services at the same time, follow the process in Installing an instance of Cloud Pak for Data instead.
  • If you didn't install RStudio Server Runtimes when you installed the Cloud Pak for Data control plane, complete this task to add RStudio Server Runtimes to your environment.

    Repeat as needed If you are responsible for multiple instances of Cloud Pak for Data, you can repeat this task to install more instances of RStudio Server Runtimes on the cluster.

Information you need to complete this task

Review the following information before you install RStudio Server Runtimes:

Version requirements

All of the components that are associated with an instance of Cloud Pak for Data must be installed at the same release. For example, if the Cloud Pak for Data control plane is installed at Version 4.7.4, you must install RStudio Server Runtimes at Version 4.7.4.

Environment variables

The commands in this task use environment variables so that you can run the commands exactly as written.

  • If you don't have the script that defines the environment variables, see Setting up installation environment variables.
  • To use the environment variables from the script, you must source the environment variables before you run the commands in this task. For example, run:
    source ./cpd_vars.sh
Security context constraint

RStudio Server Runtimes works with the default Red Hat® OpenShift® Container Platform security context constraint:

  • On Version 4.10, the default SCC is restricted.
  • On Version 4.12, the default SCC is restricted-v2
Common core services

RStudio Server Runtimes requires the Cloud Pak for Data common core services.

If the common core services are not installed in the operands project for the instance, the common core services are automatically installed when you install RStudio Server Runtimes. The common core services installation increases the amount of time the installation takes to complete.

Storage requirements
You don't need to specify storage information when you install RStudio Server Runtimes.

Before you begin

This task assumes that the following prerequisites are met:

Prerequisite Where to find more information
The cluster meets the minimum requirements for installing RStudio Server Runtimes. If this task is not complete, see System requirements.
The workstation from which you will run the installation is set up as a client workstation and includes the following command-line interfaces:
  • Cloud Pak for Data CLI: cpd-cli
  • OpenShift CLI: oc
 If this task is not complete, see Setting up a client workstation.
The Cloud Pak for Data control plane is installed. If this task is not complete, see Installing an instance of Cloud Pak for Data.
For environments that use a private container registry, such as air-gapped environments, the RStudio Server Runtimes software images are mirrored to the private container registry. If this task is not complete, see Mirroring images to a private container registry.
For environments that use a private container registry, such as air-gapped environments, the cpd-cli is configured to pull the olm-utils-v2 image from the private container registry. If this task is not complete, see Pulling the olm-utils-v2 image from the private container registry.

Prerequisite services

Before you install RStudio Server Runtimes, ensure that the following services are installed and running:

Procedure

Complete the following tasks to install RStudio Server Runtimes:

  1. Installing the service
  2. Specifying additional runtimes
  3. Validating the installation
  4. What to do next

Installing the service

To install RStudio Server Runtimes:

  1. Run the cpd-cli manage login-to-ocp command to log in to the cluster as a user with sufficient permissions to complete this task. For example:
    cpd-cli manage login-to-ocp \
--username=${OCP_USERNAME} \
--password=${OCP_PASSWORD} \
--server=${OCP_URL}
    Tip: The login-to-ocp command takes the same input as the oc login command. Run oc login --help for details.
  2. Run the following command to create the required OLM objects for RStudio Server Runtimes in the operators project for the instance:
    cpd-cli manage apply-olm \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--components=rstudio
    Wait for the cpd-cli to return the following message before you proceed to the next step:
    [SUCCESS]... The apply-olm command ran successfully

    If the apply-olm fails, see Troubleshooting the apply-olm command during installation or upgrade.

  3. Create the custom resource for RStudio Server Runtimes.
    cpd-cli manage apply-cr \
--components=rstudio \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--license_acceptance=true

Specifying additional runtimes

By default, RStudio Server Runtimes installs Runtime 23.1.

Additionally, you can install additional runtimes, for example Runtime 22.2 or 22.1. You can set the following during the creation of the custom resource during installation:

  1. Update the custom resource for RStudio Server Runtimes for each additional Runtime version:
    • To install Runtime 22.2, create the custom resource with the following: 
      cpd-cli manage apply-cr \
--components=rstudio \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--extra-vars="cr_name=ibm-cpd-rstudio-rt222" \
--license_acceptance=true
    • To install Runtime 22.1, create the custom resource with the following:
      cpd-cli manage apply-cr \
--components=rstudio \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--extra-vars="cr_name=ibm-cpd-rstudio-rt221" \
--license_acceptance=true
  2. After setting the custom resource, check the status of the new Runtime versions:
    oc -n ${PROJECT_CPD_INST_OPERANDS} get rstudioaddon
NAME                    VERSION   RECONCILED   STATUS      AGE
ibm-cpd-rstudio-rt221   7.0.0     7.0.0        Completed   9m5s
ibm-cpd-rstudio-rt222   7.0.0     7.0.0        Completed   15m
ibm-cpd-rstudio-rt231   7.0.0     7.0.0        Completed   32m
rstudio-cr              7.0.0     7.0.0        Completed   33m

# component,CR-kind,CR-name,status,version,creationtimestamp,reconciled-version,operator-info
rstudio,RStudioAddon,ibm-cpd-rstudio-rt221,Completed,7.0.0,2023-05-05T17:47:49Z,7.0.0,95
rstudio,RStudioAddon,ibm-cpd-rstudio-rt222,Completed,7.0.0,2023-05-05T17:41:21Z,7.0.0,95
rstudio,RStudioAddon,ibm-cpd-rstudio-rt231,Completed,7.0.0,2023-05-05T17:24:07Z,7.0.0,95
rstudio,RStudioAddon,rstudio-cr,Completed,7.0.0,2023-05-05T17:23:14Z,7.0.0,95

Validating the installation

RStudio Server Runtimes is installed when the apply-cr command returns:
[SUCCESS]... The apply-cr command ran successfully

If you want to confirm that the custom resource status is Completed, you can run the cpd-cli manage get-cr-status command:

cpd-cli manage get-cr-status \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--components=rstudio

What to do next

RStudio Server Runtimes is ready to use. To get started with RStudio Server Runtimes, see RStudio overview.