Skip to content

Configuration Reference

Complete reference documentation for all Instruqt lab configuration options. This reference covers all available HCL resources, configuration types, and functions for creating interactive labs.

The reference documentation is organized around two main concepts:

  • Content Resources - Define what learners see and interact with (educational content, activities, assessments)
  • Sandbox Resources - Define the technical infrastructure and environment that powers the lab

This separation makes it easier to find what you need based on whether you’re creating educational content or configuring technical infrastructure.

Resources for creating instructional content and interactive activities:

Complete guide to content creation resources including labs, pages, layouts, and interactive activities.

Essential Resources:

  • Lab - Main lab configuration, metadata, and content structure
  • Page - Individual instructional content pages with variable substitution and activity embedding
  • Layout - User interface layout definitions that arrange tabs and instructions
  • Note - Static reference materials and documentation tabs

Interactive Activities:

  • Task - Hands-on interactive challenges with automated validation and feedback
  • Quiz Overview - Knowledge assessments with multiple question types

Infrastructure and environment resources for lab environments:

Complete guide to infrastructure patterns and environment configuration.

Compute Resources:

  • Container - Docker containers for isolated application environments
  • Sidecar - Additional containers that extend main containers

Networking:

  • Network - Isolated networks for resource communication
  • Ingress - HTTP/HTTPS routing and external access

User Interface Tabs:

Storage & File Management:

  • Copy - File and directory copying operations
  • Template - Dynamic file generation from templates

Cloud Provider Integrations:

  • AWS Account - Amazon Web Services account provisioning with user management
  • Azure Subscription - Microsoft Azure subscription setup with user and service principal management
  • Google Cloud Project - Google Cloud Platform project configuration with user and service account management

Container Orchestration:

Utilities:

Advanced configuration patterns and dynamic content:

Configuration Types:

  • Resource - Resource definition patterns and best practices
  • Variable - Variable declarations and usage patterns
  • Local - Local value computations and expressions
  • Output - Output value definitions for resource sharing
  • Module - Module organization and reuse patterns

Dynamic Configuration:

If you’re focused on creating educational content and learning experiences:

  1. Lab - Start with lab structure and metadata
  2. Page - Create instructional content with embedded activities
  3. Task - Add hands-on interactive challenges
  4. Layout - Design the user interface and tab arrangement
  5. Quiz - Add knowledge assessments and quizzes

If you’re focused on setting up the technical environment:

  1. Container - Set up application environments
  2. Network - Configure container networking
  3. Terminal - Provide command-line access
  4. Service - Expose web applications
  5. Cloud Integration - Connect to cloud platforms as needed

If you’re building reusable lab infrastructure:

  1. Configuration Types - Learn advanced HCL patterns
  2. Module - Create reusable lab components
  3. Functions - Use dynamic configuration capabilities
  4. Template - Generate configuration files dynamically

Simple Web App Lab: Lab → Container → Service → Page → Layout

Development Environment Lab: Lab → Container → Terminal → Editor → Network → Page

Cloud Integration Lab: Lab → Cloud Resources → Container → Service → Task → Page

Assessment-Heavy Lab: Lab → Page → Task → Quiz → Layout

Multi-Service Architecture Lab: Lab → Multiple Containers → Network → Service → Terminal → Page

  • New to HCL? Start with Configuration Types to learn the basics
  • Looking for Examples? Check the overview pages for Content and Sandbox resources
  • Building Complex Labs? Explore Module patterns for reusable components
  • Integration Questions? See Cloud Provider documentation for specific platforms