Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Jobs

Jobs are operations that services run to perform some, usually transient, work. Like services, jobs are run in Docker containers on system instances. However when the job completes its work, its container exits.

Jobs are run by services; you cannot start or stop them yourself on demand, but you can schedule the times when they are allowed to run and specify which instances in the system that they are allowed to run on. For information, see Managing jobs

 

Note: Some functions described here are not used with HCP for cloud scale. They are not visible in the System Management application, or have no effect when used.

Trademarks, Legal disclaimer, Third-party software in this documentation

© 2017 - 2019 Hitachi Vantara Corporation. All rights reserved.

Managing jobs

This section describes how you can reconfigure, move, schedule, and otherwise manage the jobs that can run on your system.

 

Note: Some functions described here are not used with HCP for cloud scale. They are not visible in the System Management application, or have no effect when used.

Trademarks, Legal disclaimer, Third-party software in this documentation

© 2017 - 2019 Hitachi Vantara Corporation. All rights reserved.

Configuring where jobs run

The system lets you limit the system instances that jobs are allowed to run on. You can specify lists of allowed instances for all jobs, for jobs of a specific type, or for each individual job.

For example, if your system includes instances numbered 101 through 104, you could specify that:

Only instances 101, 102, and 103 can run jobs

Only instances 101 and 102 can run Example-type jobs

Only instance 101 can run the Example-type job named Example1

 

Note: Some functions described here are not used with HCP for cloud scale. They are not visible in the System Management application, or have no effect when used.

System Management application instructions

To specify where jobs can run:

1.Click on Jobs.

2.Select the job you want and click on Configure.

3.Specify which instances can run jobs:

a.On the Scale tab:

1.From the Available Instances list, select the instances where you want jobs to run. Then click on the Add Instances button.

2.Optionally, enable the Add newly selected instances to existing jobs option.

With this option enabled, any new instances that you selected in the previous step will automatically be added as selected instances to all existing jobs. When disabled, existing jobs of this type keep their current lists of selected instances.

3.From the Selected Instances list, select any instances where you don't want jobs to run. Then click on the Remove Instances button.

 

Note:  

If you remove instances where jobs are already running, any existing jobs remain running on those instances, but new jobs will not run on the removed instances.

You cannot remove all selected instances from the All Jobs menu. If you don't want jobs to run anywhere, you need to remove the selected instances for each job type.

b.Click on the Update button.

4.Specify which instances can run jobs of a particular type:

a.Select a job type and click on Configure.

b.On the Scale tab, from the Eligible Instances list, select the instances where you want this type of job to run. Then click on the Add Instances button.

c.Optionally, enable the Add newly selected instances to existing jobs option.

With this option enabled, any new instances that you selected in the previous step will automatically be added as selected instances to all existing jobs of this type. When disabled, existing jobs of this type keep their current lists of selected instances.

d.From the Selected Instances list, select any instances where you don't want this type of job to run. Then click on the Remove Instances button.

 

Note: If you remove instances where any jobs of this type are already running, the existing jobs remain running on those instances, but new jobs of this type will not run on the removed instances.

e.Click on the Update button.

f.Repeat this step for any other job types you want to configure.

5.Specify which instances can run a particular job:

a.On the Scale tab, select the instances you want from the Available Instances list and click on the Add Instances button. Here, the Available Instances list displays all instances where jobs of this type are allowed to run.

b.Click on the Update button.

c.Repeat this step for any other jobs you want to configure.

Related CLI command(s)

editJob

editJobSettings

editJobType

For information on running CLI commands, see CLI reference.

Related REST API method(s)

PUT /jobs/{uuid}

PUT /jobs/settings

PUT /jobs/types/{name}

For information on specific REST API methods, in the System Management application, click on the help icon (help-icon.png). Then:

To view the administrative REST API methods, click on REST API - Admin.

For general information about the administrative REST API, see REST API reference.

Trademarks, Legal disclaimer, Third-party software in this documentation

© 2017 - 2019 Hitachi Vantara Corporation. All rights reserved.

Configuring job settings

Configurable settings

You can configure these Docker container settings for all job types and individual jobs:

Container Memory — The hard memory limit for a job's Docker container, in megabytes (MB).

CPU — The relative CPU usage weight for a job's Docker container. Generally, a higher value means that the container receives more CPU resources than other processes (including other service Docker containers) running on the instance.

Valid values are decimal numbers.

Other configurable settings are determined by the jobs and job types themselves.

 

Note: Some functions described here are not used with HCP for cloud scale. They are not visible in the System Management application, or have no effect when used.

Job setting inheritance

When you configure settings for a job type, those settings are inherited by newly created jobs, not by the jobs that exist at the time you make the configuration change.

System Management application instructions

1.Click on Jobs.

2.Select a job type.

3.On the Configuration tab, configure the settings you want.

4.Click on the Update button.

Related CLI command(s)

editJob

editJobType

For information on running CLI commands, see CLI reference.

Related REST API method(s)

PUT /jobs/{uuid}

PUT /jobs/types/{name}

For information on specific REST API methods, in the System Management application, click on the help icon (help-icon.png). Then:

To view the administrative REST API methods, click on REST API - Admin.

For general information about the administrative REST API, see REST API reference.

Trademarks, Legal disclaimer, Third-party software in this documentation

© 2017 - 2019 Hitachi Vantara Corporation. All rights reserved.

Scheduling jobs

You can configure a schedule for both job types and individual jobs.

 

Note: Some functions described here are not used with HCP for cloud scale. They are not visible in the System Management application, or have no effect when used.

Job type schedules

When you configure a schedule for a job type, the schedule is inherited by newly created jobs, not by the jobs that exist at the time you make the configuration change.

Individual job schedules

If a job has a schedule, the job enters the Running state automatically when a scheduled time period begins, regardless of the job's current state. A job can also be started by a service outside of the job's scheduled time periods.

When the end of a scheduled time period arrives:

If the job is still running, the job stops and enters the Idle state.

If the job is not running (for example, it's in the Completed or Failed state), the job remains in its current state.

For information on viewing a job's status, see Monitoring individual jobs

System Management application instructions

1.Click on Jobs.

2.Select a job type or individual job.

3.On the Schedule tab, use the calendar tool to specify when the job or job type should run.

scheduleTableNew_1162x279.png

In this tool, click on a day to add a block of time. Click and drag the block to cover the hours you want the job or jobs to run.

To remove a block, right-click on it.

4.Click on the Update button.

Related CLI command(s)

editJob

editJobType

For information on running CLI commands, see CLI reference.

Related REST API method(s)

PUT /jobs/{uuid}

PUT /jobs/types/{name}

For information on specific REST API methods, in the System Management application, click on the help icon (help-icon.png). Then:

To view the administrative REST API methods, click on REST API - Admin.

For general information about the administrative REST API, see REST API reference.

Trademarks, Legal disclaimer, Third-party software in this documentation

© 2017 - 2019 Hitachi Vantara Corporation. All rights reserved.

 

  • Was this article helpful?