mariam199911 / DevOps-Challenge

TradeByte DevOps Challenge

TradeByte DevOps Challenge

This repository is meant to be used as a challenge for DevOps candidates at Tradebyte.

You should fork/clone this repository to use as a basis for the challenge.

The challenge

Subject of this challenge is to setup a robust, production ready and developer friendly Continuous Deployment pipeline for the given demo application.

The demo application can be found in this repository and the server for the deployment will be provided by us for you to work with.

The requirements are as follows:

• Choose an appropriate CI/CD tool.
• Use a container technology of your own choosing for the demo application.
• Setup a continuous deployment pipeline for the containerized demo application with your chosen CI/CD tool.
  • It should contain at least a testing and a deployment stage.
  • It should only be deployed if the testing stage, which runs the demo applications tests, is successful.
  • It should follow the GitHub flow workflow for the deployment.
  • It should be deployed to the provided demo server.
• Setup a development environment which mirrors the production environment as closely as possible.
• Think about scalability and performance.

Demo application

Requirements

System

• GNU/Linux
• python >= 3.7
• pip >= 9.0
• redis >= 5.0

>= means any version of the package, above or equal to the specified version.

Application

• redis-py
• tornado

You can find them in the requirements.txt file and their required version number. You can install them by using:

pip install -r requirements.txt

🚀 Starting the Application

The application uses several environment variables. You can find them all and their default values in the .env file. They need to be avaiable at runtime. Here is an overview about the environment variables:

• ENVIRONMENT the environment in which the application is run. Likely PROD for production or DEV for development context.
• HOST the hostname on which the application is running. Locally it is localhost.
• PORT is the port on which the application is running.
• REDIS_HOST is the hostname on which redis is running. Locally it is localhost.
• REDIS_PORT is the port on which to communicate with redis. Normally it is 6379.
• REDIS_DB which redis db should be used. Normally it is 0.

Application can be found in hello.py file. You can start the application by using:

export $(cat .env | xargs) && python hello.py

Although you don't have to export the environment variables that way. 😉

Static files

• Static files are located in static/ folder.
• Templates are located in template/ folder.

Executing Tests

Tests can be found in tests/test.py file. You can run the tests by using:

python tests/test.py

Contributing

We love contributions from everyone. By participating in this project, you agree to abide by our code of conduct.

We expect everyone to follow the code of conduct anywhere in DevOps-Challenge's project codebases, issue trackers, chatrooms, and mailing lists.
Thank you, contributors!

License

Copyright (c) 2019 by the Tradebyte Software GmbH.
DevOps-Challenge is free software, and may be redistributed under the terms specified in the LICENSE file.

About

DevOps-Challenge is maintained and funded by the Tradebyte Software GmbH.
The names and images for DevOps-Challenge are trademarks of the Tradebyte Software GmbH.

We love free software!