Skip to main content
Version: 2.11

Create Schedule Policies

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 more strict compliance and immutable backup requirements, while object unlock schedule policies offer more flexibility in configuring your backup schedules. For detailed information on schedule policy types and frequency types, see 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​

Create Object lock disabled schedule policies to have 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 on Create Schedule Policy button.

  3. In the Create Schedule Policy window, choose the options 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. Not limited to just 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 day given is longer than the current month, it will roll 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 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're running Stork 26.2.0 and later, you can select multiple days for the backup to run every week. Ensure to select the correct Stork version in the 3rd step to see this option.

      • Time: specify the time for the schedule to run on the selected days. For example, A schedule policy weekly on Monday and Sunday at 1:00 AM will run Every Sun and Mon @ 01:00AM.

      • Biweekly: runs on the specified day and time every two weeks. Note: Biweekly option is only available if you've selected Stork 26.2.0 and later in 3rd step. For example, A schedule policy biweekly on Monday and Sunday at 1:00 AM will run 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 day given is longer than the current month, it will roll over to the next month. You can also select a few months or all months for the schedule to run If you're running Stork 26.2.0 and later.
        • Months: select the months for the schedule to run. This option is only available if you've selected Stork 26.2.0 and later in 3rd step. Otherwise, the schedule will run every month by default and you cannot select specific months for the schedule to run.
        • 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 31st of Jan, Feb, and Mar at 1:00 AM will run Every Jan, Feb & Mar (3rd) @ 01:00AM. Only on Stork 26.2.0 and later where you can select specific months for the schedule to run. Otherwise, it will run Every month (3rd) @ 01:00AM by default.
      • Relative Date: The schedule will run on the specified relative day of the month and time. This options is only available with Stork 26.2.0 and later. Ensure to select the correct Stork version in the 3rd step 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 should be kept before they are deleted.
    • Incremental count: Specify the number of incremental backups between two full backups. This applies only to Portworx volumes. Incremental backups capture changes made since the last backup, as a result they are faster and use less storage space than full backups.

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

    An object lock disabled schedule policy should appear in the list without a lock icon.

Next steps​

Last updated on