alilordloss / devops-capstone-project Goto Github PK

As a Developer
I need to create a CD pipeline to automate deployment to Kubernetes
So that the developers are not wasting their time doing it manually

Details and Assumptions

• Use Tekton to define the pipeline
• It should clone, lint, test, build, and deploy the service
• Deployment should be to OpenShift
• It can use a manual trigger for this MVP

Acceptance Criteria

Given the CD pipeline has been created
When I trigger the pipeline run
Then I should see the accounts service deployed to OpenShift

As a User
I need to see a list of all accounts in the service
So that I could get an overview of accounts in the service

Details and Assumptions

• Maybe add pagination?

Acceptance Criteria

Given there exists some accounts in the service database
When I request to see the list of accounts
Then the accounts are listed for me

As a service provider
I need my service to run on Kubernetes
So that I can easily scale and manage the service

Details and Assumptions

• Should deploy & config a database for it too

Acceptance Criteria

Given the address of deployment
When I request some resource from the service
Then the service should respond properly

As a User
I need to update account data
So that mistakes can be fixed and changes can be done

Details and Assumptions

• Should check for account existence & permissions

Acceptance Criteria

Given there exists an account
When I request to change that account data
Then changes are made

As a service provider
I need my service to use security headers and CORS policies
So that my web site is not vulnerable to CORS attacks

Details and Assumptions

• Flask-Talisman will be used for security headers
• Flask-Cors will be used to establish cross-origin resource sharing (CORS) policies

Acceptance Criteria

Given the site is secured
When a REST API request is made
Then secure headers and a CORS policy should be returned

As a Developer
I need a development environment
So that I could develop new features

Details and Assumptions

• Need to have python & flask installed

As a Developer
I need a containerized microservice
So that I could deploy it easily

Details and Assumptions

• Should find a suitable image

Acceptance Criteria

Given a docker environment
When I build an image from the services source
Then I could deploy the project on that environment

As a Developer
I need automation to build and test every pull request
So that I do not have to rely on manual testing of each request, which is time-consuming

Details and Assumptions

• GitHub Actions will be used for the automation workflow
• The workflow must include code linting and testing
• The Docker image should be postgres:alpine for the database
• A GitHub Actions badge should be added to the README.md to reflect the build status

Acceptance Criteria

 Given code is ready to be merged
 When a pull request is created
 Then GitHub Actions should run linting and unit tests
 And the badge should show that the build is passing

As a User
I need to read an account form the service
So that I could see what are the account details

Details and Assumptions

• Should check for account existence

Acceptance Criteria

Given there exists an account
When I request the account
Then the data for that account is sent to me

As a User
I need to delete an account
So that I could remove redundant accounts from the database

Details and Assumptions

• should check for account existence & permissions

Acceptance Criteria

Given there exists an account
When I request to delete the account
Then the account is deleted