Skip to content

cr8tor-metamodel

Cr8tor metamodel project

URI: https://w3id.org/karectl-crates/cr8tor-metamodel

Name: cr8tor-metamodel

Classes

Class Description
Action Represents an action or activity performed on a Cr8tor project, tracking the ...
        AssessAction Represents an assessment action performed on a Cr8tor project, used to track ...
        CreateAction Represents a create action performed on a Cr8tor project, typically used to t...
Column Models a column within a table, representing a single field of data with a sp...
Cr8tor The root container class for the Cr8tor metamodel, aggregating all project da...
Credential Models authentication credentials for accessing a data source, including the ...
Dataset Represents a dataset to be ingested or managed within a Cr8tor project, inclu...
Deployment Models the deployment configuration for a Cr8tor project, specifying the K8TR...
Destination Models a data destination within a Cr8tor project, representing the endpoint ...
Environment Models the configuration of the target trusted research environment (TRE) for...
EnvironmentVariable A name-value environment variable pair
Governance Represents the governance structure of a Cr8tor project, encapsulating user a...
Group Represents a group or organizational unit within a Cr8tor project, used to or...
GroupSpec Operator group specification for managing keycloak groups and setting up work...
Ingress Represents the data ingress process for a Cr8tor project, modeling the flow o...
KeycloakClientConfig Configuration for a Keycloak OIDC client
KubespawnerOverride KubeSpawner override settings for a jupyterhub profile
LimitRangeConfig Default container resource limits for the project namespace
Location Represents a data location with flexible attributes to accommodate various st...
ProfileConfig JupyterHub workspace profile to select different workspace environments
Project Defines the core state and identifying properties of a Cr8tor project, includ...
ProjectSpec Operator project specification to define the resources for a research project...
ProtocolMapper Keycloak OIDC protocol mapper
Resource Abstract base class for K8TRE resources (such as applications or services) th...
        Gitea Gitea git repository resource for cr8tor project
        Jupyter Specialized resource configuration for deploying Jupyter workspaces within a ...
        Keycloak Specialized resource configuration for deploying Keycloak identity and access...
        RStudio RStudio workspace resource for cr8tor project
        VDI Virtual Desktop Infrastructure resource for cr8tor project
ResourceStorage Per-resource storage configuration for workspace persistent volumes
SecretRef Reference to a k8s Secret
Source Models a data source within a Cr8tor project, representing the origin of data...
Table Models a table within a dataset, representing a structured collection of data...
User Models an individual user associated with a Cr8tor project, capturing their i...
VdiScheduling Scheduling configuration for a VDI
VdiSchedulingResources CPU and memory resource requests/limits for a VDI pod

Slots

Slot Description
action_status The current status of the action, indicating whether it's active, completed, ...
action_type The specific type of action being performed (e
actions List of actions performed on the cr8tor project
additional_type Additional type classification for specialized actions, used to reference sub...
affiliation The name of the organization or institution with which the user is affiliated...
agent The agent (person, organization, or software) that triggered or performed the...
auth The type or method of authentication required to access the Jupyter workspace...
client_id Unique Keycloak client identifier
clients OIDC clients to be managed in this Keycloak deployment
columns List of columns that define the schema of the table, each representing a data...
config Mapper configuration as JSON string
connection Connection protocol
consent_required
credentials The credentials required to access the data source, including authentication ...
datasets List of datasets involved in the ingress process, each representing a collect...
datatype The datatype of the column, specifying the kind of data stored (e
default_client_scopes Default client scopes
default_cpu Default CPU limit (e
default_memory Default memory limit (e
default_notebook_size Default PVC size for notebook workspaces
default_request_cpu Default CPU request (e
default_request_memory Default memory request (e
default_vdi_size Default PVC size for VDI workspaces
deployment The deployment configuration for the project, detailing the resources and env...
description A brief summary describing the purpose, scope, or objectives of the Cr8tor pr...
destination The target or endpoint where data is delivered during the ingress process, re...
display A human-readable display name for the group, used for UI and reporting
display_name Profile name shown in jupyterhub spawner
email The user's email address, used for communication and notifications related to...
enabled Whether the user account is enabled
end_time The date and time when the action completed or failed
env Environment variables for the VDI container
environment The environment configuration for the deployment, specifying the target trust...
error Error message or output if the action failed
expiry_date The date when the user's access to the project expires, representing the end ...
family_name The user's last or family name, used for identification and display purposes
given_name The user's first or given name, representing their personal identity
governance The governance configuration for the project, managing user access, membershi...
groups List of groups to which the user belongs within the project, representing rol...
id Unique identifier for the project
image Container image for the VDI
ingress The data ingress configuration for the project, specifying data sources, dest...
instrument The tool or service that executed the action (e
key Key within the Secret
kubespawner_override KubeSpawner overrides for this profile
limit_range Default container resource limits for the project namespace
limits_cpu CPU limit
limits_memory Memory limit
locations List of data locations or URIs where the dataset is stored or accessed during...
members Usernames of group members
name The unique name of the Cr8tor project, used for identification and reference ...
optional_client_scopes Optional client scopes
password Optional initial password
password_key The key or identifier used to retrieve the password from the credential provi...
persist Whether workspace storage should persist across sessions
profiles JupyterHub workspace profiles for this deployment
project The project entity governed by this governance model, containing core project...
projects Project names this group grants access to
protocol Authentication protocol
protocol_mapper Mapper type or class
protocol_mappers OIDC protocol mappers
provider The credential provider or authentication service (e
public_client Whether this is a public client
realm The Keycloak realm name for this project deployment
redirect_uris Valid redirect URIs after authentication
ref The URI reference to the corresponding Group resource, enabling linkage to ex...
reference An external or internal reference identifier for the Cr8tor project, used for...
requests_cpu CPU request
requests_memory Memory requests
resource_type The type of resource (e
resources List of resource names or identifiers representing the K8TRE applications or ...
result List of result items produced by the action, typically ID references to other...
scheduling Resource scheduling configuration for VDI
schema_name The name of the schema in the target database where the dataset will reside
secret Client secret
secret_ref Reference to a k8s Secret containing the client secret
slug URL-safe profile identifier
source The origin or source of data for the ingress process, representing where data...
start_date The date when the user's access to the project becomes active, representing t...
start_time Timestamp when project was created
storage Storage configuration for notebook workspaces
subgroups Child group names
tables List of tables that make up the dataset, each representing a structured colle...
type The type of group membership, indicating how the user was assigned to the gro...
url The URL or location of the data source, specifying where data can be accessed...
user Username for the VDI session
username The user's unique login or account name, used for authentication and identifi...
username_key The key or identifier used to retrieve the username from the credential provi...
users List of users who have access to the project, each with their own roles, perm...
value The unique identifier of the group, typically used as the group ID for refere...
web_origins Allowed web origins for CORS

Enumerations

Enumeration Description
ActionStatusType Status states for actions, based on schema
ActionType Types of actions that can be performed on a Cr8tor project
ConnectionType VDI connection protocols
DestinationType
GroupMembershipType Type of TRE group membership
SourceType

Types

Type Description
Boolean A binary (true or false) value
Curie a compact URI
Date a date (year, month and day) in an idealized calendar
DateOrDatetime Either a date or a datetime
Datetime The combination of a date and time
Decimal A real number with arbitrary precision that conforms to the xsd:decimal speci...
Double A real number that conforms to the xsd:double specification
Float A real number that conforms to the xsd:float specification
Integer An integer
Jsonpath A string encoding a JSON Path
Jsonpointer A string encoding a JSON Pointer
Ncname Prefix part of CURIE
Nodeidentifier A URI, CURIE or BNODE that represents a node in a model
Objectidentifier A URI or CURIE that represents an object in the model
Sparqlpath A string encoding a SPARQL Property Path
String A character string
Time A time object represents a (local) time of day, independent of any particular...
Uri a complete URI
Uriorcurie a URI or a CURIE

Subsets

Subset Description