runai-bgu template Manual

Introduction

runai-bgu template is a command-line interface (CLI) wrapper for the template tool used to manage resource templates for workloads on the BGU HPC cluster. This command provides access to the template management system that allows you to create, modify, and use predefined resource configurations for your workloads. Templates help standardize resource allocation and simplify workload submission by providing reusable configurations.

This manual explains how to use runai-bgu template to access the template management system.

For a detailed guide on creating and managing templates, refer to the dedicated template documentation.

Quick Start

To access the template system, use:

$ runai-bgu template

Launches the template management interface.

Basic Usage

Access Template System

Launch the template management tool:

$ runai-bgu template

This command is a wrapper that calls the underlying template CLI tool with any additional arguments you provide.

Pass Arguments to Template Tool

Forward arguments to the template system:

$ runai-bgu template [arguments]

Any arguments following template are passed directly to the underlying template command.

Understanding Templates

Templates in the BGU HPC cluster serve several purposes:

Resource Standardization: Templates define standard resource configurations (CPU, memory, GPU) for common workload types.
User Templates: Personal templates that you can create and manage for your own workloads.
Group Templates: Shared templates created by your research group or department for team use.
Simplified Submission: Templates allow you to submit workloads without specifying individual resource parameters each time.

Template Usage with Workloads

Templates can be used when submitting workloads:

User Template: Use your personal templates with the --ut flag when submitting workloads.
Group Template: Use shared group templates with the --gt flag when submitting workloads.

Example with user template:

$ runai-bgu submit python -n my-job --ut my-template

Example with group template:

$ runai-bgu submit python -n my-job --gt shared-template

Getting Help

For detailed information about template management:

Template Documentation

For comprehensive documentation about the template system, including how to create, modify, and manage templates, please refer to the dedicated template documentation.

Template Command Help

Get help for the template command:

$ runai-bgu template --help

This will show you all available options and subcommands for template management.

Common Template Operations

While the specific commands are handled by the underlying template tool, common operations include:

Creating Templates: Define new resource configurations for reuse.
Listing Templates: View available user and group templates.
Modifying Templates: Update existing template configurations.
Deleting Templates: Remove templates that are no longer needed.

Best Practices

Template Naming: Use descriptive names for your templates to make them easy to identify.
Resource Planning: Design templates based on your typical workload requirements.
Team Coordination: Coordinate with your team when creating group templates.
Regular Review: Periodically review and update templates to ensure they meet current needs.