Find and set maintenance windows

Memorystore for Valkey updates instances routinely by performing maintenance on them to ensure that the service is reliable, performant, secure, up-to-date, and has a zero downtime impact. 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 schedules, 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 either the Google Cloud console or the gcloud CLI.

Console

To create an instance with maintenance windows, see Create instances.

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 either the Google Cloud console or the gcloud CLI.

Console

  1. In the Google Cloud console, go to the Memorystore for Valkey page.

    Memorystore for Valkey

  2. Click the instance for which you want to set a preferred window.

  3. On the Instance at a glance page, scroll until the Maintenance card appears.

  4. Next to the Maintenance window field, click Edit ().

    If a day and time appear next to the field, then you already set the maintenance window for the instance.

  5. In the Edit maintenance window dialog, do the following:

    1. Select Custom.
    2. From the Day menu, select the day that you want maintenance to occur.
    3. From the Time menu, select the hour when you want the maintenance window to start.
    4. Click Update instance.

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

If you schedule maintenance for a Memorystore for Valkey instance, then you can use the Google Cloud console to turn on maintenance notifications for the instance.

  1. In the Google Cloud console, go to the Memorystore for Valkey page.

    Memorystore for Valkey

  2. Click the instance for which you want to turn on maintenance notifications.

  3. On the Instance at a glance page, scroll until the Maintenance card appears.

  4. Click Edit notification preferences.

    If this link is deactivated, then you haven't scheduled maintenance for the instance.

  5. Click Product Notifications.

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

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

You set maintenance notifications 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 the scheduled maintenance

If you schedule maintenance for a Memorystore for Valkey instance, then you can view the maintenance by using either the Google Cloud console or the gcloud CLI.

Console

  1. In the Google Cloud console, go to the Memorystore for Valkey page.

    Memorystore for Valkey

  2. Click the instance for which you want to find the scheduled maintenance.

  3. On the Instance at a glance page, scroll until the Maintenance card appears.

    Next to the Maintenance window field, the day and time of the scheduled maintenance appear.

gcloud

To find the scheduled maintenance 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 displays information about the creation time of the preferred maintenance policy.
  • weeklyMaintenanceWindow displays information about the weekly maintenance window for the instance.
    • DAY is the day of the week when maintenance occurs.
    • HOUR is the hour (in UTC time) when maintenance begins.
  • maintenanceSchedule displays 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 either the Google Cloud console or 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.

Console

  1. In the Google Cloud console, go to the Memorystore for Valkey page.

    Memorystore for Valkey

  2. Click the instance for which you want to reschedule maintenance.

  3. On the Instance at a glance page, scroll until the Maintenance card appears.

  4. Next to the Upcoming maintenance field, click Edit ().

    If the No maintenance scheduled right now status appears next to this field, then maintenance isn't scheduled for the instance.

  5. In the Reschedule upcoming maintenance dialog, do the following:

    1. From the Choose a new time menu, select Specific time.
    2. From the Date field, click Calendar (), and then select the date that you want maintenance to occur.
    3. From the Time menu, designate a specific time for the update. This time must be no more than 14 days from the time of the original maintenance window.
    4. Click Reschedule.

    You can also use the Reschedule upcoming maintenance dialog to have Memorystore for Valkey perform maintenance on the instance immediately. From this dialog, select Update now from the Choose a new time menu, and then click Update now.

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 either the Google Cloud console or the gcloud CLI to remove the policy from the instance.

Console

  1. In the Google Cloud console, go to the Memorystore for Valkey page.

    Memorystore for Valkey

  2. Click the instance for which you want to remove a maintenance policy.

  3. On the Instance at a glance page, scroll until the Maintenance card appears.

  4. Next to the Maintenance window field, click Edit ().

    If a day and time don't appear next to the field, then you already removed the maintenance policy from the instance.

  5. In the Edit maintenance window dialog, do the following:

    1. Select Default.
    2. Click Update 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 that you need to manage maintenance windows for a Memorystore for Valkey instance.