Creating Runtime Templates

As described in Runtime Overview, runtimes are the compute resources used to execute processes and logic within jobs and notebooks defined within the Syntasa platform. The various tasks and experiments being done in apps and notebooks likely require different types and sizes of runtimes.

Creating a new runtime template entails several pieces of information, some only affecting the attributes of the runtime template seen within the Syntasa environment, and others relating to the cluster instance that is initiated within the cloud platform.

Creating a New Runtime template

The first and most important decision when creating a new runtime template is the runtime type. The selection of runtime type affects the subsequent fields and settings available, which vary widely, therefore the details of each runtime type are detailed in a dedicated article. In this article, we will cover basic details when creating any runtime template. 

Runtime attributes

The following fields define the runtime template object within the Syntasa application. The defined runtime templates are available for selection in jobs, notebooks, and the interactive mode of apps; the attributes affect how they are displayed in those areas.

  • Name - This is the name displayed in the Runtime Template drop-down menus across the application. Each name must be unique among all runtime templates.
  • Copy Runtime - It allows you to copy an existing runtime template. For more information on how to copy a runtime, please click here.
  • Description - Provide information explaining the purpose of the runtime template. This is especially useful if the runtime template is to be shared with other users.
  • Tags - All objects throughout the Syntasa application support tags to help organize and search for related objects. To know more about this, please refer to this article.
  • Runtime Type - This dropdown displays a list of all available runtime types based on your environment. 
  • Default Development/Default Production

    For GCP Dataproc and AWS EMR, each runtime type can have one default runtime template designated for use in an app's development and/or production environment. This default template is assigned to the process or step of a job.

    For Kubernetes containers, the default template is determined by a combination of Runtime type and image name. This means that a unique combination of Kubernetes runtime type and image type can have one default runtime template for use in an app's development and/or production environment.

    Each job process type is associated with a specific default runtime type(or Runtime type + Image type). Therefore, the default runtime template assigned to a process or step is the one that matches the appropriate runtime type (or Runtime type + Image type) and has the corresponding environment selected.

 

Copying the Runtime Template

It may be needed to create a new runtime template that is slightly different from an existing one. Turning this on allows you to create a new runtime template from an existing one instead of starting from scratch. You can follow the steps to copy the existing runtime template:

  1. Go to Resources>>Runtimes
  2. Click on the plus (+) icon to access the 'Create Runtime' screen.
  3. Enter a unique Runtime template name and toggle 'Copy Runtime' to enable.
  4. A new dropdown labeled 'Source' will appear, displaying all existing runtime templates grouped by their type.
  5. Choose the runtime template you wish to copy from the 'Source' dropdown.
  6. Once a runtime template is selected from 'Source':
    • The displayed fields will adjust based on the chosen runtime template. Some fields like Runtime type and Image type may be locked to maintain consistency across fields.
    • Field values will auto-populate from the selected runtime template.
  7. Make any necessary changes to the fields and click 'Save'.
  8. The new runtime will be added to the list.

The screenshots below illustrate an example where the 'Syntasa Demo-GCP' runtime template is chosen from the 'Source' dropdown, and all its values are automatically copied into the respective fields.

 

As mentioned earlier, the fields on the 'Create Runtime Template' screen change based on the selected Runtime type. To provide detailed guidance for each runtime type, we've created separate articles. Below are the links to each: