Scheduling Operations

CCKM allows you to periodically refresh or rotate keys in the background. To refresh or rotate keys, you need to create schedule configuration. A schedule configuration defines when to run a refresh or rotation job. You can use either basic format or cron format to specify the time when the rotation or refresh job will run.

Specify basic format in the following order:

[Repeats, at]

Where,

• Repeats: frequency of the scheduler. Possible values are daily, weekly, monthly, and yearly.

• at: specific time at which the rotation or refresh operation will be performed. Possible value lies between 12:00-11:00 AM/PM UTC.

Specify cron format in the following order:

"* * * * *"

These five values indicate when the job should be executed. These values are mandatory and must be specified in order of minute, hour, day of month, month, and day of week.

The following table lists the accepted values:

Adding Key Rotation Schedule

A key rotation schedule replaces selected keys with new cryptographic keys at the specified time.

To add key rotation schedule:

1. Open the Cloud Key Manager application.

2. In the left pane, click Schedules. The list of available schedules is displayed.

3. Click Add Schedule. The Add New Schedule wizard is displayed.

4. Select Schedule Type as Key Rotation.

5. Click Next.

6. On the General Info screen, enter or select following details:

   • Enter a unique Scheduler Name.

   • From the Cloud Name drop-down list, select AWS.

   • Add Description for the scheduler in a maximum of 250 characters.

   • Select Enable Schedule to enable the schedule.

   • Click Next.

7. Set the values on the Schedule Config screen.

   You can schedule configuration for:

   • All Keys: Refer to Configuring Rotation Schedule for All Keys for details.

   • Only Expiring Keys: Refer to Configuring Rotation Schedule for Expiring Keys for details.

   • All Keys Based on Creation/Last Rotation Date: Refer to Configuring Roation Schedule for All Keys Based on Creation or Last Rotation Date for details.

Configuring Rotation Schedule for All Keys

To configure rotation schedule for all keys:

1. Configure DURATION for the scheduler. Specify the following values:

   1. Schedule Starts

   2. Schedule Ends

   If you select the Never check box, the scheduler configuration will never expire, and the Schedule Ends field becomes unavailable.

2. Configure FREQUENCY of the scheduler. The frequency determines how often the scheduler will rotate keys. Select either the Basic or the Raw (Cron) format to specify the value.

3. (Optional) Set the expiry of the new key that will be created through rotation. If not specified, the new key material never expires. For example, if you set the expiry time to 6 Hours, the key material of the new key will expire in 6 hours.

4. Select Apply Gravestone Alias on Current Key to retain the key alias with timestamp on the archived key after rotation. The format of the Gravestone alias is <current alias>-rotated-<timestamp>. The alias will only be applied to keys with an existing alias.

5. Click Save.

A message Schedule successfully created is displayed on the screen.

Configuring Rotation Schedule for Expiring Keys

To configure rotation schedule for expiring keys:

1. In the SELECTION section, select the keys to be rotated based on their expiry time. In the Only rotate keys within _ of material expiration field, select or enter the key expiry time. For example, if the value of Only rotate keys within _ of material expiration field is set to 4 Days, then the rotation schedule is created for all the keys that will expire in 4 days.

2. Configure DURATION for scheduler. Specify the following values:

   1. Schedule Starts

   2. Schedule Ends

   If you select the Never check box, the scheduler configuration will never expire, and the Schedule Ends field becomes unavailable.

3. (Optional) Set the expiry of the new key that will be created through rotation. If not specified, the new key material never expires. For example, if you set the expiry time to 6 Hours, the key material of the new key will expire in 6 hours.

4. Select Apply Gravestone Alias on Current Key to retain the key alias with timestamp on the archived key after rotation. The format of the Gravestone alias is <current alias>-rotated-<timestamp>. The alias will only be applied to keys with an existing alias.

5. Click Save.

A message Schedule successfully created is displayed on the screen.

Configuring Roation Schedule for All Keys Based on Creation or Last Rotation Date

To configure rotation schedule for all keys based on their creation or last rotation date:

1. In the SELECTION section, select the keys to be rotated based on their creation or last rotation date.

   In the Only rotate keys after _ of creation/last rotation date field, select or enter the number of days, weeks, months, or years. For example, if the value of Only rotate keys after _ of creation/last rotation date field is set to 4 Days, then all the keys will rotate after 4 days of their creation or last rotation date. The default duration is 7 Days.

2. Configure DURATION for scheduler. Specify the following values:

   1. Schedule Starts

   2. Schedule Ends

   If you select the Never check box, the scheduler configuration will never expire, and the Schedule Ends field becomes unavailable.

3. (Optional) Set the expiry of the new key that will be created through rotation. If not specified, the new key material never expires. For example, if you set the expiry time to 6 Hours, the key material of the new key will expire in 6 hours.

4. Select Apply Gravestone Alias on Current Key to retain the key alias with timestamp on the archived key after rotation. The format of the Gravestone alias is <current alias>-rotated-<timestamp>. The alias will only be applied to keys with an existing alias.

5. Click Save.

A message Schedule successfully created is displayed on the screen.

Adding Key Refresh Schedule

To add a key refresh schedule:

1. Open the Cloud Key Manager application.

2. In the left pane, click Schedules. The list of available schedules is displayed.

3. Click Add Schedule. The Add New Schedule wizard is displayed.

4. Select Schedule Type as Key Refresh.

5. Click Next.

6. On the General Info screen, enter or select following details:

   • Enter a unique Scheduler Name.

   • Select AWS from the Cloud Name drop-down list.

   • Add Description for the scheduler in a maximum of 250 characters.

   • Select Enable Schedule to enable the schedule.

   • Click Next.

7. On the Schedule Config screen, enter or select the following details.

   1. Configure Duration for the scheduler. Specify the following values:

      • Schedule Starts

      • Schedule Ends

      If you select the Never check box, the scheduler configuration will never expire, and the Schedule Ends field becomes unavailable.

   2. Configure Frequency of the scheduler. The frequency determines how often the scheduler will rotate keys. Select either Basic or Raw (Cron) format to specify the value.

   3. Click Next.

8. On the Add Accounts screen:

   1. Select the account name from the Refresh Keys from Selected Account(s) drop-down list.

   2. Click + button.

   3. Similarly, you can add more accounts.

   4. Select the Refresh All Accounts option if you want to refresh all the existing accounts.

   5. Click Save.

A message Schedule successfully created is displayed on the screen.

Viewing/Editing Schedules

To view/edit a schedule:

1. Open the Cloud Key Manager application.

2. In the left pane, click Schedules. The Schedules page displays following details:

   Field	Description
   Name	Unique name of the scheduler configuration.
   Schedule Type	Type of the schedule. Possible types are: • Key Rotation • Key Refresh
   Cloud Name	Name of the cloud.
   Last Modified	Time when the schedule is modified.
   Frequency	Frequency of the scheduler configuration.
   Start Date	Creation time of the scheduler configuration.
   End Date	Expiry time of the scheduler configuration.
   Status	Status of the scheduler configuration. Possible values are: • Enabled • Disabled

3. Click the overflow icon () corresponding to the desired schedule and click View/Edit.

4. Edit or configure the following fields and click Update:

   • Description.

   • Status of the scheduler configuration.

   • Scheduler configuration parameters such as duration and frequency. Refer to Schedule Config for details on key rotation schedule fields.

The Schedules page also contains a section named JOB HISTORY that contains all the related information about a schedule such as Run Date, Job ID, Status, and Errors.

Disabling Schedules

To disable a schedule configuration:

1. Open the Cloud Key Manager application.

2. In the left pane, click Schedules. The list of available schedules is displayed.

3. Click the overflow icon () corresponding to the desired schedule and click Disable. The Disable Schedule message is displayed.

4. Click Disable Schedule.

A message Successfully disabled the schedule is displayed on the screen.

Enabling Schedules

To enable a schedule configuration:

1. Open the Cloud Key Manager application.

2. In the left pane, click Schedules. The list of available schedules is displayed.

3. Click the overflow icon () corresponding to the desired schedule and click Enable. The Enable Schedule message is displayed.

4. Click Enable Schedule.

A message Successfully enabled the schedule is displayed on the screen.

Manually Running Schedules

To manually run a schedule:

1. Open the Cloud Key Manager application.

2. In the left pane, click Schedules. The list of available schedules is displayed.

3. Click the overflow icon () corresponding to the desired schedule and click Run Now.

The Run Now schedule is started in the background. A message Schedule is running now. It will take a few seconds to finish. is displayed on the screen. After the schedule is run successfully, a message Successfully finished running the schedule is displayed.

Deleting Schedules

1. Open the Cloud Key Manager application.

2. In the left pane, click Schedules. The list of available schedules is displayed.

3. Click the overflow icon () corresponding to the desired schedule and click Delete Schedule. The Delete Schedule message is displayed.

4. Click Delete Schedule.

A message Successfully deleted schedule is displayed on the screen.