Skip to content

doc: Update project documentation to remove api_keys references #1386

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 15, 2023
Merged

doc: Update project documentation to remove api_keys references #1386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion examples/atlas-api-key/create-and-assign-pak-seperately/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,4 @@ Variables Required to be set:
- `private_key`: Atlas private key

In this example, we will set up an organization API key and attach an access list to it.
**Note:** in this example parameter api_keys is deprecated and will be removed in v1.12.0 release from codebase. Use `mongodbatlas_project_api_key` resource instead.

2 changes: 0 additions & 2 deletions website/docs/d/project.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,6 @@ In addition to all arguments above, the following attributes are exported:
* `created` - The ISO-8601-formatted timestamp of when Atlas created the project.
* `teams.#.team_id` - The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
* `teams.#.role_names` - Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The [MongoDB Documentation](https://www.mongodb.com/docs/atlas/reference/user-roles/#organization-roles) describes the roles a user can have.
* `api_keys.#.api_key_id` - The unique identifier of the programmatic API key you want to associate with the project. The programmatic API key and project must share the same parent organization.
* `api_keys.#.role_names` - Each string in the array represents a project role assigned to the programmatic API key. The [MongoDB Documentation](https://www.mongodb.com/docs/atlas/reference/user-roles/#organization-roles) describes the roles a user can have.
* `limits.#.name` - Human-readable label that identifies this project limit.
* `limits.#.value` - Amount the limit is set to.
* `limits.#.current_usage` - Amount that indicates the current usage of the limit.
Expand Down
7 changes: 0 additions & 7 deletions website/docs/d/projects.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,6 @@ resource "mongodbatlas_project" "test" {
team_id = "5e1dd7b4f2a30ba80a70cd4rw"
role_names = ["GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE"]
}

api_keys {
api_key_id = "61003b299dda8d54a9d7d10c"
role_names = ["GROUP_READ_ONLY"]
}

limits {
name = "atlas.project.deployment.clusters"
Expand Down Expand Up @@ -68,8 +63,6 @@ data "mongodbatlas_projects" "test" {
* `created` - The ISO-8601-formatted timestamp of when Atlas created the project.
* `teams.#.team_id` - The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
* `teams.#.role_names` - Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The [MongoDB Documentation](https://www.mongodb.com/docs/atlas/reference/user-roles/#organization-roles) describes the roles a user can have.
* `api_keys.#.api_key_id` - The unique identifier of the Organization Programmatic API key assigned to the Project.
* `api_keys.#.role_names` - List of roles that the Organization Programmatic API key has been assigned. The [MongoDB Documentation](https://www.mongodb.com/docs/atlas/reference/user-roles/#organization-roles) describes the roles a user can have.
* `limits.#.name` - Human-readable label that identifies this project limit.
* `limits.#.value` - Amount the limit is set to.
* `limits.#.current_usage` - Amount that indicates the current usage of the limit.
Expand Down
14 changes: 0 additions & 14 deletions website/docs/r/project.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,6 @@ resource "mongodbatlas_project" "test" {
role_names = ["GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE"]
}

api_keys {
api_key_id = "61003b299dda8d54a9d7d10c"
role_names = ["GROUP_READ_ONLY"]
}

limits {
name = "atlas.project.deployment.clusters"
value = 26
Expand Down Expand Up @@ -83,15 +78,6 @@ Teams attribute is optional

~> **NOTE:** Project created by API Keys must belong to an existing organization.

### Programmatic API Keys
api_keys allows one to assign an existing organization programmatic API key to a Project. The api_keys attribute is optional.

* `api_key_id` - (Required) The unique identifier of the Programmatic API key you want to associate with the Project. The Programmatic API key and Project must share the same parent organization. Note: this is not the `publicKey` of the Programmatic API key but the `id` of the key. See [Programmatic API Keys](https://docs.atlas.mongodb.com/reference/api/apiKeys/) for more.

**WARNING:** The `api_keys` parameter is deprecated and will be removed in v1.12.0 release from codebase. Use `mongodbatlas_project_api_key` resource instead.

* `role_names` - (Required) List of Project roles that the Programmatic API key needs to have. Ensure you provide: at least one role and ensure all roles are valid for the Project. You must specify an array even if you are only associating a single role with the Programmatic API key. The [MongoDB Documentation](https://www.mongodb.com/docs/atlas/reference/user-roles/#organization-roles) describes the roles a user can have.

### Limits
`limits` allows one to configure a variety of limits to a Project. The limits attribute is optional.

Expand Down