An Atlas Stream Processing workspace provides a context for all of your operations on streaming data. The procedures in this page walk you through creating and configuring your stream processing workspaces.
Prerequisites
To create and configure a stream processing workspace, you must have the following:
An Atlas project
An Atlas user with the
Project Owner, theProject Stream Processing Owner, or theProject Data Access Adminrole to manage a Stream Processing Workspace.Note
While the
Project Owner,Project Stream Processing Owner, andProject Data Access Adminroles all grant the privileges to create, view, edit and delete stream processing workspaces, theProject Ownerrole also allows users to perform tasks such as creating database deployments, managing project access, and more.See Project Roles to learn more about the differences between these roles.
View stream processing workspaces
To view your stream processing workspaces:
To list all stream processing instances in the project you specify using the Atlas CLI, run the following command:
atlas streams instances list [options]
To return details of one stream processing instance you specify using the Atlas CLI, run the following command:
atlas streams instances describe <name> [options]
To learn more about the syntax and parameters for the previous commands, see the Atlas CLI documentation for atlas streams instances list and atlas streams instances describe.
In Atlas, go to the Stream Processing page for your project.
If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.
If it's not already displayed, select your project from the Projects menu in the navigation bar.
In the sidebar, click Stream Processing under the Streaming Data heading.
The Stream Processing page displays.
The Atlas Administration API provides different endpoints for retrieving one or all stream processing workspaces.
Create a stream processing workspace
To create a new stream processing workspace:
To create one stream processing instance in the project you specify using the Atlas CLI, run the following command:
atlas streams instances create <name> [options]
To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas streams instances create.
In Atlas, go to the Stream Processing page for your project.
If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.
If it's not already displayed, select your project from the Projects menu in the navigation bar.
In the sidebar, click Stream Processing under the Streaming Data heading.
The Stream Processing page displays.
Create your stream processing workspace.
Click Create instance in the upper right corner.
Configure your new stream processing workspace.
Select a stream processing workspace tier.
Select a Cloud Provider.
Select a Region from the dropdown menu.
Enter a string for the Instance Name. Each stream processing workspace name must be unique within a project.
Click Create.
The Atlas Administration API provides an endpoint for creating a stream processing workspace.
Delete a stream processing workspace
To delete a stream processing workspace:
To remove one stream processing instance from the project you specify using the Atlas CLI, run the following command:
atlas streams instances delete <name> [options]
To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas streams instances delete.
In Atlas, go to the Stream Processing page for your project.
If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.
If it's not already displayed, select your project from the Projects menu in the navigation bar.
In the sidebar, click Stream Processing under the Streaming Data heading.
The Stream Processing page displays.
The Atlas Administration API provides an endpoint for deleting a stream processing workspace.
Edit a stream processing workspace
To edit an stream processing workspace:
To update one stream processing instance in the project you specify using the Atlas CLI, run the following command:
atlas streams instances update <name> [options]
To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas streams instances update.
The Atlas Administration API provides an endpoint for editing a stream processing workspace.
Download Audit Logs
To download your stream processing workspace audit logs:
To download audit logs of one stream processing instance you specify using the Atlas CLI, run the following command:
atlas streams instances download <tenantName> [options]
To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas streams instances download.
In Atlas, go to the Stream Processing page for your project.
If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.
If it's not already displayed, select your project from the Projects menu in the navigation bar.
In the sidebar, click Stream Processing under the Streaming Data heading.
The Stream Processing page displays.
Click . From the dropdown menu, select Audit Logs.
In the modal window, select a Time Period from the dropdown menu. This value determines the logging interval used to delimit events in the downloadable log file.
The Atlas Administration API provides an endpoint for creating a stream processing workspace.
Download Audit Logs for One Atlas Stream Processing Instance