CLOUDP-336891: Add warnings about rolling index (#4367)

Author: blva

docs/command/atlas-api-rollingIndex-createRollingIndex.txt

@@ -19,6 +19,9 @@ Admin API capabilities have their own release lifecycle, which you can check via
 
 Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role.
 
+
+Warning: Building an index in a rolling fashion reduces the resiliency of your cluster and increases index build times. We only recommend using rolling index builds when regular index builds do not meet your needs.
+
 This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusterindexrollingindex.
 
 For more information and examples, see the referenced API documentation linked above.

docs/command/atlas-clusters-indexes-create.txt

@@ -14,6 +14,8 @@ atlas clusters indexes create
 
 Create a rolling index for the specified cluster for your project.
 
+Warning: Building an index in a rolling fashion reduces the resiliency of your cluster and increases index build times. We only recommend using rolling index builds when regular index builds do not meet your needs.
+
 To use this command, you must authenticate with a user account, a service account, or an API key with the Project Data Access Admin role.
 
 Syntax

internal/api/commands.go

@@ -150,8 +150,10 @@ func CreateBuilder() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "create [indexName]",
 		Short: "Create a rolling index for the specified cluster for your project.",
-		Long:  fmt.Sprintf(usage.RequiredRole, "Project Data Access Admin"),
-		Args:  require.MaximumNArgs(1),
+		Long: `Warning: Building an index in a rolling fashion reduces the resiliency of your cluster and increases index build times. We only recommend using rolling index builds when regular index builds do not meet your needs.
+
+` + fmt.Sprintf(usage.RequiredRole, "Project Data Access Admin"),
+		Args: require.MaximumNArgs(1),
 		Annotations: map[string]string{
 			"indexNameDesc": "Name of the index.",
 		},

internal/cli/clusters/indexes/create.go

@@ -0,0 +1,14 @@
+overlay: 1.0.0
+info:
+  title: Add warning message to rolling index builds
+  version: 1.0.0
+actions:
+  - target: $.paths['/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index'].post
+    update:
+      x-xgen-atlascli:
+        override:
+          description: |
+            Creates an index on the cluster identified by its name in a rolling manner. Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role.
+
+            Warning: Building an index in a rolling fashion reduces the resiliency of your cluster and increases index build times. We only recommend using rolling index builds when regular index builds do not meet your needs.
+

tools/internal/specs/overlays/rolling-index-warning.yaml

@@ -45980,6 +45980,12 @@ paths:
                 customMethod: false
                 verb: createRollingIndex
             x-xgen-operation-id-override: createRollingIndex
+            x-xgen-atlascli:
+                override:
+                    description: |
+                        Creates an index on the cluster identified by its name in a rolling manner. Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role.
+
+                        Warning: Building an index in a rolling fashion reduces the resiliency of your cluster and increases index build times. We only recommend using rolling index builds when regular index builds do not meet your needs.
     /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives:
         get:
             description: Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.