Upgrading Yandex StoreDoc version

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

   yc managed-mongodb cluster list
   

2. Get the target cluster details and check its Yandex StoreDoc version in the config.version setting:

   yc managed-mongodb cluster get <cluster_name_or_ID>
   

3. Run the Yandex StoreDoc upgrade:

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

   Once 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 Yandex StoreDoc 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>
   

1. Open the current Terraform configuration file describing your infrastructure.

   For more information about creating this file, see this guide.

2. Add the version field to the Yandex StoreDoc cluster description or edit its value if it is already there:

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

3. Validate your configuration.

   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 resource changes.

   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 this Terraform provider guide.

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 place it in an 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": "<Yandex_StoreDoc_new_version>"
               }
             }'
   

   Where:

   • updateMask: Comma-separated list of settings you want to update.

     In this case, one parameter is provided.

   • configSpec.version: New Yandex StoreDoc version.

   You can get the cluster ID from the folder’s cluster list.

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and place it in an 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": "<Yandex_StoreDoc_version>"
             }
          }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mongodb.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of paths[] strings.

     In this case, one parameter is provided.

   • version: New Yandex StoreDoc version.

   You can get the cluster ID from the folder’s cluster list.

4. Check the server response to make sure your request was successful.

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

   yc managed-mongodb cluster list
   

2. Get the target cluster details and check its Yandex StoreDoc version in the config.feature_compatibility_version setting:

   yc managed-mongodb cluster get <cluster_name_or_ID>
   

3. Run the cluster update command by specifying the new compatibility version:

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

1. Open the current Terraform configuration file describing your infrastructure.

   For more information about creating this file, see this guide.

2. Add the feature_compatibility_version field to the Yandex StoreDoc cluster description or edit its value if it is already there:

   resource "yandex_mdb_mongodb_cluster" "<cluster_name>" {
     ...
     cluster_config {
       feature_compatibility_version = "<Yandex_StoreDoc_compatibility_version>"
     }
   }
   

3. Validate your configuration.

   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 resource changes.

   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 this Terraform provider guide.

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 place it in an 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.featureCompatibilityVersion",
               "configSpec": {
                 "featureCompatibilityVersion": "<Yandex_StoreDoc_compatibility_version>"
               }
             }'
   

   Where:

   • updateMask: Comma-separated list of settings you want to update.

     In this case, one parameter is provided.

   • configSpec.featureCompatibilityVersion: New Yandex StoreDoc compatibility version.

   You can get the cluster ID from the folder’s cluster list.

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and place it in an 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.feature_compatibility_version"
               ]
             },  
             "config_spec": {
               "feature_compatibility_version": "<Yandex_StoreDoc_compatibility_version>"
             }
          }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mongodb.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of paths[] strings.

     In this case, one parameter is provided.

   • feature_compatibility_version: New Yandex StoreDoc compatibility version.

   You can get the cluster ID from the folder’s cluster list.

4. Check the server response to make sure your request was successful.