Creating a Notebook Instance

Preparations

• Create a resource group. For details about how to create a resource group, see Managing Notebook Resource Groups.
• There are preset images in the system that you can use.

Constraints

• You can create a maximum of 10 notebook instances in a workspace.
• The permissions of preset roles are as follows: You can select a proper role to perform desired operations.
  • If you are the administrator of the current workspace or have the DAYU Administrator or Tenant Administrator permissions, you can create runtime environments owned by yourself and delete, operate, query, and edit all runtime environments in the workspace. To create a runtime environment for another user, you need to create a runtime environment owned by yourself first, and then change the environment owner to the target user.
  • As a developer, you can create, delete, operate, query, and edit runtime environments owned by yourself.
• If you are assigned a custom role and have the create permission, you can only create and manage runtime environments owned by yourself. If you have the delete, operate, query, and edit permissions, you can perform the corresponding operations on all runtime environments in the workspace. You can change the owner of a runtime environment only if you have the edit permission on the environment. For details about how to create a custom role, see (Optional) Defining a Workspace Role.
• If you are assigned both a preset role and a custom role, you have permissions of both roles.
• Notebook instances are owned by and can only be used by the environment owner.

Creating a Notebook Instance

1. Log in to the DataArts Studio console.

   For details, see Accessing the DataArts Studio Instance Console.

2. On the DataArts Studio console, locate a workspace and click DataArts Factory.
3. In the lower right corner of the DataArts Factory page, Runtime Environment Unavailable is displayed. Click Runtime Environment Unavailable. The following message is displayed: "An individual development environment is an account-level development instance on the cloud that supports interactive Python programming based on notebooks. You have no environment."
   Figure 1 Runtime Environment Unavailable
   
   

   1. If there is a notebook instance in the current workspace, Individual Development Environment is displayed in the lower right corner. You can click Individual Development Environment to view the notebook instance. You can click Manage Environment to view details about the notebook instance.
      Figure 2 Viewing the notebook instance name
      
   2. If there is no notebook instance, click Runtime Environment Unavailable, Manage Environment, and Create Runtime Environment to create a notebook instance.
      Figure 3 Creating a runtime environment
      

4. Click Create Environment. On the Create Runtime Environment page, set the following parameters.

   Table 1 Creating a notebook

   Parameter	Description
   Runtime Environment Name	Name of the runtime environment, that is, name of the notebook instance The notebook instance name can contain a maximum of 128 characters.
   Owner	Owner of the runtime environment
   Resource Group	Resource group to which the notebook belongs. For details about how to view or create resource groups, see Managing Notebook Resource Groups.
   Runtime Resource Specifications	1CU (1U4G) 2CU (2U8G) 4CU (4U16G) 8CU (8U32G) 16CU (16U64G) 1 CU means 1 vCPU and 4 GB memory
   Image	Image. For details about how to view images, see Managing Images.
   Auto stop	Select this option. Then the runtime environment will automatically stop if no operation is performed within the specified period. The period ranges from 1 hour to 72 hours. It is 1 hour by default.
   Description (Optional)	Description, which can contain a maximum of 1,000 characters

   Figure 4 Creating a notebook instance
   

5. In the lower right corner, click Create. The creation takes about one minute. You can also create a notebook instance by referring to Managing Notebook Resources.

   You can view the created notebook instance in the lower right corner of the page. Click the instance name to view all the notebook instances that have been created. You can also view the created notebook instance in Manage Environment.

   Before using the notebook instance, run it first.

Manage Environments

1. In the lower right corner of the DataArts Factory page, click a notebook instance name to view all the notebook instances that have been created.
2. Click Manage Environment.
3. You can perform the following operations:
   • Create a notebook instance. For details, see Creating a Notebook Instance.
   • Edit a notebook instance. You can edit a notebook instance only when it is disabled. You can change the owner of an environment only if you are the current workspace administrator, have the permissions of the DAYU Administrator or Tenant Administrator, or have been assigned a custom role that has the edit permission of the environment.
   • View all notebook instances and the information of each instance (including Runtime Environment Name, Runtime Resource Specifications, Status, Resource Group, Owner, and Create Time). You can search for and filter notebook instances by keyword (Runtime Environment Name, Status, Resource Group, and Owner). You can perform a fuzzy search by Runtime Environment Name.

     In the lower right corner of the page, you can check whether there are notebook instances. Click a running notebook instance, and you can view its details in the lower right corner, including Cell x/x, Memory Usage, Total Memory, Used Memory, CPU Usage, and Runtime Environment Name. In x/x, the first x indicates the sequence number of the selected cell in the notebook instance that is being edited, and the second x indicates the total number of cells in the notebook instance. You can click Individual Development Environment in the lower right corner and hover the cursor over an instance to view its information, including Runtime Environment Name, Status, Resource Group, Resource Quota, and Image.

   • Run a notebook instance. Then you can perform development operations in the notebook instance. You can click Run to start a notebook instance that you created or stopped.

     You can click the instance name in the lower right corner of the page to view the name of all notebook instances and start desired instances.

   • Stop a running notebook instance by clicking Stop.
   • Delete a notebook instance. Click Delete. In the displayed dialog box, enter DELETE and click OK.
     

     In the displayed dialog box, the following information is displayed: "The system disk of the runtime environment is not empty. When you delete the runtime environment, any files on the disk will be deleted along with it."

Disconnecting Notebook Instances

1. In the lower right corner of the DataArts Factory page, click a notebook instance name to view all the notebook instances that have been created.
2. Click Disconnect to disconnect all notebook instances. Then the notebook environment directory tree below the job directory tree in the middle of the DataArts Factory page is no longer displayed. You can click Individual Development Environment in the lower right corner and click a notebook instance name to show the notebook environment tree again.