Instruqt Docs
PlatformGithub
Search
⌃K
Links
Comment on page

Create a sandbox preset

This guide explains how to create a draft sandbox preset from scratch using Web UI or Instruqt CLI.

Before you begin

Did you check the Sandbox presets page? This page introduces the concept of Sandbox presets.

Create

Pick the Web UI or the Instruqt CLI route depending on your preference:
🌐 Web UI
💻 Instruqt CLI
  1. 1.
    Go to play.instruqt.com. ↳ Instruqt shows your content.
  2. 2.
    Click Team settings > Sandbox presets. ↳ The Sandbox presets page opens.
  3. 3.
    Click Create a new preset. ↳ Instruqt shows the Create sandbox preset page.
  4. 4.
    In the Name field, enter the name of the preset. ↳ As you enter the title, Instruqt automatically generates a slug in the slug field.
    You can manually change the slug field if desired.
  5. 5.
    In the Description field, enter a description for the preset. ?? The description should help content creators understand how the Sandbox preset should be used. It's recommend to keep the descriptions brief but indicative of the purpose of the preset.
  6. 6.
    If you click Add a host, you will have the option to add a Container, a Virtual machine (VM) or Website Service. You have to fill required fields, then click Add host. You can repeat this process as many times as desired, or skip this step entirely.
    For both containers and VMs there are two types of images: Preset images provided by Instruqt, and Choose your own images provided by you. Read more about custom images.​
  7. 7.
    If you have added a host, you will have the option to create ??life cycle scripts for the new host by clicking the ?? button.
  8. 8.
    If you click Add a cloud account, you will have the option to add either a Google, AWS or Azure provider. In either case, you must specify a name and some permissions.
  9. 9.
    If you click Add a secret, you will have the option to select some secrets which the sandbox preset will have access to in Lifecycle scripts.
  10. 10.
    Click Save to drafts. ↳ Instruqt shows the Sandbox presets page with the drafts tab in focus.
  1. 1.
    Type the following command to create a sandbox preset:
    instruqt sandbox create
  2. 2.
    Enter the track title:
    ==> Name: SANDBOX_PRESET_NAME
    ↳ Instruqt CLI generates a slug and a sandbox preset showing the following output:
    ==> Creating TEAM/SANDBOX_PRESET_SLUG
    OK
  3. 3.
    Change into the track directory:
    cd SANDBOX_PRESET_NAME
  4. 4.
    Push the sandbox preset to Instruqt:
    instruqt sandbox push
    ↳ Instruqt CLI pushes the sandbox preset and shows this output:
    ==> Pushing config (SANDBOX_PRESET_NAME)
    OK
  5. 5.
    Your sandbox preset will be available on the Sandbox presets page found under Team settings on play.instruqt.com.
Well done! You now have a draft sandbox preset ready to be modified and or published for use on the Instruqt platform.
How-to guides - Previous
Build sandbox presets
Next
Pull a sandbox preset
Last modified 3mo ago