Configure plans

Last modified: 28 February 2024

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, specify plan parameters under the plansConfig key in datalore.values.yaml.

Each particular plan is described by the following set of fields:

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:

plansConfig:
  - planId: "Student"
    default: true
    name: "Student plan"
    instanceDurationQuotaMap:
      k8s-datalore-agent: "PT100H"
      k8s-datalore-agent-big: "PT10H"
    diskUsageLimit: "5.00 GB"
    numRunningInstancesLimit: 3
  - planId: "Teacher"
    name: "Teacher plan"
    instanceDurationQuotaMap:
      k8s-datalore-agent: "PT300H"
      k8s-datalore-agent-big: "PT100H"
    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

tip

For Helm-based installations, you can control GPU machine resources by assigning different plans to different users.

  1. Create two instances in the agentsConfig variable: one with access to a GPU machine and the other without. Follow the template provided in the file.

  2. Create two plans in agentsConfig variable:

    • With two instanceDurationQuotaMap parameters specifying quotas for both instances

    • With one instanceDurationQuotaMap parameter referencing only the instance without access to a GPU machine.

As a result, users with the second plan can only use CPU machine resources.

Refer to Manage user groups for information on how to assign configured plans to registered users.