Skip to content

(DOCSP-49661): Sunset Atlas CLI v1.23 #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 236 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
236 commits
Select commit Hold shift + click to select a range
be9e14a
DOCSP-24941 Add support for Chocholatey to the installation options
kanchana-mongodb Sep 14, 2022
a6656fd
Merge pull request #67 from kanchana-mongodb/DOCSP-24941
kanchana-mongodb Sep 16, 2022
b46cb45
add deb 11, remove deb 9
davidhou17 Sep 20, 2022
305f734
Merge pull request #69 from davidhou17/DOCSP-25383
davidhou17 Sep 21, 2022
0c87f16
DOCSP-25235 Add section on how to specifying a config file path
kanchana-mongodb Sep 21, 2022
e48f112
Merge pull request #70 from kanchana-mongodb/DOCSP-25235
kanchana-mongodb Sep 23, 2022
165e3d4
(DOCSP-25843) Release notes, source contstant updates for version 1.2.1
JuliaMongo Oct 17, 2022
6b31396
Set submodule to 1.2.1
JuliaMongo Oct 17, 2022
60f1795
Added release notes
JuliaMongo Oct 17, 2022
3c1beb0
Removed vscode settings file that got added by mistake
JuliaMongo Oct 17, 2022
7632a17
trigger build
JuliaMongo Oct 17, 2022
0c6bfd7
Tech review
JuliaMongo Oct 17, 2022
e32eef7
Fixing the build
JuliaMongo Oct 17, 2022
f430ed3
Fix the build
JuliaMongo Oct 17, 2022
a3f6940
Edits
JuliaMongo Oct 17, 2022
29c2f70
Copy review from Sarah
JuliaMongo Oct 17, 2022
d9169ab
Copy review from Sarah
JuliaMongo Oct 17, 2022
a2cf838
Merge pull request #71 from JuliaMongo/DOCSP-25843
JuliaMongo Oct 17, 2022
ff0a75d
(DOCSP-25907) Fix the Debian tabs
JuliaMongo Oct 19, 2022
1b6110a
Copy review and tech review, adjusted paths for Ubuntu and Debian, ad…
JuliaMongo Oct 20, 2022
250890b
Merge pull request #72 from JuliaMongo/DOCSP-25907
JuliaMongo Oct 20, 2022
5e29116
(DOCSP-26031) Makes two small updates to quickstart tutorial (#73)
sarahsimpers Oct 20, 2022
f29180e
Revert "(DOCSP-26031) Makes two small updates to quickstart tutorial …
sarahsimpers Oct 20, 2022
5500880
(DOCSP-26031) Adds changes from MCLI quickstart edits (#76)
sarahsimpers Oct 21, 2022
f58326d
(DOCSP-26157) Adds link to cluster create command and config file (#80)
sarahsimpers Oct 27, 2022
f625cc0
(DOCSP-26581) Adds release notes and updates version (#86)
sarahsimpers Nov 17, 2022
1c28930
Release notes, redirects, source constant updates for 1.4.0
kanchana-mongodb Dec 13, 2022
4091e1a
Set submodule to v1.4.0
kanchana-mongodb Dec 13, 2022
2e4e8ab
Apply suggestions from code review
kanchana-mongodb Dec 13, 2022
4ab2e51
DOCSP-26855 updates for external review feedback
kanchana-mongodb Dec 13, 2022
66013d7
Merge pull request #88 from kanchana-mongodb/DOCSP-26855
kanchana-mongodb Dec 13, 2022
f6bdd90
DOCSP-27054 Edit AtlasCLI Ubuntu Install Links
ajhuh-mdb Dec 14, 2022
1052374
fix debian versions
ajhuh-mdb Dec 15, 2022
8ff5a65
insert constants for mdbversion on debian 11
ajhuh-mdb Dec 15, 2022
a4fa3e3
fix path
ajhuh-mdb Dec 15, 2022
bf4ec56
fix enterprise path
ajhuh-mdb Dec 15, 2022
48d4898
Merge pull request #89 from ajhuh-mdb/DOCSP-27054-edit-atlascli-ubunt…
ajhuh-mdb Dec 15, 2022
02c21f1
(DOCSP-26171) Adds example for geosharded cluster.
erabil-mdb Dec 22, 2022
65e402b
Adds required specs for geosharded clusters.
erabil-mdb Dec 22, 2022
733e6aa
Revises per copy review.
erabil-mdb Jan 3, 2023
0693bcc
Merge pull request #90 from erabil-mdb/DOCSP-26171
erabil-mdb Jan 3, 2023
ecfd0c7
Release notes, redirects, source constant updates for 1.5.0
davidhou17 Feb 9, 2023
126bab4
Set submodule to v1.5.0
davidhou17 Feb 9, 2023
23ecc13
fix build error for release notes
davidhou17 Feb 9, 2023
6d3be58
copy review
davidhou17 Feb 9, 2023
ba6166b
Merge pull request #97 from davidhou17/DOCSP-27934
davidhou17 Feb 9, 2023
b8a5f1e
(DOCSP-26322) Added an IP access list restriction
JuliaMongo Feb 14, 2023
49efee1
Copy review
JuliaMongo Feb 14, 2023
7243761
(DOCSP-28106) Release notes and source constant updates for v1.5.1 (#…
sarahsimpers Feb 16, 2023
32e662d
(DOCSP-28106) Release notes and source constant updates for v1.5.1 (#…
sarahsimpers Feb 16, 2023
32d59a1
Adding newer submodules
JuliaMongo Feb 21, 2023
13d2a95
(DOCSP-28387)(DOCSP-28289) Adds troubleshooting page (#105)
sarahsimpers Mar 6, 2023
80b2d9c
DOCSP-25516 Add missing content on custom output (#103)
pierwill Mar 13, 2023
1449084
(DOCSP-28064) Changes incorrect include file for programmatic steps (…
sarahsimpers Mar 14, 2023
caa959d
added cloud backup schedule config file
kyuan-mongodb Mar 20, 2023
b580c18
Trigger Build
kyuan-mongodb Mar 20, 2023
c376e14
file rename
kyuan-mongodb Mar 20, 2023
56e640b
param structure update
kyuan-mongodb Mar 20, 2023
b9443c9
MM suggestions
kyuan-mongodb Mar 21, 2023
2579303
Merge pull request #98 from JuliaMongo/DOCSP-26322
JuliaMongo Mar 22, 2023
0a50ace
Release notes, redirects, source constant updates for v1.6.0
kanchana-mongodb Mar 30, 2023
1c8824a
added link to command page
kyuan-mongodb Mar 30, 2023
8704aff
Updates the submodule
kanchana-mongodb Mar 30, 2023
61517d9
adding submodule
kanchana-mongodb Mar 30, 2023
39a1ebb
Merge pull request #123 from kyuan-mongodb/DOCSP-28323
kyuan-mongodb Mar 30, 2023
55ca08f
DOCSP-28902 fix for broken links
kanchana-mongodb Mar 30, 2023
821b6c8
Merge pull request #125 from kanchana-mongodb/DOCSP-28902
kanchana-mongodb Mar 30, 2023
499bcf5
DOCSP-28477: add redirects (#126)
jwilliams-mongo Apr 7, 2023
45f61e6
(DOCSP-29108) Adds redirect for cluster config file and changes a lin…
sarahsimpers Apr 12, 2023
a96a0d1
DOCSP-29139 tutorial on using an existing cluster def to create a new…
kanchana-mongodb Apr 27, 2023
6075691
Add guidance for using json config files
davidhou17 Apr 28, 2023
bb8bdfb
small fixes
davidhou17 Apr 28, 2023
4692c04
Set submodule to v1.6.0
davidhou17 Apr 28, 2023
83040e5
Apply suggestions from copy review
davidhou17 May 1, 2023
da7ad8c
Update language
davidhou17 May 2, 2023
f4c3f40
Merge pull request #134 from davidhou17/DOCSP-29111
davidhou17 May 2, 2023
d2d5c24
(DOCSP-26893) Adds page/section for automating processes (#136)
sarahsimpers May 10, 2023
320b27f
(DOCSP-30159) Release notes and submodule update for release v1.7.0 (…
sarahsimpers May 26, 2023
a00cefd
(DOCSP-30466) Adds RNs for 1.7.2
erabil-mdb Jun 8, 2023
ecd76ef
Set submodule to v1.7.2
erabil-mdb Jun 8, 2023
6d173bc
Revises per tech review.
erabil-mdb Jun 8, 2023
867a9bc
Merge pull request #145 from erabil-mdb/DOCSP-30466
erabil-mdb Jun 8, 2023
568a6fb
(DOCSP-30564) Adds release notes, updates submodule for Atlas CLI v1.…
sarahsimpers Jun 9, 2023
fb66666
(DOCSP-30272) Adds RNs for 1.7.1.
erabil-mdb Jun 9, 2023
69f9016
Merge pull request #150 from erabil-mdb/DOCSP-30272
erabil-mdb Jun 9, 2023
d8a990a
(DOCSP-27483) Adds guidance to create Atlas search index from a file …
sarahsimpers Jun 9, 2023
6098a2f
(DOCSP-30497) Adds RN for cluster tagging flag.
erabil-mdb Jun 12, 2023
486e605
Links to new cluster tagging topic.
erabil-mdb Jun 12, 2023
3129e5c
Merge pull request #153 from erabil-mdb/DOCSP-30497
erabil-mdb Jun 14, 2023
563b63e
(DOCSP-29595): Pulled in specific steps for API key access lists. (#156)
corryroot Jun 16, 2023
021ca29
DOCSP-30693: update release notes with breaking changes (#154)
jwilliams-mongo Jun 16, 2023
37565b0
(DOCSP-30302) Adds new tag option.
erabil-mdb Jun 22, 2023
87d05e7
Merge pull request #165 from erabil-mdb/DOCSP-30302
erabil-mdb Jun 26, 2023
fec72b0
Resets submodule (#164)
sarahsimpers Jun 27, 2023
4a35eec
(DOCSP-25302) Adds ephemeral clusters tutorial (#167)
sarahsimpers Jun 27, 2023
a1f204c
DOCSP-30807: 1.8.0 release notes (#163)
jwilliams-mongo Jun 27, 2023
99e0f20
added missing rn item
kyuan-mongodb Jun 28, 2023
ef5c50b
Merge pull request #172 from kyuan-mongodb/DOCSP-31032
kyuan-mongodb Jun 28, 2023
468cfcb
(DOCSP-31172) Adds MongoDB Server support info (#174)
sarahsimpers Jul 6, 2023
7b73998
added v1.9.0 and v1.9.1 release notes
kyuan-mongodb Jul 6, 2023
0bf7949
proofread
kyuan-mongodb Jul 6, 2023
0bbb0ea
added dates
kyuan-mongodb Jul 6, 2023
f6a0fe1
source constant update for v1.9.1
kyuan-mongodb Jul 6, 2023
1534e1d
Set submodule to v1.9.1
kyuan-mongodb Jul 6, 2023
4932b15
pulled in new commands
kyuan-mongodb Jul 6, 2023
fde0475
fixed refs
kyuan-mongodb Jul 6, 2023
27487f5
GB suggestions
kyuan-mongodb Jul 7, 2023
3ea9eac
GB suggestions
kyuan-mongodb Jul 7, 2023
9890cad
Merge pull request #179 from kyuan-mongodb/DOCSP-31074
kyuan-mongodb Jul 7, 2023
38d0448
(DOCSP-31036) Adds example data federation config file.
erabil-mdb Jul 10, 2023
5409119
(DOCSP-31349) Adds deprecated Atlas CLI commands to v1.9 changelog.
erabil-mdb Jul 13, 2023
f093944
Set submodule to v1.9.1
erabil-mdb Jul 14, 2023
c960b29
Changes spelling from British to American.
erabil-mdb Jul 14, 2023
4d42a90
Merge pull request #181 from erabil-mdb/DOCSP-31349
erabil-mdb Jul 14, 2023
79c2d4c
Adds sample data.
erabil-mdb Jul 14, 2023
5bc9d0a
Revises per tech review.
erabil-mdb Jul 17, 2023
1a752b4
Merge pull request #180 from erabil-mdb/DOCSP-31036
erabil-mdb Jul 17, 2023
24cf804
DOCSP-31499 Release notes, source constant updates for v1.9.2 (#185)
kanchana-mongodb Jul 21, 2023
8a693c7
"(DOCSP-31684) Release notes, source constant updates for version 1.1…
sarahsimpers Jul 27, 2023
f1ad3f4
(DOCSP-30771) Adds Docker image as way to install Atlas CLI (#183)
sarahsimpers Aug 1, 2023
ed09598
(DOCSP-31520) Updates tutorial from quickstart to setup (#191)
sarahsimpers Aug 14, 2023
dc27915
(DOCSP-32090) Tutorial to run commands with Docker (#190)
sarahsimpers Aug 22, 2023
8aabdde
fix broken links
davidhou17 Aug 22, 2023
51cbf3b
Merge pull request #197 from davidhou17/DOCSP-32541
davidhou17 Aug 22, 2023
901a00e
Add programmatic taxonomy tags for product & genre (#198)
sarahemlin Aug 29, 2023
947d401
Add config file details for alert configurations
davidhou17 Sep 8, 2023
8446e34
copy review feedback
davidhou17 Sep 11, 2023
ef7c5ca
Merge pull request #199 from davidhou17/DOCSP-32865
davidhou17 Sep 13, 2023
91be88c
(DOCSP-33104) EOL Ubuntu 18.04 (#201)
zach-carr Sep 21, 2023
3067100
(DOCSP-32120) Adds local deployment for the Atlas CLI. (#200)
corryroot Sep 22, 2023
03e0081
(DOCSP-33221): "Release notes, redirects, source constant updates for…
corryroot Sep 22, 2023
01b478e
(DOCSP-33221): Added release dates.
corryroot Sep 22, 2023
78dc446
(DOCSP-33276): Removed Amazon Linux for Local Deploy.
corryroot Sep 25, 2023
4130176
DOCSP-33308: 1.12.1 release notes (#211)
jwilliams-mongo Sep 26, 2023
a93d86e
DOCSP-33495 fix Wrong index name in sample vector search aggregation …
kanchana-mongodb Oct 6, 2023
fdc6f90
updated facets.toml file for correct product/subproduct (#214)
sarahemlin Oct 9, 2023
57f6682
DOCSP-27817 manual tags for the atlas cli top 250 pages (#202)
sarahemlin Oct 9, 2023
53c25be
(DOCSP-33582): Removed rst syntax from code example.
corryroot Oct 10, 2023
e727c49
Revert "(DOCSP-33582): Removed rst syntax from code example."
corryroot Oct 10, 2023
48962f6
(DOCSP-33582): Removed Removed rst syntax from code example.
corryroot Oct 10, 2023
c6744d2
Set submodule to v1.12.1.
corryroot Oct 10, 2023
5d9fe3a
(DOCSP-33494): Added MongoDB Tools prereq.
corryroot Oct 17, 2023
f146f99
(DOCSP-33818) Adds release notes and updates source constants for 1.1…
sarahsimpers Oct 20, 2023
d7f3c4a
DOCSP-31790 update title to alphabetize legacy product menu (#225)
sarahemlin Oct 25, 2023
5fa0fec
(DOCSP-33498): Added deploy and search to landing page.
corryroot Oct 13, 2023
e974be5
(DOCSP-33623): Broke out search tutorials. (#220)
corryroot Nov 8, 2023
403908c
(DOCSP-34509) Adds release notes, source constant, submodule updates …
sarahsimpers Nov 17, 2023
bb9ef50
DOCSP-34513 Add support for Debian 12 (#232)
kanchana-mongodb Dec 6, 2023
6bec61e
Release notes, redirects, source constant updates for 1.14.0
erabil-mdb Dec 6, 2023
2374ce0
Set submodule to v1.14.0
erabil-mdb Dec 6, 2023
74b9217
Revises per copy review.
erabil-mdb Dec 6, 2023
201d784
Merge pull request #233 from erabil-mdb/DOCSP-34811
erabil-mdb Dec 6, 2023
701aef1
(DOCSP-34815): Updated the Atlas CLI TOC labels.
corryroot Dec 8, 2023
30a49fa
DOCSP-34512 update steps for Atlas Search Index Configuration File (#…
kanchana-mongodb Dec 15, 2023
60fc8c7
(DOCSP-34859): Added local deploy in docker. (#247)
corryroot Dec 20, 2023
d32d57a
DOCSP-34286 -- add file options for online create and update
jvincent-mongodb Jan 16, 2024
449359c
DOCSP-34286 -- fix table column widths
jvincent-mongodb Jan 16, 2024
9fe7f26
DOCSP-34286 -- fix table column widths
jvincent-mongodb Jan 16, 2024
a0de5c3
DOCSP-34286 -- add path param fields to JSON examples
jvincent-mongodb Jan 16, 2024
4ed7900
DOCSP-34286 -- add page to json.txt toc
jvincent-mongodb Jan 16, 2024
16ae81e
DOCSP-34286 -- add command explanations
jvincent-mongodb Jan 16, 2024
fa79c84
DOCSP-34286 -- incorporate internal review feedback
jvincent-mongodb Jan 17, 2024
0eff4d4
DOCSP-34286 -- incorporate interal review feedback
jvincent-mongodb Jan 18, 2024
65576de
DOCSP-34286 -- fix typo
jvincent-mongodb Jan 18, 2024
e52fc2e
DOCSP-35716 AtlasCLI 1.14.1 Release Notes (#250)
kanchana-mongodb Jan 19, 2024
20d33db
(DOCSP-35993) Fixes typo (#256)
sarahsimpers Jan 29, 2024
8fd7e7d
DOCSP-35386 Add an automation authentication section (#260)
kanchana-mongodb Jan 29, 2024
cfebd8c
DOCSP-36054 AtlasCLI 1.14.2 Release Notes (#261)
kanchana-mongodb Jan 30, 2024
388437e
Merge pull request #249 from jvincent-mongodb/DOCSP-34286
jvincent-mongodb Jan 30, 2024
80c1827
DOCSP-36053 Add a warning to docker compose mode on experimental stat…
kanchana-mongodb Jan 31, 2024
afe2ff4
(DOCSP-34098)(DOCSP-34247): Updated local tutorial and search tutorial.
corryroot Nov 15, 2023
2df9d50
(DOCSP-34098)(DOCSP-34247): Incorporated feedback.
corryroot Nov 16, 2023
f1156c6
(DOCSP-34098): Incorporated Sarah's feedback.
corryroot Nov 16, 2023
aae9e22
(DOCSP-36569): Release notes, source constant updates for v1.14.3. (#…
corryroot Feb 8, 2024
d4ee437
(DOCSP-36965) Add a PR template to this repo (#267)
JuliaMongo Feb 22, 2024
448f0b5
(DOCSP-37106) Atlas CLI v1.15.0 release notes and submodule update (#…
sarahsimpers Feb 22, 2024
ec26dcb
(DOCSP-36970) Adds disclaimer that you should use local deployments f…
sarahsimpers Feb 23, 2024
0850dc4
Add documentation around HTTP Proxy support (#275)
davidhou17 Feb 27, 2024
2ca0df4
(DOCSP-36734): Add JSON configuration page for Atlas Search Nodes (#274)
davidhou17 Feb 28, 2024
198cb51
(DOCSP-37332) Changes configuration file template (#278)
sarahsimpers Mar 4, 2024
769ca73
DOCSP-37255: 1.15.1 release notes (#289)
jwilliams-mongo Mar 7, 2024
fa96eba
DOCSP-37455: fix tools install command (#292)
jwilliams-mongo Mar 8, 2024
0bd1e62
DOCSP-37456: atlascli 1.16.0 release notes (#291)
jwilliams-mongo Mar 8, 2024
407a7fa
redirects + version update (#297)
jwilliams-mongo Mar 8, 2024
e4123cb
(DOCSP-37638) Adds symlinks for Atlas CLI docs (#300)
sarahsimpers Mar 12, 2024
a71f9bc
(DOCSP-37597) Adds note to migration page for redirected readers (#299)
sarahsimpers Mar 13, 2024
5b2ceac
(DOCSP-37706) Release notes, redirects, source constant updates for v…
sarahsimpers Mar 15, 2024
9343429
(DOCSP-37438): Added details about persisting data. (#303)
corryroot Mar 19, 2024
4a600ea
typo fix (#305)
davidhou17 Mar 19, 2024
35bc03c
Fixes typo in Docker Compose file
Mar 25, 2024
51e5631
Fixes build errors related to submodule (#322)
sarahsimpers Mar 26, 2024
1b9f6dd
(DOCSP-37881): Clarified where to find the RHEL instructions for prer…
corryroot Mar 26, 2024
734cf0a
(DOCSP-36718) Confirm signatures on Atlas CLI packages (#304)
sarahsimpers Mar 28, 2024
e1c4d4f
DOCSP-33172 added meta description for top 250 pages in docs-atlas-cl…
sarahemlin Apr 2, 2024
7915dba
DOCSP-38088 added the v1.18 release notes (#346)
kyuan-mongodb Apr 3, 2024
c251344
DOCSP-38088 v1.18 submodules (#347)
kyuan-mongodb Apr 3, 2024
2c87778
DOCSP-37703 Document how to create indexes with options in Atlas CLI …
kanchana-mongodb Apr 3, 2024
f0e0003
(DOCSP-38423): Added missing Docker compose line.
corryroot Apr 9, 2024
6665b94
(DOCSP-38281) Release notes for 1.19.0 (#355)
sarahsimpers Apr 9, 2024
e6c7eb2
DOCSP-38506 AtlasCLI 1.20.0 Release Notes (#356)
kanchana-mongodb Apr 16, 2024
88fe158
(DOCSP-38401) Documents config file for projects update (#348)
sarahsimpers Apr 17, 2024
a0fe1e9
(DOCSP-37380) Updates all remaining config file pages to template (#358)
sarahsimpers Apr 18, 2024
31d26aa
(DOCSP-39049) Atlas CLI v1.21.0 release notes (#360)
sarahsimpers May 1, 2024
35327e8
(DOCSP-38876) Updates MacOS compatibility (#361)
sarahsimpers May 1, 2024
f005881
(DOCSP-39205) Atlas CLI 1.22.0 release notes (#367)
sarahsimpers May 7, 2024
c69c660
(DOCSP-39082): Updates local deploy with unified docker image. (#368)
corryroot May 13, 2024
df996c4
(DOCSP-39284) Adds example config for federated auth connected orgs. …
erabil-mdb May 22, 2024
0a98f6f
Add support for Amazon Linux 2023 (#369)
davidhou17 May 24, 2024
76c3c6e
(DOCSP-39910): Release notes, redirects, source constant updates for …
corryroot May 31, 2024
f77948c
(DOCSP-40310): Backport DOCSP-40213 to v1.23. (#382)
corryroot Jun 7, 2024
a9ca6cd
DOCSP-39200 updated version on installation page (#402)
kyuan-mongodb Jun 27, 2024
6a5142c
Backport DOCSP-40123 to v1.23 (#404)
jvincent-mongodb Jun 27, 2024
20b096d
Docsp 41256 (#419)
sarahsimpers Jul 8, 2024
a8c97e0
(DOCSP-41222) Resolves quickstart build warnings (#447) (#455)
sarahsimpers Jul 12, 2024
a345050
Adds netlify files (#472) (#482)
jwilliams-mongo Aug 1, 2024
1040e6f
v1.23: Removes submodule and adds in files (#515)
sarahsimpers Aug 19, 2024
6171b44
(DOCSP-42800): Backports DOCSP-41388 to v1.23. (#536)
corryroot Aug 21, 2024
aff6adf
Dark icons v1.23 (#558)
mmeigs Aug 30, 2024
7b3ceb8
ADL september release updates (#582) (#589)
jwilliams-mongo Sep 9, 2024
198c578
update banner severity (#584) (#606)
jwilliams-mongo Sep 10, 2024
8ca6c68
update banner severity (#584) (#607)
jwilliams-mongo Sep 10, 2024
8a3034d
fix banner link (#621) (#626)
jwilliams-mongo Sep 10, 2024
da060bf
add banner to local deployment pages (#642) (#649)
jwilliams-mongo Sep 18, 2024
9dff985
DOCSP-43449 updated text for nLogs param (#669)
kyuan-mongodb Sep 19, 2024
1230539
(DOCSP-42975) [Atlas CLI] Atlas CLI nested components (#677) (#692)
elyse-mdb Oct 1, 2024
2da5e2e
DOCSP-44126-ToC-Refactor (#709) (#721)
ltran-mdb2 Oct 18, 2024
b7731b5
DOCSP-44250-remove-v1.11 (#735) (#744)
ltran-mdb2 Oct 25, 2024
aad5fc2
(DOCSP-45098) Updates localdev Docker compose example. (#760) (#766)
erabil-mdb Nov 13, 2024
de25935
DOCSP-45301 -- Add checklist and examples for converting from officia…
jvincent-mongodb Dec 16, 2024
dff8663
(DOCSP-46401) Adds install workaround for m4 chips. (#809) (#821) (#823)
erabil-mdb Jan 14, 2025
b95a2ba
DOCSP-46527 -- Add GitHub access requirement note (#844) (#859)
jvincent-mongodb Feb 7, 2025
b9fbfa8
(DOCSP-47165) Removes workaround per fix. (#875) (#899) (#901)
erabil-mdb Feb 13, 2025
224e77c
Docsp 46527 -- Add Troubleshooting entry (#885) (#927)
jvincent-mongodb Feb 14, 2025
9f9072d
add sunset version prompt-v1.23-backport (994) (#1044)
davidhou17 Apr 30, 2025
df1b6f4
fix (#1046) (#1065)
davidhou17 Apr 30, 2025
07e54d5
Sunset v1.23
davidhou17 Apr 30, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
54 changes: 54 additions & 0 deletions .github/prompts/eol-branch.prompt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<!-- Download and configure Github CLI before running -->

You are an agent that will help sunset a version of our docs. The user will provide the version number (e.g. v1.20). Complete the following tasks:

1. Open the `snooty.toml` file and make the following changes:

- Add `eol = true` to line 3.
- Add the following code where other banners are located in the file. Don't forget the closing quotations.

```
[[banners]]
targets = ["*"]
variant = "info"
value = """\
This version of the documentation is archived and no longer supported. View the `current documentation <https://www.mongodb.com/docs/atlas/cli/current/>`__ to learn how to `upgrade your version of the Atlas CLI <https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli/>`__.\
"""
```

2. Create a new file named `NoindexEntireSource.sh` that contains the following code:

```
#!/bin/sh
while getopts p: flag
do
case "${flag}" in
p) project=${OPTARG};;
esac
done
echo "Adding noindex to all files in $project..."
# Use find to recursively search for .txt files in the source directory and noindex them
find ~/"$project"/source -type f -name "*.txt" | while read -r file; do
sed -i '' "1s%^%.. meta::\n :robots: noindex, nosnippet \n\n%" "$file"
done
```

3. Run the following command in the terminal: `sh <path-to-bash-script>/NoindexEntireSource.sh -p docs-atlas-cli`, replacing `<path-to-bash-script>` with the path to `NoindexEntireSource.sh`.

For example: `sh ~/Projects/NoindexEntireSource.sh -p Projects/docs-atlas-cli`

This script should add the following code to the top of every file in the repo:

```
.. meta::
:robots: noindex, nosnippet
```

4. Then, create a PR with these changes by performing the following actions:

- Run `git status`
- Run `git add -- ':!submodules/mongodb-atlas-cli'`. This is to add all files to the commit except for the submodules files.
- Generate a short PR description like "Sunset v1.20" and run `gcmsg "<PR description>"` in the terminal.
- Generate a descriptive PR title like "Sunset Atlas CLI v1.20" and Run `gh pr create --title "(<current-branch>): <title>"`. Replace the placeholders with appropriate values.

The user will finalize the PR via the terminal prompts.
19 changes: 19 additions & 0 deletions .github/pull-request-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!-- Add a description of your PR here (optional) -->

- [DOCSP-number](https://jira.mongodb.org/browse/)
- [STAGING](paste the link to staging here)

- [LATEST BUILD LOG](paste the build here)

### Self-Review Checklist

- [ ] Check that the submodule pulled in the right changes (if applicable).
- [ ] [Define](https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions) taxonomy [values](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) at top of page.
- [ ] Add genre facets (tutorial or reference), as in this [example PR](https://github.com/10gen/cloud-docs/pull/5042).
- [ ] Add programmingLanguage (if necessary).
- [ ] Add meta keywords (if necessary).
- [ ] Resolve any new warnings or errors in the build.
- [ ] Proofread for spelling and grammatical errors.
- [ ] Check staging for rendering issues.
- [ ] Confirm links are working.

3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.DS_Store
.vscode/settings.json
settings.json
settings.json
NoindexEntireSource.sh
3 changes: 0 additions & 3 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +0,0 @@
[submodule "submodules/mongodb-atlas-cli"]
path = submodules/mongodb-atlas-cli
url = https://github.com/mongodb/mongodb-atlas-cli.git
Empty file removed .vscode/settings.json
Empty file.
7 changes: 7 additions & 0 deletions build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# ensures that we always use the latest version of the script
if [ -f build-site.sh ]; then
rm build-site.sh
fi

curl https://raw.githubusercontent.com/mongodb/docs-worker-pool/netlify-poc/scripts/build-site.sh -o build-site.sh
sh build-site.sh
20 changes: 18 additions & 2 deletions config/redirects
Original file line number Diff line number Diff line change
@@ -1,4 +1,20 @@
define: base https://www.mongodb.com/docs/atlas/cli
define: versions v1.0 master

define: versions v1.0 v1.1 v1.2 v1.3 v1.4 v1.5 v1.6 v1.7 v1.8 v1.9 v1.10 v1.11 v1.12 v1.13 v1.14 v1.15 v1.16 v1.17 v1.18 v1.19 v1.20 v1.21 v1.22 v1.23 master
symlink: upcoming -> master
symlink: v1.24 -> master
symlink: stable -> v1.23

raw: docs/atlas/cli/ -> ${base}/stable/
raw: docs/atlas/cli/stable/cluster-config-file -> ${base}/stable/reference/json/cluster-config-file

# DOCSP-28477 -- I looked in the docs content source and was unable to find where these malformed links were. so adding redirects to prevent future 404s

raw: docs/atlas/cli/stablecommand/atlas-config-describe/ -> ${base}/stable/command/atlas-config-describe/
raw: docs/atlas/cli/stablecommand/atlas-liveMigrations-create/ -> ${base}/stable/command/atlas-liveMigrations-create/
raw: docs/atlas/cli/stablecommand/atlas-liveMigrations-link-create/ -> ${base}/stable/command/atlas-liveMigrations-link-create/
raw: docs/atlas/cli/stablecommand/atlas-liveMigrations-validation-create/ -> ${base}/stable/command/atlas-liveMigrations-validation-create/
raw: docs/atlas/cli/stablecommand/atlas-privateEndpoints-onlineArchive-aws-describe/ -> ${base}/stable/command/atlas-privateEndpoints-onlineArchive-aws-describe/

# Atlas CLI Version 1.6 and later

[v1.6-*]: docs/atlas/cli/${version}/cluster-config-file -> ${base}/${version}/reference/json/cluster-config-file
6 changes: 6 additions & 0 deletions netlify.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[[integrations]]
name = "snooty-cache-plugin"

[build]
publish = "snooty/public"
command = ". ./build.sh"
47 changes: 33 additions & 14 deletions snooty.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
name = "atlas-cli"
title = "Atlas Command Line Interface"
title = "Atlas CLI"
eol = true

intersphinx = [ "https://www.mongodb.com/docs/ops-manager/current/objects.inv",
"https://www.mongodb.com/docs/manual/objects.inv",
Expand All @@ -10,22 +11,29 @@ intersphinx = [ "https://www.mongodb.com/docs/ops-manager/current/objects.inv",
toc_landing_pages = [
"/atlas-cli-changelog",
"/atlas-cli-env-variables",
"/atlas-cli-automate",
"/atlas-cli-profiles",
"/atlas-cli-quickstart",
"/atlas-cli-tutorials",
"/atlas-cli-local-cloud",
"/command/atlas",
"/compatibility",
"/connect-atlas-cli",
"/install-atlas-cli",
"/migrate-to-atlas-cli",
"/reference/json",
"/telemetry"
]

[constants]
aagent = "Automation Agent"
adf = "Atlas Data Federation"
atlas-cli = "Atlas CLI"
atlas-cli-full = "MongoDB Atlas CLI"
atlas-cli-version = "1.1.7"
atlas-cli-version = "1.23.0"
ak8so = "Atlas Kubernetes Operator"
atlas-sp = "Atlas Stream Processing"
avs = "Atlas Vector Search"
cloudgov = ":atlas:`MongoDB Atlas for Government </government>`"
cloudgov-short = "AtlasGov"
cluster = "cluster"
Expand All @@ -39,12 +47,16 @@ data-lake-store = "data store"
database-deployment = "database deployment"
database-deployments = "database deployments"
default-profile = ":ref:`default profile <mcli-profiles>`"
df = "Data Federation"
FDI = "Federated Database Instance"
fdi = "federated database instance"
mcli = "MongoDB CLI"
mcli-long = "MongoDB Command Line Interface (``mongocli``)"
mcli-version = "1.23.1"
mdbagent = "MongoDB Agent"
mdbVersion = "6.0"
mdbVersion = "7.0"
mongosh = ":binary:`~bin.mongosh`"
oidc = ":abbr:`OIDC (OpenID Connect)`"

[substitutions]
a-application = "an Ops Manager Application"
Expand Down Expand Up @@ -106,17 +118,24 @@ utc = ":abbr:`UTC (Coordinated Universal Time)`"
vpc = ":abbr:`VPC (Virtual Private Cloud)`"

[[banners]]
targets = ["command/atlas-dataLakes*.txt"]
targets = ["command/atlas-dataLakePipelines*.txt"]
variant = "warning"
value = """\
**Data Lake is deprecated.** \
As of September 2024, Data Lake is deprecated and will reach end-of-life. It will be removed on September 30, 2025. If you use Data Lake, you should migrate to alternative solutions before the service is removed. To learn more, see :adl:`Migration Guide </data-lake-deprecation/>`\
"""

[[banners]]
targets = ["*"]
variant = "info"
value = """\
``atlas dataLakes`` commands control the functionality previously \
named Data Lake, which is now called \
`Data Federation <https://www.mongodb.com/docs/atlas/data-federation/>`__ \
in the Atlas UI. The ``atlas dataLakes`` commands will \
continue to work for Data Federation without interruption. \
MongoDB's new \
`Data Lake <https://www.mongodb.com/docs/datalake/>`__ \
functionality doesn't include CLI commands. When we introduce a \
new set of CLI commands for our new Data Lake functionality, we \
will reach out to you to prevent any interruption of service.\
This version of the documentation is archived and no longer supported. View the `current documentation <https://www.mongodb.com/docs/atlas/cli/current/>`__ to learn how to `upgrade your version of the Atlas CLI <https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli/>`__.\
"""

[[banners]]
targets = ["command/atlas-deployments*.txt"]
variant = "warning"
value = """\
**Public Preview.** \
The ``atlas deployments`` command and subsequent related commands are available as a Public Preview. The feature and corresponding documentation may change at any time in the Public Preview stage. To ask questions and provide feedback, see the `Atlas CLI Local Development Community Forum <https://www.mongodb.com/community/forums/tag/local-dev-atlas-cli>`__.\
"""
114 changes: 114 additions & 0 deletions source/atlas-cli-automate.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
.. meta::
:robots: noindex, nosnippet

.. _atlas-cli-automate:

=========================================
Automate Processes with the {+atlas-cli+}
=========================================

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol

To automate a process with the {+atlas-cli+} in a script, use
the following resources and best practices as guidance.

To learn how to connect to the {+atlas-cli+} programmatically, see
the :guilabel:`Programmatic User` tabs on :ref:`connect-atlas-cli`.

Resources for Automation with the {+atlas-cli+}
-----------------------------------------------

.. list-table::
:header-rows: 1
:widths: 40 60

* - Resource
- Objective

* - :ref:`atlas-cli-env-vars`
- Set environment variables that you can define once and use
across all of your scripts.

* - :ref:`go-template-output`
- Use Go templates or |json| paths to customize the output from
the {+atlas-cli+}. You can include the anticipated custom output in your scripts.

Best Practices for Automation with the {+atlas-cli+}
----------------------------------------------------

Follow these best practices when you automate processes with the
{+atlas-cli+}:

Use |service| Private Keys
~~~~~~~~~~~~~~~~~~~~~~~~~~

When you create a script to automate processes, we recommend that you
use |service| :ref:`private keys <atlas-admin-api-access>` to access
|service|. {+atlas-cli+} login sessions last for twelve hours,
after which you must login again to access |service|. Use |service|
:ref:`private keys <atlas-admin-api-access>` for continued access to
|service|.

Base Your Script on the Version of the {+atlas-cli+} that You Run
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

When you create a script to automate processes, you should base the
script on the version of the {+atlas-cli+} that you currently run.
**Don't** build automatic upgrades for the {+atlas-cli+} into your
script because new {+atlas-cli+} releases could introduce breaking
changes, which could break your automated processes.

Instead, check release notes for deprecated features and
breaking changes before you manually upgrade your version of the
{+atlas-cli+}.

.. _atlas-cli-redirect-stderr:

Redirect ``stderr``
~~~~~~~~~~~~~~~~~~~

The {+atlas-cli+} prints error messages and command deprecation
warnings in the output for commands. These unanticipated error messages
and warnings can cause issues for your automated processes that
anticipate a specific output. To prevent issues, you can redirect
``stderr`` to an output file in your script.

For example, the following command redirects the ``stderr`` output from
a script called ``myScript.sh`` to a text file called ``error.txt``:

.. code-block::

myScript.sh 2> error.txt

In the previous example, all error messages and deprecation warnings
are stored in ``error.txt`` and don't display in the output, so
they don't disrupt your automated processes.

Command deprecation messages are similar to the following text:

.. code-block::

Command "describe" is deprecated, Please use atlas privateEndpoints aws interfaces describe <atlasPrivateEndpointId> [--privateEndpointId privateEndpointID] [--projectId projected]

Update Scripts Regularly
~~~~~~~~~~~~~~~~~~~~~~~~

You should regularly update your scripts to discontinue use of
deprecated commands because they will be removed in future releases.
You can learn which commands are deprecated from the
:ref:`atlas-cli-changelog`. If you
:ref:`set up a redirect file for stderr <atlas-cli-redirect-stderr>`,
you can also check that file for deprecation warnings.

.. toctree::
:titlesonly:

Environment Variables </atlas-cli-env-variables>
Customize Output </custom-output-cli>

Loading