Skip to content

Commit 405a4db

Browse files
andreaangiolilloandreaangiolillo
authored
CLOUDP-112245: [Milestone] Atlascli/Mongocli Doc changes (#975)
1 parent 2492bd0 commit 405a4db

File tree

922 files changed

+67306
-6
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

922 files changed

+67306
-6
lines changed

‎Makefile

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,15 @@ gen-mocks: ## Generate mocks
9191
go generate ./internal...
9292

9393
.PHONY: gen-docs
94-
gen-docs: ## Generate docs for commands
95-
@echo "==> Generating docs"
96-
go run ./internal/docs/main.go
94+
gen-docs: gen-docs-mongocli gen-docs-atlascli ## Generate docs for commands
95+
96+
gen-docs-mongocli: ## Generate docs for mongocli commands
97+
@echo "==> Generating docs for mongocli"
98+
go run ./internal/docs/mongocli/main.go
99+
100+
gen-docs-atlascli: ## Generate docs for atlascli commands
101+
@echo "==> Generating docs for atlascli"
102+
go run ./internal/docs/atlascli/main.go
97103

98104
.PHONY: build
99105
build: build-mongocli ## Generate a binary for mongocli

‎docs/atlascli/command/atlas-accessLists-create.txt

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
.. _atlas-accessLists-create:
2+
3+
========================
4+
atlas accessLists 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+
Create an IP access list for your project.
16+
17+
Syntax
18+
------
19+
20+
.. code-block::
21+
22+
atlas accessLists create [entry] [options]
23+
24+
Arguments
25+
---------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - entry
36+
- string
37+
- false
38+
- The IP address, CIDR address, or AWS security group ID of the access list entry to create.
39+
40+
Options
41+
-------
42+
43+
.. list-table::
44+
:header-rows: 1
45+
:widths: 20 10 10 60
46+
47+
* - Name
48+
- Type
49+
- Required
50+
- Description
51+
* - --comment
52+
- string
53+
- false
54+
- Optional description or comment for the entry.
55+
* - --currentIp
56+
-
57+
- false
58+
- Flag that indicates whether to use the IP Address from the host that is currently executing the command. Only applicable for type ipAddress entries. To learn more, see: https://docs.mongodb.com/mongocli/master/command/mongocli-atlas-accessLists-create/.
59+
* - --deleteAfter
60+
- string
61+
- false
62+
- ISO-8601-formatted UTC date after which Atlas removes the value from the entry.
63+
* - -h, --help
64+
-
65+
- false
66+
- help for create
67+
* - -o, --output
68+
- string
69+
- false
70+
- Output format. Valid values are json, json-path, go-template, or go-template-file.
71+
* - --projectId
72+
- string
73+
- false
74+
- Project ID to use. Overrides the settings in the configuration file or environment variable.
75+
* - --type
76+
- string
77+
- false
78+
- Type of access list entry. Valid values are cidrBlock, ipAddress, or awsSecurityGroup. This value defaults to "ipAddress".
79+
80+
Inherited Options
81+
-----------------
82+
83+
.. list-table::
84+
:header-rows: 1
85+
:widths: 20 10 10 60
86+
87+
* - Name
88+
- Type
89+
- Required
90+
- Description
91+
* - -P, --profile
92+
- string
93+
- false
94+
- Profile to use from your configuration file.
95+
96+
Examples
97+
--------
98+
99+
.. code-block::
100+
101+
Create IP address access list with the current IP address. Entry is not needed in this case.
102+
$ mongocli atlas accessList create --currentIP
103+
104+

‎docs/atlascli/command/atlas-accessLists-delete.txt

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
.. _atlas-accessLists-delete:
2+
3+
========================
4+
atlas accessLists 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 an IP access list from your project.
16+
17+
Syntax
18+
------
19+
20+
.. code-block::
21+
22+
atlas accessLists delete <entry> [options]
23+
24+
Arguments
25+
---------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - entry
36+
- string
37+
- false
38+
- The IP address, CIDR address, or AWS security group ID of the access list entry to delete.
39+
40+
Options
41+
-------
42+
43+
.. list-table::
44+
:header-rows: 1
45+
:widths: 20 10 10 60
46+
47+
* - Name
48+
- Type
49+
- Required
50+
- Description
51+
* - --force
52+
-
53+
- false
54+
- If specified, skips asking for confirmation before proceeding with a requsted action.
55+
* - -h, --help
56+
-
57+
- false
58+
- help for delete
59+
* - --projectId
60+
- string
61+
- false
62+
- Project ID to use. Overrides the settings in the configuration file or environment variable.
63+
64+
Inherited Options
65+
-----------------
66+
67+
.. list-table::
68+
:header-rows: 1
69+
:widths: 20 10 10 60
70+
71+
* - Name
72+
- Type
73+
- Required
74+
- Description
75+
* - -P, --profile
76+
- string
77+
- false
78+
- Profile to use from your configuration file.
79+

‎docs/atlascli/command/atlas-accessLists-describe.txt

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
.. _atlas-accessLists-describe:
2+
3+
==========================
4+
atlas accessLists 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+
Describe an IP access list entry.
16+
17+
Syntax
18+
------
19+
20+
.. code-block::
21+
22+
atlas accessLists describe <name> [options]
23+
24+
Arguments
25+
---------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - entry
36+
- string
37+
- false
38+
- The IP address, CIDR address, or AWS security group ID of the access list entry to retrieve.
39+
40+
Options
41+
-------
42+
43+
.. list-table::
44+
:header-rows: 1
45+
:widths: 20 10 10 60
46+
47+
* - Name
48+
- Type
49+
- Required
50+
- Description
51+
* - -h, --help
52+
-
53+
- false
54+
- help for describe
55+
* - -o, --output
56+
- string
57+
- false
58+
- Output format. Valid values are json, json-path, go-template, or go-template-file.
59+
* - --projectId
60+
- string
61+
- false
62+
- Project ID to use. Overrides the settings in the configuration file or environment variable.
63+
64+
Inherited Options
65+
-----------------
66+
67+
.. list-table::
68+
:header-rows: 1
69+
:widths: 20 10 10 60
70+
71+
* - Name
72+
- Type
73+
- Required
74+
- Description
75+
* - -P, --profile
76+
- string
77+
- false
78+
- Profile to use from your configuration file.
79+

‎docs/atlascli/command/atlas-accessLists-list.txt

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
.. _atlas-accessLists-list:
2+
3+
======================
4+
atlas accessLists list
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+
List Atlas IP access list entries for your project.
16+
17+
Syntax
18+
------
19+
20+
.. code-block::
21+
22+
atlas accessLists list [options]
23+
24+
Options
25+
-------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - -h, --help
36+
-
37+
- false
38+
- help for list
39+
* - --limit
40+
- int
41+
- false
42+
- Number of items per page. This value defaults to 100.
43+
* - -o, --output
44+
- string
45+
- false
46+
- Output format. Valid values are json, json-path, go-template, or go-template-file.
47+
* - --page
48+
- int
49+
- false
50+
- Page number. This value defaults to 1.
51+
* - --projectId
52+
- string
53+
- false
54+
- Project ID to use. Overrides the settings in the configuration file or environment variable.
55+
56+
Inherited Options
57+
-----------------
58+
59+
.. list-table::
60+
:header-rows: 1
61+
:widths: 20 10 10 60
62+
63+
* - Name
64+
- Type
65+
- Required
66+
- Description
67+
* - -P, --profile
68+
- string
69+
- false
70+
- Profile to use from your configuration file.
71+

0 commit comments

Comments
 (0)