MongoDB version upgrade

1. Get a list of your MongoDB clusters using this command:

   yc managed-mongodb cluster list
   

2. Get information about the cluster you need and check the MongoDB version in the config.version parameter:

   yc managed-mongodb cluster get <cluster_name_or_ID>
   

3. Run the MongoDB upgrade:

   yc managed-mongodb cluster update <cluster_name_or_ID> \
      --mongodb-version=<new_version_number>
   

   As soon as you run the upgrade, the cluster status will change to UPDATING. Wait for the operation to complete and then check the cluster version.

4. After the upgrade, all MongoDB features that are not backward-compatible with the previous version will be disabled. To remove this restriction, run this command:

   yc managed-mongodb cluster update <cluster_name_or_ID> \
      --feature-compatibility-version=<new_version_number>
   

   Learn more about backward compatibility in the MongoDB documentation.

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about creating this file, see Creating clusters.

2. To the Managed Service for MongoDB cluster description, add the version field or change its value if it is already there:

   resource "yandex_mdb_mongodb_cluster" "<cluster_name>" {
     ...
     cluster_config {
       version = "<MongoDB_version>"
     }
   }
   

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see the Terraform provider documentation.

resource "yandex_mdb_mongodb_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # An hour and a half
    update = "2h"    # Two hours
  }
}

1. Get an IAM token for API authentication and put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.Update method and send the following request, e.g., via cURL:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
      --request PATCH \
      --header "Authorization: Bearer $IAM_TOKEN" \
      --header "Content-Type: application/json" \
      --url 'https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/<cluster_ID>' \
      --data '{
               "updateMask": "configSpec.version",
               "configSpec": {
                 "version": "<new_MongoDB_version>"
               }
             }'
   

   Where:

   • updateMask: List of parameters to update as a single string, separated by commas.

     In this case, one parameter is provided.

   • configSpec.version: New MongoDB version.

   You can request the cluster ID with the list of clusters in the folder.

3. View the server response to make sure the request was successful.

4. After the upgrade, all MongoDB features that are not backward-compatible with the previous version will be disabled. To remove this restriction, send one more request and provide the new MongoDB version number in the configSpec.featureCompatibilityVersion property.

   curl \
      --request PATCH \
      --header "Authorization: Bearer $IAM_TOKEN" \
      --header "Content-Type: application/json" \
      --url 'https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/<cluster_ID>' \
      --data '{
               "updateMask": "configSpec.featureCompatibilityVersion",
               "configSpec": {
                 "featureCompatibilityVersion": "<new_MongoDB_version>"
               }
             }'
   

1. Get an IAM token for API authentication and put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

3. Use the ClusterService.Update call and send the following request, e.g., via gRPCurl:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/mongodb/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [ 
                 "config_spec.version"
               ]
             },  
             "config_spec": {
               "version": "<MongoDB_version>"
             }
          }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mongodb.v1.ClusterService.Update
   

   Where:

   • update_mask: List of parameters to update as an array of paths[] strings.

     In this case, one parameter is provided.

   • version: New MongoDB version.

   You can request the cluster ID with the list of clusters in the folder.

4. View the server response to make sure the request was successful.

5. After the upgrade, all MongoDB features that are not backward-compatible with the previous version will be disabled. To remove this restriction, send one more request and provide the new MongoDB version number in the config_spec.feature_compatibility_version property.

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/mongodb/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [ 
                 "config_spec.feature_compatibility_version"
               ]
             },  
             "config_spec": {
               "feature_compatibility_version": "<new_MongoDB_version>"
             }
          }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mongodb.v1.ClusterService.Update