CLOUDP-289219: Create CLI commands for manipulating stream processors

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

@@ -0,0 +1,118 @@
+.. _atlas-streams-processors-create:
+
+===============================
+atlas streams processors create
+===============================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Creates a stream processor for an Atlas Stream Processing instance.
+
+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 processors create <processorName> [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
+   * - processorName
+     - string
+     - true
+     - Name of the processor
+
+Options
+-------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - -f, --file
+     - string
+     - true
+     - Path to a JSON configuration file that defines an Atlas Stream Processing connection.
+   * - -h, --help
+     - 
+     - false
+     - help for create
+   * - -i, --instance
+     - string
+     - true
+     - Name of your Atlas Stream Processing instance.
+   * - -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::
+
+   Processor <Name> created.
+
+
+Examples
+--------
+
+.. code-block::
+   :copyable: false
+
+   # create a new stream processor for Atlas Stream Processing Instance:
+   atlas streams processor create kafkaprod -i test01 -f processorConfig.json
+
+
+.. code-block::
+   :copyable: false
+
+   # create a new stream processor using the name from a cluster configuration file
+   atlas streams processor create -i test01 -f clusterConfig.json
+

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

@@ -0,0 +1,106 @@
+.. _atlas-streams-processors-delete:
+
+===============================
+atlas streams processors delete
+===============================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Delete a specific Atlas Stream Processor in a Stream Processing Instance.
+
+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 processors delete <processorName> [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
+   * - processorName
+     - string
+     - true
+     - Name of the Stream Processor
+
+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
+   * - -i, --instance
+     - string
+     - true
+     - Name of your Atlas Stream Processing instance.
+   * - --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 Stream Processor '<Name>' deleted
+
+
+Examples
+--------
+
+.. code-block::
+   :copyable: false
+
+   # deletes stream processor 'ExampleSP' from instance 'ExampleInstance':
+   atlas streams processors delete ExampleSP --instance ExampleInstance

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

@@ -0,0 +1,96 @@
+.. _atlas-streams-processors-describe:
+
+=================================
+atlas streams processors describe
+=================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Get details about a specific Atlas Stream Processor in a Stream Processing Instance.
+
+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 processors describe <processorName> [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
+   * - processorName
+     - string
+     - true
+     - Name of the Stream Processor
+
+Options
+-------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - -h, --help
+     - 
+     - false
+     - help for describe
+   * - --includeStats
+     - 
+     - false
+     - Flag that indicates whether to include Stream Processor stats. This flag defaults to false.
+   * - -i, --instance
+     - string
+     - true
+     - Name of your Atlas Stream Processing instance.
+   * - --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.
+
+Examples
+--------
+
+.. code-block::
+   :copyable: false
+
+   # Return a JSON-formatted view of stream processor 'ExampleProcessor' for an instance 'ExampleInstance':
+   atlas streams processors describe ExampleProcessor --instance ExampleInstance