Skip to content

Commit 22ef83a

Browse files
auddin431auddin431
committed
CLOUDP-289219: Create CLI commands for manipulating stream processors
1 parent d469444 commit 22ef83a

32 files changed

+2379
-2
lines changed

‎docs/command/atlas-clusters-create.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Options
9191
- false
9292
- Major MongoDB version of the cluster.
9393

94-
Mutually exclusive with --file. This value defaults to "7.0".
94+
Mutually exclusive with --file. This value defaults to "8.0".
9595
* - -m, --members
9696
- int
9797
- false

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

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
.. _atlas-streams-processors-create:
2+
3+
===============================
4+
atlas streams processors create
5+
===============================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Creates a stream processor for an Atlas Stream Processing instance.
16+
17+
To use this command, you must authenticate with a user account or an API key with the Project Owner role.
18+
19+
Syntax
20+
------
21+
22+
.. code-block::
23+
:caption: Command Syntax
24+
25+
atlas streams processors create <processorName> [options]
26+
27+
.. Code end marker, please don't delete this comment
28+
29+
Arguments
30+
---------
31+
32+
.. list-table::
33+
:header-rows: 1
34+
:widths: 20 10 10 60
35+
36+
* - Name
37+
- Type
38+
- Required
39+
- Description
40+
* - processorName
41+
- string
42+
- true
43+
- Name of the processor
44+
45+
Options
46+
-------
47+
48+
.. list-table::
49+
:header-rows: 1
50+
:widths: 20 10 10 60
51+
52+
* - Name
53+
- Type
54+
- Required
55+
- Description
56+
* - -f, --file
57+
- string
58+
- true
59+
- Path to a JSON configuration file that defines an Atlas Stream Processing connection.
60+
* - -h, --help
61+
-
62+
- false
63+
- help for create
64+
* - -i, --instance
65+
- string
66+
- true
67+
- Name of your Atlas Stream Processing instance.
68+
* - -o, --output
69+
- string
70+
- false
71+
- Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
72+
* - --projectId
73+
- string
74+
- false
75+
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
76+
77+
Inherited Options
78+
-----------------
79+
80+
.. list-table::
81+
:header-rows: 1
82+
:widths: 20 10 10 60
83+
84+
* - Name
85+
- Type
86+
- Required
87+
- Description
88+
* - -P, --profile
89+
- string
90+
- false
91+
- 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.
92+
93+
Output
94+
------
95+
96+
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
97+
98+
.. code-block::
99+
100+
Processor <Name> created.
101+
102+
103+
Examples
104+
--------
105+
106+
.. code-block::
107+
:copyable: false
108+
109+
# create a new stream processor for Atlas Stream Processing Instance:
110+
atlas streams processor create kafkaprod -i test01 -f processorConfig.json
111+
112+
113+
.. code-block::
114+
:copyable: false
115+
116+
# create a new stream processor using the name from a cluster configuration file
117+
atlas streams processor create -i test01 -f clusterConfig.json
118+

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

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
.. _atlas-streams-processors-delete:
2+
3+
===============================
4+
atlas streams processors delete
5+
===============================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Delete a specific Atlas Stream Processor in a Stream Processing Instance.
16+
17+
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
18+
19+
Syntax
20+
------
21+
22+
.. code-block::
23+
:caption: Command Syntax
24+
25+
atlas streams processors delete <processorName> [options]
26+
27+
.. Code end marker, please don't delete this comment
28+
29+
Arguments
30+
---------
31+
32+
.. list-table::
33+
:header-rows: 1
34+
:widths: 20 10 10 60
35+
36+
* - Name
37+
- Type
38+
- Required
39+
- Description
40+
* - processorName
41+
- string
42+
- true
43+
- Name of the Stream Processor
44+
45+
Options
46+
-------
47+
48+
.. list-table::
49+
:header-rows: 1
50+
:widths: 20 10 10 60
51+
52+
* - Name
53+
- Type
54+
- Required
55+
- Description
56+
* - --force
57+
-
58+
- false
59+
- Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action.
60+
* - -h, --help
61+
-
62+
- false
63+
- help for delete
64+
* - -i, --instance
65+
- string
66+
- true
67+
- Name of your Atlas Stream Processing instance.
68+
* - --projectId
69+
- string
70+
- false
71+
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
72+
73+
Inherited Options
74+
-----------------
75+
76+
.. list-table::
77+
:header-rows: 1
78+
:widths: 20 10 10 60
79+
80+
* - Name
81+
- Type
82+
- Required
83+
- Description
84+
* - -P, --profile
85+
- string
86+
- false
87+
- 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.
88+
89+
Output
90+
------
91+
92+
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
93+
94+
.. code-block::
95+
96+
Atlas Stream Processor '<Name>' deleted
97+
98+
99+
Examples
100+
--------
101+
102+
.. code-block::
103+
:copyable: false
104+
105+
# deletes stream processor 'ExampleSP' from instance 'ExampleInstance':
106+
atlas streams processors delete ExampleSP --instance ExampleInstance

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

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
.. _atlas-streams-processors-describe:
2+
3+
=================================
4+
atlas streams processors describe
5+
=================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Get details about a specific Atlas Stream Processor in a Stream Processing Instance.
16+
17+
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
18+
19+
Syntax
20+
------
21+
22+
.. code-block::
23+
:caption: Command Syntax
24+
25+
atlas streams processors describe <processorName> [options]
26+
27+
.. Code end marker, please don't delete this comment
28+
29+
Arguments
30+
---------
31+
32+
.. list-table::
33+
:header-rows: 1
34+
:widths: 20 10 10 60
35+
36+
* - Name
37+
- Type
38+
- Required
39+
- Description
40+
* - processorName
41+
- string
42+
- true
43+
- Name of the Stream Processor
44+
45+
Options
46+
-------
47+
48+
.. list-table::
49+
:header-rows: 1
50+
:widths: 20 10 10 60
51+
52+
* - Name
53+
- Type
54+
- Required
55+
- Description
56+
* - -h, --help
57+
-
58+
- false
59+
- help for describe
60+
* - --includeStats
61+
-
62+
- false
63+
- Flag that indicates whether to include Stream Processor stats. This flag defaults to false.
64+
* - -i, --instance
65+
- string
66+
- true
67+
- Name of your Atlas Stream Processing instance.
68+
* - --projectId
69+
- string
70+
- false
71+
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
72+
73+
Inherited Options
74+
-----------------
75+
76+
.. list-table::
77+
:header-rows: 1
78+
:widths: 20 10 10 60
79+
80+
* - Name
81+
- Type
82+
- Required
83+
- Description
84+
* - -P, --profile
85+
- string
86+
- false
87+
- 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.
88+
89+
Examples
90+
--------
91+
92+
.. code-block::
93+
:copyable: false
94+
95+
# Return a JSON-formatted view of stream processor 'ExampleProcessor' for an instance 'ExampleInstance':
96+
atlas streams processors describe ExampleProcessor --instance ExampleInstance

0 commit comments

Comments
 (0)