hris2003 / devops-capstone-project Goto Github PK

As a user
I need to be able to list all account in the service
So that I can check all accounts in the service

Details and Assumptions

* [document what you know]      

Acceptance Criteria

gherkin 
Given an REST url to list all the accounts
When user sends a request to that url
Then the list of all accounts should be returned

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

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 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 user
I need to be able to delete an account from the service
So that I can delete an account from the service

Details and Assumptions

* [document what you know]      

Acceptance Criteria

gherkin 
Given a REST url to delete an account
When user send a request to delete an account to that url
Then the account should be deleted from the database

As a user
I need to be able to read an account from the service
So that I can check the account information

Details and Assumptions

* [document what you know]      

Acceptance Criteria

gherkin 
Given the REST url to get an account
When user send a request of an account to that url
Then account information should be returned

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

   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 be able to update an account in the service
So that I can update an account in the service

Details and Assumptions

* [document what you know]      

Acceptance Criteria

gherkin 
Given a REST url to update account information
When user send a request to update an account to that url
Then the account should be updated

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

    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 to have my development environment set up
So that I can develop features for the project

Details and Assumptions

* [document what you know]      

Acceptance Criteria

gherkin 
Given the instructions to set up the development environment
When I followed all the instructions
Then I should have my development environment set up

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