aditya-kashyap / devops-capstone-project Goto Github PK

As a developer
I need to containerize my microservice using Docker
So that I can deploy it easily with all of its dependencies

Details and Assumptions

* Create a Dockerfile for repeatable builds
* Use a Python:3.9-slim image as the base
* It must install all of the Python requirements
* It should not run as root
* It should use the gunicorn wsgi server as an entry point     

Acceptance Criteria

Given the Docker image named accounts has been created
When I use docker run accounts
Then I should see the accounts service running in Docker

As a developer
I need to containerize my microservice using Docker
So that I can deploy it easily with all of its dependencies

Assumptions

• Create a Dockerfile for repeatable builds
• Use a Python:3.9-slim image as the base
• It must install all of the Python requirements
• It should not run as root
• It should use the gunicorn wsgi server as an entry point

Acceptance Criteria

Given the Docker image named accounts has been created
When I use docker run accounts
Then I should see the accounts service running in Docker

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

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

gherkin
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 client
I need a function to list all accounts
So that I can check accounts

Details and Assumptions

* Already has a database storing accounts

Acceptance Criteria

gherkin 
Given nothing
When I list all accounts
Then all accounts are listed

As a client
I need a function to update an account
So that I can change, update and correct the information on this account

Details and Assumptions

* Already have a database storing accounts     

Acceptance Criteria

gherkin 
Given the account id
When I update the new information to the account with this id
Then the account detail is updated

As a Client
I need a function to read the detail of an account
So that I can check and verify information from this account

Details and Assumptions

* Already have a database storing accounts    

Acceptance Criteria

gherkin 
Given the account id
When I use this account id to get the detail of this account
Then the service returns the detail of this account

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

* Kubernetes manifests will be created in yaml format
* These manifests could be useful to create a CD pipeline
* The actual deployment will be to OpenShift     

Acceptance Criteria

Given the Kubernetes manifests have been created
When I use the oc command to apply the manifests
Then the service should be deployed and run it in Kubernetes

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

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 Developer
I need Development Environment
So that Start my Development Process

Details and Assumptions

* A Development Environment      

Acceptance Criteria

gherkin 
Given the document on how to set up development environment
When I follow instructions in this document
Then I have a fully set up development environment

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

Assumptions

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

Acceptance Criteria

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

As a Client
I need a function to delete an account
So that I can remove unwanted / deactivated account

Details and Assumptions

* Already has a database storing accounts  

Acceptance Criteria

gherkin 
Given the account id
When I call service delete with this account id
Then this account is deleted