Skip to content

Commit 7e633b2

Browse files
committed
doc: DOCSP-54251 -- Minimal style edits
1 parent eb4364b commit 7e633b2

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

docs/guides/provider-configuration.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@ This guide covers authentication and configuration options for the MongoDB Atlas
1010

1111
The MongoDB Atlas provider supports the following authentication methods:
1212

13-
1. **Service Account (SA)** - Recommended
14-
2. **Programmatic Access Key (PAK)**
13+
1. [**Service Account (SA)** - Recommended](#service-account-recommended)
14+
2. [**Programmatic Access Key (PAK)**](#programmatic-access-key)
1515

1616
Credentials can be provided through (in priority order):
17+
1718
- AWS Secrets Manager
1819
- Provider attributes
1920
- Environment variables
@@ -24,7 +25,7 @@ The provider uses the first available credentials source.
2425

2526
SAs simplify authentication by eliminating the need to create new Atlas-specific user identities and permission credentials. See [Service Accounts Overview](https://www.mongodb.com/docs/atlas/api/service-accounts-overview/) and [MongoDB Atlas Service Account Limits](https://www.mongodb.com/docs/manual/reference/limits/#mongodb-atlas-service-account-limits) for more information.
2627

27-
Create an SA in your [MongoDB Atlas organization](https://www.mongodb.com/docs/atlas/configure-api-access/#grant-programmatic-access-to-an-organization) and set the credentials, for example:
28+
To use SA authentication, create an SA in your [MongoDB Atlas organization](https://www.mongodb.com/docs/atlas/configure-api-access/#grant-programmatic-access-to-an-organization) and set the credentials, for example:
2829

2930
```terraform
3031
provider "mongodbatlas" {
@@ -33,13 +34,13 @@ provider "mongodbatlas" {
3334
}
3435
```
3536

36-
**Note:** SAs can't be used with `mongodbatlas_event_trigger` resources as its API doesn't support it yet.
37+
**Note:** SAs can't be used with `mongodbatlas_event_trigger` resources because its API doesn't support it yet.
3738

3839
### Programmatic Access Key
3940

40-
Generate a PAK with the appropriate [role](https://docs.atlas.mongodb.com/reference/user-roles/). See [MongoDB Atlas documentation](https://www.mongodb.com/docs/atlas/configure-api-access-org/) for instructions.
41+
Generate a PAK with the appropriate [role](https://docs.atlas.mongodb.com/reference/user-roles/). See the [MongoDB Atlas documentation](https://www.mongodb.com/docs/atlas/configure-api-access-org/) for detailed instructions.
4142

42-
**Role recommendation:** If unsure which role to grant, use an organization API key with the Organization Owner role to ensure sufficient access.
43+
**Role recommendation:** If unsure which role to grant, use an organization API key with the Organization Owner role to ensure sufficient access as in the following example:
4344

4445
```terraform
4546
provider "mongodbatlas" {
@@ -73,13 +74,15 @@ The provider supports retrieving credentials from AWS Secrets Manager. See [AWS
7374
3. **Configure AWS credentials** (using AWS CLI or environment variables)
7475

7576
4. **Assume the role** to obtain STS credentials
77+
7678
```shell
7779
aws sts assume-role --role-arn <ROLE_ARN> --role-session-name newSession
7880
```
7981

8082
5. **Configure provider with AWS Secrets Manager**
8183

8284
Using provider attributes:
85+
8386
```terraform
8487
provider "mongodbatlas" {
8588
aws_access_key_id = var.aws_access_key_id
@@ -96,6 +99,7 @@ The provider supports retrieving credentials from AWS Secrets Manager. See [AWS
9699
### Cross-Account and Cross-Region Access
97100

98101
For cross-account secrets, use the fully qualified ARN for `secret_name`. For cross-region or cross-account access, the `sts_endpoint` parameter is required, for example:
102+
99103
```terraform
100104
provider "mongodbatlas" {
101105
aws_access_key_id = var.aws_access_key_id
@@ -157,6 +161,7 @@ As per [HashiCorp's recommendations](https://developer.hashicorp.com/terraform/r
157161
- Windows / AMD64
158162

159163
We ship binaries but do not prioritize fixes for the following operating system / architecture combinations:
164+
160165
- Linux / 386
161166
- Windows / 386
162167
- FreeBSD / 386

0 commit comments

Comments
 (0)