Skip to content

You are viewing documentation for Instruqt 2.0 Labs. For Tracks documentation, please visit docs.instruqt.com.

Service


Defined intabs.hcl

The service resource provides HTTP/HTTPS proxy access to web applications running in sandbox resources such as containers and VMs. It creates browser-accessible tabs that route traffic to services within the lab environment, enabling users to interact with web applications, APIs, and dashboards.

As a lab author, you can use service resources to provide web access:

  • Web Application Access: Expose web applications, dashboards, and user interfaces for hands-on interaction
  • Development Tools: Access code editors, database admin tools (e.g. pgAdmin), monitoring dashboards (e.g. Grafana)
  • Multi-Port Services: Expose different services from the same container or VM on different ports (e.g. frontend and API)

Service resources bridge the gap between isolated lab environments and user browser access, enabling realistic web application scenarios.

resource "service" "webapp" {
target = resource.container.webapp
port = 3000
}
resource "service" "webapp_admin" {
target = resource.container.webapp
scheme = "http"
port = 3000
path = "/admin"
open_in_new_window = true
show_refresh_button = true
custom_request_headers = {
"X-Api-Key" = "secret"
}
custom_response_headers = {
"Cache-Control" = "no-store"
}
}

Fields

FieldTypeRequiredDescription
targetreferencecontainer, vm, k8s_cluster, kubernetes_cluster, nomad_cluster, ingress✓Select the container where your web application or API is running. The service tab will proxy HTTP/HTTPS requests to this container.
portnumber✓Specify the port where your application listens for connections inside the container
ConstraintsMinimum 1; Maximum 65535
schemestring—Choose whether to connect using HTTP or HTTPS. Use HTTPS if your application has TLS/SSL enabled.
Allowedhttp https
Defaulthttp
pathstring—Optional. Set a default path if your application serves content from a subdirectory (e.g., /api or /dashboard).
ConstraintsPath must begin with /
open_in_new_windowbool—Enable this if the application can't be embedded in an iframe, or users should use it outside the lab UI. When true, the tab opens the service in a new window with full browser functionality.
Defaultfalse
show_refresh_buttonbool—Shows a refresh button on the tab so users can reload the service themselves. It is how someone who opened the tab before the application had finished starting, or who changed something the page needs to pick up, gets the current page without restarting the lab.
Defaulttrue
custom_request_headersmap(string)—Headers the proxy adds to each request before it reaches your application, e.g. an API key. A Host header also replaces the host the request is sent with.
custom_response_headersmap(string)—Headers the proxy adds to each response before it reaches the user's browser, e.g. Cache-Control.
resource "service" "webapp" {
target = resource.container.webapp
port = 3000
}
resource "service" "dashboard" {
target = resource.container.monitoring
scheme = "https"
port = 3000
path = "/dashboard"
}

With scheme = "https", the proxy does not verify the service’s certificate. A self-signed, expired or otherwise untrusted certificate works, so a service such as a VM’s admin console loads without extra setup. The connection between the user’s browser and the lab keeps its own HTTPS.

resource "service" "vm_dashboard" {
target = resource.vm.workbench
port = 8080
path = "/dashboard"
}
resource "service" "api" {
target = resource.container.api
port = 8080
custom_request_headers = {
"Authorization" = "Bearer ${variable.api_token}"
}
custom_response_headers = {
"Cache-Control" = "no-store"
}
}
  • custom_request_headers are added to every request the proxy sends to the service. A Host header also replaces the host the request is sent with.
  • custom_response_headers are added to every response before it reaches the learner’s browser. A Content-Security-Policy set here replaces the default one.
  • A header with the same name as an existing one replaces it.
resource "container" "multiservice" {
image {
name = "myapp/multiservice:latest"
}
port {
local = 8080
}
port {
local = 8081
}
}
resource "service" "app_ui" {
target = resource.container.multiservice
port = 8080
}
resource "service" "app_api" {
target = resource.container.multiservice
port = 8081
path = "/api/v1"
}
resource "layout" "default" {
column {
width = "50"
instructions {}
}
column {
width = "50"
tab "webapp" {
target = resource.service.webapp
title = "Web Application"
}
}
}

The tab carries a refresh button that reloads the service. It is how someone who opened the tab before the application had finished starting, or who changed something the page needs to pick up, gets the current page without restarting the lab.

The button is on by default. Turn it off for a tab the user should not be able to reload, for example one holding a single-page application that would lose its state:

resource "service" "kiosk" {
target = resource.container.webapp
port = 3000
show_refresh_button = false
}

A tab with open_in_new_window = true has no embedded page to reload, so it carries no refresh button whatever show_refresh_button is set to.

When open_in_new_window = false:

  • Service loads in an iframe within the lab tab
  • Users stay within the lab environment
  • The tab carries a refresh button unless show_refresh_button = false

When open_in_new_window = true:

  • Service opens in a new browser window/tab
  • Full browser functionality available
  • Users can switch between lab and service
  • No refresh button, since the page is not embedded in the tab

When you want a controlled browser entry point for Kubernetes API access, use a proxy container:

# Proxy container for Kubernetes dashboard
resource "container" "k8s_proxy" {
image {
name = "bitnami/kubectl:latest"
}
command = ["kubectl", "proxy", "--address=0.0.0.0", "--port=8001", "--accept-hosts=.*"]
network {
target = resource.network.main
}
volume {
source = resource.k8s_cluster.dev.kube_config.path
destination = "/root/.kube/config"
type = "bind"
}
port {
local = 8001
}
}
# Service pointing to the proxy container
resource "service" "k8s_dashboard" {
target = resource.container.k8s_proxy
port = 8001
path = "/api/v1/namespaces/kubernetes-dashboard/services/https:kubernetes-dashboard:/proxy/"
}
  1. Use Meaningful Names: Name your service resources based on their function (e.g., webapp, api, dashboard)
  2. Matching Schemes: Set scheme to the protocol the service listens with. Use "https" for a service that only serves TLS, even with a self-signed certificate
  3. Path Configuration: Use the path field to route to specific application paths
  4. Port Documentation: Document which ports your services use in comments
  5. Health Checks: Ensure the target resource has health checks configured for service availability
  1. Target Type Error: “target can only be of the following types: container, vm, k8s_cluster, kubernetes_cluster, nomad_cluster, ingress”

    • Solution: Ensure you’re referencing a supported sandbox resource
  2. Service Not Accessible: Service loads but shows connection errors

    • Check that the target resource is running and healthy
    • Verify the port number matches the service’s actual listening port
    • Ensure the target exposes the port in its configuration
  3. Tab Stays on “Please wait”: The proxy cannot reach the service

    • Check that the service is running and listening on the configured port
    • Check that scheme matches the protocol the service listens with: "https" for a TLS port, "http" otherwise. With "https" against a plain HTTP port, the tab never loads
  4. Tab Shows a Stale Page: The service answered before it was ready, and the tab kept that first response

    • This is what the refresh button is for: the page the tab holds is only re-fetched when something asks for it
    • Leave show_refresh_button on so users can recover without restarting the lab