Configuration files
This reference describes the configuration files that make up Instruqt tracks.
Instruqt tracks are Infrastructure-as-Code artifacts and are made up of configuration files that contain all the properties and settings for tracks in YAML and Markdown format. You manage these files either from Web UI or Instruqt CLI. For example, the configuration file
track.yml sets track characteristics and can look something like this:YAML
slug: mytrack
id: baekpuxv2m5g
type: track
title: MyTrack
teaser: Get started quickly with just one container-based sandbox host.
description: Get started quickly with a container-based sandbox host. Choose a container
when you need a fast, lightweight Linux system.
icon: https://cdn.instruqt.com/assets/templates/ubuntu.png
tags: []
owner: myteam
developers:
maintenance: true
show_timer: true
skipping_enabled: true
↳ You probably recognize tracks details like
title and teaser as you set them from Web UI. But you can also set these properties by manipulating the track.yml file from your code editor and push your changes with Instruqt CLI to the Instruqt platform.YAML spaces for indentation
YAML files use spaces for indentation. You can use 2 or 4 spaces for indentation, but no tabs.
If you created a track with Instruqt CLI or pulled a track to your machine, you will find the configuration files inside the track directory and subdirectories:
# Example directory layout with track configuration files
.
├── 01-first-challenge # <- First challenge
| ├── assignment.md # <- Challenge assignment and configuration
│ ├── check-host01 # <- Challenge lifecycle scripts
│ └── solve-host01
├── 02-second-challenge # <- Second challenge
| ├── assignment.md
│ ├── setup-host01
│ ├── check-host01
│ ├── solve-host01
│ └── cleanup-host01
├── track_scripts # <- Track lifecycle scripts
│ ├── setup-host01
│ └── cleanup-host01
├── config.yml # <- Sandbox configuration
└ ── track.yml # <- Track configuration
Continuing on the example directory with track configuration files, Instruqt has the following configuration files:
cleanup-hostContains a script for cleaning up the track. See the Lifecycle scripts topic for details.
assignment.mdContains the challenge definition in a combination of YAML and Markdown. See the Challenges topic for details.setup-hostContains a script for setting up the challenge. See the Lifecycle scripts topic for details.check-hostContains a script for checking if the learner solved the challenge. See the Lifecycle scripts topic for details.solve-hostContains a script for automatically solving a challenge when the learner skips a challenge or when you test a track. See the Lifecycle scripts topic for details.cleanup-hostContains a script for cleaning up the challenge. See the Lifecycle scripts topic for details.
You edit configuration files from your code editor. And when you are done, you push your updated track to the Instruqt platform:
instruqt track push
Last modified 1yr ago