feat: Adds support for `skip_default_alerts_settings` in `mongodbatlas_organization` resource & data sources #2933

maastha · 2024-12-30T12:09:52Z

Description

Adds support for skip_default_alerts_settings in mongodbatlas_organization resource & data sources

Link to any related issue(s): CLOUDP-282824

Type of change:

Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR. A migration guide must be created or updated if the new feature will go in a major version.
Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR. A migration guide must be created or updated.
This change requires a documentation update
Documentation fix/enhancement

Required Checklist:

I have signed the MongoDB CLA
I have read the contributing guides
I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
I have added any necessary documentation (if appropriate)
I have run make fmt and formatted my code
If changes include deprecations or removals I have added appropriate changelog entries.
If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

github-actions · 2024-12-30T12:22:46Z

APIx bot: a message has been sent to Docs Slack channel

lmkerbey-mdb · 2024-12-30T18:16:45Z

docs/data-sources/organization.md

@@ -27,6 +27,6 @@ In addition to all arguments above, the following attributes are exported:
 * `multi_factor_auth_required` - (Optional) Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/.
 * `restrict_employee_access` - (Optional) Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/.
 * `gen_ai_features_enabled` - (Optional) Flag that indicates whether this organization has access to generative AI features. This setting only applies to Atlas Commercial and defaults to `true`. With this setting on, Project Owners may be able to enable or disable individual AI features at the project level. To learn more, see https://www.mongodb.com/docs/generative-ai-faq/.
-
+* `skip_default_alerts_settings` - (Optional) Disables automatic alert creation and defaults to `true`. When set to true, no organization level alerts will be created automatically.


Suggested change

* `skip_default_alerts_settings` - (Optional) Disables automatic alert creation and defaults to `true`. When set to true, no organization level alerts will be created automatically.

* `skip_default_alerts_settings` - (Optional) Disables automatic alert creation. When set to true, Atlas doesn't automatically create organization-level alerts. Defaults to `true`.

Favor active voice and present tense. Default values generally come after the 'core' description.

@maastha @lmkerbey-mdb Terraform (and other IaCs) are intentionally defaulting to true to avoid drift changes in the customer state configurations (since alerts would be created as a side-effect). Should we add a small note about to explain why we are defaulting to true?

yes I think the 'why' would make sense since we diverge from API behavior which clearly states the default value to be false.

Updated and added a note about we we default to true

lmkerbey-mdb · 2024-12-30T18:18:49Z

docs/data-sources/organizations.md

@@ -32,5 +32,6 @@ data "mongodbatlas_organizations" "test" {
 * `multi_factor_auth_required` - (Optional) Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/.
 * `restrict_employee_access` - (Optional) Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/.
 * `gen_ai_features_enabled` - (Optional) Flag that indicates whether this organization has access to generative AI features. This setting only applies to Atlas Commercial and defaults to `true`. With this setting on, Project Owners may be able to enable or disable individual AI features at the project level. To learn more, see https://www.mongodb.com/docs/generative-ai-faq/.
-
+* `skip_default_alerts_settings` - (Optional) Disables automatic alert creation and defaults to `true`. When set to true, no organization level alerts will be created automatically.


lmkerbey-mdb · 2024-12-30T18:19:03Z

docs/resources/organization.md

@@ -33,6 +33,8 @@ resource "mongodbatlas_organization" "test" {
 * `multi_factor_auth_required` - (Optional) Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/.
 * `restrict_employee_access` - (Optional) Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/.
 * `gen_ai_features_enabled` - (Optional) Flag that indicates whether this organization has access to generative AI features. This setting only applies to Atlas Commercial and defaults to `true`. With this setting on, Project Owners may be able to enable or disable individual AI features at the project level. To learn more, see https://www.mongodb.com/docs/generative-ai-faq/.
+* `skip_default_alerts_settings` - (Optional) Disables automatic alert creation and defaults to `true`. When set to true, no organization level alerts will be created automatically.


marcosuma · 2024-12-31T07:50:09Z

internal/service/organization/resource_organization.go

@@ -82,6 +82,11 @@ func Resource() *schema.Resource {
 				Optional: true,
 				Default:  true,
 			},
+			"skip_default_alerts_settings": {


is there a way to define the default value here?

I could only find the following in the docs so just wondering if you know:

https://developer.hashicorp.com/terraform/plugin/framework/migrating/attributes-blocks/default-values

https://developer.hashicorp.com/terraform/plugin/framework/resources/default

https://developer.hashicorp.com/terraform/plugin/sdkv2/schemas/schema-behaviors#computed
The above clarifies that default cannot be used with Computed.

The problem is that if backend ever returns a false for an org that may be created with <1.25 (assuming this would be released in 1.25), then:

user config will not have this attr specified

so TF will try to use the default true value

during Read() TF will get false from the backend

since we cannot mark the attribute as Computed if it also has Default, TF will plan to change the value to default true resulting in below non-empty plan for orgs created with older versions of our provider:

~ update in-place Terraform will perform the following actions: # mongodbatlas_organization.test will be updated in-place ~ resource "mongodbatlas_organization" "test" { id = "b3JnX2lk:Njc3Mjk1Y2Y4ZTMyNWI0MjExOTVjMGJl" name = "manual-org-renamed-3-def" ~ skip_default_alerts_settings = false -> true # (10 unchanged attributes hidden) }

We may be able to define Default: true here ONLY if it can be guaranteed from the backend for all IaC orgs created with older versions of our provider to return true for this attribute. But we should not go this route because APIx 1 may do a one-time 'backfill' of this attr to true for IaC orgs but it may be possible in the future for users to use lower provider version for some reason and create new orgs. Does that make sense?

github-actions · 2025-01-06T00:27:21Z

This PR has gone 7 days without any activity and meets the project’s definition of "stale". This will be auto-closed if there is no new activity over the next 7 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!

adds support for skip_default_alerts_settings

abb0746

github-actions bot added the enhancement label Dec 30, 2024

chnaglog

0f5994b

maastha marked this pull request as ready for review December 30, 2024 12:22

maastha requested review from a team as code owners December 30, 2024 12:22

maastha marked this pull request as draft December 30, 2024 12:52

min

522dc69

lmkerbey-mdb requested changes Dec 30, 2024

View reviewed changes

marcosuma reviewed Dec 31, 2024

View reviewed changes

github-actions bot added the stale label Jan 6, 2025

maastha added 2 commits January 7, 2025 13:25

Merge branch 'master' into CLOUDP-282824-org-skipalert

e33d05c

doc update

60be637

github-actions bot removed the stale label Jan 8, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Adds support for `skip_default_alerts_settings` in `mongodbatlas_organization` resource & data sources #2933

feat: Adds support for `skip_default_alerts_settings` in `mongodbatlas_organization` resource & data sources #2933

maastha commented Dec 30, 2024

github-actions bot commented Dec 30, 2024

lmkerbey-mdb Dec 30, 2024

marcosuma Dec 31, 2024

maastha Dec 31, 2024

maastha Jan 7, 2025

lmkerbey-mdb Dec 30, 2024

maastha Jan 7, 2025

lmkerbey-mdb Dec 30, 2024

maastha Jan 7, 2025

marcosuma Dec 31, 2024

maastha Dec 31, 2024

github-actions bot commented Jan 6, 2025

	* `skip_default_alerts_settings` - (Optional) Disables automatic alert creation and defaults to `true`. When set to true, no organization level alerts will be created automatically.
	* `skip_default_alerts_settings` - (Optional) Disables automatic alert creation. When set to true, Atlas doesn't automatically create organization-level alerts. Defaults to `true`.

feat: Adds support for skip_default_alerts_settings in mongodbatlas_organization resource & data sources #2933

Are you sure you want to change the base?

feat: Adds support for skip_default_alerts_settings in mongodbatlas_organization resource & data sources #2933

Conversation

maastha commented Dec 30, 2024

Description

Type of change:

Required Checklist:

Further comments

github-actions bot commented Dec 30, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 6, 2025

feat: Adds support for `skip_default_alerts_settings` in `mongodbatlas_organization` resource & data sources #2933

feat: Adds support for `skip_default_alerts_settings` in `mongodbatlas_organization` resource & data sources #2933