[DOCS-15394] [Atlas] Update tools docs to explain that using stdin does not work well with password prompts Created: 06/Jun/22  Updated: 29/Oct/23  Resolved: 28/Jun/22

Status: Closed
Project: Documentation
Component/s: Atlas
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Minor - P4
Reporter: Dave Rolsky Assignee: Carrie Kim
Resolution: Fixed Votes: 0
Labels: captain-ticket, new-hire-ticket
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 1 year, 33 weeks, 5 days ago
Story Points: 3

 Description   

If a user is specified with --user but no --password is given, or if the --password is an empty string, then the tools will prompt for the password. However, if stdin is not a terminal, it will attempt to read the password from stdin without prompting. That means if the user pipes input to the tool on stdin, we will try to read the password from it.

We should document this behavior, and anywhere that we refer to passing input via stdin, we should tell the user that this does not work properly when the password is not somehow provided. Note that this also applies to the --sslPEMKeyPassword parameter as well.

I'm not clear on whether we should document this behavior of reading the password from stdin. AFAICT, this is not documented anywhere currently, but the tools will log the fact that they do this. I think for now let's not document this, but just document that the password prompting won't work when other input is passed to stdin.



 Comments   
Comment by Carrie Kim [ 17/Jun/22 ]

Hi Dave, could you take a look at this PR? Thanks.

https://github.com/10gen/cloud-docs/pull/3412

Generated at Thu Feb 08 08:12:46 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.