Exporting Configuration Schema

Administrators are also able to export the system configuration schema ( data structure ). This may be helpful when constructing a custom yaml configuration and is analogous to a database schema dump. Like the import and export files, this will include a matching Configuration Schema Versioning and Details

1. Log into the Workspace UI as an administrator.

2. From the Admin panel, select System Info from the menu.

3. Click Export Schema

   

   Export Schema

4. The configuration schema will be downloaded as a yaml file.

   

   Schema Download

Example Export

Below is a short example snippet 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