Deploying IBM Spectrum LSF

Creating the project by using the UI

You can deploy your IBM® Spectrum LSF cluster by using the IBM Cloud console UI to create an IBM Spectrum LSF project.

1. Log in to the IBM Cloud catalog by using your unique credentials.

2. In the Works with section, select LSF and then select the IBM Spectrum LSF tile.

3. In the Variation section, select Cluster with LSF v10.1.0.14 to indicate IBM Spectrum LSF and version as the scheduler to use for the deployment.

4. Select the Product version (in Architecture) that you want to install.

5. Click Review deployment options.

6. In the Deployment options section, click Add to project to add this deployment to an IBM Cloud project and combine it with other deployments, if applicable. IBM Cloud projects include several more pipeline steps before deployment, including deployment validation, cost calculation, compliance verification, and approval process.

7. In the Create a project section:

   • Specify a Name for your IBM® Spectrum LSF project.
   • Optionally provide a Description to describe the purpose of the project.
   • Specify a Configuration name for your IBM® Spectrum LSF project. The name can be up to 64 characters.
   • Select a Region for the location where you want the IBM® Spectrum LSF project deployed. The region for the LSF project container can be different from the actual region where the cluster is deployed.
   • Select a Resource group for where to get resources for your IBM® Spectrum LSF project.

   Click Add to save and add your project. When created, the project is added to the Projects view of the IBM Cloud console.

8. In the Configure section of the Edit configuration page, edit the configuration by entering the Security, Required, and Optional input values.

   Descriptions of the deployment input values are next to each variable in the IBM Cloud console.

   Secure deployment input values might be entered directly or might be referenced from an existing IBM Cloud® Secrets Manager. As a best practice, the more secure option is to use a Secrets Manager to store secured input values.

   • In the Security tab, you have two sections:

     • Authentication: specify an API key for the IBM Cloud account where you want to deploy your IBM® Spectrum LSF cluster to fulfill the ibmcloud_api_key input variable.
     • Security and compliance: configure the IBM Cloud® Security and Compliance Center controls that you want to use to validate the deployable architecture code before the deployment. You can use the architecture defaults or select your own from an existing Security and Compliance Center instance. When you deploy the IBM® Spectrum LSF cluster and create a new Security and Compliance Center instance, you set these deployment input variables in the Optional tab.

   • In the Required tab, specify the deployment values for the mandatory input variables: cluster_name, remote_allowed_ips, existing_resource_group, bastion_ssh_keys, compute_ssh_keys, and zones.

   For production clusters, work with your business owners or license management team to make sure that your organization has procured enough licenses to deploy the LSF cluster by using IBM Spectrum LSF.

   • In the Optional tab, specify deployment values for advanced configuration and for deeper customization of the provisioned elements.

   For example, to enable the observability_monitoring_enable variable, you need to set the value to true.

   Click Save to save your configuration options.

9. Click Validate. IBM Cloud projects run a Code Risk Analyzer scan that includes a supported set of Security and Compliance Center rules. It checks controls that are part of the IBM® Spectrum LSF deployment and that IBM Cloud projects support. Any extra controls that are not included in the list of supported Security and Compliance Center rules are not checked when you validate the configuration.

   Provide a comment to approve the validation and proceed to deployment.

10. Click Deploy to proceed with the deployment. Deploying the deployable architecture can take several minutes. You are notified when the deployment is successful. Optionally click View resources from the Summary tab to see details about the deployed IBM® Spectrum LSF project.

When deployed, you can then access your deployed environment.

Deploying IBM Spectrum LSF by using the CLI

To generate the API key, refer Managing user API keys.

To login to the IBM Cloud CLI, refer ibmcloud login.

You can deploy your IBM® Spectrum LSF cluster by using the IBM Cloud CLI to create a catalog workspace with the supported IBM® Spectrum LSF version. The CLI requires a values.json file with your configuration settings.

1. Install the IBM Cloud CLI and the catalogs management plug-in before you run any CLI commands.

2. The CLI requires a version_locator_value. You can retrieve this value from the IBM Cloud console UI:

   1. Log in to the IBM Cloud catalog by using your unique credentials.

   2. In the Works with section, select LSF and then select the IBM Spectrum LSF tile.

   3. In the Variation section, select Cluster with LSF v10.1.0.14 to indicate IBM Spectrum LSF and version as the scheduler to use for the deployment.

   4. Select the Product version (in Architecture) that you want to install.

   5. Click Review deployment options.

   6. In the Deployment options section, select Create from the CLI, copy the version_locator_value, and save this value to be used in a later step. The value is an 80 character alphanumeric string, such as:

      1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.398b4df2-8186-4326-b31d-d8a5af20d8fc-global
      

3. The CLI requires a values.json file with your configuration settings. Use the following example values.json file as a reference: you can copy the contents, change the values to meet your own deployment configurations, and then save it as values.json.

   Take note of these mandatory deployment input values:

   • Provide the mandatory deployment values for your IBM® Spectrum LSF cluster, specifically, replace the Fill here text with values for cluster_name, remote_allowed_ips, existing_resource_group, bastion_ssh_keys, compute_ssh_keys, and zones.

4. Run this command in the IBM Cloud CLI to deploy your IBM® Spectrum LSF cluster with the configuration you specified in your values.json file; you use your version_locator_value copied and saved in a previous step, here:

   ibmcloud catalog install --vl <version_locator_value> --override-values values.json
   

   For example, running:

   ibmcloud catalog install --vl 1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.398b4df2-8186-4326-b31d-d8a5af20d8fc-global --override-values values.json
   

   outputs:

   Attempting install of {{site.data.keyword.spectrum_full_notm}} version x.x.x...
   Schematics workspace: https://cloud.ibm.com/schematics/workspaces/us-south.workspace.globalcatalog-collection.40b1c1e4/jobs?region=
   Workspace status: DRAFT
   Workspace status: INACTIVE
   Workspace status: INPROGRESS
   Workspace status: ACTIVE
   Installation successful
   OK
   

When deployed, you can then access your deployed environment.