Tools → CMC Scheduler
About the CMC Scheduler
For a given cluster, the CMC Scheduler allows an administrator to create and manage jobs for:
- Tenant backups
- The Inspector Tool
Tenant backup
A tenant backup is a .zip
file that includes a tenant export .zip
file and a properties file for the tenant configuration.
The naming convention for the tenant backup is:
MM-DD-YYYY_hh-mm-ss_<TENANT_NAME>.zip
The default location for tenant backup is:
~/IncortaAnalytics/cmc/tenantsBackups/<CLUSTER_GUID>/<TENANT_NAME>/
The backup count determines the number of stored backups in a first-in, first-out (FIFO) rotation. For example, if the schedule expression generates a backup every hour and the backup count is set for 5, only the most recent 5 hours of backups are available. When the next tenant backup job runs, the CMC Scheduler deletes the oldest backup file.
Create a tenant backup job
A newly created tenant backup job is by default an Active job. Here are the steps to create a tenant backup job:
- In the Navigation bar, select Scheduler.
- In the Tenants backup tab, in Cluster Name, select a cluster.
- In the List view, in the Action Menu, select +.
- In the Add a new job dialog, specify the following:
- Name
- Tenant
- Backups count
- Specify the schedule expression as follows:
- Every in terms of numeric frequency, time intervals, and recurrence
- Starting at in terms of a set time and GMT
- From in terms of a Start Date, optional End Date, and Does Not End selection
- Select Add job.
Edit a tenant backup job
Here are the steps to edit a tenant backup job:
- In the Navigation bar, select Scheduler.
- In the Tenants backup tab, in Cluster Name, select a cluster.
- In the List view, for a given tenant backup job, in the Job Name column, select the job name.
- In the Add a new job dialog, specify the following:
- Name
- Tenant
- Backups count
- Specify the schedule expression as follows:
- Every in terms of numeric frequency, time intervals, and recurrence
- Starting at in terms of a set time and GMT
- From in terms of a Start Date, optional End Date, and Does Not End selection
- Select Update job.
Suspend an active tenant backup job
Here are the steps to suspend an active tenant backup job:
- In the Navigation bar, select Scheduler.
- In the Tenants backup tab, in Cluster Name, select a cluster.
- In the List view, for a given tenant backup job, in the Status column, select Active.
- In the Confirm Changing Status dialog, select OK.
Activate a suspended tenant backup job
Here are the steps to activate a suspended tenant backup job:
- In the Navigation bar, select Scheduler.
- In the Tenants backup tab, in Cluster Name, select a cluster.
- In the List view, for a given tenant backup job, in the Status column, select Suspended.
- In the Confirm Changing Status dialog, select OK.
Delete a tenant backup job
You can delete both active and suspended tenant backup jobs. Deleting a tenant backup job does not remove the tenant backup files. Here are the steps to delete a tenant backup job:
- In the Navigation bar, select Scheduler.
- In the Tenants backup tab, in Cluster Name, select a cluster.
- In the List view, for a given tenant backup job, first select the row, then select the Trash icon on the right side of the row.
- In the dialog, select Delete.
Inspector
In this release, you can schedule a job for the Inspector Tool.
About an Inspector Job
For the selected tenant in the cluster, an Inspector job performs the following:
- Creates a tenant export
- Creates the related
.csv
files in the data directory - Writes the
inspector.log
file
The Inspector job does not load the InspectorMetadata schema. The Inspector job is a CMC Scheduler job. You must manually load the InspectorMetadata schema or create a scheduled job in the Analytics Service to load the InspectorMetadata schema.
For an Inspector job, the default location for the tenant backup is:
~/IncortaAnalytics/cmc/InspectorTenantExports/<TENANT_NAME>/
A recurring Inspector job overwrites this tenant export. The naming convention for the tenant backup is <TENANT_NAME>.zip
.
You can find the related .csv
files in the inspector folder in the data directory for the tenant. The default path is:
~/IncortaAnalytics/Tenants/<TENANT_NAME>/data/inspector/
The default path of the inspector.log
file is:
/IncortaAnalytics/cmc/inspector/logs/inspector.log
Create an Inspector job
A newly created Inspector job is by default an Active job. Here are the steps to create Inspector job:
- In the Navigation bar, select Scheduler.
- In the Inspector tab, in Cluster Name, select a cluster.
- In the List view, in the Action Menu, select +.
- In the Add a new job dialog, specify the following:
- Name
- Tenant
- Specify the schedule expression as follows:
- Every in terms of numeric frequency, time intervals, and recurrence
- Starting at in terms of a set time and GMT
- From in terms of a Start Date, optional End Date, and Does Not End selection
- Select Add job.
Edit an Inspector job
Here are the steps to edit an Inspector job:
- In the Navigation bar, select Scheduler.
- In the Inspector tab, in Cluster Name, select a cluster.
- In the List view, for a given Inspector job, in the Job Name column, select the job name.
- In the Add a new job dialog, specify the following:
- Name
- Tenant
- Specify the schedule expression as follows:
- Every in terms of numeric frequency, time intervals, and recurrence
- Starting at in terms of a set time and GMT
- From in terms of a Start Date, optional End Date, and Does Not End selection
- Select Update job.
Suspend an Inspector job
Here are the steps to suspend an Inspector job:
- In the Navigation bar, select Scheduler.
- In the Inspector tab, in Cluster Name, select a cluster.
- In the List view, for a given Inspector job, in the Status column, select Active.
- In the Confirm Changing Status dialog, select OK.
Activate an Inspector job
Here are the steps to activate a suspended Inspector job:
- In the Navigation bar, select Scheduler.
- In the Inspector tab, in Cluster Name, select a cluster.
- In the List view, for a given Inspector job, in the Status column, select Suspended.
- In the Confirm Changing Status dialog, select OK.
Delete an Inspector job
You can delete both active and suspended Inspector jobs. Here are the steps to delete a Inspector job:
- In the Navigation bar, select Scheduler.
- In the Inspector tab, in Cluster Name, select a cluster.
- In the List view, for a given Inspector job, first select the row, then select the Trash icon on the right side of the row.
- In the dialog, select Delete.
Tenants: Backup now, Restore and Overwrite, and Execute Inspector now
In this release, for a given tenant, you can now directly:
- Create a tenant backup
- Restore and overwrite an existing tenant from a tenant backup
- Execute an Inspector job
The above options are now available in the More Options menu for a tenant. Here are the steps to open the More Options menu in the CMC:
- In the Navigation bar, select Clusters.
- In the cluster list, select a cluster name.
- In the canvas tabs, select Tenants.
- In the list view, for a tenant row, select the ⋮ vertical ellipsis icon.
More Options → Backup now
Select Backup now to create an immediate tenant backup. A tenant backup is a .zip
file that includes a tenant export .zip
file and a properties file for the tenant configuration.
The naming convention for the tenant backup is:
MM-DD-YYYY_hh-mm-ss_<TENANT_NAME>.zip
The default location for tenant backup is:
~/IncortaAnalytics/cmc/tenantsBackups/<CLUSTER_GUID>/<TENANT_NAME>/immediateExecution/
More Options → Restore and Overwrite
Select Restore and Overwrite to choose an existing backup. You can create a backup of the existing tenant before restoring and overwriting the tenant.
More Options → Execute Inspector now
Select Execute Inspector now to immediately execute an Inspector job. To learn more about an Inspector job, please review About an Inspector Job.