CLOUDP-333877: create stub for atlas cli commands streams workspaces and streams workspaces create

docs/command/atlas-streams-workspaces-create.txt

@@ -0,0 +1,122 @@
+.. _atlas-streams-workspaces-create:
+
+===============================
+atlas streams workspaces create
+===============================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Create an Atlas Stream Processing workspace for your project
+
+To get started quickly, specify a name, a cloud provider, and a region to configure an Atlas Stream Processing workspace.To use this command, you must authenticate with a user account or an API key with the Project Owner role.
+
+Syntax
+------
+
+.. code-block::
+   :caption: Command Syntax
+
+   atlas streams workspaces create <name> [options]
+
+.. Code end marker, please don't delete this comment
+
+Arguments
+---------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - name
+     - string
+     - true
+     - Name of the Atlas Stream Processing workspace. After creation, you can't change the name of the workspace. The name can contain ASCII letters, numbers, and hyphens.
+
+Options
+-------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - --defaultTier
+     - string
+     - false
+     - Default Tier for your Stream Workspace.
+   * - -h, --help
+     - 
+     - false
+     - help for create
+   * - --maxTierSize
+     - string
+     - false
+     - Max Tier Size for your Stream Workspace.
+   * - -o, --output
+     - string
+     - false
+     - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
+   * - --projectId
+     - string
+     - false
+     - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
+   * - --provider
+     - string
+     - true
+     - Cloud service provider that applies to the provisioned Atlas Stream Processing instance. Valid values are AWS or AZURE. This value defaults to "AWS".
+   * - -r, --region
+     - string
+     - true
+     - Human-readable label that identifies the physical location of your Atlas Stream Processing instance. The region can affect network latency and performance if it is far from your source or sink. For AWS, region name must be in the following format: VIRGINIA_USA. For a list of valid values, see https://www.mongodb.com/docs/atlas/reference/amazon-aws/#std-label-aws-stream-processing-regions. For Azure, region name must be in the following format: eastus. For a list of valid values, see https://www.mongodb.com/docs/atlas/reference/microsoft-azure/#std-label-azure-stream-processing-regions.
+   * - --tier
+     - string
+     - false
+     - Tier for your Stream Workspace. This value defaults to "SP30".
+
+Inherited Options
+-----------------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - -P, --profile
+     - string
+     - false
+     - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
+
+Output
+------
+
+If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
+
+.. code-block::
+
+   Atlas Streams Processor Workspace '<Name>' successfully created.
+
+
+Examples
+--------
+
+.. code-block::
+   :copyable: false
+
+   # Deploy an Atlas Stream Processing workspace called myProcessor for the project with the ID 5e2211c17a3e5a48f5497de3:
+   atlas streams instance create myProcessor --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region VIRGINIA_USA --tier SP10 --defaultTier SP30 --maxTierSize SP50

docs/command/atlas-streams-workspaces-delete.txt

@@ -0,0 +1,112 @@
+.. _atlas-streams-workspaces-delete:
+
+===============================
+atlas streams workspaces delete
+===============================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Delete an Atlas Stream Processing instance.
+
+The command prompts you to confirm the operation when you run the command without the --force option.
+
+Before deleting an Atlas Streams Processing instance, you must first stop all processes associated with it.
+To use this command, you must authenticate with a user account or an API key with the Project Owner role.
+
+Syntax
+------
+
+.. code-block::
+   :caption: Command Syntax
+
+   atlas streams workspaces delete <name> [options]
+
+.. Code end marker, please don't delete this comment
+
+Arguments
+---------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - name
+     - string
+     - true
+     - Name of the Atlas Streams instance.
+
+Options
+-------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - --force
+     - 
+     - false
+     - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action.
+   * - -h, --help
+     - 
+     - false
+     - help for delete
+   * - --projectId
+     - string
+     - false
+     - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
+
+Inherited Options
+-----------------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - -P, --profile
+     - string
+     - false
+     - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
+
+Output
+------
+
+If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
+
+.. code-block::
+
+   Atlas Streams processor instance '<Name>' deleted
+
+
+Examples
+--------
+
+.. code-block::
+   :copyable: false
+
+   # Remove an Atlas Stream Processing instance after prompting for a confirmation:
+   atlas streams instance delete myProcessorInstance
+
+
+.. code-block::
+   :copyable: false
+
+   # Remove an Atlas Stream Processing instance named myProcessorInstance without requiring confirmation:
+   atlas streams instance delete myProcessorInstance --force

docs/command/atlas-streams-workspaces-describe.txt

@@ -0,0 +1,109 @@
+.. _atlas-streams-workspaces-describe:
+
+=================================
+atlas streams workspaces describe
+=================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Describe an Atlas Stream Processing instance for your project.
+
+To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
+
+Syntax
+------
+
+.. code-block::
+   :caption: Command Syntax
+
+   atlas streams workspaces describe <name> [options]
+
+.. Code end marker, please don't delete this comment
+
+Arguments
+---------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - name
+     - string
+     - true
+     - Name of the Atlas Streams processor instance.
+
+Options
+-------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - -h, --help
+     - 
+     - false
+     - help for describe
+   * - -o, --output
+     - string
+     - false
+     - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
+   * - --projectId
+     - string
+     - false
+     - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
+
+Inherited Options
+-----------------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - -P, --profile
+     - string
+     - false
+     - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
+
+Output
+------
+
+If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
+
+.. code-block::
+
+   ID     NAME     CLOUD                               REGION
+   <Id>   <Name>   <DataProcessRegion.CloudProvider>   <DataProcessRegion.Region>
+
+
+Examples
+--------
+
+.. code-block::
+   :copyable: false
+
+   # Return an Atlas Stream Processing instance with a specific name:
+   atlas streams instance describe myProcessor
+
+.. code-block::
+   :copyable: false
+
+   # Return a JSON-formatted Atlas Stream Processing instance with a specific name:
+   atlas streams instance describe myProcessor --output json