-
Notifications
You must be signed in to change notification settings - Fork 207
doc: DOCSP-54251 & DOCSP-54252 -- Document how to move from or to Service Accounts authentication #3753
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
base: CLOUDP-334161-service-accounts-dev
Are you sure you want to change the base?
Conversation
APIx bot: a message has been sent to Docs Slack channel |
|
||
The JWT token is only valid during its set duration time. See [Generate Service Account Token](https://www.mongodb.com/docs/atlas/api/service-accounts/generate-oauth2-token/#std-label-generate-oauth2-token-atlas) for more details on creating an SA token. | ||
|
||
**IMPORTANT:** Currently, the MongoDB Terraform provider does not support additional Token OAuth features. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Q: what do we mean with this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Definitely the phrasing is not the better (changes incoming), but there are 3 ideas here:
- The token expires.
- Redirect the user to the Atlas SA docs.
- "the MongoDB Terraform provider does not support additional Token OAuth features." I'm explicitly stating a suggestion mentioned in the project scope doc: https://docs.google.com/document/d/1PuAwTTNbVLUsqMH9wmmHKUCbEojhkQ_oHL2ONxwXZhs/edit?tab=t.0#heading=h.5c9t51nomy3f. However, i'm not sure if we actually need to have this in the final version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we need @bodegus inputs here, can you reach out to him?
docs/guides/migrate-to-service-accounts-authentication-guide.md
Outdated
Show resolved
Hide resolved
docs/guides/migrate-to-service-accounts-authentication-guide.md
Outdated
Show resolved
Hide resolved
docs/guides/migrate-to-service-accounts-authentication-guide.md
Outdated
Show resolved
Hide resolved
docs/guides/migrate-to-service-accounts-authentication-guide.md
Outdated
Show resolved
Hide resolved
docs/guides/migrate-to-service-accounts-authentication-guide.md
Outdated
Show resolved
Hide resolved
Co-authored-by: kanchana-mongodb <54281287+kanchana-mongodb@users.noreply.github.com>
Co-authored-by: kanchana-mongodb <54281287+kanchana-mongodb@users.noreply.github.com>
Added the changes related to DOCSP-54252 since it seemed easier to manage it all in one PR. |
docs/guides/migrate-to-service-accounts-authentication-guide.md
Outdated
Show resolved
Hide resolved
docs/guides/migrate-to-service-accounts-authentication-guide.md
Outdated
Show resolved
Hide resolved
} | ||
``` | ||
|
||
Consider that the access token is **valid for one hour only**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we also mention the 10 token / minute rate limiting when using SA client_id and client_secret?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see why not. I added it.
docs/guides/migrate-to-service-accounts-authentication-guide.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Leo Antoli <430982+lantoli@users.noreply.github.com> Co-authored-by: Manuel Pedrozo <19614462+manupedrozo@users.noreply.github.com>
See [Migration Guide: Service Accounts Authentication](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/migrate-to-service-accounts-authentication-guide) for more | ||
details on setting up SA authentication. | ||
|
||
### AWS Secrets Manager |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@lantoli Do the auth methods currently described in the landing page use PAK? If so, and the idea is to discourage using PAK, should we replace them all with SA information?
Just trying to figure out if mixing PAK and SA info in the index may lead to confusions.
Description
DOCSP-54251
DOCSP-54252
Creates a guide to move to Service Accounts auth and updates the landing page with SA as the first auth option.
Link to any related issue(s):
Type of change:
Required Checklist:
Further comments