A Lab is simply a logical grouping of experiment resources. In the future, other potential resource assets may be group-able into Labs, but for now, think of a Lab as a folder or workspace that experiments live inside. Common use cases for labs include:

  • by org (i.e., Marketing, Engineering)
  • by team
  • used as folders

There are no limits to the number of labs that can be created. Go crazy!

​
YAML

​
Metadata

The possible statuses for labs are: active or archived. parentKind and parentId should be excluded.

When defining a resource in YAML, each must have a metadata section. The following properties within metadata are shared across all resource types:

KeyData TypeDescription
idstringUnique identifier. Case insensitive and consist of alphanumeric characters, ’-’, ’_’ or ’.’ For example: home-page-test. IDs will be stored and displayed in UPPERCASE.
namestringName of the resource.
descriptionstringDescription of the resource.
resourceVersionintModification version for a given resource. Incremented each time the resource is updated. This will be shown when retreiving a resource, but is ignored if provided as part of a resource update.
statusResourceStatusThe status of the resource.
parentKindlabThe kind of resouce this one belongs to. Only applies to experiments, in which case the value is lab. Exclude for non experiments.
parentIdstringThe ID of the resources parent. Only applies to experiments and the ID of its parent lab. Exclude for non experiments.

​
ResourceStatus

Possible statuses include:

StatusDescriptionResources
draftThe experiment exists, but is not ready to go live.Experiment
activeThe experiment is live and making/tracking/returned assignments.All
winner_declaredA winner has been declared.Experiment
endedThe experiment has ended. No assignments are made/returned.Experiment
archivedThe experiment has ended and is archived from view.All

​
Spec

Labs don’t have any special that needs to be defined that isn’t in the metadata, so no spec is necessary.

​
Example

schemaVersion: 1
kind: lab
metadata:
  id: marketing
  resourceVersion: 1
  status: active
  name: Marketing
  description: All initiatives for the marketing org.