# track.ymltype: trackslug: my-first-trackicon: https://storage.googleapis.com/instruqt-frontend/img/tracks/default.pngtitle: My first trackteaser: A short description of the track.description: |A long description of the track.You can use any GitHub flavoured markdown.tags: []challenges: []owner: my-org-slugdevelopers:- bas@instruqt.compublished: falseprivate: true
After the track is created, fill out the track.yml and config.yml files with the needed information. The track object contains the metadata that describes a track.
field | type | description |
type |
| The type of the track. Can either be |
slug |
| A string that is the ID of the track. The value of the ID should be globally unique. |
icon |
| The URL of the icon that is to be shown with the track. The size of the icon should be 48x48 pixels. |
title |
| The title of the track. |
teaser |
| A short description of the track, which is shown in the track list. |
description |
| A full description of the track, which is shown at the track details. |
tags |
| A list of strings that represent tags associated with the track. |
| A list of challenges that belong to the track. | |
owner |
| The slug of the organization that owns this track. |
developers |
| The developers of this track. Developers can preview the track when it is not yet published. |
published |
| Whether the track is published or not. When unpublished, the tracks is only visible to the track developers. |
private |
| Whether the track is visible outside an organization. |
maintenance |
| Whether the track is in maintenance. When |
show_timer |
| Whether to show a timer during the assignment. When |
skipping_enabled |
| Whether skipping challenges is enabled for end-users. Read more about skipping challenges here. Defaults to false. |
The config object defines the environment that will be created for the participant. Configurations support containers, virtual machines and GCP projects. Depending on the resource type, different values need to be supplied in the configuration file.
# config.ymlversion: 2containers:- name: containerimage: alpineports:- 8080- 9090resources:memory: 128shell: /bin/bashenvironment:ENV_VAR: valueANOTHER: onevirtualmachines:- name: vmimage: debian-9machine_type: g1-smallpool_size: 1shell: /bin/bashenvironment:ENV_VAR: valueANOTHER: onegcp_projects:- name: gcp-projectservices:- cloudresourcemanager.googleapis.com- compute.googleapis.comaws_accounts:- name: aws-accountiam_policy: |{"Version": "2012-10-17","Statement": [{"Effect": "Allow","Action": "cloudformation:*","Resource": "*"}]}managed_policies:- arn:aws:iam::aws:policy/AmazonEC2FullAccess
The config object defines the environment that will be created for the participant. Configurations support containers, virtual machines and GCP projects. Depending on the resource type, different values need to be supplied in the configuration file.