"In accelerator physics, a beamline refers to the trajectory of the beam of accelerated particles, including the overall construction of the path segment (vacuum tube, magnets, diagnostic devices) along a specific path of an accelerator facility. This part is either

• the line in a linear accelerator along which a beam of particles travels, or
• the path leading from a cyclic accelerator to the experimental endstation (as in synchrotron light sources or cyclotrons)."

BeamlineJS will accelerate the build, test, release and deployment of node.js based lambda functions across various facilities (regions).

• Auto-scaleable (AWS Lambda) and multi-region availability.
• Ability to setup BeamlineJS in multiple regions.
• Automatically create pull request to merge from fork into develop branch and from develop branch to master (read further to see the Git branching model it uses).
• Development and QA (staging) pipeline are started automatically when merge of PR is successful on the respective branch.
• Manages lambda function versioning and aliases.
• Handles rollbacks in case of failures.
• Verifies the SHA256 of lambda function’s code and configuration.
• Uses NodeJS frameworks to run unit, functional (QA), integration and load tests.
• Sends slack notifications
• function code is released in S3 bucket
• Multi region testing at fork, development, staging (qa) and production pipelines.

• BeamlineJ - CI/CD pipeline for AWS Lambda function with Java runtime
• BeamlinePY - CI/CD pipeline for AWS Lambda function with Python runtime

You can setup your own Beamline by following below simple steps. Please note that for Beamline to work you will have to create accounts using vendor services that may result in $$ cost. Please go through the pricing model of each services offered by the vendors prior to using these services.

It will create following three AWS Lambda functions:

This function is used for sending Slack notifications to your slack channel(s).

This function manages the overall execution of BeamlineJS. It parses the GitHub event and then initiates the pipeline based on the event.

This function will perform the continuous integration and deployment of CLIENT based on the Beamline configuration provided by the CLIENT.

CLIENT- Is the AWS Lambda function which will use BeamlineJS functions to perform its automated build, test and deployment activities.

• You will need AWS Account

  • How to create AWS Account?
  • Generate ACCESS_KEY and SECRET_KEY of your AWS Account
    • This is used for integrating AWS Simple Notification Service (SNS) with GitHub repository. Unfortunately GitHub's Amazon SNS integration does not work with IAM Role.

• You will need AWS CLI installed on your machine

  • How to install AWS CLI?
  • How to configure AWS Profile?
    • Configure profile in all regions where you want Beamline.

• You will need GitHub Account

  • How to create GitHub Account?
  • How to generate GitHub personal access token?
    • You will need this token to create new pull requests and respective branches

• You will need Slack Account

  • How to create Slack Account?
  • How to create Slack channels?
  • How to create incoming Webhook on Slack channel?
    • You will need webhooks to send notifications from Beamline to your Slack channels

• You will need NPM

  • How to install NPM on Mac?
  • How to install NPM on Windows?

• CLIENT

  • Will have to follow Vincent Driessen's successful branching model. In summary:
  • Developer will
    • Develop on fork repository's develop branch
    • Merge from master to fork repository's develop to resolve any conflicts
    • push commits to fork repository's develop branch
  • BeamlineJS will enforce following flow
    • Automatically create a new pull request to merge new PR branch of fork repository into base repository's develop branch
    • Developers will use the GitHub console to review and merge the new pull request
    • Automatically create a new pull request to merge new PR branch of base repository's develop branch into base repository's master branch
    • Developers will use the GitHub console to review and merge changes into master branch

I have tested these steps only on MAC. I don't see a reason why it will not work on Windows. You will need something like GitBash to run these steps on Windows

• Clone BeamlineJS repository on your local machine

git clone https://github.com/GaurangBhatt/BeamlineJS.git

• Navigate into your cloned repository's home directory and run following commands

  • Copy setup.properties.rename file and create setup.properties file

    cp setup.properties.rename setup.properties
    

    • Update setup.properties file to change
      • AWS_PROFILE_NAME - name of your configured profile using AWS Secret key and access key
      • INFRASTRUCTURE_PREFIX - to any string value of your choice
      • GITHUB_PERSONAL_TOKEN - to your personal token
      • S3_BUCKET_NAME - name of your S3 bucket
      • AWS_REGIONS - provide comma separated list of all regions where you want to install/setup BeamlineJS
      • PRIMARY_AWS_REGION - Set the primary region. This will integrate the SNS topic of this region to your repository via repository hooks
      • REPOSITORY_HOOKS_URLS - comma separated list of all repository hook URLs to which you want to add Amazon SNS integration

  • Update beamline-env-variables.json and pipeline-manager-env-variables.json file

    • Change FUNCTION_PREFIX to INFRASTRUCTURE_PREFIX value from setup.properties

  • Install and setup BeamlineJS

    chmod +x setup.sh
    ./setup.sh
    

  • Uninstall BeamlineJS

    chmod +x uninstall.sh
    ./uninstall.sh
    

  • Create Amazon SNS integration with your repository If you want to disable the hook then set active=false

    curl -v -b -X POST \
    -H "Content-Type: application/json" \
    -H "Authorization: token ${GITHUB_PERSONAL_TOKEN}" \
    -d '{
      "name": "amazonsns",
      "active": true,
      "events": ["push", "pull_request"],
      "config": {
        "aws_key": "'"${AWS_ACCESS_KEY}"'",
        "aws_secret": "'"${AWS_SECRET_KEY}"'",
        "sns_topic": "'"${snsTopicARN}"'",
        "sns_region": "'"${PRIMARY_AWS_REGION}"'"
      }
    }' \
    "${REPOSITORY_HOOK_URL}"