Configure plans

Last modified: 31 March 2023

Use the plans feature to limit resources that are available for users. 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:
    ...
    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

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"

large-agent: "PT10H"

Computation time per month available for each agent type; more than one agent type allowed, details in the tip below.

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

tip

The format used to define computation time is PnDTnHnMnS:

  • P: mandatory first character

  • nD (optional): number of days (day = 24 hours)

  • T: required when specifying time (hours, minutes, or seconds)

  • nH (optional): number of hours

  • nM (optional): number of minutes

  • nS (optional): number of seconds with a fractional part

  • D, H, M, and S can also be passed as d, h, m, and s respectively.

  • T is used before the first occurrence, if any, of an hour, minute, or second section.

  • If T is used, it must be followed by at least one section.

Examples:

  • PT20.345S: 20.345 seconds

  • PT15M: 15 minutes

  • PT10H: 10 hours

  • P2D: 2 days

  • P2DT3H4M: 2 days, 3 hours and 4 minutes