Batch Framework

Overview

The Buckit Batch Framework allows you to create, manage, monitor, and execute jobs using a YAML-formatted job definition file (a “batch file”). The batch jobs run directly on the Buckit deployment to take advantage of the server-side processing power without constraints of the local machine where you run the Buckit Client.

A batch file defines one job task.

Once started, Buckit starts processing the job. Time to completion depends on the resources available to the deployment.

If any portion of the job fails, Buckit retries the job up to the number of times defined in the job definition.

The Buckit Batch Framework supports the following job types:

Job Type

Description

replicate

Perform a one-time replication procedure from one Buckit location to another Buckit location.

keyrotate

Perform a one-time process to cycle the sse-s3 or sse-kms cryptographic keys on objects.

expire

Perform a one-time immediate expiration of objects in a bucket.

Buckit Batch CLI

The bm batch commands include

bm batch generate

The bm batch generate command creates a basic YAML-formatted template file for the specified job type.

bm batch start

The bm batch start command launches a batch job from a job batch YAML file.

bm batch list

The bm batch list command outputs a list of the batch jobs currently in progress on a deployment.

bm batch status

The bm batch status command outputs summaries of job events on a Buckit server.

bm batch describe

The bm batch describe command outputs the job definition for a specified job ID.

bm batch cancel

The bm batch cancel stops an ongoing batch job.

Access to mc batch

Each batch job executes using the credentials specified in the batch definition. The success of a given batch job depends on those credentials having the appropriate permissions to perform all requested actions.

The user executing the batch job must have the following permissions. You can alternatively restrict users from accessing these functions by blocking or limiting access to these actions:

admin:ListBatchJobs

Grants the user the ability to see batch jobs currently in process.

admin:DescribeBatchJobs

Grants the user the ability to see the definition details of batch job currently in process.

admin:StartBatchJob

Grants the user the ability to start a batch job. The job may be further restricted by the credentials the job uses to access either the source or target deployments.

admin:CancelBatchJob

Allows the user to stop a batch job currently in progress.

You can assign any of these actions to users independently or in any combination.

The built-in ConsoleAdmin policy includes sufficient access to perform all of these types of batch job actions.

Local Deployment

You run a batch job against a particular deployment by passing an alias to the bm batch command. The deployment you specify in the command becomes the local deployment within the context of that batch job.