@runnerty/executor-s3

Smart Processes Management

S3 executor for Runnerty:

Installation:

Through NPM

npm i @runnerty/executor-s3

You can also add modules to your project with runnerty-cli

npx runnerty-cli add @runnerty/executor-s3

This command installs the module in your project, adds example configuration in your config.json and creates an example plan of use.

If you have installed runnerty-cli globally you can include the module with this command:

rty add @runnerty/executor-s3

Configuration sample:

Add in config.json:

{
  "id": "s3_default",
  "type": "@runnerty-executor-s3",
  "apiVersion": "2006-03-01",
  "accessKeyId": "ABC123",
  "secretAccessKey": "ABC123",
  "region": "eu-west-1",
  "bucket": "my.s3bucket.com"
}

Plan samples:

Add in plan.json:

• Upload

{
  "id": "s3_default",
  "method": "upload",
  "local_file": "/tmp/test.txt",
  "remote_file": "dir_one/dir_two/test_up.txt"
}

• Download

{
  "id": "s3_default",
  "method": "download",
  "remote_file": "test.txt",
  "local_file": "/tmp/test_down.txt"
}

• Delete

{
  "id": "s3_default",
  "method": "delete",
  "remote_path": "folder_test/foo.txt"
}

• Delete array of files

{
  "id": "s3_default",
  "method": "delete",
  "remote_path": ["folder_test/sample.txt", "folder_test/sample.zip"]
}

• Delete glob pattern

{
  "id": "s3_default",
  "method": "delete",
  "remote_path": "folder_test/*.txt"
}