Code Monkey home page Code Monkey logo

devops-capstone-project's Introduction

DevOps Capstone Template

License Python 3.9

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 People

Contributors

sundar-05 avatar

Watchers

 avatar

devops-capstone-project's Issues

Set up the development environment

As a Developer
I need to set up a Development environment
So that I can start work on my project

Details and Assumptions

* None    

Acceptance Criteria

gherkin 
Given this Project
When I launch the Development environment
Then I should have the platform for starting off my work

Deploy your Docker image to Kubernetes

As a Developer
I need to Deploy a Docker image to Kubernetes
So that it is easily accessed & deployed as an application

Details and Assumptions

* I know the entire process of Docker deployment 

Acceptance Criteria

gherkin 
Given the need to have a scalable app deployment
When  Deploy a Docker image to Kubernetes
Then I can Deploy a Docker image to Kubernetes

Update an account in the service

As a Developer
I need to update an account in the service
So that I can update a particular person's information

Details and Assumptions

* I have read the account  from service

Acceptance Criteria

gherkin 
Given an account
When I update it
Then changes will be incorporated in it

Delete an account from the service

As a Developer
I need to delete an account from service
So that it may be removed from the system

Details and Assumptions

* The said person does NOT want his/her account to remain further active   

Acceptance Criteria

gherkin 
Given a person's requirement as above
When I delete his/her account
Then it will be removed from the system

Containerize your microservice using Docker

As a Developer
I need to Containerize a microservice using Docker
So that it can be easily made a Docker image

Details and Assumptions

* I know the entire process of Containerization 

Acceptance Criteria

gherkin 
Given the need to have an easy deployment
When I containerize a microservice using Docker
Then I will have a single image for further deployment

Read an account from the service

As a Developer
I need to read an account from the service
So that I can analyze the corresponding person's details

Details and Assumptions

* I have the Dev. environment ready     

Acceptance Criteria

gherkin 
Given an Account
When I read it from the service
Then I can analyze the corresponding person's details

List all accounts in the service

As a Developer
I need to list all accounts in the service
So that I know the status of each

Details and Assumptions

* I can read the accounts 

Acceptance Criteria

gherkin 
Given the need to retrieve overall status
When I list all account
Then I can know the status of each

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.