Skip to content

Hikkigaya/nops-aws-forwarder

 
 

Repository files navigation

Aws Nops Forwarder (Testing)

Forward event from AWS CT into nOps

Prerequisites

  • AWS Cloudtrail with S3 bucket for CloudTrail logs must be configured before deploying this stack.
  • S3 bucket for AWS CloudTrail, and nOps-aws-forwarder should be within the some Region.
  • API key from nOps, if you want to use encrypted version, please setup a symmetric encryption key within KMS in the same region of lambda and provide the permission for Lambda execution's role later.

Installation

CloudFormation

Launch Stack

  1. Log into your admin AWS account/role and deploy the CloudFormation Stack using the button seen above.
  2. Fill in pnOpsApiKey or pnOpsKmsAPIKey, pCTForwarderReleaseVersion, pCloudtrailBucketName. All other parameters are optional.
  3. Click Create stack, and wait for the creation to complete.
  4. Find the installed forwarder Lambda function under the stack's "Resources" tab with logical ID rLambdaForwarder.
  5. If you use KMS encrypted API key, please provide the access permission for lambda role for KMS Key
  6. Repeat the steps 1-4 above in another region if you operate in multiple AWS regions with single-region trail.

Manual

If you can't install the Forwarder using the provided CloudFormation template, you can install the Forwarder manually following the steps below. Feel free to open an issue or create a pull request to let us know if there is anything we can improve to make the template work for you.

  1. Create a Python 3.9 Lambda function using nops-aws-forwarder-deployment-package-<VERSION>.zip from the latest releases.
  2. Save your NOPS API key to Lambda's environment variable NOPS_API_KEY or encrypted kms key as NOPS_KMS_API_KEY
  3. Add the s3:GetObject permission to the Lambda execution role.
  4. Configure triggers.
  5. If you use KMS encrypted API key, please provide the access permission for lambda role for KMS Key

Upgrade

Usage

Support

Development

  • Run ./bump_version minor/major/main to add a new version

About

test fork

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Python 84.4%
  • Shell 12.0%
  • Makefile 3.6%