templates

package
v0.4.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 16, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	MaxCPULimit       = 64.0
	MaxMemoryLimitMB  = 262144 // 256 GB
	MaxTimeoutSeconds = 86400  // 24 hours
	MaxSlugLength     = 100
	MaxNameLength     = 200
	MaxTagCount       = 20
	MaxAllowedHosts   = 100
	MaxEnvVarCount    = 100
	MaxStartupScript  = 64 * 1024 // 64 KB
)

Validation bounds. These are deliberately generous — they exist to reject values that would break the Docker API or exhaust the host, not to express a per-deployment quota (that belongs in the policy layer).

Variables

View Source 
var (
	ErrTemplateNotFound   = errors.New("template not found")
	ErrTemplateSlugExists = errors.New("template with this slug already exists")
	ErrInvalidTemplate    = errors.New("invalid template configuration")
)
View Source 
var BuiltInTemplates = []Template{
	{
		ID:          uuid.MustParse("00000000-0000-0000-0000-000000000001"),
		Slug:        "python-data-science",
		Name:        "Python Data Science",
		Description: "Python 3.12 with Jupyter, pandas, numpy, matplotlib, and scikit-learn",
		Category:    "data-science",
		Tags:        []string{"python", "jupyter", "machine-learning", "data-analysis"},
		Image:       "python:3.12-slim",
		Author:      "VaultRun Team",
		Version:     "1.0.0",
		Published:   true,
		Featured:    true,
		Resources: ResourceConfig{
			CPULimit:       2.0,
			MemoryLimitMB:  4096,
			TimeoutSeconds: 7200,
		},
		Network: NetworkConfig{
			Enabled:      true,
			AllowedHosts: []string{"github.com", "pypi.org"},
		},
		Policy: "Python data science environment. Allow github.com and pypi.org. Max 2 CPU, 4GB RAM, 2 hour timeout.",
		Packages: map[string][]string{
			"python": {"jupyter", "pandas", "numpy", "matplotlib", "scikit-learn", "seaborn"},
		},
		Readme: "# Python Data Science\n\nPre-configured for data analysis and machine learning.\n\n## Included\n- Python 3.12\n- Jupyter Lab\n- pandas, numpy, matplotlib\n- scikit-learn, seaborn",
	},
	{
		ID:          uuid.MustParse("00000000-0000-0000-0000-000000000002"),
		Slug:        "nodejs-api",
		Name:        "Node.js API Development",
		Description: "Node.js 20 with Express, TypeScript, and common API tools",
		Category:    "web-dev",
		Tags:        []string{"nodejs", "typescript", "api", "express"},
		Image:       "node:20-slim",
		Author:      "VaultRun Team",
		Version:     "1.0.0",
		Published:   true,
		Featured:    true,
		Resources: ResourceConfig{
			CPULimit:       2.0,
			MemoryLimitMB:  2048,
			TimeoutSeconds: 3600,
		},
		Network: NetworkConfig{
			Enabled:      true,
			AllowedHosts: []string{"github.com", "registry.npmjs.org"},
		},
		Policy: "Node.js API development. Allow github.com and npm registry. Max 2 CPU, 2GB RAM, 1 hour timeout.",
		Packages: map[string][]string{
			"npm": {"express", "typescript", "ts-node", "@types/node", "@types/express"},
		},
		Readme: "# Node.js API Development\n\nPre-configured for REST API development.\n\n## Included\n- Node.js 20\n- TypeScript\n- Express\n- Common type definitions",
	},
	{
		ID:          uuid.MustParse("00000000-0000-0000-0000-000000000003"),
		Slug:        "web-scraping",
		Name:        "Web Scraping",
		Description: "Python with Playwright and headless Chrome for web scraping",
		Category:    "automation",
		Tags:        []string{"python", "playwright", "scraping", "browser"},
		Image:       "vaultrun/browser:playwright-python",
		Author:      "VaultRun Team",
		Version:     "1.0.0",
		Published:   true,
		Featured:    true,
		Resources: ResourceConfig{
			CPULimit:       2.0,
			MemoryLimitMB:  4096,
			TimeoutSeconds: 1800,
		},
		Network: NetworkConfig{
			Enabled:      true,
			AllowedHosts: []string{},
		},
		Policy: "Web scraping environment. Network enabled. Max 2 CPU, 4GB RAM, 30 minute timeout.",
		Packages: map[string][]string{
			"python": {"playwright", "beautifulsoup4", "requests", "lxml"},
		},
		Readme: "# Web Scraping\n\nHeadless Chrome with Playwright for web scraping.\n\n## Included\n- Python 3.12\n- Playwright + Chromium\n- BeautifulSoup4\n- Requests",
	},
	{
		ID:          uuid.MustParse("00000000-0000-0000-0000-000000000004"),
		Slug:        "rust-dev",
		Name:        "Rust Development",
		Description: "Latest Rust with cargo and common crates",
		Category:    "development",
		Tags:        []string{"rust", "cargo", "systems"},
		Image:       "rust:latest",
		Author:      "VaultRun Team",
		Version:     "1.0.0",
		Published:   true,
		Featured:    false,
		Resources: ResourceConfig{
			CPULimit:       4.0,
			MemoryLimitMB:  8192,
			TimeoutSeconds: 3600,
		},
		Network: NetworkConfig{
			Enabled:      true,
			AllowedHosts: []string{"github.com", "crates.io"},
		},
		Policy: "Rust development. Allow github.com and crates.io. Max 4 CPU, 8GB RAM for compilation.",
		Packages: map[string][]string{
			"cargo": {"serde", "tokio", "reqwest"},
		},
		Readme: "# Rust Development\n\nLatest Rust with cargo.\n\n## Included\n- Latest Rust stable\n- cargo\n- Common crates pre-cached",
	},
}

BuiltInTemplates are shipped with VaultRun

Functions

This section is empty.

Types

type CreateTemplateRequest 

type CreateTemplateRequest struct {
	Slug          string              `json:"slug" binding:"required"`
	Name          string              `json:"name" binding:"required"`
	Description   string              `json:"description" binding:"required"`
	Category      string              `json:"category" binding:"required"`
	Tags          []string            `json:"tags"`
	Image         string              `json:"image" binding:"required"`
	Version       string              `json:"version"`
	Resources     ResourceConfig      `json:"resources"`
	Network       NetworkConfig       `json:"network"`
	Environment   map[string]string   `json:"environment"`
	Policy        string              `json:"policy"`
	Packages      map[string][]string `json:"packages"`
	Readme        string              `json:"readme"`
	StartupScript string              `json:"startup_script"`
}

CreateTemplateRequest for API

func (CreateTemplateRequest) Validate added in v0.3.1 

func (r CreateTemplateRequest) Validate() error

Validate checks a create request before it reaches the database. Returning all problems at once rather than the first keeps the API usable for callers building templates programmatically.

type Manager 

type Manager struct {
	// contains filtered or unexported fields
}

Manager handles template operations

func New 

func New(db *sqlx.DB) *Manager

New creates a new template manager

func (*Manager) Bootstrap 

func (m *Manager) Bootstrap(ctx context.Context) error

Bootstrap inserts built-in templates if they don't exist

func (*Manager) Create 

func (m *Manager) Create(ctx context.Context, orgID *uuid.UUID, req CreateTemplateRequest) (*Template, error)

Create creates a new template owned by orgID, or unowned when orgID is nil (a template created with the master key, like the built-ins).

func (*Manager) Delete 

func (m *Manager) Delete(ctx context.Context, id uuid.UUID) error

Delete deletes a template

func (*Manager) Get 

func (m *Manager) Get(ctx context.Context, id uuid.UUID) (*Template, error)

Get retrieves a template by ID

func (*Manager) GetBySlug 

func (m *Manager) GetBySlug(ctx context.Context, slug string) (*Template, error)

GetBySlug retrieves a template by slug

func (*Manager) List 

func (m *Manager) List(ctx context.Context, filter TemplateFilter) ([]Template, error)

List returns templates with optional filtering

func (*Manager) RecordUsage 

func (m *Manager) RecordUsage(ctx context.Context, templateID, sessionID uuid.UUID, orgID *uuid.UUID) error

RecordUsage records that a template was used for a session. orgID is nil for a session that does not belong to an org.

func (*Manager) Update 

func (m *Manager) Update(ctx context.Context, id uuid.UUID, req UpdateTemplateRequest) (*Template, error)

Update updates a template

type NetworkConfig 

type NetworkConfig struct {
	Enabled      bool     `json:"enabled"`
	AllowedHosts []string `json:"allowed_hosts"`
}

NetworkConfig defines network access

type ResourceConfig 

type ResourceConfig struct {
	CPULimit       float64 `json:"cpu_limit"`
	MemoryLimitMB  int     `json:"memory_limit_mb"`
	TimeoutSeconds int     `json:"timeout_seconds"`
}

ResourceConfig defines default resource limits

type Template 

type Template struct {
	ID          uuid.UUID  `db:"id" json:"id"`
	Slug        string     `db:"slug" json:"slug"`               // URL-friendly identifier
	Name        string     `db:"name" json:"name"`               // Display name
	Description string     `db:"description" json:"description"` // Short description
	Category    string     `db:"category" json:"category"`       // Category (data-science, web-dev, etc.)
	Tags        []string   `db:"tags" json:"tags"`               // Tags for search
	Image       string     `db:"image" json:"image"`             // Docker image
	Author      string     `db:"author" json:"author"`           // Author name
	AuthorOrg   *uuid.UUID `db:"author_org" json:"author_org"`   // Author organization (nullable)
	Version     string     `db:"version" json:"version"`         // Template version
	Published   bool       `db:"published" json:"published"`     // Whether publicly visible
	Featured    bool       `db:"featured" json:"featured"`       // Featured on homepage
	UseCount    int        `db:"use_count" json:"use_count"`     // Times used

	// Configuration
	Resources   ResourceConfig    `db:"resources" json:"resources"`     // Default resource limits
	Network     NetworkConfig     `db:"network" json:"network"`         // Network configuration
	Environment map[string]string `db:"environment" json:"environment"` // Environment variables
	Policy      string            `db:"policy" json:"policy"`           // Natural language policy

	// Metadata
	Packages      map[string][]string `db:"packages" json:"packages"`             // Pre-installed packages
	Readme        string              `db:"readme" json:"readme"`                 // Full README (Markdown)
	StartupScript string              `db:"startup_script" json:"startup_script"` // Optional startup script

	CreatedAt time.Time `db:"created_at" json:"created_at"`
	UpdatedAt time.Time `db:"updated_at" json:"updated_at"`
}

Template represents a pre-configured session template

type TemplateFilter 

type TemplateFilter struct {
	Category  string   `form:"category"`
	Tags      []string `form:"tags"`
	Search    string   `form:"search"` // Search in name/description
	Featured  bool     `form:"featured"`
	Published bool     `form:"published"`
	Limit     int      `form:"limit"`
	Offset    int      `form:"offset"`
}

TemplateFilter for listing/searching

type UpdateTemplateRequest 

type UpdateTemplateRequest struct {
	Name          *string             `json:"name"`
	Description   *string             `json:"description"`
	Category      *string             `json:"category"`
	Tags          []string            `json:"tags"`
	Image         *string             `json:"image"`
	Version       *string             `json:"version"`
	Published     *bool               `json:"published"`
	Featured      *bool               `json:"featured"`
	Resources     *ResourceConfig     `json:"resources"`
	Network       *NetworkConfig      `json:"network"`
	Environment   map[string]string   `json:"environment"`
	Policy        *string             `json:"policy"`
	Packages      map[string][]string `json:"packages"`
	Readme        *string             `json:"readme"`
	StartupScript *string             `json:"startup_script"`
}

UpdateTemplateRequest for API

func (UpdateTemplateRequest) Validate added in v0.3.1 

func (r UpdateTemplateRequest) Validate() error

Validate checks the mutable fields of an update request. Only non-nil fields are checked, so a partial update cannot be rejected for a field it omits.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.