Create and manage instances for Notebooks

Prerequisites

• You have a STACKIT customer account: Create a customer Account
• You have a STACKIT user account: Create a user account
• You have a STACKIT project: Create a project

Instance properties

Independently of the method you choose to create and manage an instance, there are common properties of a Notebooks instance. This chapter explains the parameters and properties.

General properties

Every instance has a name and operates on a specified version. Optionally, you can also add a description.

External Identity Provider (IdP)

As for now, Notebooks depends on an external Identity Provider for authentication, authorization and single-sign-on. It uses the OpenID Connect protocol. The following IdPs are supported:

• Entra ID (Azure)
• Google
• Okta
• AWS Cognito
• Keycloak

To integrate an IdP, you need to provide the Client ID, the Client secret, the Scope and the Discovery Endpoint. You need to get these values from the respective provider.

The values for Scope are in most cases openid email, for Entra ID it is openid email User.Read.

The format for a Discovery Endpoint is https://\<provider-domain\>/.well-known/openid-configuration.

Monitoring

Under this section, you can select a STACKIT Observability instance within the same project to integrate with your STACKIT Notebooks deployment. Once configured, relevant notebook metrics – such as resource usage, active sessions, and system performance indicators – are automatically forwarded to the selected Observability instance. These metrics are delivered with preconfigured standard dashboards in Grafana, providing immediate visibility without additional setup. This enables customers to operate their Notebooks instance transparently, monitor utilization trends, identify bottlenecks, and ensure stable and efficient operation.

Create an instance

Note: Only the Lite version of STACKIT Notebooks is available yet. It can only be requested and booked by opening a support ticket.

List instances

STACKIT Portal

To list your Notebooks instances, follow these steps:

1. In the STACKIT Portal, navigate to Notebooks.
2. You see your instances on the panel on the right.

Edit an instance

STACKIT Portal

To edit a Notebooks instance, follow these steps:

1. In the STACKIT Portal, navigate to Notebooks.
2. Select an existing instance to open the detail view.
3. You can make changes to the General properties, the Identity provider and Monitoring. To make changes select the Edit button in the respective section. After making your changes, select Save
   Changes are only possible when the instance is in the Active state.
4. After making changes, the instance is in the Updating state. Wait for the instance to reach the Active state again.
   It is also possible that the state changes to Error, for example when there are problems with the credentials. In this case, you need to troubleshoot manually.

Delete an instance

STACKIT Portal

To delete a Notebooks instance, follow these steps:

1. In the STACKIT Portal, navigate to Notebooks.
2. On the right side in the three dots menu select Delete.
3. On the new pane enter the instance name as confirmation and select Delete to delete the instance.