docs: improve ADC related error and warning messages #449
Conversation
lib/googleauth/credentials_loader.rb
Outdated
| "You are authenticating using user credentials." \ | ||
| "For production, we recommend using service account credentials." \ | ||
| "To learn more about service account credentials, see" \ | ||
| "http://cloud.google.com/docs/authentication/external/set-up-adc-on-cloud".freeze |
There was a problem hiding this comment.
Is the intent to drop the note about being able to suppress the message with an environment variable?
There was a problem hiding this comment.
I don't think so. I'll remove it. Thanks.
| "server applications use service accounts instead. If your application continues to use end user credentials " \ | ||
| 'from Cloud SDK, you might receive a "quota exceeded" or "API not enabled" error. For more information about ' \ | ||
| "service accounts, see https://cloud.google.com/docs/authentication/. To suppress this message, set the " \ | ||
| "You are authenticating using user credentials." \ |
There was a problem hiding this comment.
Per the document we want to REMOVe the old message. (1.2.1)
The substitution has different logic (show in prod only) and for now we implement it only for Java/Python. (1.2.2)
So in case of Ruby you can just remove this logic and message completely.
| @@ -21,7 +21,7 @@ module Google | |||
| module Auth | |||
| NOT_FOUND_ERROR = <<~ERROR_MESSAGE.freeze | |||
| Could not load the default credentials. Browse to | |||
| https://developers.google.com/accounts/docs/application-default-credentials | |||
| https://cloud.google.com/docs/authentication/provide-credentials-adc | |||
There was a problem hiding this comment.
Per (1.2.3) both mesage and link has to be updated. the "external" link does redirect and is expected, it allows tech writer to make changes later:
Your credentials were not found. To set up Application Default Credentials for your environment, see https://cloud.google.com/docs/authentication/external/set-up-adc
Fixes #415