Template Management Commands

The template management commands provide CRUD (Create, Read, Update, Delete) operations for compute templates in the Open Resource Broker. These commands use the TemplateConfigurationManager as the single source of truth.

Note: For complete CLI reference including all flags and argument patterns, see CLI Reference.

Available Commands

List Templates

List all available templates:

orb templates list

List with detailed configuration fields:

orb templates list --long

Filter by provider API:

orb templates list --provider-api aws

Output formats:

orb templates list --format table
orb templates list --format yaml
orb templates list --format json
orb templates list --format list

Show Template Details

Show detailed information about a specific template:

orb templates show TEMPLATE_ID

Show with different output formats:

orb templates show my-template --format yaml
orb templates show my-template --format table

Create Template

Create a new template from a configuration file:

orb templates create --file template.json

Create with validation only (don't save):

orb templates create --file template.json --validate-only

Template Configuration File Format

Templates can be defined in JSON or YAML format:

JSON Format:

{
  "template_id": "my-aws-template",
  "name": "My AWS Template",
  "provider_api": "aws",
  "image_id": "ami-12345678",
  "machine_type": "t3.medium",
  "key_name": "my-keypair",
  "security_group_ids": ["sg-12345678"],
  "subnet_ids": ["subnet-12345678"],
  "user_data": "#!/bin/bash\necho 'Hello World'",
  "tags": {
    "Environment": "development",
    "Project": "hostfactory"
  },
  "version": "1.0"
}

YAML Format:

template_id: my-aws-template
name: My AWS Template
provider_api: aws
image_id: ami-12345678
machine_type: t3.medium
key_name: my-keypair
security_group_ids:
  - sg-12345678
subnet_ids:
  - subnet-12345678
user_data: |
  #!/bin/bash
  echo 'Hello World'
tags:
  Environment: development
  Project: hostfactory
version: "1.0"

Update Template

Update an existing template:

orb templates update TEMPLATE_ID --file updated-template.json

Delete Template

Delete a template:

orb templates delete TEMPLATE_ID

Force deletion without confirmation:

orb templates delete TEMPLATE_ID --force

Validate Template

Validate a template configuration file:

orb templates validate --file template.json

Refresh Templates

Refresh the template cache and reload from files:

orb templates refresh

Force complete refresh:

orb templates refresh --force

Template File Hierarchy

The system supports provider-specific template files with hierarchical loading:

Instance Files: {provider}inst_templates.json (Priority 1)
Type Files: {provider}type_templates.json (Priority 2)
Main Files: {provider}prov_templates.json (Priority 3)
Legacy Files: templates.json (Priority 4)

Templates are merged with higher priority files overriding lower priority ones.

Examples

Basic Usage

# List all templates
$ orb templates list
{
  "success": true,
  "templates": [
    {
      "template_id": "aws-basic",
      "name": "Basic AWS Template",
      "provider_api": "aws",
      "image_id": "ami-12345678",
      "machine_type": "t3.medium"
    }
  ],
  "total_count": 1,
  "message": "Retrieved 1 templates successfully"
}

# Show specific template
$ orb templates show aws-basic
{
  "success": true,
  "template": {
    "template_id": "aws-basic",
    "name": "Basic AWS Template",
    "provider_api": "aws",
    "image_id": "ami-12345678",
    "machine_type": "t3.medium",
    "key_name": "my-keypair",
    "security_group_ids": ["sg-12345678"],
    "subnet_ids": ["subnet-12345678"],
    "tags": {
      "Environment": "production"
    }
  },
  "message": "Retrieved template aws-basic successfully"
}

Template Creation

# Create template from file
$ orb templates create --file new-template.json
{
  "success": true,
  "message": "Template created successfully",
  "template_id": "new-aws-template"
}

# Validate template without creating
$ orb templates create --file new-template.json --validate-only
{
  "success": true,
  "message": "Template validation successful",
  "template_id": "new-aws-template"
}

Template Validation

# Validate template file
$ orb templates validate --file template.json
{
  "success": true,
  "valid": true,
  "validation_errors": [],
  "validation_warnings": [],
  "template_id": "my-template",
  "message": "Validation completed"
}

# Validation with errors
$ orb templates validate --file invalid-template.json
{
  "success": false,
  "valid": false,
  "validation_errors": [
    "Missing required field: template_id",
    "Invalid machine_type: must be a valid instance type"
  ],
  "validation_warnings": [
    "No tags specified: recommended for resource management"
  ],
  "message": "Validation failed"
}