CLOUDP-164347: Add --flag file to the atlas cluster index create command

[andreaangiolillo]

Proposed changes

Jira ticket: CLOUDP-164347

Checklist

• I have signed the MongoDB CLA
• I have added tests that prove my fix is effective or that my feature works
• I have added any necessary documentation in document requirements section listed in CONTRIBUTING.md (if appropriate)
• I have addressed the @mongodb/docs-cloud-team comments (if appropriate)
• I have updated test/README.md (if an e2e test has been added)
• I have run make fmt and formatted my code

Further comments

./bin/atlas cluster index create --help                                                                                                                          1.22.1  16.18.0
To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role.

Usage:
  atlas clusters indexes create [indexName] [flags]

Examples:
  # Create an index named bedrooms_1 on the listings collection of the realestate database:
  atlas clusters indexes create bedrooms_1 --clusterName Cluster0 --collection listings --db realestate --key bedrooms:1

  # Create a compound index named property_room_bedrooms on the
  listings collection of the realestate database:
  atlas clusters indexes create property_room_bedrooms --clusterName Cluster0 --collection listings --db realestate --key property_type:1 --key room_type:1 --key bedrooms:1

  # Create an index named my_index from a JSON configuration file named myfile.json:
  atlas clusters indexes create my_index --file file.json

Flags:
      --clusterName string   Name of the cluster.
      --collection string    Name of the collection.
      --db string            Name of the database.
  -f, --file string          Path to an optional JSON configuration file that defines index settings.
  -h, --help                 help for create
      --key strings          Field to be indexed and the type of index in the following format: field:type.
      --projectId string     Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
      --sparse               Flag that creates a sparse index. To learn more, see https://dochub.mongodb.org/core/index-sparse-manual.

Global Flags:
  -P, --profile string   Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

./bin/atlas cluster index create testIndex1 --collection listingsAndReviews --db sample_airbnb --clusterName ClusterM10test --key notes:1                     
Your index is being created

cat ~/Downloads/atlas_cluster_index_create_test.json                                                                                                         
{
  "collation": {
    "alternate": "non-ignorable",
    "backwards": false,
    "caseFirst": "lower",
    "caseLevel": false,
    "locale": "af",
    "maxVariable": "punct",
    "normalization": false,
    "numericOrdering": false,
    "strength": 3
  },
  "collection": "accounts",
  "db": "sample_airbnb",
  "keys": [
    {
      "property_type": "1",
      "room_type": "1"
    }
  ],
  "options": {
    "name": "PartialIndexTest",
    "partialFilterExpression":{
    	"limit": {"$gt": 900}
    }
  }

./bin/atlas cluster index create --file ~/Downloads/atlas_cluster_index_create_test.json --clusterName ClusterM10test                                       
Your index is being created

[fmenezes]

do you intend to have documentation for the file structure? if so make sure to ask for a dochub link and add it here

[andreaangiolillo]

I think we need the doc team to create the doc page and then we can update the description here. Let me know if I am missing something

[fmenezes]

you can have the link ahead of time if you ask them and once the page is up they redirect it. we've done this way before

[fmenezes]

You can alternatively open a docsp ticket and ask them to update this line, make sure to add a link to where they should add the link if that is the approach you prefer.

[andreaangiolillo]

Unfortunately, we cannot use the example in the open api spec (it does not work) and I haven't found any examples in the doc. The doc team will need to use the files in the data folders included in this PR 😭

[jwilliams-mongo]

@sarahsimpers FYI as I think you've done some work here recently on the config files for the CLI.

[gssbzn]

LGTM

[jwilliams-mongo]

@andreaangiolillo copy lgtm but I'd like Sarah to chime in on the config file issue

[andreaangiolillo]

I created https://jira.mongodb.org/browse/DOCSP-37703 and included a description of what we will need on the doc side