Welcome to the HERMES-SOC SDC Pipeline Architecture documentation!
This documentation is for the SDC AWS Pipeline Architecture repo which is used to deploy the AWS Cloud Resources required for the pipeline architecture. This documentation is intended to be used by developers who are interested in contributing to the project as well as those who’d like to know more about the project.
If you would like to learn how to deploy the pipeline on your own AWS account or an overview of the different components of the pipeline, please refer to the user-guide.
If you would like to learn more about contributing to the project, please refer to the developer-guide.
If you’d like to know more about the project, please visit the project’s GitHub repository page.
The documentation is written in reStructuredText and built using Sphinx.
Contents:
- User’s Guide
- Prerequisites
- Getting Started
- Step 1: Download the Code
- Step 2: Install dependencies for project
- Step 3: Modify config file to fit your naming scheme
- Step 4: Deploy the SDCAWSPipelineArchitectureStack Stack using CDK
- Step 5: Build and Push the Lambda Function into the S3 Bucket
- Step 6: Deploy the SDCAWSSortingLambdaStack Stack using CDK
- Step 7: Build and Push Processing Lambda Function into ECR Repo
- Step 8: Deploy the SDCAWSProcessingLambdaStack Stack using CDK
- Step 9: Verify the three different Stacks that compose the pipeline are up and running
- Where to go from here:
- Repository Guide
- Pipeline Diagrams
- Developer’s Guide