christopherkeim / devops-capstone-project

DevOps Capstone Template

This repository contains the starter code for the project in IBM-CD0285EN-SkillsNetwork DevOps Capstone Project which is part of the IBM DevOps and Software Engineering Professional Certificate

Usage

You should use this template to start your DevOps Capstone project. It contains all of the code that you will need to get started.

Do Not fork this code! It is meant to be used by pressing the Use this Template button in GitHub. This will copy the code to your own repository with no connection back to the original repository like a fork would. This is what you want.

Development Environment

These labs are designed to be executed in the IBM Developer Skills Network Cloud IDE with OpenShift. Please use the links provided in the Coursera Capstone project to access the lab environment.

Once you are in the lab environment, you can initialize it with bin/setup.sh by sourcing it. (Note: DO NOT run this program as a bash script. It sets environment variable and so must be sourced):

source bin/setup.sh

This will install Python 3.9, make it the default, modify the bash prompt, create a Python virtual environment and activate it.

After sourcing it you prompt should look like this:

(venv) theia:project$

Useful commands

Under normal circumstances you should not have to run these commands. They are performed automatically at setup but may be useful when things go wrong:

Activate the Python 3.9 virtual environment

You can activate the Python 3.9 environment with:

source ~/venv/bin/activate

Installing Python dependencies

These dependencies are installed as part of the setup process but should you need to install them again, first make sure that the Python 3.9 virtual environment is activated and then use the make install command:

make install

Starting the Postgres Docker container

The labs use Postgres running in a Docker container. If for some reason the service is not available you can start it with:

make db

You can use the docker ps command to make sure that postgres is up and running.

Project layout

The code for the microservice is contained in the service package. All of the test are in the tests folder. The code follows the Model-View-Controller pattern with all of the database code and business logic in the model (models.py), and all of the RESTful routing on the controller (routes.py).

├── service         <- microservice package
│   ├── common/     <- common log and error handlers
│   ├── config.py   <- Flask configuration object
│   ├── models.py   <- code for the persistent model
│   └── routes.py   <- code for the REST API routes
├── setup.cfg       <- tools setup config
└── tests                       <- folder for all of the tests
    ├── factories.py            <- test factories
    ├── test_cli_commands.py    <- CLI tests
    ├── test_models.py          <- model unit tests
    └── test_routes.py          <- route unit tests

Data Model

The Account model contains the following fields:

Name	Type	Optional
id	Integer	False
name	String(64)	False
email	String(64)	False
address	String(256)	False
phone_number	String(32)	True
date_joined	Date	False

Your Task

Complete this microservice by implementing REST API's for READ, UPDATE, DELETE, and LIST while maintaining 95% code coverage. In true Test Driven Development fashion, first write tests for the code you "wish you had", and then write the code to make them pass.

Local Kubernetes Development

This repo can also be used for local Kubernetes development. It is not advised that you run these commands in the Cloud IDE environment. The purpose of these commands are to simulate the Cloud IDE environment locally on your computer.

At a minimum, you will need Docker Desktop installed on your computer. For the full development environment, you will also need Visual Studio Code with the Remote Containers extension from the Visual Studio Marketplace. All of these can be installed manually by clicking on the links above or you can use a package manager like Homebrew on Mac of Chocolatey on Windows.

Please only use these commands for working stand-alone on your own computer with the VSCode Remote Container environment provided.

1. Bring up a local K3D Kubernetes cluster

   $ make cluster

2. Install Tekton

   $ make tekton

3. Install the ClusterTasks that the Cloud IDE has

   $ make clustertasks

You can now perform Tekton development locally, just like in the Cloud IDE lab environment.

Author

John Rofrano, Senior Technical Staff Member, DevOps Champion, @ IBM Research, and Instructor @ Coursera

License

Licensed under the Apache License. See LICENSE

© IBM Corporation 2022. All rights reserved.

devops-capstone-project's Issues

Deploy your Docker image to Kubernetes

Role: As a Service Provider
Function: I need my service to run on Kubernetes
Business Value: 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 in Kubernetes

Delete an account from the service

Role: As a User
Function: I need the ability to delete an account from the service
Business Value: So that I can keep our accounts up to date

Details and Assumptions

• Accounts service will have basic customer information like names and addresses

Acceptance Criteria

Given a customer offboards
When I delete their account
Then that account's data will no longer be present

Need to add security headers and CORS policies

Role: As a Service Provider
Function: I need my service to use security headers and CORS policies
Business Value: 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

Read an account from the service

Role: As a User
Function: I need the ability to read an account from the service
Business Value: So that I can extract its data

Details and Assumptions

• Accounts service will have basic customer information like names and addresses

Acceptance Criteria

Given I need to retrieve data from the service
When I request to read an account from the service
Then I will get that account's data

Update an account in the service

Role: As a User
Function: I need the ability to update an account in the service
Business Value: So that I can keep our accounts up to date

Details and Assumptions

• Accounts service will have basic customer information like names and addresses

Acceptance Criteria

Given an account's information changes
When I update the account in the service
Then the account's new data is persisted

Create a CD Pipeline to Automate Deployment to Kubernetes

Role: As a Developer
Function: I need to create a CD pipeline to automate deployment to Kubernetes
Business Value: 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

Set up the development environment

Role: As a Developer
Function: I need a development environment with high parity to our deployment environment
Business Value: So that I can write robust, deployable code.

Details and Assumptions

• Deploy target is Ubuntu.

Acceptance Criteria

Given I write code
When my test cases pass
Then my code will have less errors moving to production

List all accounts in the service

Role: As a User
Function: I need to be able to list all accounts in the service
Business Value: So that I can manage our accounts

Details and Assumptions

• Accounts service will have basic customer information like names and addresses

Acceptance Criteria

Given I need a list of all the accounts in our service
When I request this list
Then the list should contain all of the accounts in our service

Containerize your microservice using Docker

Role: As a Developer
Function: I need to containerize my microservice using Docker
Business Value: So that I can deploy it easily with all 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

Need the ability to automate continuous integration checks

Role: As a Developer
Function: I need automation to build and test every pull request
Business Value: 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