Skip to content
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

Docs : remove the description of the feature in preview #28260

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

sinbai
Copy link
Contributor

@sinbai sinbai commented Dec 12, 2024

Purpose of this PR:

  • Remove the description of the cross-region replication feature in preview as the feature recently became generally available.
  • Update test cases to test the generally available feature.

Test result:

PASS: TestAccMongoCluster_geoReplica
PASS: TestAccMongoCluster_previewFeature (2480.43s)
PASS: TestAccMongoClusterFreeTier/freeTier/update (3077.22s)

@@ -92,7 +92,29 @@ func TestAccMongoCluster_previewFeature(t *testing.T) {
},
data.ImportStep("administrator_password", "create_mode"),
{
Config: r.geoReplica(data),
Config: r.geoReplica(data, r.previewFeature(data)),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the acceptance test we're still setting preview_features = ["GeoReplicas"] in the config but in the notes it says this isn't required anymore?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although GeoReplicas is now generally available, the current API behavior is still supported for preview_features = ["GeoReplicas"]. Therefore, I still keep the test case for preview_features property. Do you mean I should remove that test case? Any feedback feel free to let me know, thank you.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our tests should validate that GeoReplicas work without having to set preview_features = ["GeoReplicas"] since that is what we have written in the docs.

You are right in that we should still have a test case for the preview_features property though, are there any other preview features that we can use here instead of GeoReplicas?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, you are right. I have updated TestAccMongoCluster_geoReplica test case and test passed. Currently, GeoReplicas still works for the preview_features property test, I'm already asking the service team if there are other values ​​other than GeoReplicas available. If so, I would update the tests.

image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @stephybun given the response provided by the service team below, I have deleted the validation of preview_features to avoid TF from continuously updating this list in the future. In addition, regarding the test case of preview_features, I assume that it is OK to always use GeoReplicas. What do you think?

We intend on 'previewFeatures' to have new values added in an ongoing manner that can be orthogonal to an API version release. We will publicly document new preview feature settings that customers can try, but we can't guarantee these will be tied to an API version release.

Preview features will eventually be made GA – this can mean the behavior becomes default on mongo clusters, or the feature state is no longer gated by the preview switch. Preview feature values for GA'd feature will continue to be supported for backwards compat, but will be effectively no-ops.

Clients/tools should not attempt to validate/assume what the allowed values – they should allow any string values in the array to be accepted.

@sinbai sinbai force-pushed the mongocluster/fix_docs branch from b4bfaa4 to 74f64b1 Compare January 14, 2025 10:37
@github-actions github-actions bot added size/XS and removed size/S labels Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants