Skip to content

Latest commit

 

History

History
353 lines (277 loc) · 14.5 KB

README.md

File metadata and controls

353 lines (277 loc) · 14.5 KB
Raw

Read this first

I have been away from the world of Glue so it is difficult for me to maintain this plugin since I do not have an AWS account to test and improve the plugin. So if someone wants to keep making updates to the repository, talk to me internally to add it as a maintainer so I can publish new versions.

Regards from Chile!

Serverless Glue

Serverless-glue is an open source MIT licensed project, which has been able to grow thanks to the community. This project is the result of an idea that did not let it rest in oblivion and many hours of work after hours.

If you want to help me you can do it in the following ways:

  • With a donation through Paypal here.
  • Sharing your feedback here.

I hope you liked this project and it is useful for you.

Any problems? Join to the slack channel.

The principal changes are available here

This is a plugin for Serverless framework that provide the possibility to deploy AWS Glue Jobs and Triggers

Install

  1. run npm install --save-dev serverless-glue
  2. add serverless-glue in serverless.yml plugin section 
    plugins:
    - serverless-glue

How it works

The plugin creates CloufFormation resources of your configuration before making the serverless deploy then add it to the serverless template.

So any glue-job deployed with this plugin is part of your stack too.

How to configure your GlueJob(s)

Configure your glue jobs in the root of servelress.yml like this:

Glue:
  bucketDeploy: someBucket # Required
  createBucket: true # Optional, default = false
  createBucketConfig: # Optional 
    ACL: private # Optional, private | public-read | public-read-write | authenticated-read
    LocationConstraint: af-south-1
    GrantFullControl: 'STRING_VALUE' # Optional
    GrantRead: 'STRING_VALUE' # Optional
    GrantReadACP: 'STRING_VALUE' # Optional
    GrantWrite: 'STRING_VALUE' # Optional
    GrantWriteACP: 'STRING_VALUE' # Optional
    ObjectLockEnabledForBucket: true # Optional
    ObjectOwnership: BucketOwnerPreferred # Optional
  s3Prefix: some/s3/key/location/ # optional, default = 'glueJobs/'
  tempDirBucket: someBucket # optional, default = '{serverless.serviceName}-{provider.stage}-gluejobstemp'
  tempDirS3Prefix: some/s3/key/location/ # optional, default = ''. The job name will be appended to the prefix name
  jobs:
    - name: super-glue-job # Required
      id: # Optional, string
      scriptPath: src/script.py # Required script will be named with the name after '/' and uploaded to s3Prefix location
      Description: # Optional, string
      tempDir: true # Optional true | false
      type: spark # spark / spark_streaming / pythonshell # Required
      glueVersion: python3-2.0 # Required "python3.9-1.0" | "python3.9-2.0" | "python3.9-3.0" | "python3-1.0" | "python3-2.0" | "python3-3.0" | "python2-1.0" | "python2-0.9" | "scala2-1.0" | "scala2-0.9" | "scala2-2.0" | "scala3-3.0"
      role: arn:aws:iam::000000000:role/someRole # Required
      MaxCapacity: 1 #Optional
      MaxConcurrentRuns: 3 # Optional
      WorkerType: Standard # Optional, G.1X | G.2X
      NumberOfWorkers: 1 # Optional
      SecurityConfiguration: # Optional, name of security configuration
      Connections: # Optional
        - some-conection-string
        - other-conection-string
      Timeout: # Optional, number
      MaxRetries: # Optional, number
      DefaultArguments: # Optional
        class: string # Optional
        scriptLocation: string # Optional
        extraPyFiles: string # Optional
        extraJars: string # Optional
        userJarsFirst: string # Optional
        usePostgresDriver: string # Optional
        extraFiles: string # Optional
        disableProxy: string # Optional
        jobBookmarkOption: string # Optional
        enableAutoScaling: string # Optional
        enableS3ParquetOptimizedCommitter: string # Optional
        enableRenameAlgorithmV2: string # Optional
        enableGlueDatacatalog: string # Optional
        enableMetrics: string # Optional
        enableContinuousCloudwatchLog: string # Optional
        enableContinuousLogFilter: string # Optional
        continuousLogLogGroup: string # Optional
        continuousLogLogStreamPrefix: string # Optional
        continuousLogConversionPattern: string # Optional
        enableSparkUi: string # Optional
        sparkEventLogsPath: string # Optional
        additionalPythonModules: string # Optional
        customArguments: # Optional; these are user-specified custom default arguments that are passed into cloudformation with a leading -- (required for glue)
          custom_arg_1: custom_value
          custom_arg_2: other_custom_value
      SupportFiles: # Optional
        - local_path: path/to/file/or/folder/ # Required if SupportFiles is given, you can pass a folder path or a file path
          s3_bucket: bucket-name-where-to-upload-files # Required if SupportFiles is given
          s3_prefix: some/s3/key/location/ # Required if SupportFiles is given
          execute_upload: True # Boolean, True to execute upload, False to not upload. Required if SupportFiles is given
      Tags:
        job_tag_example_1: example1
        job_tag_example_2: example2
  triggers:
    - name: some-trigger-name # Required
      Description: # Optional, string
      StartOnCreation: True # Optional, True or False
      schedule: 30 12 * * ? * # Optional, CRON expression. The trigger will be created with On-Demand type if the schedule is not provided.
      Tags:
        trigger_tag_example_1: example1     
      actions: # Required. One or more jobs to trigger
        - name: super-glue-job # Required
          args: # Optional
            custom_arg_1: custom_value
            custom_arg_2: other_custom_value
          timeout: 30 # Optional, if set, it overwrites specific jobs timeout when job starts via trigger
          SecurityConfiguration: # Optional, name of security configuration

You can define a lot of jobs...

  Glue:
    bucketDeploy: someBucket
    jobs:
      - name: jobA
        scriptPath: scriptA
        ...
      - name: jobB
        scriptPath: scriptB
        ...

And a lot of triggers...

  Glue:
    triggers:
        - name:
            ...
        - name:
            ...

Glue configuration parameters

Parameter Type Description Required
bucketDeploy String S3 Bucket name true
createBucket Boolean If true, a bucket named as bucketDeploy will be created before. Helpful if you have not created the bucket first false
createBucketConfig createBucketConfig Bucket configuration for creation on S3 false
s3Prefix String S3 prefix name false
tempDirBucket String S3 Bucket name for Glue temporary directory. If dont pass argument the bucket'name will generates with pattern {serverless.serviceName}-{provider.stage}-gluejobstemp false
tempDirS3Prefix String S3 prefix name for Glue temporary directory false
jobs Array Array of glue jobs to deploy true

CreateBucket confoguration parameters

Parameter Type Description Required
ACL String The canned ACL to apply to the bucket. Possible values include:
  • private
  • public-read
  • public-read-write
  • authenticated-read
 False
LocationConstraint String Specifies the Region where the bucket will be created. If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1). Possible values are:
  • af-south-1
  • ap-east-1
  • ap-northeast-1
  • ap-northeast-2
  • ap-northeast-3
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ca-central-1
  • cn-north-1
  • cn-northwest-1
  • EU
  • eu-central-1
  • eu-north-1
  • eu-south-1
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • me-south-1
  • sa-east-1
  • us-east-2
  • us-gov-east-1
  • us-gov-west-1
  • us-west-1
  • us-west-2
 false
GrantFullControl String Allows grantee the read, write, read ACP, and write ACP permissions on the bucket. false
GrantRead (String Allows grantee to list the objects in the bucket. false
GrantReadACP String Allows grantee to read the bucket ACL. false
GrantWrite String Allows grantee to create new objects in the bucket. For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects. false
GrantWriteACP String Allows grantee to write the ACL for the applicable bucket. false
ObjectLockEnabledForBucket Boolean Specifies whether you want S3 Object Lock to be enabled for the new bucket. false
ObjectOwnership String The container element for object ownership for a bucket's ownership controls.Possible values include:
  • BucketOwnerPreferred
  • ObjectWriter
  • BucketOwnerEnforced
 false

Jobs configurations parameters

Parameter Type Description Required
name String name of job true
id String logical ID in CloudFormation for the job false
Description String Description of the job False
scriptPath String script path in the project true
tempDir Boolean flag indicate if job required a temp folder, if true plugin create a bucket for tmp false
type String Indicate if the type of your job. Values can use are : spark, spark_streaming or pythonshell true
glueVersion String Indicate language and glue version to use ( [language][version]-[glue version]) the value can you use are:
  • python3-1.0
  • python3-2.0
  • python2-1.0
  • python2-0.9
  • scala2-1.0
  • scala2-0.9
  • scala2-2.0
 true
role String arn role to execute job true
MaxCapacity Double The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs false
MaxConcurrentRuns Double max concurrent runs of the job false
MaxRetries Int Maximum number of retires in case of failure False
Timeout Int Job timeout in number of minutes False
WorkerType String The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X. false
NumberOfWorkers Integer number of workers false
SecurityConfiguration String The name of the security configuration that the job should use false
Connections List a list of connections used by the job false
DefaultArguments object Special Parameters Used by AWS Glue for mor information see this read the AWS documentation false
SupportFiles List List of supporting files for the glue job that need upload to S3 false
Tags JSON The tags to use with this job. You may use tags to limit access to the job. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide. false

Triggers configuration parameters

Parameter Type Description Required
name String name of the trigger true
schedule String CRON expression false
actions Array An array of jobs to trigger true
Description String Description of the Trigger False
StartOnCreation Boolean Whether the trigger starts when created. Not supperted for ON_DEMAND triggers False

Only On-Demand and Scheduled triggers are supported.

Trigger job configuration parameters

Parameter Type Description Required
name String The name of the Glue job to trigger true
timeout Integer Job execution timeout. It overwrites false
args Map job arguments false
Tags JSON The tags to use with this triggers. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide. false

And now?...

Only run serverless deploy

Changelog

[2.12.1] - 2023-05-31

Fix

  • Fixed tempDir being added when set to false

[2.12.0] - 2023-02-09

Add

  • Add support for spark streams
  • Add support for --additional-python-modules

Fix

  • fix when parametter s3Prefix is omitted generate a undefine prefix

[2.11.1] - 2022-09-13

Add

  • Add support for custom logical IDs for jobs

Fix

  • Fix Pascal Case generation for sections of names that are only numeric

[2.10.0] - 2022-09-12

Add

  • Add support for python 3.9 shell jobs

[2.9.0] - 2022-06-03

Add

  • Add support to Glue 3.0 (Spark 3.1.1/Python 3.7)
  • Now aws-s3 client is generated with region defined on "provider" part of serverless.yml

Fix

  • the hard coded path generator is replaced by the "path" package, to solve problems when running the package on Windows
  • the last "/" characters on tempDirS3Prefix are automatically removed to avoid wrong paths in S3

[2.8.0] - 2022-03-31

Add

  • Add check if bucket exist before create it

[2.7.0] - 2022-02-25

Add

  • Add configuration MaxCapacity for job

[2.6.0] - 2022-02-25

Add

  • Add support for SecurityConfiguration property

[2.5.0] - 2022-02-14

Add

  • Add the createBucketConfig feature to set the bucket creation configuration.

Changed

  • Removed message when support files not found, now logging message when support files exist.

Fix

  • Improve the createBucket example of documentation.

[2.4.1] - 2022-02-01

Fix

  • Fix schema typo that blocks serverless 3.

[2.4.0] - 2022-01-17

Fix

  • Fix NumberOwfWorkers typo.

Add

  • Added Timeout, MaxRetries and Description parameters to Glue Job arguments. Added Description and StartOnCreation parameters to Glue Job Trigger arguments.
  • Added SupportFiles to Glue Job arguments handling the upload to S3 of relevant-to-the-Glue-Job(s) files

[2.3.0] - 2021-12-23

Add

  • Implement Custom Arguments for Jobs

[2.2.0] - 2021-12-22

Add

  • Implement Tags for jobs and triggers

[2.1.1] - 2021-12-21

Fixed

  • Remove empty connections object from CF template when don`t specify any conection

[2.1.0] - 2021-12-15

Add

  • Implement DefaultArguments for jobs

[2.0.2] - 2021-12-13

Fixed

  • Replace incorrect async loop in serverless

[2.0.1] - 2021-12-09

Changed

  • Move typescript dependencie to dev

[2.0.0] - 2021-11-29

Changed

  • Refactoring code from JS to TS, and restructured folders.
  • Plugin`s configuration get out from custom level in serverless.yml now are in root of file.
  • Remove redundant level job in jobs config.
  • script attribute are rename to *scriptPath
  • Remove redundant level Connections in Connections config.
  • Remove redundant level trigger from triggers config.
  • Rename job attribute to action in trigger config.

Fixed

  • Improve documentation for Connections config.