Chapter 2. Installing Cryostat

Procedure

1. In your browser, navigate to Home > Projects by using the web console.
2. Select the name of the project in which you want to install the Red Hat build of Cryostat Operator.

3. Install the Red Hat build of Cryostat Operator:

   1. In the navigation menu of your web console, navigate to Operators > OperatorHub.
   2. Select the Red Hat build of Cryostat Operator from the list. You can use the search box in the upper part of the screen to find the Red Hat build of Cryostat Operator.

   3. To install the Red Hat build of Cryostat Operator in your project, click Install.

      The Red Hat OpenShift web console prompts you to create a Cryostat custom resource (CR).

      Note

      From Cryostat 3.0 onward, in the Installation mode area, the All namespaces on the cluster (default) radio button is the only available option.

      You can create the CR either manually or automatically. If you want to create the CR manually, see step 4. If you want to create the CR automatically, see step 5.

4. If you want to create the CR manually, complete the following steps:

   1. Navigate to Operators > Installed Operators by using the web console and select Red Hat build of Cryostat Operator from the list of installed operators:

      Figure 2.1. Viewing the Red Hat build of Cryostat operator in the list of installed operators

      
   2. Click the Details tab.

   3. To create a Cryostat instance, go to the Provided APIs section. Then, under Cryostat, click Create instance.

      Note

      From Cryostat 3.0 onward, the Cryostat API enables you to create both single-namespace and multi-namespace Cryostat instances.

      Figure 2.2. Selecting the Cryostat API that is provided by the Red Hat build of Cryostat Operator

      
   4. Click either the Form view radio button or the YAML view radio button. If you want to enter your information in the YAML configuration file, click YAML view .
   5. Specify a unique name for the instance of Cryostat that you want to create.
   6. Optional: In the Labels field, specify a label or annotation for the Operand workload you want to deploy.

   7. In the Target Namespaces field, select namespaces whose workloads you want to permit this instance of Cryostat to access and work with. Optionally, you can select the same namespace where you installed Cryostat or you can choose a different namespace. To add additional namespaces, click +Add Target Namespace.

      Important

      Users who can access the Cryostat instance have access to all target applications in any namespace that is visible to that Cryostat instance. Therefore, when you deploy a multi-namespace Cryostat instance, you must consider which namespaces to select for monitoring, which namespace to install Cryostat into, and which users you want to grant access to.

      You can also specify additional configuration options for your deployment:

      Figure 2.3. Creating an instance of Cryostat by using a form in the web console

      

      Alternatively, you can use a YAML template to create your instance and specify additional configuration options instead of using the form:

      Figure 2.4. Creating an instance of Cryostat by using a YAML template in the web console

      

5. If you want to create the CR by using the automatic prompt option, follow the prompt’s instructions and then complete the following steps:

   1. Click either the Form view radio button or the YAML view radio button. If you want to enter your information in the YAML configuration file, click YAML view.
   2. Specify a unique name for the instance of Cryostat that you want to create.
   3. Optional: In the Labels field, specify a label or annotation for the Operand workload you want to deploy.

   4. In the Target Namespaces field, select namespaces whose workloads you want to permit this instance of Cryostat to access and work with. Optionally, you can select the same namespace where you installed Cryostat or you can choose a different namespace. To add additional namespaces, click +Add Target Namespace.

      Important

      Users who can access the Cryostat instance have access to all target applications in any namespace that is visible to that Cryostat instance. Therefore, when you deploy a multi-namespace Cryostat instance, you must consider which namespaces to select for monitoring, which namespace to install Cryostat into, and which users you want to grant access to.

      You can also specify additional configuration options for your deployment:

      Figure 2.5. Creating an instance of Cryostat by using a form in the web console

      

      Alternatively, you can use a YAML template to create your instance and specify additional configuration options instead of using the form:

      Figure 2.6. Creating an instance of Cryostat by using a YAML template in the web console

      

6. To start the creation process for your Cryostat instance, click Create.

   You must wait for all resources of your Cryostat instance to be ready before you can access it.

Verification

1. In the navigation menu of the web console, click Operators, then click Installed Operators.
2. From the table of installed operators, select Red Hat build of Cryostat Operator.

3. Select the Cryostat tab.

   Your Cryostat instance opens in the table of instances and lists the following conditions:

   • TLSSetupComplete is set to true.
   • MainDeploymentAvailable is set to true.

   • Optional: If you enabled the reports generator service then ReportsDeploymentAvailable is shown and set to true.

     Figure 2.7. Example of conditions set to True under the Status column for a Cryostat instance on OpenShift

     

4. Optional: Select your Cryostat instance from the Cryostat table. Go to the Cryostat Conditions table, where you can see more information for each condition.

   Figure 2.8. Example of a Cryostat Conditions table that lists each condition and its criteria