(DOCSP-28193) created a page for securely storing config file#133
(DOCSP-28193) created a page for securely storing config file#133carriecwk wants to merge 3 commits intomongodb:masterfrom
Conversation
erabil-mdb
left a comment
erabil-mdb
left a comment
There was a problem hiding this comment.
Awesome job @carriecwk! LGTM. Just one suggestion you can take or leave.
| :depth: 1 | ||
| :class: singlecol | ||
|
|
||
| {+atlas-cli+}, like most popular CLIs, enables you to store your configuration file in |
There was a problem hiding this comment.
| {+atlas-cli+}, like most popular CLIs, enables you to store your configuration file in | |
| The {+atlas-cli+}, like most popular CLIs, enables you to store your configuration file in |
| - Installing the ``platformdirs`` `Python package <https://pypi.org/project/platformdirs/>`__ to determine appropriate platform-specific directories | ||
|
|
There was a problem hiding this comment.
not really sure what to do with this, what do I do once I found the file location?
| Overriding the Private API Key Value by Using an Environment Variable | ||
| --------------------------------------------------------------------- | ||
|
|
||
| You can specify configuration settings by using :ref:`environment variables <atlas-cli-env-vars>`. | ||
| When you run any command, each setting that you specify with an environment variable takes precedence | ||
| over the profile stored in the configuration file. | ||
|
|
||
| You can encrypt the value of your private API key by overriding your private API key value through | ||
| the :ref:`MONGODB_ATLAS_PRIVATE_API_KEY environment variable <atlas-cli-env-vars>`. |
There was a problem hiding this comment.
this guide is about storing the file location but then the first recommendation is not not use the file, I find this a bit confusing
There was a problem hiding this comment.
this guide is a bit confusing, it doesn't really tell me how to tore the file securely, it first tells me not to use the file and use envs instead, then just tells me to change to config file location without actually telling me how to make it secure
There was a problem hiding this comment.
Personally I think mongocli docs handles this a bit better dirrectly explaning the file in a general config file page
https://www.mongodb.com/docs/mongocli/stable/configure/configuration-file/
Atlas CLI instead talks about saving connections settins, https://docs-mongodbcom-staging.corp.mongodb.com/atlas-cli/docsworker-xlarge/DOCSP-28193/atlas-cli-save-connection-settings/, which would be the last place I would look for the config file details, and it then for linux mentions XDG_CONFIG_HOME
4 participants
JIRA
STAGING
BUILD