Instance Monitor |
Description |
![]() |
The instance is monitored by the {NEBULA} system. Below is a brief explanation of how to interpret the
small chart icons in the List Card. From left to right, you will see three small chart icons, each
representing:
|
Data Stream Dialog |
Description |
![]() |
The Data Stream dialog is used to provision a new Data Stream instance, which contains a three-node Kafka-compatible data streaming cluster. |
Name field | Specifies the name for the instance, which can be any desired name. |
Sky Node field | Specifies the Sky Node where the instance will be created. This field also determines which {ANYNODE}'s code service is used. |
Network field | Specifies the network for the instance. You can read more about networks in the documentation: Private Network. |
Boot field | Specifies the operating system for the instance, which is magna-os, the only available OS for Data Stream. |
Password field | Specifies the root user password for the instance. This field allows the use of Secret Key Tags to obfuscate the password, ensuring enhanced security. |
CPU (#) field | Specifies the number of CPU cores that will be assigned to the instance. |
CPU (Time) field | Specifies how much time of the assigned CPU cores can be allocated. For example: If you have 1 CPU core and utilize 50% of CPU Time, that would be like assigning 1/2 (half) a CPU to the instance. |
RAM (GB) field | Specifies the amount of memory, in gigabytes, that will be allocated to the instance. |
DISK (GB) field | Specifies the amount of disk space, in gigabytes, that will be allocated to the instance. |
NET (Mbps) field | Specifies the network bandwidth, measured in megabits per second, that will be allocated to the instance. |
VLAN field | Specify the VLAN tag ID for the instance's network only if xcLAN is selected and the {ANYNODE} is connected to a network with multiple untagged VLANs, otherwise set it to 0. |
GPU field | Specifies whether the instance can access the GPU of the Sky Node. You can find more information about how to enable GPU here: GPU for Instances. |
Show button | Toggle the visibility of the password field. |
Create button | Save the configuration of the instance and provision it. |
Cancel button | Abort and close the dialog. |
Data Stream Actions Menu |
Description |
![]() |
On the right-hand side of the Data Stream list view, you will find the "Actions" menu that displays shortcut icons and the dropdown menu icon. Below, we have listed the actions for the Data Stream module. |
Copy ID item | Stores the instance ID in the clipboard. |
Copy IP item | Stores the instance IP address in the clipboard. |
Open Terminal item | Initiates a Terminal session for the Data Stream instance as the root user. |
PIN - Open Terminal item | Pins the Open Terminal command to the {NEXUS} Start area for convenient access. |
View Stream Brokers item | Opens a dialog that displays the streaming ports of the cluster, indicating the leader with an * (asterisk) sign. |
Edit Stream item | Opens the Data Stream dialog to edit the configuration of the instance. The instance must be stopped to update its configuration. |
Edit Configuration item | Opens the Data Stream dialog in live mode displaying the fields that can be configured while the instance is running. |
Edit IP Settings item | Opens the IP Settings dialog that allows the configuration of DHCP and Static IP settings of the instance. |
Start Stream item | Starts the Data Stream instance. |
Stop Stream item | Opens a confirmation dialog that, if confirmed, stops the Data Stream instance. |
Backup Manager item | Opens the Backup Manager dialog, where you can create, list, restore, and delete backup images of the Data Stream instance. |
Snapshot Manager item | Opens the Snapshot Manager dialog, where you can create, list, restore, and delete snapshot images of the Data Stream instance. |
Clone Stream item | Opens the Clone dialog, enabling the cloning of the Data Stream instance. |
Migrate Stream item | Opens the Migrate dialog, enabling the migration (move) of the Data Stream instance to another Sky Node. |
Delete Stream item | Opens a confirmation dialog that, if confirmed, deletes the Data Stream instance. |
Terminal Window |
Description |
![]() |
The Terminal Window initiates a terminal session, allowing interaction with the Data Stream instance. It is a component of the {NEBULA} Workspaces service. For further details on Workspaces features, refer to the documentation: Workspaces. |
Brokers Dialog |
Description |
![]() |
The Data Stream Brokers dialog displays the streaming ports of the cluster, indicating the leader with an * (asterisk) sign. |
Backup Manager Dialog |
Description |
![]() |
The Backup Manager dialog streamlines the processes of creating, listing, restoring, and deleting backup images for Data Stream. Below, we have outlined the features of the Backup Manager. |
Backup Now button | Starts a live backup process for the Data Stream instance and lists the backup image upon completion. |
Delete button | Removes the backup image from the storage. |
Restore button | Restore the Data Stream instance using the backup image. |
Close button | Close the dialog. |
Snaphot Manager Dialog |
Description |
![]() |
The Snaphot Manager dialog streamlines the processes of creating, listing, restoring, and deleting snapshot images for Data Stream instance. Below, we have outlined the features of the Snaphot Manager. |
Snaphot Now button | Starts a live snapshot process for the Data Stream instance and lists the snapshot image upon completion. |
Delete button | Removes the snapshot image from the storage. |
Restore button | Restore the Block Storage using the snapshot image. |
Close button | Close the dialog. |
Clone Data Stream Dialog |
Description |
![]() |
The Clone Data Stream dialog is used to clone (create a copy of) the Data Stream instance. |
New Name field | Specifies a new name for the copy of the Data Stream instance. |
Clone button | Starts the cloning process for the Data Stream instance. |
Cancel button | Abort and close the dialog. |
Migrate Data Stream Dialog |
Description |
![]() |
The Migrate Data Stream dialog is used to migrate (move) the Data Stream instance to another Sky Node. |
Destination field | Lists available Sky Nodes to which the Data Stream instance can be migrated. |
Migrate button | Starts the migration process for the Data Stream instance. |
Cancel button | Abort and close the dialog. |
The datastream PolicyThe following is a list of policy grants that define and regulate access permissions for both users and the API. To manage these policies, please use the Roles dialog. |
||
Grants |
Description |
API Command |
full | Grants full access | ALL |
backup | Permits access to the Bakup Manager dialog. | |
change-ip | Permits access to the "IP Settings" dialog. | |
clone | Permits access to the "Clone" dialog. | |
config | Permits access to the "Edit Configuration" dialog, which displays fields that can be updated while the instance isrunning. | |
console | Permits the initiation of a Workspaces session for terminal access using the current {NEXUS} user identity. | console |
delete | Permits the deletion of the item. | delete |
delete-backup | Permits the deletion of a backup image. | delete-backup |
delete-snapshot | Permits the deletion of a snapshot image. | delete-snapshot |
edit | Permits access to the "Edit" dialog. | |
list | Permits listing in the List View area or as JSON objects. | list |
list-backup | Permits listing backup images in the Backup Manager dialog. | list-backup |
list-snapshot | Permits listing backup images in the Snapshot Manager dialog. | list-snapshot |
migrate | Permits access to the "Migrate" dialog. | |
new | Permits access to the new "Provisioning" dialog. | |
ports | Permits access to display the Kafka ports. | ports |
restore-backup | Permits the restoration of a backup image. | restore-backup |
restore-snapshot | Permits the restoration of a snapshot image. | restore-snapshot |
save | Permits execution of the create or update process. | create, update |
saveconfig | Permits execution of the update process. | update-live |
set-ip | Permits the alteration of the IP address. | set-ip |
snapshot | Permits access to the Snapshot Manager dialog. | |
start | Permits starting the instance. | start |
start-backup | Permits starting the backup process. | start-backup |
start-clone | Permits starting the clone process. | start-clone |
start-migrate | Permits starting the migrate process. | start-migrate |
start-snapshot | Permits starting the snapshot process. | start-snapshot |
status | Permits retrieving the status of the instance. | status |
stop | Permits stopping the instance. | stop |
suroot | Permits the initiation of a Workspaces session for terminal access as the root user. |