⌘K
Documentation

Add Studio Panel

Overview

The Add Studio panel enables administrators and platform engineers to create, configure, and orchestrate Studio environments (development, data science, or workflow design tools) on the DataFloem platform.

Studio assets configured via this panel are deployed as isolated, scalable containers managed within a Kubernetes cluster using fine-grained resource allocations (CPU/Memory limits), container images, and Ingress routing rules.

Access Requirements

To access this page, the user must either have Administrator privileges or the CREATE permission for the Studios module.

The CREATE permission allows users to create new groups. Users without administrator privileges or the required permission cannot access this page.

If you do not have the required permission, ask your administrator to grant it from one of the authorization pages below.

Authorization

Users without the required authorization will receive the following error:

Access Denied

You don't have access to this resource.

Prerequisites

Before deploying a new Studio environment, ensure that:

  • A valid target Kubernetes Cluster is registered and active within the platform.
  • The designated Kubernetes Namespace exists in the target cluster, and any necessary Image Pull Secrets are provisioned for private container registries.

Form Elements

The fields that need to be configured within the panel are as follows:

General Meta Data

Field Required? Description
Name Yes A unique alias identifying this Studio instance across the platform.
Description No Optional operational notes describing the scope or purpose of the Studio (Maximum 200 characters).
Is Active Yes (Toggle) Defines whether the Studio is activated immediately upon deployment. Enabled (on) by default.
Type Yes (Dropdown) Selects the environment engine type (e.g., JupyterLab, VS Code Studio, Custom IDE).
Cluster Yes (Dropdown) The target Kubernetes cluster where the Studio container pods will be scheduled.
Password Yes The secure password required to authenticate into the deployed Studio workspace (Visibility can be toggled using the eye icon).

Kubernetes Information

Field Required? Description
Kubernetes Namespace Yes (Dropdown) The target Kubernetes namespace boundary where pods will be deployed.
CPU Minimum Yes The guaranteed baseline CPU request for the pod (e.g., 250m, 0.5, or 1).
CPU Maximum Yes The hard upper limit for CPU utilization (e.g., 2 or 4).
Memory Minimum Yes The guaranteed baseline memory request for the pod (e.g., 512Mi or 1Gi).
Memory Maximum Yes The hard upper limit for memory allocation (e.g., 4Gi or 8Gi).
Image Yes (Dropdown) The container image repository/tag hosting the Studio software.
Image Pull Secret No The Kubernetes secret name used to authenticate against private image registries.
Ingress Type Yes (Dropdown) The Ingress controller type managing external HTTP/HTTPS routing (e.g., NGINX, Traefik).
Ingress URL Yes The external domain/URL endpoint designated to access the Studio web UI.
Ingress Detail No Custom annotations, routing rules, or header configurations for the Ingress resource.

Studio Deployment Process

  1. Click the Add Studio action button on the Studio management dashboard to launch the panel.
  2. Provide a unique Name, operational Description, and select the Studio Type.
  3. Select the target Cluster and set an access Password for the instance.
  4. Under Kubernetes Information, designate the target Kubernetes Namespace and container Image.
  5. Configure the pod resource boundaries (CPU Minimum, CPU Maximum, Memory Minimum, and Memory Maximum).
  6. Enter an Image Pull Secret if pulling images from authenticated private registries.
  7. Configure external connectivity parameters (Ingress Type, Ingress URL, and optional Ingress Detail).
  8. Review all parameters and click Save to provision the Studio, or click Cancel to abort the operation.

Validation Rules

  • Name, CPU Minimum/Maximum, Memory Minimum/Maximum, and Ingress URL fields cannot be left empty.
  • The Description field must strictly observe the 0 - 200 character boundary.
  • CPU Maximum cannot be less than CPU Minimum, and Memory Maximum cannot be less than Memory Minimum.
ESC

Start typing to search across the documentation.