Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

Thales Logo

All

  • All
back

Google Cloud Resources

Scheduling Operations

search

Please Note:

Scheduling Operations

CCKM allows you to periodically refresh keys, rotate keys, or add KMS containers in the background. To refresh keys, rotate keys, or add KMS containers, you need to create schedule configuration. A schedule configuration defines when to run a refresh, rotation, or KMS container job. You can use either the basic or cron format to specify when the rotation, refresh, or KMS container 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:

FieldAllowed valuesAllowed special characters
Minute0-59* / , -
Hour0-23* / , -
Day of month1-31* / , - ?
Month1-12 or JAN-DEC* / , -
Day of week0-6 or SUN-SAT* / , - ?

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.

    • Select Google 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 schedule start and end time:

      • Schedule Starts: Specify time when the schedule starts.

      • Schedule Ends: Unavailable by default, that is, the scheduler never expires.

      • Never: Selected by default, that is, the scheduler configuration never expires.

      To set an end time for the scheduler, clear the Never check box, and specify the Scheduler Ends time.

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

A message Schedule successfully created is displayed on the screen. The newly created schedule is displayed in the schedules list.

Adding Key Refresh Schedule

A key refresh schedule synchronizes keys from linked Google Cloud accounts to Cloud Key Manager.

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 Google 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 schedule start and end time:

      • Schedule Starts: Specify time when the schedule starts.

      • Schedule Ends: Unavailable by default, that is, the scheduler never expires.

      • Never: Selected by default, that is, the scheduler configuration never expires.

      To set an end time for the scheduler, clear the Never check box, and specify the Scheduler Ends time.

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

    3. Click Next.

  8. On the Add Key Rings screen:

    1. Select the desired key ring from the Refresh Keys from Selected Key Ring(s) drop-down list.

    2. Click + button. Similarly, you can add more key rings. To remove an added key ring, click the close (X) icon in the name of the added key ring.

      Alternatively, if you want to refresh all the existing key rings, select the Refresh All Key Rings check box. When selected, the Refresh Keys from Selected Key Ring(s) field becomes unavailable.

    3. Click Save.

A message Schedule successfully created is displayed on the screen. The newly created scheduled is displayed in the schedules list.

Automatic Cloud Key Discovery

A KMS container schedule automatically detects the KMS containers based on the Google Cloud connection and adds them to the CipherTrust Cloud Key Manager.

Adding a KMS container (key ring or project) to CCKM consumes one CCKM license count.

To add a KMS container 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 Select Schedule Type screen of the Add New Schedule wizard is displayed.

Schedule Type

  1. Select Schedule Type as Add KMS Container.

  2. Click Next. The General Info screen is displayed.

General Info

  1. Enter a unique Scheduler Name.

  2. Select Google from the Cloud Name drop-down list.

  3. (Optional) Add Description for the scheduler in a maximum of 250 characters.

  4. (Optional) Select Enable Schedule to enable the schedule.

  5. Select a Define Job Type. You can select either Discover Only or Discover and Add.

    Note

    Discover Only lists all the discovered containers. Discover and Add adds all the discovered containers to the CCKM.

  6. Click Next. The Connection & ACL Info screen is displayed.

Connection & ACL Info

  1. Select a Connection.

  2. (Optional) Enable or disable Success Audit Event.

  3. In the ACCESS CONTROL section.

    1. Click Assign User/Group. The Assign User/Group dialog box is displayed.

    2. Select the desired user or group from the User/Group drop-down list.

    3. Click Save. The newly added user/group is displayed under Name in the ACCESS CONTROL section.

    4. Grant the permissions to the user/group, as appropriate.

      Granting additional permisions

      To grant the additional permissions, select the check box under the desired operation corresponding to the desired users or groups. The following permissions can be granted.

      • View Keys, Add Key, Edit / Disable/ Enable, Synchronize, Upload

      • Schedule Destroy, Cancel Destroy

      To remove a permission, clear the check box under the desired operation.

    5. Remove a user or group.

      1. Under Unassign, click X corresponding to the desired user/group. The Remove Group dialog box is displayed.

      2. Click Remove.

  4. Click Next. The Schedule Config screen is displayed.

Schedule Config

  1. Configure DURATION for the scheduler. Specify the schedule start and end time:

    • Schedule Starts: Specify time when the schedule starts.

    • Schedule Ends: Unavailable by default, that is, the scheduler never expires.

    • Never: Selected by default, that is, the scheduler configuration never expires.

    To set an end time for the scheduler, clear the Never check box, and specify the Scheduler Ends time.

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

A message Schedule successfully created is displayed on the screen. The newly created schedule is displayed in the schedules list.

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:

    FieldDescription
    NameUnique name of the scheduler configuration.
    Schedule TypeType of the schedule. Possible types are:
    • Key Rotation
    • Key Refresh
    • Add KMS Container (GCP and Azure only)
    Cloud NameName of the cloud.
    Last ModifiedTime when the schedule is modified.
    FrequencyFrequency of the scheduler configuration.
    Start DateCreation time of the scheduler configuration.
    End DateExpiry time of the scheduler configuration. Never is displayed if the schedule is set to never expire.
    StatusStatus of the scheduler configuration. Possible values are:
    • Enabled
    • Disabled

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

    Alternatively, click the Name link corresponding to the desired schedule.

  4. Edit or configure the following fields:

    • Optional, basic description of the schedule.

    • Status of the scheduler configuration. Select Enable Schedule to enable the schedule, clear to disable.

    • (For KMS Container schedule) Define Job Type.

    • CONNECTION & ACL INFO details, refer to the add KMS container Connection & ACL Info section.

    • Scheduler configuration parameters such as duration, frequency, and expiry time of the key. Refer to the key rotation Schedule Config screen, key refresh Schedule Config screen, or KMS container Schedule Config screen for details, as appropriate.

  5. Click Update to save the changes.

JOB HISTORY

The Schedules page also contains a section named JOB HISTORY. The JOB HISTORY section displays information related to a job such as Run Date, Job ID, Status, and Errors. Every time a schedule is run, a Job is created.

  • For the KMS Container schedule, this section allows you to download the CSV report containing the list of Key Rings or Projects.

    To download the report, click the overflow icon (ellipsis) corresponding to the desired schedule and click Download Key Rings Only or Download Projects Only.

  • To view the details of the job, click the Job ID link corresponding to the desired job. The Job details page is displayed. It shows the list of Key Rings and Projects associated with the job along with their details.

    To download the reports of Key Rings and Projects, go to the top left of the Job details page, click Download, and select a report from the drop-down menu. The options are Key Rings Only, Projects Only, and Key Rings and Projects.

Note

You can download the report after the schedule has run successfully.

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 (ellipsis) 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 (ellipsis) 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 (ellipsis) 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 (ellipsis) corresponding to the desired schedule and click Delete Schedule. The Delete Schedule message is displayed.

  4. Click Delete.

A message Successfully deleted schedule is displayed on the screen.

On this page