Git Product home page Git Product logo

scumblr-spillguard's Introduction

Scumblr GithubSpillGuard

serverless

A simple github webhook integration. Uses Scumblr as a source of terms to check incomming commits for. If a hit is found, sends the results to Scumblr for remediation.

The service has a dependency on external packages (requests and retrying) and it exposes 1 REST API endpoints:

Endpoint Description
POST /github Analyzes github commits based on Scumblr configuration

Serverless Setup

Step Command Description
1. npm install -g serverless Install Serverless CLI
2. npm install Install our package and it's dependencies

AWS Setup

Serverless requires different IAM credentials to deploy depending what infrastructure exists. If we assume that you have never used serverless before you will need admin credentials to deploy this lambda.

  1. Create KMS Key
  2. Create scumblr-spill-guard security group

Configure serverless.yml

Replace variables in the serverless.yml with your own.

KMS Encryption

To encrypt your variables, with your KMS key run:

aws kms encrypt --key-id <YOUR-KEY-ID> --plaintext fileb://ExamplePlaintextFile --output text --query CiphertextBlob

Usage

Deployment

sls deploy

Invocation

curl <host>/github

Tips & Tricks

help command

Just use it on anything:

sls  help

or

sls <command> --help

deploy function command

Deploy only one function:

sls deploy function -f <function-name>

logs command

Tail the logs of a function:

sls logs -f <function-name> -t

info command

Information about the service (stage, region, endpoints, functions):

sls info

invoke command

Run a specific function with a provided input and get the logs

sls invoke -f <function-name> -p event.json -l

Development

Step Command Description
1. mkvirtualenv posts Create virtual environment
2. pip install -r requirements.txt Install dependencies

Thanks

Big thanks to Jeremy for the project idea and initial implementation

scumblr-spillguard's People

Contributors

kevgliss avatar mikegrima avatar sbehrens avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.