Service Templates

Service templates simplify the procedure for submitting jobs that include many options.

Feature Description

The service template feature allows users to start jobs from preconfigured templates, reducing the number of input parameters required. Each release of OpCenter contains a library of templates that are available for use. Service templates are available to use from the CLI or from the web interface.

Using Service Templates from the CLI

All template-related actions begin with the float template command followed by a subcommand and any options that apply. To see the available subcommands, enter float template -h.

To view available service templates, enter float template list.

$ float template list
+----------+---------+-------------+-------------------------------+
|   NAME   |   TAG   |    TYPE     |          LASTUPDATED          |
+----------+---------+-------------+-------------------------------+
| jupyter  | sos     | JobTemplate | 2023-09-25 03:41:35 +0000 UTC |
|          | v3.5.0  | JobTemplate | 2023-06-30 12:01:36 +0000 UTC |
| nextflow | jfs     | JobTemplate | 2023-10-12 06:11:25 +0000 UTC |
| rstudio  | 2022.12 | JobTemplate | 2023-06-30 13:50:51 +0000 UTC |
+----------+---------+-------------+-------------------------------+

To view more information about a template, enter float template info -T <template_name>, for example,

$ float template info -T jupyter
name: jupyter
tag: v3.5.0
type: JobTemplate
lastUpdated: 2023-06-30T12:01:36Z
jobParams:
    - image: jupyter_server:v3.5.0
      cpu: "2"
      mem: "4"
      env:
        - JUPYTER_PASS=Welcome123!
      publish:
        - 8888:8888
      withRoot: true

To submit a job using a template, use the float template deploy -T <template_name> command followed by other options (for example, --securityGroup) where <template_name> is the name of the template.

Using Service Templates from the Web Interface

To view available templates, click Job Templates from the left-hand panel.
To get more information regarding a template, click anywhere in the box displaying the template in the Job Templates screen.
To submit a job using a service template, choose one of the following options
- From the screen listing the available templates, select a template and then click the Submit Job button on the right-hand side.
  
  This opens the Submit Job pop-up where you must populate any required fields and where you can customize optional parameters.
- To customize parameters, click the Start from Scratch tab, load a template from the dropdown menu, and then choose which fields to populate.
- Click Submit (bottom, right-hand side of screen).

Saving a Job as a Private Template

You can save a current or a past job as a private template to launch other jobs.

To save a job as a private template using the CLI, enter the following command.

float template save -j JOB_ID --template NAME:TAG

Replace:

JOB_ID: ID of job to save as private template
NAME: name for template
TAG: tag to associate with template (default: latest)

To save a job as a private template using the web interface, complete the following steps.

On the Jobs screen, identify the job you want to save as a private template, then click the ID.
On the Job Details screen, click More Actions (on the top, right-hand side of the screen).
Click Save as Template, then fill in the fields in the pop-up window.
Click Save.