francostellari/devops-capstone-project

devops-capstone-project's Issues

Delete an account from the service

As a user
I need to be able to delete a customer entry
So that it is removed from the application

Details and Assumptions

* A would like to be able to completely remove the record of a customer XYZ from the application so that it is no more accessible    

Acceptance Criteria

gherkin 
Given a customer XYZ in the application
When I delete the record of customer XYZ
Then the record of customer XYZ should be removed from the application and not be accessible anymore

Create a CD pipeline to automate deployment to Kubernetes

As a developer
I need to create a CD pipeline to automate deployment to Kubernetes
So that developers aren't 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

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

List all accounts in the service

As a user
I need to retrieve a list of the accounts
So that I can get a list of all the accounts available in the application

Details and Assumptions

* [document what you know]      

Acceptance Criteria

gherkin 
Given a list of accounts available in the application
When I request a list of accounts
Then I should get a full list of all the accounts available 

Need to add security headers and CORS policies

Set up the development environment

As a developer
I need to setup a development environment
So that I can start working on the project

Details and Assumptions

* On my windows machine I need to install vagrant to be able to bring up the development environment

Acceptance Criteria

gherkin 
Given a cloned copy of the Git repo
When i run the command `vagrant up`
Then I should have a ready to use development environment

Sprint 1

Need the ability to automate continuous integration checks

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

Read an account from the service

As a user
I need to read an customer account from the service
So that I get the customer information

Details and Assumptions

* Assuming that I have the microservice running with some customer information in it, I would like to call on the RESTful API to get a specific customer information

Acceptance Criteria

gherkin 
Given a running microservice with XYZ customer information in it
When I trigger the restful API to get customer XYZ
Then I should get the customer XYZ information

Sprint 2

Need to add security headers and CORS policies

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

Containerize your microservice using Docker

As a developer
I need create a Docker container of the microservice application
So that it can be deployed in the cloud

Details and Assumptions

* Given the Python code of the microservice application, I need to to create a Dockerfile that packages the code into a container

Acceptance Criteria

gherkin 
Given the local Python code of the application that has been tested to work
When I run the docker build command
Then I should get a docker container image corresponding to the python code

Sprint 3

Update an account in the service

As a user
I need update a customer information
So that the new customer information is saved in the application

Details and Assumptions

* Given a customer XYZ, I would like to change some detail about the customer information, such as the address, so that it is updated in the application for future use

Acceptance Criteria

gherkin 
Given A customer XYZ with `address1`
When When I update it's address to `address2`
Then The new `address2` should replace the previous `address`1 and be stored in the application for future retrieval

Deploy your Docker image to Kubernetes

As a user
I need deploy the Docker image of the microservice in Kubernetes
So that the microservice can be run and accessed in the cloud

Details and Assumptions

* Give the Docker container image of the microservice application, I need to deploy it into Kubernetes using appropriate YAML

Acceptance Criteria

gherkin 
Given the existing Docker image of the microservice
When I deploy it into a Kubernetes cluster
Then I should be able to access the features of the microservice from the cloud