Create a track from a template
Speed up track building.
This guide explains how to create a template-based track through Web UI and Instruqt CLI.
Templates are track skeletons based on commonly used sandbox types. Using templates speeds up your track building. Because after creating from a template, you only have to complete the track. But first, you decide which template best suits your needs.
Use the following table to decide which template best suits your needs:
Need/situation | Template | Content |
---|---|---|
I need a sandboxed AWS account in my Instruqt track | AWS Cloud Account |
|
I need a container-based sandbox host | Sandbox container | Lightweight Linux system |
I need a virtual machine with more computing power and memory.
Or
I want to run Docker containers. | Sandbox virtual machine |
|
I need a pre-installed helm chart. | Helm chart |
|
I need a single node Kubernetes cluster | Kubernetes |
|
I need a Kubernetes cluster on multiple sandbox hosts | Multi-node Kubernetes cluster |
|
I need a VS Code editor | VSCode & TypeScript |
|
This guide will choose the Kubernetes template. If you choose another template, replace your choice where appropriate.
Pick the Web UI or the Instruqt CLI route depending on your preference:
🌐 Web UI
💻 Instruqt CLI
- 1.
- 2.Click Create track on the Content page. ↳ The Start creating content page opens.
- 3.Click Create from template to open the Instruqt templates page.
- 4.Select the template of your choice. ↳ The Track info pop-up opens.
- 5.In the Track title field, enter your title.
- 6.In the Track slug field, modify the slug if you want to.
- 7.Click Create. ↳ Instruqt creates the track and shows the Track overview page of the newly created track.
- 1.Type the following command to create a track:instruqt track create
- 2.Enter the track title:==> Track title: KubernetesTrack
- 3.Enter option 2 to select
From a template
:==> Start with an empty track or use a template:[1] From scratchFor full flexibility, start with an empty track[2] From a templateTo get started quickly, start from one of our templatesPlease select your method: 2 - 4.Enter the number of the template you want to use:==> Choose a template:[1] AWS Cloud AccountLearn how to build tracks with an AWS account[2] Sandbox containerGet started quickly with just one container-based sandbox host.[3] Sandbox virtual machineUse a virtual machine (VM) as a sandbox host[4] Helm chartLearn how to install helm charts with Instruqt.[5] KubernetesLearn how to build Kubernetes-based tracks with this template[6] Multi-node Kubernetes clusterSetup a Kubernetes cluster on multiple sandbox hosts[7] VSCode & TypeScriptEdit and test TypeScript applications in VSCodePlease select your template: 5↳ Instruqt CLI creates the track and returns this output:Using the template: Kubernetes==> Creating new track files:kubernetestrack├── 01-deploying-nginx│ ├── assignment.md│ ├── check-kubernetes-vm│ └── solve-kubernetes-vm├── 02-exposing-nginx│ ├── assignment.md│ ├── check-kubernetes-vm│ ├── setup-kubernetes-vm│ └── solve-kubernetes-vm├── 03-showing-the-service│ └── assignment.md├── 04-kubernetes-dashboard│ ├── assignment.md│ └── setup-kubernetes-vm├── track_scripts│ └── setup-kubernetes-vm├── config.yml└── track.ymlOK==> More templates are available at https://play.instruqt.com/inspiration-library==> To play your track, change into the track directory and push it to Instruqt:cd kubernetestrackinstruqt track push
- 5.Deploy the track to the Instruqt platform:instruqt track push
- 6.Open your browser and go to play.instruqt.com/. ↳ Instruqt now shows the created track in your content.
Your output depends on the template you have chosen. The same applies to the created directories and files. But you will have these components anyway:
- A main directory with the track name. In this case
kubernetestrack
- The configuration files
config.yml
andtrack.yml
inside the main directory - A subdirectory whose name starts with
01
. In this case:01-deploying-nginx
- The configuration files
assignment.md
,check-...
, andsolve-...
inside the01
subdirectory
kubernetestrack
├── 01-deploying-nginx
│ ├── assignment.md
│ ├── check-kubernetes-vm
│ └── solve-kubernetes-vm
├── 02-exposing-nginx
│ ├── assignment.md
│ ├── check-kubernetes-vm
│ ├── setup-kubernetes-vm
│ └── solve-kubernetes-vm
├── 03-showing-the-service
│ └── assignment.md
├── 04-kubernetes-dashboard
│ ├── assignment.md
│ └── setup-kubernetes-vm
├── track_scripts
│ └── setup-kubernetes-vm
├── config.yml
└── track.yml
The topic configuration files explains the created files in detail. But the following table is already a short overview:
File | Purpose | Content | Remark |
---|---|---|---|
config.yml | Sets the characteristics for the sandbox | YAML | |
track.yml | Sets the characteristics for the track | YAML | |
assingment.md | Sets the characteristics for a challenge | Markdown | Created for every challenge in your track |
check-... | Checks if the learner solved a challenge | Scripting language | The full name depends on your setting |
solve-... | Solves a challenge automatically if the learner skips a challenge | Scripting language | The full name depends on your setting |
You can also watch this video tutorial for creating a track:
Well done! Now you can play your track to see if everything works as expected.
Last modified 9mo ago