Skip to content

Commit 48eb33a

Browse files
sarahsimperssarahsimpers
authored
Merge pull request #1 from sarahsimpers/DOCSP-21597
(DOCSP-21597) Sets up new Atlas CLI Repo
2 parents 32d2560 + a2e0701 commit 48eb33a

17 files changed

+1371
-0
lines changed

‎config/sphinx_local.yaml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
project: 'atlas-cli'
2+
master_doc: 'index'
3+
paths:
4+
static: ['source/.static']
5+
theme:
6+
name: 'atlas-cli'
7+
sitename: 'MongoDB Atlas CLI'
8+
jira: 'DOCSP'
9+
google_analytics: 'UA-7301842-8'
10+
# Excluded means that a file appearing in this block will not
11+
# automatically load as an .html page
12+
# when its corresponding link in the nav tree is clicked.
13+
nav_excluded:
14+
- /
15+
sidebars:
16+
'**':
17+
- 'pagenav.html'
18+
...

‎snooty.toml

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
name = "atlas-cli"
2+
title = "Atlas Command Line Interface"
3+
4+
intersphinx = [ "https://www.mongodb.com/docs/ops-manager/current/objects.inv",
5+
"https://www.mongodb.com/docs/manual/objects.inv",
6+
"https://www.mongodb.com/docs/atlas/objects.inv",
7+
"https://www.mongodb.com/docs/mongodb-shell/objects.inv"
8+
]
9+
10+
toc_landing_pages = [
11+
"/atlas-cli-profiles",
12+
"/connect-atlas-cli",
13+
"/install-atlas-cli",
14+
"/migrate-to-atlas-cli",
15+
]
16+
17+
[constants]
18+
aagent = "Automation Agent"
19+
atlas-cli = "Atlas CLI"
20+
atlas-cli-full = "MongoDB Atlas CLI"
21+
atlas-cli-version = "1.0.1"
22+
cloudgov = ":atlas:`MongoDB Atlas for Government </government>`"
23+
cloudgov-short = "AtlasGov"
24+
data-lake = "Atlas Data Lake"
25+
data-lake-short = "Data Lake"
26+
data-lake-stores = "data stores"
27+
data-lake-store = "data store"
28+
default-profile = ":ref:`default profile <mcli-profiles>`"
29+
mcli = "MongoDB CLI"
30+
mcli-long = "MongoDB Command Line Interface (``mongocli``)"
31+
mcli-version = "1.23.1"
32+
mdbagent = "MongoDB Agent"
33+
mdbVersion = "5.0"
34+
mongosh = ":binary:`~bin.mongosh`"
35+
36+
[substitutions]
37+
a-application = "an Ops Manager Application"
38+
a-mms = "an Ops Manager"
39+
A-mms = "An Ops Manager"
40+
application-s = "Ops Manager Applications"
41+
application = "Ops Manager Application"
42+
"2fa" = ":abbr:`2FA (Two Factor Authentication)`"
43+
cloud = ":cloudmgr:`MongoDB Cloud Manager </>`"
44+
cloud-short = "Cloud Manager"
45+
api = ":abbr:`API (Application Programming Interface)`"
46+
API = ":abbr:`API (Application Programming Interface)`"
47+
aws = ":abbr:`AWS (Amazon Web Services)`"
48+
azure = ":abbr:`Azure (Microsoft Azure)`"
49+
bic-short = ":bic:`BI Connector </>`"
50+
bic = "BI Connector for Atlas"
51+
bson = ":abbr:`BSON (Binary Javascript Object Notation)`"
52+
cidr = ":abbr:`CIDR (Classless Inter-Domain Routing)`"
53+
com = "Cloud Manager or Ops Manager"
54+
dns = ":abbr:`DNS (Domain Name System)`"
55+
Epoch-time-ms = "Timestamp in the number of milliseconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
56+
epoch-time-ms = "timestamp in the number of milliseconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
57+
Epoch-time = "Timestamp in the number of seconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
58+
epoch-time = "timestamp in the number of seconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
59+
fcv = ":abbr:`FCV (Feature Compatibility Version)`"
60+
fcv-fulllink = ":dbcommand:`Feature Compatibility Version <setFeatureCompatibilityVersion>`"
61+
fqdn = ":abbr:`FQDN (fully qualified domain name)`"
62+
fts = "Atlas Search"
63+
gcp = ":abbr:`GCP (Google Cloud Platform)`"
64+
http = ":abbr:`HTTP (HyperText Transport Protocol)`"
65+
https = ":abbr:`HTTPS (Secure HyperText Transport Protocol)`"
66+
iana = ":abbr:`IANA (Internet Assigned Numbers Authority)`"
67+
iops = ":abbr:`IOPS (Input/Output Operations per Second)`"
68+
ipaddr = ":abbr:`IP (Internet Protocol)`"
69+
iso8601-time = "Timestamp in `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601?oldid=793821205>`__ date and time format in |utc|"
70+
iso8601-tzoffset = ":wikipedia:`ISO-8601 timezone offset </ISO_8601?oldid=960381594#Time_offsets_from_UTC>`"
71+
iso8601 = "`ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601?oldid=793821205>`__"
72+
ipv4 = ":abbr:`IPv4 (Internet Protocol version 4)`"
73+
ipv6 = ":abbr:`IPv6 (Internet Protocol version 6)`"
74+
json = ":abbr:`JSON (Javascript Object Notation)`"
75+
kmip = ":abbr:`KMIP (Key Management Interoperability)`"
76+
ldap = ":abbr:`LDAP (Lightweight Directory Access Protocol)`"
77+
mms-full = ":opsmgr:`MongoDB Ops Manager </>`"
78+
mms = "``Ops Manager``"
79+
mongod = ":binary:`~bin.mongod`"
80+
mongos = ":binary:`~bin.mongos`"
81+
mongo = ":binary:`~bin.mongo`"
82+
onprem = "Ops Manager"
83+
onprem-link = ":opsmgr:`Ops Manager </>`"
84+
s3 = ":abbr:`S3 (Simple Storage Service)`"
85+
service-fullname = ":atlas:`MongoDB Atlas <>`"
86+
service = "Atlas"
87+
ssl = ":abbr:`SSL (Secure Sockets Layer)`"
88+
svc-api-key = "Programmatic API Key"
89+
snmp = ":abbr:`SNMP (Simple Network Management Protocol)`"
90+
tls = ":abbr:`TLS (Transport Layer Security)`"
91+
url = ":abbr:`URL (Uniform Resource Locator)`"
92+
utc = ":abbr:`UTC (Coordinated Universal Time)`"
93+
vpc = ":abbr:`VPC (Virtual Private Cloud)`"

‎source/.static/.mongodb

Whitespace-only changes.

‎source/atlas-cli-changelog.txt

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
:noprevnext:
2+
3+
=======================
4+
{+atlas-cli+} Changelog
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+
.. _atlas-cli-1.0.1:
16+
17+
{+atlas-cli+} 1.0.1
18+
-------------------
19+
20+
Released 16 March 2022
21+
22+
Changes
23+
~~~~~~~
24+
25+
Fixes an issue with the alert for new releases.
26+
27+
.. _atlas-cli-1.0.0:
28+
29+
{+atlas-cli+} 1.0.0
30+
-------------------
31+
32+
Released 15 March 2022
33+
34+
This is the Generally Available (GA) release of {+atlas-cli-full+}.
35+
36+
Changes
37+
~~~~~~~
38+
39+
Introduces the ability to use {+atlas-cli-full+} to manage |service-fullname|,
40+
including managing:
41+
42+
- Projects
43+
- Clusters
44+
- Backup
45+
- Alerts
46+
- Metrics and monitoring
47+
48+
For a complete list of available commands, see :doc:`</atlas-cli-commands>`.
49+
50+
To install this version, see :ref:`<install-atlas-cli>`.

‎source/atlas-cli-commands.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. _atlascli-commands:
2+
3+
=====================
4+
{+atlas-cli+} Commands
5+
=====================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol

‎source/atlas-cli-env-variables.txt

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
.. _atlas-cli-env-vars:
2+
3+
===================================
4+
{+atlas-cli+} Environment Variables
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+
For easier scripting, you can specify configuration settings by using environment variables.
16+
17+
Precedence
18+
----------
19+
20+
- When you run any command, each setting that you specify with an
21+
environment variable takes precedence over the :ref:`profile stored in the
22+
configuration file <atlas-cli-save-connection-settings>`.
23+
24+
- When you run a command using the ``--projectId`` option, the command
25+
line option takes precedence over both the environment variable and
26+
the profile stored in the configuration file.
27+
28+
Supported Environment Variables
29+
--------------------------------
30+
31+
.. important::
32+
33+
{+atlas-cli+} supports both {+mcli+} environment variables and
34+
{+atlas-cli+} environment variables. You can use either {+mcli+}
35+
environment variables or {+atlas-cli+} environment variables,
36+
but not both together.
37+
38+
The {+atlas-cli+} supports the following environment variables:
39+
40+
.. list-table::
41+
:header-rows: 1
42+
:widths: 30 70
43+
44+
* - Variable
45+
- Description
46+
47+
* - ``MONGODB_ATLAS_PUBLIC_API_KEY``
48+
- Sets the public |api| key for commands that interact with
49+
|service|.
50+
51+
* - ``MONGODB_ATLAS_PRIVATE_API_KEY``
52+
- Sets the private |api| key for commands that interact with
53+
|service|.
54+
55+
* - ``MONGODB_ATLAS_ORG_ID``
56+
- Sets the organization ID for commands that require the
57+
``--orgId`` option.
58+
59+
* - ``MONGODB_ATLAS_PROJECT_ID``
60+
- Sets the project ID for commands that require the ``--projectId``
61+
option.
62+
63+
* - ``MONGODB_ATLAS_OUTPUT``
64+
- Sets the output fields and format. Valid values are:
65+
66+
.. list-table::
67+
:header-rows: 1
68+
:widths: 40 60
69+
70+
* - Value
71+
- Output Format
72+
73+
* - | Empty
74+
| *default*
75+
- Human-readable output that includes all fields that the {+atlas-cli+} returns.
76+
77+
* - ``json``
78+
- JSON output that includes all fields that the {+atlas-cli+} returns.
79+
80+
* - ``json-path``
81+
- JSON output that includes the fields that you specify.
82+
83+
* - ``go-template``
84+
- Custom-formatted output that includes the fields
85+
that you specify in a Go template.
86+
87+
* - ``MONGODB_ATLAS_MONGOSH_PATH``
88+
- The full path on your local system to the MongoDB Shell,
89+
{+mongosh+}.
90+
91+
* - ``MONGODB_ATLAS_SKIP_UPDATE_CHECK``
92+
- When set to ``yes``, the {+atlas-cli+} does not prompt you to update
93+
to new versions.
94+
95+
* - ``MONGODB_ATLAS_ACCESS_TOKEN``
96+
- String that grants access to your |service| account. The access token is
97+
valid for 12 hours.
98+
99+
* - ``MONGODB_ATLAS_REFRESH_TOKEN``
100+
- String that allows |service| to automatically request a new
101+
access token when the current access token expires.

‎source/atlas-cli-profiles.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _atlas-cli-profiles:
2+
3+
====================================
4+
Save Connection Settings as Profiles
5+
====================================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
Content

0 commit comments

Comments
 (0)