Export the Kasm configuration schema as YAML

Overview

Administrators who build custom YAML configurations need an accurate reference for the data structure that Kasm Workspaces expects. This guide exports the system configuration schema as a YAML file from the Workspaces UI. The export describes the data structure of the configuration, similar to a database schema dump, so each property can be mapped to the correct table, type, and constraints.

Prerequisites

• A Kasm Workspaces deployment that you can reach through the Workspaces UI.
• An administrator account with access to the Admin panel.

Solution approach

This guide progresses through the following phases:

1. Open the import and export configuration interface.
2. Export the schema as a YAML file.
3. Review the exported schema structure.

Detailed steps

Open the import and export configuration interface

1. Log into the Workspaces UI as an administrator.
2. From the Admin panel, select Diagnostics -> System Info from the menu.
3. Navigate to the Import/Export Config tab.

Export Schema

Export the schema as a YAML file

1. Click the Export Schema button.
2. Confirm that the configuration schema downloads as a YAML file.

Schema Download

The exported file includes a matching alembic_version property. This value identifies the schema revision and the properties that make up an import or export file. For details on how this version controls compatibility between builds, see Configuration Schema Versioning and Details.

Review the exported schema structure

The schema lists each configuration table and its properties. Every property records its data type, whether it is required, and any foreign key relationship. Use these definitions to construct a custom YAML configuration that matches the expected structure.

Example Export

The following snippet shows a short example of the YAML based configuration schema export.

Exported Configuration Schema Snippet

alembic_version: 52136dd39702
images:
    allow_network_selection:
      required: false
      type: BOOLEAN
    available:
      required: false
      type: BOOLEAN
    categories:
      required: false
      type: JSON
    cores:
      required: false
      type: FLOAT
    cpu_allocation_method:
      required: false
      type: VARCHAR
    description:
      required: false
      type: VARCHAR
    docker_registry:
      required: false
      type: VARCHAR
    docker_token:
      required: false
      type: VARCHAR
    docker_user:
      required: false
      type: VARCHAR(255)
    enabled:
      required: false
      type: BOOLEAN
    exec_config:
      required: false
      type: JSON
    filter_policy_force_disabled:
      required: false
      type: BOOLEAN
    filter_policy_id:
      foreign_key: filter_policies.filter_policy_id
      required: false
      type: UUID
    friendly_name:
      required: false
      type: VARCHAR(255)
    gpu_count:
      required: false
      type: INTEGER
    hash:
      required: false
      type: VARCHAR(255)
    hidden:
      required: false
      type: BOOLEAN
    image_id:
      required: false
      type: UUID
    image_src:
      required: false
      type: VARCHAR(255)
    image_type:
      required: false
      type: VARCHAR
    link_url:
      required: false
      type: VARCHAR
    memory:
      required: false
      type: BIGINT
    name:
      required: false
      type: VARCHAR(255)
    notes:
      required: false
      type: VARCHAR
    persistent_profile_path:
      required: false
      type: VARCHAR
    require_gpu:
      required: false
      type: BOOLEAN
    restrict_network_names:
      required: false
      type: JSON
    restrict_to_network:
      required: false
      type: BOOLEAN
    restrict_to_server:
      required: false
      type: BOOLEAN
    restrict_to_zone:
      required: false
      type: BOOLEAN
    run_config:
      required: false
      type: JSON
    server_id:
      foreign_key: servers.server_id
      required: false
      type: UUID
    server_pool_id:
      foreign_key: server_pools.server_pool_id
      required: false
      type: UUID
    session_time_limit:
      required: false
      type: INTEGER
    volume_mappings:
      required: false
      type: JSON
    x_res:
      required: false
      type: INTEGER
    y_res:
      required: false
      type: INTEGER
    zone_id:
      foreign_key: zones.zone_id
      required: false
      type: UUID

Common troubleshooting steps

• The Export Schema button is not visible. Confirm that you are logged in with an administrator account and viewing the Import/Export Config tab under Diagnostics -> System Info.
• An imported schema or configuration is rejected. Verify that the alembic_version in the file matches the deployment. Kasm Workspaces allows imports only between matching versions. See Configuration Schema Versioning and Details.