Find and set maintenance windows

Memorystore for Valkey updates instances routinely to ensure that the service is reliable, performant, secure, and up-to-date. These updates are called maintenance.

Maintenance is managed fully by the service and is designed to have a zero downtime impact. However, in addition to Memorystore for Valkey performing maintenance on your instances, you can customize maintenance schedules to align with your application's needs and to minimize disruptions. To customize your maintenance schedule, you can configure maintenance windows for your instances.

This page provides instructions on how to complete the following tasks for customizing maintenance windows:

For an overview of maintenance updates and maintenance windows, see About maintenance.

Create an instance with maintenance windows

You can create a Memorystore for Valkey instance with maintenance windows by using the gcloud CLI.

gcloud

To create an instance with maintenance windows, use the gcloud memorystore instances create command:

gcloud memorystore instances create INSTANCE_ID \
--project=PROJECT_ID \
--location=REGION_ID \
--psc-auto-connections=network=projects/PROJECT_ID/global/networks/NETWORK_ID \
--shard-count=SHARD_COUNT \
--maintenance-policy-weekly-window=day=DAY,startTime=hours=HOUR

Make the following replacements:

  • INSTANCE_ID: the ID of the Memorystore for Valkey instance that you're creating. The instance ID must be 1 to 63 characters and use only lowercase letters, numbers, or hyphens. It must start with a lowercase letter and end with a lowercase letter or number.

  • PROJECT_ID: the project ID or number of the Google Cloud project where you want to create the instance.

  • REGION_ID: the region where you want the instance to be located.

  • NETWORK_ID: the ID of the network that you want to use to create the instance.

  • SHARD_COUNT: the number of shards in the instance. The shard count determines the total memory capacity for storing instance data. For more information about instance specifications, see Instance and node specification.

  • DAY: the day that you want maintenance to occur. Acceptable values are
    MONDAY - SUNDAY.

  • HOUR: the hour of the day (in UTC time) when the maintenance window starts. Acceptable values are 0 - 23.

For example:

gcloud memorystore instances create my-instance \
--project=my-project \
--location=us-central1 \
--psc-auto-connections=network=projects/my-project/global/networks/default \
--shard-count=8 \
--maintenance-policy-weekly-window=day=MONDAY,startTime=hours=9

By default, when you create an instance with maintenance windows, in-transit encryption is deactivated and the authorized network is default.

Set a preferred window for maintenance

You can set a maintenance window for a Memorystore for Valkey instance by using the gcloud CLI.

gcloud

To set a maintenance window for an instance, use the gcloud memorystore instances update command:

gcloud memorystore instances update INSTANCE_ID \
--project=PROJECT_ID \
--location=REGION_ID \
--maintenance-policy-weekly-window=day=DAY,startTime=hours=HOUR

Make the following replacements:

  • INSTANCE_ID: the ID of the instance.
  • PROJECT_ID: the project ID or number of the Google Cloud project that contains the instance.
  • REGION_ID: the region where the instance is located.
  • DAY: the day that you want maintenance to occur. Acceptable values are
    MONDAY - SUNDAY.
  • HOUR: the hour of the day (in UTC time) when the maintenance window starts. Acceptable values are 0 - 23.

Turn on maintenance notifications

You can turn on maintenance notifications for a Memorystore for Valkey instance by using the Google Cloud console.

  1. In the Google Cloud console, go to the Communication page.

    Communication

  2. Click Product Notifications.

  3. From the menu, select your Google Cloud project.

  4. In the row for Memorystore, toggle the email button to ON.

A maintenance notification email uses this title: "Upcoming maintenance for your Cloud Memorystore instance [your-instance-name]". Each email address that needs to receive notifications must opt in separately.

Maintenance notifications are set at the project level rather than on instances. Memorystore for Valkey sends notifications to the email address associated with your Google Account. You can't configure a custom email alias (for example, a team email alias).

Find scheduled maintenance

If maintenance is scheduled for an Memorystore for Valkey instance, then you can view the scheduled maintenance by using the gcloud CLI.

gcloud

To find maintenance that's scheduled for an instance, use the gcloud memorystore instances describe command.

gcloud memorystore instances describe INSTANCE_ID \
--project=PROJECT_ID \
--location=REGION_ID

Make the following replacements:

  • INSTANCE_ID: the ID of the instance
  • PROJECT_ID: the project ID or number of the Google Cloud project that contains the instance
  • REGION_ID: the region where the instance is located

The output for scheduled maintenance is, as follows:

maintenancePolicy:
  weeklyMaintenanceWindow:
  - day: DAY
      duration: 3600 seconds
  - startTime
       hour: HOUR
maintenanceSchedule:
  endTime: 'END_DATE_AND_TIME_STAMP'
  scheduleDeadlineTime: 'SCHEDULED_DATE_AND_TIME_STAMP'
  startTime: 'START_DATE_AND_TIME_STAMP'

Where:

  • maintenancePolicy shows information about the creation time of the preferred maintenance policy.
    • DAY is the day of the week that maintenance occurs.
    • HOUR is the hour (in UTC time) that maintenance begins.
  • maintenanceSchedule shows information about the scheduled maintenance for the instance.
    • END_DATE_AND_TIME_STAMP indicates when a scheduled maintenance update ends for the instance.
    • SCHEDULED_DATE_AND_TIME_STAMP indicates when a maintenance update is scheduled to be completed for the instance.
    • START_DATE_AND_TIME_STAMP indicates when a scheduled maintenance update begins for the instance.

Reschedule maintenance

You can use the gcloud CLI to reschedule maintenance for a Memorystore for Valkey instance. As a result, you can defer a maintenance update for up to two weeks from when the update is scheduled originally for the instance.

gcloud

To reschedule maintenance for an instance, use the gcloud memorystore instances reschedule-maintenance command.

gcloud memorystore instances reschedule-maintenance INSTANCE_ID \
--project=PROJECT_ID \
--location=REGION_ID \
--reschedule-type=RESCHEDULE_TYPE [--schedule-time=RESCHEDULE_TIME]

Make the following replacements:

  • INSTANCE_ID: the ID of the instance.
  • PROJECT_ID: the project ID or number of the Google Cloud project that contains the instance.
  • REGION_ID: the region where the instance is located.
  • RESCHEDULE_TYPE: the type of rescheduled update. Available values are:

    • IMMEDIATE: start the maintenance update immediately.
    • SPECIFIC_TIME: designate a specific time for the update. This time must be no more than 14 days from the time of the original maintenance window.
  • RESCHEDULE_TIME: the date and time when Memorystore for Valkey reschedules the maintenance update.

Remove a maintenance policy from an instance

If you no longer need a maintenance policy for a Memorystore for Valkey instance, and you want to use the service's default setting for maintenance instead, then you can use the gcloud CLI to remove the policy from the instance.

gcloud

To remove a maintenance policy from an instance, use the gcloud memorystore instances update command.

gcloud memorystore instances update INSTANCE_ID \
--project=PROJECT_ID \
--location=REGION_ID \
--clear-maintenance-policy-weekly-window

Make the following replacements:

  • INSTANCE_ID: the ID of the instance from which you want to remove the maintenance policy
  • PROJECT_ID: the project ID or number of the Google Cloud project that contains the instance
  • REGION_ID: the region where the instance is located

What's next

  • View the permissions required to manage maintenance windows for a Memorystore for Valkey instance.