Documentation

Documentation

mc batch generate

Changed in version MinIO: RELEASE.2022-10-08T20-11-00Z or later

Syntax

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

After MinIO creates the file, open it in your preferred text editor tool to further customize.

  • You can add multiple job task definitions to a batch file.

  • MinIO imposes no limit to the number of job task definitions per batch file.

See job types for the supported jobs you can generate.

The following command creates a basic YAML file for a replicate job on the mybucket bucket of the myminio alias.

mc batch generate myminio/mybucket replicate

The command has the following syntax:

mc [GLOBALFLAGS] batch generate \
                       TARGET   \
                       JOBTYPE
  • Brackets [] indicate optional parameters.

  • Parameters sharing a line are mutually dependent.

  • Parameters seperated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

Parameters

TARGET
Required

The alias and bucket on the MinIO deployment to which to add the object lifecycle management rule.

For example:

mc batch generate myminio/mydata replicate

You can use just an alias without specifying a bucket to perform the job at the deployment’s root.

JOBTYPE
Required

The type of job to generate a YAML document for.

Currently, mc batch only supports the replicate job type.

Global Flags

This command supports any of the global flags.

Examples

Generate a yaml File for a Replicate Job Type

The following command generates a YAML blueprint for a replicate type batch job and names the file replicate with the .yaml extension:

mc batch generate alias/<bucket> replicate
  • Replace alias with the alias and (optionally) bucket of the MinIO deployment that is the source of the replication job.

  • Replace <bucket> with the bucket on the alias where the batch should run. The bucket can be left blank to perform the action on the alias deployment’s root location.

  • Replace replicate with the type of job to generate a yaml file for.

    At the time of release, :mc:mc batch only supports the replicate job type.

S3 Compatibility

The mc commandline tool is built for compatibility with the AWS S3 API and is tested MinIO and AWS S3 for expected functionality and behavior.

MinIO provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported. While mc commands may work as documented, any such usage is at your own risk.

Job Types

mc batch currently supports the following job task types:

  • replicate

    Replicate objects between two MinIO deployments. Provides similar functionality to bucket replication as a batch job rather than continual scanning function.

MinIO may add more job types in the future.

replicate

Use the replicate job type to create a batch job that performs replicates objects between two MinIO deployments.

The YAML must define the source and target deployments. Optionally, the YAML can also define flags to filter which objects replicate, send notifications for the job, or define retry attempts for the job.

For the source deployment

  • Required information

    type:

    Must be s3.

    bucket:

    The bucket on the deployment.

  • Optional information

    prefix:

    The prefix on the object(s) that should replicate.

    endpoint:

    Location of the source deployment.
    If the location is not remote, use local.

    credentials:

    The accesskey: and secretKey: or the sessionToken: that grants access to the object(s).

For the target deployment

  • Required information

    type:

    Must be s3.

    bucket:

    The bucket on the deployment.

  • Optional information

    prefix:

    The prefix on the object(s) to replicate.

    endpoint:

    The location of the source deployment.
    If the location is not remote, use local.

    credentials:

    The accesskey and secretKey or the sessionToken that grants access to the object(s).

For filters

newerThan:

A string representing a length of time in #d#h#s format.

Only objects newer than the specified length of time replicate. For example, 7d, 24h, 5d12h30s are valid strings.

olderThan:

A string representing a length of time in #d#h#s format.

Only objects older than the specified length of time replicate.

createdAfter:

A date in YYYY-MM-DD format.

Only objects created after the date replicate.

createdBefore:

A date in YYYY-MM-DD format.

Only objects created prior to the date replicate.

For notifications

endpoint:

The predefined endpoint to send events for notifications.

token:

An optional JWT <JSON Web Token> to access the endpoint.

For retry attempts

If something interrupts the job, you can define how many attempts to retry the job batch. For each retry, you can also define how long to wait between attempts.

attempts:

Number of tries to complete the batch job before giving up.

delay:

The least amount of time to wait between each attempt.

Sample YAML

replicate:
  apiVersion: v1
  # source of the objects to be replicated
  source:
      type: TYPE # valid values are "s3"
        bucket: BUCKET
           prefix: PREFIX
           # NOTE: if source is remote then target must be "local"
           # endpoint: ENDPOINT
           # credentials:
      #   accessKey: ACCESS-KEY
      #   secretKey: SECRET-KEY
      #   sessionToken: SESSION-TOKEN # Available when rotating credentials are used

  # target where the objects must be replicated
  target:
           type: TYPE # valid values are "s3"
           bucket: BUCKET
           prefix: PREFIX
           # NOTE: if target is remote then source must be "local"
           # endpoint: ENDPOINT
           # credentials:
      #   accessKey: ACCESS-KEY
      #   secretKey: SECRET-KEY
      #   sessionToken: SESSION-TOKEN # Available when rotating credentials are used

  # optional flags based filtering criteria
  # for all source objects
  flags:
           filter:
              newerThan: "7d" # match objects newer than this value (e.g. 7d10h31s)
              olderThan: "7d" # match objects older than this value (e.g. 7d10h31s)
              createdAfter: "date" # match objects created after "date"
              createdBefore: "date" # match objects created before "date"

        ## NOTE: tags are not supported when "source" is remote.
              # tags:
        #   - key: "name"
        #     value: "pick*" # match objects with tag 'name', with all values starting with 'pick'

        ## NOTE: metadata filter not supported when "source" is non MinIO.
              # metadata:
        #   - key: "content-type"
        #     value: "image/*" # match objects with 'content-type', with all values starting with 'image/'

           notify:
              endpoint: "https://notify.endpoint" # notification endpoint to receive job status events
              token: "Bearer xxxxx" # optional authentication token for the notification endpoint

           retry:
              attempts: 10 # number of retries for the job before giving up
              delay: "500ms" # least amount of delay between each retry