Lab

The lab resource provides the metadata about the lab and some of its configuration. This is the reusable part of what is currently called a "track" today.

Attributes

Attributes are the properties of a resource that can be used to configure it.

Attribute	Description
Title title required string	The title of the lab.
Description description required string	A description of the lab.
Tags tags []string	Tags that describe the lab.
Settings settings block Settings	Settings that configure the lab.
Layouts layout required []block Layout	A layout that can be used within the lab. This block can be specified multiple times on a lab resource, to allow using multiple layouts throughout a lab.
Content content block Content	The instructional content of the lab that is presented to the end-user.

Computed Attributes

These attributes are computed when the config is parsed and applied, and are therefor only known at parsetime or runtime.

Attribute	Description
Meta ID meta.id string	The full ID of the resource e.g. `resource.type.name`. This is computed from the full resource path: resource "type" "name" { ... }
Meta Type meta.type string	The type of the resource. This taken from the type label of the resource definition. resource "type" "name" { ... }
Meta Name meta.name string	The name of the resource. This taken from the name label of the resource definition. resource "type" "name" { ... }
DefaultLayout default_layout string	The default layout to use when the lab does not have any instructional content or it is not overridden by a Chapter or page.

Examples

Full Example

resource "lab" "minimal" {
  title = "Minimal"
  description = "This is a minimal example lab."

  settings {
    idle {
      enabled = false
    }
  }

  layout "minimal" {
    default = true
    source = resource.layout.minimal

    tab "terminal" {
      panel = "terminal"
      target = resource.terminal.shell
    }

    instructions {
      panel = "instructions"
    }
  }

  layout "instructions_only" {
    source = resource.layout.minimal

    instructions {
      panel = "instructions"
    }
  }

  content {
    chapter "introduction" {
      title = "Introduction"
      layout = "minimal"
      
      page "first" {
        layout = "instructions_only"
        source = resource.page.first
      }

      page "second" {
        source = resource.page.second
      }
    }

    chapter "imported" {
      title = "Imported"

      page "first" {
        source = module.chapter.output.pages.first
      }

      page "second" {
        source = module.chapter.output.pages.second
      }
    }
  }
}