Skip to main content
Version: 3.0

Create Schedule Policies

Applicable to both Classic and Federated modes

Schedule policies automate backup operations by defining when and how often backups run. Portworx Backup supports two types of schedule policies that help ensure backups are performed regularly and reliably. Object lock-enabled schedule policies provide stricter compliance and immutable backup requirements, while object lock-disabled schedule policies offer more flexibility in configuring your backup schedules. For detailed information on schedule policy types and frequency types, see the Schedule policy types and Frequency types sections in the Schedule Policies overview page.

Before you begin creating schedule policies, ensure that your cluster is not in Delete Pending or Offline state, as you cannot create a backup schedule or a schedule policy in either of those states.

Create a schedule policy​

Object lock-disabled schedule policies provide more flexibility in configuring your backup schedules.

  1. Log in to the Portworx Backup web console.

  2. From the left navigation pane, select Policies. Click Create Schedule Policy.

  3. In the Create Schedule Policy window, choose the option based on the Stork version you are using in your application cluster:

    • Stork earlier than 26.2.0
      OR
    • Stork 26.2.0 and later

    For details on features available with each Stork version, see Enhanced scheduling capabilities when using Stork version 26.2.0 or later.

  4. After selecting the Stork version, populate the following fields:

    • Name: Name of your schedule policy.
    • Frequency Type: Select the frequency type for your schedule policy. You can choose between Periodic, Daily, Weekly, and Monthly frequency types for an object lock-disabled schedule policy. These policies are not limited to Periodic and Daily like object lock-enabled schedule policies.
      • Periodic: A periodic policy runs at fixed intervals defined in minutes and hours.
      • Daily: Runs every day at a specified time. Provide the hours and minutes from midnight to define the time.
      • Weekly: Runs once a week on the specified day and time.
      • Monthly: Runs on a specified day of the month. If the specified day exceeds the number of days in the current month, the schedule rolls over to the next month.
    • Object Lock Policy: Keep this option unselected to create an unlocked schedule policy for your backup.

    Based on your selection of Frequency Type, you can configure the following settings for your schedule policy:

    • Periodic: Specify the hours or minutes for the schedule to run at the defined intervals.
    • Daily: Specify the time range, hours, and minutes from midnight for the schedule to run.
    • Weekly: Runs on the specified days and time every week. Select the Time range from the following options:

      • Days: Select the days of the week for the schedule to run. If you are running Stork 26.2.0 and later, you can select multiple days for the backup to run every week. Ensure you select the correct Stork version in step 3 to see this option.

      • Time: Specify the time for the schedule to run on the selected days. For example, a schedule policy set to weekly on Monday and Sunday at 1:00 AM runs as Every Sun and Mon @ 01:00AM.

      • Biweekly: Runs on the specified day and time every two weeks. Note: The Biweekly option is only available if you selected Stork 26.2.0 and later in step 3. For example, a schedule policy set to biweekly on Monday and Sunday at 1:00 AM runs as Every Bi-weekly Sun and Mon @ 01:00AM.

    • Monthly: Specify the day of the month or relative day for the schedule to run. Select the Time Range from the following options:
      • Specific day: Runs on the specified day of the month. If the specified day exceeds the number of days in the current month, the schedule rolls over to the next month. If you are running Stork 26.2.0 and later, you can also select specific months or all months for the schedule to run.
        • Months: Select the months for the schedule to run. This option is only available if you selected Stork 26.2.0 and later in step 3. Otherwise, the schedule runs every month by default and you cannot select specific months.
        • Day: Specify the day of the month for the schedule to run.
        • Time: Specify the time for the schedule to run on the selected day of the month. For example, a schedule policy on the 31st of January, February, and March at 1:00 AM runs as Every Jan, Feb & Mar (3rd) @ 01:00AM. This is only available on Stork 26.2.0 and later. Otherwise, the schedule runs as Every month (3rd) @ 01:00AM by default.
      • Relative Date: The schedule runs on the specified relative day of the month at the configured time. This option is only available with Stork 26.2.0 and later. Ensure you select the correct Stork version in step 3 to see this option.
        • Position: Select the position of the day in the month for the schedule to run. Options include:
          • beginning of month
          • 2nd week of month
          • 3rd week of month
          • 4th week of month
          • end of month
        • Day of week: Select the day of the week from Monday to Sunday for the schedule to run.
        • Time: Specify the time for the schedule to run on the selected relative day of the month.
    • Retain: Select the number of backups to retain concurrently. This option determines how long backups and snapshots are kept before they are deleted.
    • Incremental count: Specify the number of incremental backups to run between two full backups. This applies to both Portworx volumes and generic volumes. Incremental backups capture changes made since the last backup and typically complete faster and use less storage space than full backups.

  5. When you're done, select the Create button.

    An object lock-disabled schedule policy appears in the list without a lock icon.

Next steps​

Last updated on