Instruqt Docs
  • 🚩Getting started
    • Overview
    • Setting up
      • Study Room
    • Quickstart
  • 🛤️Tracks
    • Manage tracks
      • Create tracks
      • Edit locally
      • Test tracks
      • Track logs
      • Track time limits
      • Track feedback
      • Developer workflow
      • Track tags
      • Track authors
      • Delete tracks
      • Custom layouts
      • Version control
      • Loading experience
    • Challenges
      • Create challenges
      • Challenge tabs
      • Challenge order
      • Skip challenges
      • Add quizzes
      • Assignment display
      • Assignment editor
    • Share tracks
      • Live Events
        • Instructor tools
      • Track invites
      • Embed tracks
      • Landing pages
  • 🏖️Sandboxes
    • Overview
    • Sandbox hosts
      • Add hosts
      • Custom VM images
      • Custom container images
      • Public images
      • Windows VMs
      • Website service
      • SSL certificates
    • Cloud accounts
      • Securing your cloud accounts
      • Cloud Client
      • AWS accounts
        • AWS Environment Variables
        • AWS Managed Policies
        • AWS IAM Policies
        • AWS SCP Policies
      • Azure subscriptions
        • Azure Environment Variables
        • Azure Roles
        • Azure Resource Providers
      • GCP projects
        • GCP Environment Variables
        • GCP IAM Permissions
    • Lifecycle scripts
      • Scripting overview
      • Track scripts
      • Challenge scripts
      • Example scripts
      • Helper scripts
    • UI Checks
    • Global Sandbox Settings
      • Hot start
      • Sandbox presets
      • Custom resources
      • Cloud services and regions
        • Allowed services and regions
    • Secrets and variables
      • Runtime variables
      • Runtime parameters
      • Secrets
  • ⚙️Settings
    • Integrations
      • Salesforce (Beta)
      • HubSpot (Beta)
      • HubSpot (Using zapier)
      • LTI
      • Version control
        • GitHub
    • Authentication
      • SSO
      • API keys
    • Platform
      • API
      • Webhooks
      • Track limits
  • 💡Reference
    • Feature overview
    • Instruqt CLI
      • Commands
      • Configuration files
      • Assets
    • Instruqt platform
      • Networking
      • Host machine types
      • Quotas and limits
      • Roles and permissions
      • Network access
      • Requirements
  • 🛟Resources
    • Content design tips
    • Advanced use cases
    • Templates
    • FAQ
      • Running Windows Client Hosts on Instruqt
      • Using Cleanup Scripts in SaaS and Cloud Environments
      • Instruqt Regional Configurations and Restrictions
      • Troubleshooting Instruqt CLI Authentication Issues
      • Copy a Track from One Organization to Another via CLI
      • Network Configuration: IP and MAC Address Control
      • Container Troubleshooting in Instruqt
Powered by GitBook
On this page
  • Overview
  • Add VMs to sandboxes
  • Add containers to sandboxes

Was this helpful?

Edit on GitHub
  1. Sandboxes
  2. Sandbox hosts

Add hosts

How to add virtual machines and containers to sandboxes.

PreviousSandbox hostsNextCustom VM images

Last updated 7 months ago

Was this helpful?

Overview

Sandboxes support VMs and containers natively. Use the following points to determine if you should use one or the other.

You should use VMs if...

  • You need control how many CPUs the host gets

  • The host needs to be externally accessible ()

You should use containers if...

  • You want to make loading times as short as possible (they are generally faster to deploy)

  • You have a lightweight application with minimal resource requirements

Add VMs to sandboxes

You can use the web UI or Instruqt CLI to add VMs to a sandbox.

  1. Select a track.

  2. In the Sandbox section, click Edit.

  3. In the Your hosts section, click + Add a host.

  4. Select Virtual machine.

  5. Enter a hostname.

  6. Select Preset image or Choose your own.

    • If you select Preset image, select the preset you wish to use.

    • If you select Choose your own, provide a GCP image and machine type ().

  7. Define any additional settings you need.

    • Shell

    • External ingress

    • SSL certificate

    • Nested virtualization

  8. Click Save host.

Within a track's config.yml file, VM hosts are defined like so:

virtualmachines:
- name: <hostname>
  image: <gcp_project>/<image_name>
  machine_type: <machine_size>

Add containers to sandboxes

You can use the web UI or Instruqt CLI to add containers to a sandbox.

  1. Select a track.

  2. In the Sandbox section, click Edit.

  3. In the Your hosts section, click + Add a host.

  4. Select Container.

  5. Enter a hostname.

  6. Select Preset image or Choose your own.

    • If you select Preset image, select the preset you wish to use.

  7. Define any additional settings you need.

    • Entrypoint

    • Cmd

    • Ports

    • Shell

  8. Click Save host.

Within a track's config.yml file, container hosts are defined like so:

containers:
- name: <hostname>
  image: <container_image>
  memory: <memory_ammount_mb>

Each sandbox is subject to a limit of 15 containers and website services combined at any given time. This limitation helps ensure optimal performance and resource allocation for all users.

If you select Choose your own, provide a custom image ().

🏖️
see networking documentation
see docs
see docs