README
¶
pennsieve-go-api
Golang API for the Pennsieve Platform
API Gateway
The Pennsieve-Go-API is a serverless api that is built around an AWS API Gateway.
The API Gateway routes traffic to the api to various Lambda functions that are defined in separate services, which are manages in independent Github repositories.
API Controllers and Models
The API provides interfaces with the Postgres DB.
Testing
The tests are automatically run by Jenkins once you push to a feature branch. Successful tests are required to merge a feature branch into the main branch.
Deployment
Build and Development Deployment
Artifacts are built in Jenkins and published to S3. The dev build triggers a deployment of the Lambda function and creates a "Lambda version" that is used by the model-service.
Deployment of an Artifact
-
Deployements to development are automatically done by Jenkins once you merge a feature branch into main.
-
Deployments to production are done via Jenkins.
- Determine the artifact version you want to deploy (you can find the latest version number in the development deployment job).
- Run the production deployment task with the new IMAGE_TAG
Note: After terraforming the authorizer, you need to manually add the invoke role to the authorizer as this is currently not automatically picked up from the OAS configuration for HTTP APIs.
Directories