Configure plans

Use the plans feature to limit resources that are available for users. You can assign plans to individual users or user groups.

To enable the feature, mount the configuration file into the Datalore container and put the path to it into the DATALORE_PLANS_CONFIGURATION variable.

services:
  datalore:
    ...
    volumes:
      ...
      - "/home/user/datalore/plans.yaml:/opt/datalore/configs/plans.yaml"
    environment:
      ...
      DATALORE_PLANS_CONFIGURATION: "file:/opt/datalore/configs/plans.yaml"

Each plan has a unique planId. Make sure that one of them is marked as default. When adding or configuring a plan, specify the following parameters:

Option	Value example	Description
planId	"analyst"	ID of the plan for internal needs, should be unique
default	true	Required for only one plan on the list, assigns the plan for all users as default
name	"Data analyst plan"	Name of the plan that will be shown in UI
diskUsageLimit	10 Gb	Disk space in persistence storage allowed per user
numRunningInstancesLimit	10	Number of parallel running agents allowed per user
instanceDurationQuotaMap	basic-agent: "PT100H"	Computation time per month available for each agent type; more than one agent type allowed, details in the tip below. Keys inside this field (like `basic-agent`) should match IDs used in the agents configuration.

Example:

- planId: "Student"
  default: true
  name: "Student plan"
  instanceDurationQuotaMap:
    docker-base: "PT100H"
    docker-advanced: "PT100H"
  diskUsageLimit: "5.00 GB"
  numRunningInstancesLimit: 3
- planId: "Teacher"
  name: "Teacher plan"
  instanceDurationQuotaMap:
    docker-base: "PT100H"
    docker-advanced: "PT50H"
  diskUsageLimit: "25.00 GB"
  numRunningInstancesLimit: 10
                

Last modified: 31 July 2024