Skip to content

Commit abe5ab0

Browse files
Migrate to auto-generated command reference documentation (#533)
* Migrate to auto-generated documentation * Remove irrelevant includes * Render all parent command pages as landing pages * Update to v1.17 * Pull in new autogenerated docs for 1.17.1
1 parent 078aee3 commit abe5ab0

File tree

977 files changed

+37285
-57321
lines changed

Some content is hidden

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

977 files changed

+37285
-57321
lines changed

config/redirects

Lines changed: 310 additions & 1 deletion
Large diffs are not rendered by default.

snooty.toml

Lines changed: 158 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,164 @@ title = "MongoDB Command Line Interface"
44
intersphinx = ["https://docs.opsmanager.mongodb.com/current/objects.inv", "https://docs.mongodb.com/manual/objects.inv",
55
"https://docs.atlas.mongodb.com/objects.inv"]
66

7-
toc_landing_pages = ["/configure", "/install", "/quick-start"]
7+
toc_landing_pages = [
8+
"/configure",
9+
"/install",
10+
"/command/mongocli",
11+
"/command/mongocli-atlas",
12+
"/command/mongocli-atlas-accessLists",
13+
"/command/mongocli-atlas-alerts",
14+
"/command/mongocli-atlas-alerts-global",
15+
"/command/mongocli-atlas-alerts-settings",
16+
"/command/mongocli-atlas-alerts-settings-fields",
17+
"/command/mongocli-atlas-backups",
18+
"/command/mongocli-atlas-backups-restores",
19+
"/command/mongocli-atlas-backups-snapshots",
20+
"/command/mongocli-atlas-cloudProviders",
21+
"/command/mongocli-atlas-cloudProviders-accessRoles",
22+
"/command/mongocli-atlas-cloudProviders-accessRoles-aws",
23+
"/command/mongocli-atlas-clusters",
24+
"/command/mongocli-atlas-clusters-connectionStrings",
25+
"/command/mongocli-atlas-clusters-indexes",
26+
"/command/mongocli-atlas-clusters-onlineArchives",
27+
"/command/mongocli-atlas-clusters-search",
28+
"/command/mongocli-atlas-clusters-search-indexes",
29+
"/command/mongocli-atlas-customDbRoles",
30+
"/command/mongocli-atlas-customDns",
31+
"/command/mongocli-atlas-customDns-aws",
32+
"/command/mongocli-atlas-dataLakes",
33+
"/command/mongocli-atlas-dbusers",
34+
"/command/mongocli-atlas-dbusers-certs",
35+
"/command/mongocli-atlas-events",
36+
"/command/mongocli-atlas-integrations",
37+
"/command/mongocli-atlas-integrations-create",
38+
"/command/mongocli-atlas-logs",
39+
"/command/mongocli-atlas-maintenanceWindows",
40+
"/command/mongocli-atlas-metrics",
41+
"/command/mongocli-atlas-metrics-databases",
42+
"/command/mongocli-atlas-metrics-disks",
43+
"/command/mongocli-atlas-networking",
44+
"/command/mongocli-atlas-networking-containers",
45+
"/command/mongocli-atlas-networking-peering",
46+
"/command/mongocli-atlas-networking-peering-create",
47+
"/command/mongocli-atlas-performanceAdvisor",
48+
"/command/mongocli-atlas-performanceAdvisor-namespaces",
49+
"/command/mongocli-atlas-performanceAdvisor-slowQueryLogs",
50+
"/command/mongocli-atlas-performanceAdvisor-suggestedIndexes",
51+
"/command/mongocli-atlas-privateEndpoints",
52+
"/command/mongocli-atlas-privateEndpoints-aws",
53+
"/command/mongocli-atlas-privateEndpoints-aws-interfaces",
54+
"/command/mongocli-atlas-privateEndpoints-azure",
55+
"/command/mongocli-atlas-privateEndpoints-azure-interfaces",
56+
"/command/mongocli-atlas-privateEndpoints-regionalModes",
57+
"/command/mongocli-atlas-processes",
58+
"/command/mongocli-atlas-security",
59+
"/command/mongocli-atlas-security-customerCerts",
60+
"/command/mongocli-atlas-security-ldap",
61+
"/command/mongocli-atlas-security-ldap-verify",
62+
"/command/mongocli-atlas-security-ldap-verify-status",
63+
"/command/mongocli-cloud-manager",
64+
"/command/mongocli-cloud-manager-agents",
65+
"/command/mongocli-cloud-manager-agents-apiKeys",
66+
"/command/mongocli-cloud-manager-agents-versions",
67+
"/command/mongocli-cloud-manager-alerts",
68+
"/command/mongocli-cloud-manager-alerts-global",
69+
"/command/mongocli-cloud-manager-alerts-settings",
70+
"/command/mongocli-cloud-manager-alerts-settings-fields",
71+
"/command/mongocli-cloud-manager-automation",
72+
"/command/mongocli-cloud-manager-backups",
73+
"/command/mongocli-cloud-manager-backups-checkpoints",
74+
"/command/mongocli-cloud-manager-backups-config",
75+
"/command/mongocli-cloud-manager-backups-restores",
76+
"/command/mongocli-cloud-manager-backups-snapshots",
77+
"/command/mongocli-cloud-manager-backups-snapshots-schedule",
78+
"/command/mongocli-cloud-manager-clusters",
79+
"/command/mongocli-cloud-manager-clusters-indexes",
80+
"/command/mongocli-cloud-manager-dbusers",
81+
"/command/mongocli-cloud-manager-events",
82+
"/command/mongocli-cloud-manager-featurePolicies",
83+
"/command/mongocli-cloud-manager-logs",
84+
"/command/mongocli-cloud-manager-logs-jobs",
85+
"/command/mongocli-cloud-manager-maintenanceWindows",
86+
"/command/mongocli-cloud-manager-metrics",
87+
"/command/mongocli-cloud-manager-metrics-databases",
88+
"/command/mongocli-cloud-manager-metrics-disks",
89+
"/command/mongocli-cloud-manager-monitoring",
90+
"/command/mongocli-cloud-manager-performanceAdvisor",
91+
"/command/mongocli-cloud-manager-performanceAdvisor-namespaces",
92+
"/command/mongocli-cloud-manager-performanceAdvisor-slowQueryLogs",
93+
"/command/mongocli-cloud-manager-performanceAdvisor-suggestedIndexes",
94+
"/command/mongocli-cloud-manager-processes",
95+
"/command/mongocli-cloud-manager-security",
96+
"/command/mongocli-cloud-manager-servers",
97+
"/command/mongocli-config",
98+
"/command/mongocli-iam",
99+
"/command/mongocli-iam-globalAccessLists",
100+
"/command/mongocli-iam-globalApiKeys",
101+
"/command/mongocli-iam-organizations",
102+
"/command/mongocli-iam-organizations-apiKeys",
103+
"/command/mongocli-iam-organizations-apiKeys-accessLists",
104+
"/command/mongocli-iam-organizations-users",
105+
"/command/mongocli-iam-projects",
106+
"/command/mongocli-iam-projects-apiKeys",
107+
"/command/mongocli-iam-projects-teams",
108+
"/command/mongocli-iam-projects-users",
109+
"/command/mongocli-iam-teams",
110+
"/command/mongocli-iam-teams-users",
111+
"/command/mongocli-iam-users",
112+
"/command/mongocli-ops-manager",
113+
"/command/mongocli-ops-manager-admin",
114+
"/command/mongocli-ops-manager-admin-backups",
115+
"/command/mongocli-ops-manager-admin-backups-blockstores",
116+
"/command/mongocli-ops-manager-admin-backups-fileSystems",
117+
"/command/mongocli-ops-manager-admin-backups-oplog",
118+
"/command/mongocli-ops-manager-admin-backups-s3",
119+
"/command/mongocli-ops-manager-admin-backups-sync",
120+
"/command/mongocli-ops-manager-agents",
121+
"/command/mongocli-ops-manager-agents-apiKeys",
122+
"/command/mongocli-ops-manager-agents-versions",
123+
"/command/mongocli-ops-manager-alerts",
124+
"/command/mongocli-ops-manager-alerts-global",
125+
"/command/mongocli-ops-manager-alerts-settings",
126+
"/command/mongocli-ops-manager-alerts-settings-fields",
127+
"/command/mongocli-ops-manager-automation",
128+
"/command/mongocli-ops-manager-backups",
129+
"/command/mongocli-ops-manager-backups-checkpoints",
130+
"/command/mongocli-ops-manager-backups-config",
131+
"/command/mongocli-ops-manager-backups-restores",
132+
"/command/mongocli-ops-manager-backups-snapshots",
133+
"/command/mongocli-ops-manager-backups-snapshots-schedule",
134+
"/command/mongocli-ops-manager-clusters",
135+
"/command/mongocli-ops-manager-clusters-indexes",
136+
"/command/mongocli-ops-manager-dbusers",
137+
"/command/mongocli-ops-manager-diagnoseArchives",
138+
"/command/mongocli-ops-manager-events",
139+
"/command/mongocli-ops-manager-featurePolicies",
140+
"/command/mongocli-ops-manager-logs",
141+
"/command/mongocli-ops-manager-logs-jobs",
142+
"/command/mongocli-ops-manager-maintenanceWindows",
143+
"/command/mongocli-ops-manager-metrics",
144+
"/command/mongocli-ops-manager-metrics-databases",
145+
"/command/mongocli-ops-manager-metrics-disks",
146+
"/command/mongocli-ops-manager-monitoring",
147+
"/command/mongocli-ops-manager-owner",
148+
"/command/mongocli-ops-manager-performanceAdvisor",
149+
"/command/mongocli-ops-manager-performanceAdvisor-namespaces",
150+
"/command/mongocli-ops-manager-performanceAdvisor-slowQueryLogs",
151+
"/command/mongocli-ops-manager-performanceAdvisor-suggestedIndexes",
152+
"/command/mongocli-ops-manager-processes",
153+
"/command/mongocli-ops-manager-security",
154+
"/command/mongocli-ops-manager-servers",
155+
"/command/mongocli-ops-manager-serverUsage",
156+
"/command/mongocli-ops-manager-serverUsage-organizations",
157+
"/command/mongocli-ops-manager-serverUsage-organizations-hosts",
158+
"/command/mongocli-ops-manager-serverUsage-organizations-serverType",
159+
"/command/mongocli-ops-manager-serverUsage-projects",
160+
"/command/mongocli-ops-manager-serverUsage-projects-hosts",
161+
"/command/mongocli-ops-manager-serverUsage-projects-serverType",
162+
"/command/mongocli-ops-manager-softwareComponents",
163+
"/command/mongocli-ops-manager-versionManifest"
164+
]
8165

9166
[constants]
10167
aagent = "Automation Agent"
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
.. _mongocli-atlas-accessLists-create:
2+
3+
=================================
4+
mongocli 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+
mongocli atlas accessLists create <entry> [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+
* - --comment
36+
- string
37+
- false
38+
- Optional description or comment for the entry.
39+
* - --deleteAfter
40+
- string
41+
- false
42+
- ISO-8601-formatted UTC date after which Atlas removes the entry from the entry.
43+
* - -h, --help
44+
-
45+
- false
46+
- help for create
47+
* - -o, --output
48+
- string
49+
- false
50+
- Output format.
51+
Valid values: json|json-path|go-template|go-template-file
52+
* - --projectId
53+
- string
54+
- false
55+
- Project ID to use. Overrides configuration file or environment variable settings.
56+
* - --type
57+
- string
58+
- false
59+
- Type of access list entry.
60+
Valid values: cidrBlock|ipAddress|awsSecurityGroup (default "ipAddress")
61+
62+
Inherited Options
63+
-----------------
64+
65+
.. list-table::
66+
:header-rows: 1
67+
:widths: 20 10 10 60
68+
69+
* - Name
70+
- Type
71+
- Required
72+
- Description
73+
* - -P, --profile
74+
- string
75+
- false
76+
- Profile to use from your configuration file.
77+
78+
*Auto generated by MongoDB CLI on 29-Jun-2021*
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
.. _mongocli-atlas-accessLists-delete:
2+
3+
=================================
4+
mongocli 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+
mongocli atlas accessLists delete <entry> [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+
* - --force
36+
-
37+
- false
38+
- Don't ask for confirmation.
39+
* - -h, --help
40+
-
41+
- false
42+
- help for delete
43+
* - --projectId
44+
- string
45+
- false
46+
- Project ID to use. Overrides configuration file or environment variable settings.
47+
48+
Inherited Options
49+
-----------------
50+
51+
.. list-table::
52+
:header-rows: 1
53+
:widths: 20 10 10 60
54+
55+
* - Name
56+
- Type
57+
- Required
58+
- Description
59+
* - -P, --profile
60+
- string
61+
- false
62+
- Profile to use from your configuration file.
63+
64+
*Auto generated by MongoDB CLI on 29-Jun-2021*
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
.. _mongocli-atlas-accessLists-describe:
2+
3+
===================================
4+
mongocli 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+
mongocli atlas accessLists describe <name> [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 describe
39+
* - -o, --output
40+
- string
41+
- false
42+
- Output format.
43+
Valid values: json|json-path|go-template|go-template-file
44+
* - --projectId
45+
- string
46+
- false
47+
- Project ID to use. Overrides configuration file or environment variable settings.
48+
49+
Inherited Options
50+
-----------------
51+
52+
.. list-table::
53+
:header-rows: 1
54+
:widths: 20 10 10 60
55+
56+
* - Name
57+
- Type
58+
- Required
59+
- Description
60+
* - -P, --profile
61+
- string
62+
- false
63+
- Profile to use from your configuration file.
64+
65+
*Auto generated by MongoDB CLI on 29-Jun-2021*

0 commit comments

Comments
 (0)