Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xanderstevenson/diy-devops-dashboard-in-docker
https://github.com/xanderstevenson/diy-devops-dashboard-in-docker
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/xanderstevenson/diy-devops-dashboard-in-docker
- Owner: xanderstevenson
- License: mit
- Created: 2023-10-08T19:02:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-08T20:37:17.000Z (over 1 year ago)
- Last Synced: 2023-10-09T20:21:52.985Z (over 1 year ago)
- Language: Python
- Size: 192 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Do-It-Yourself (DIY) DevOps Dashboard in Docker
## Description
I made this project as a way for those new to DevOps to get started with the basic technologies invlolved. It requires setting up the basic accounts and then provides the user with an all-in-one place to see their progress and to better understand how these different tools interact in the DevOps lifecycle.
This project runs a Flask App inside a Docker container, which serves the web dashboard. It is written in Python and most of the data is collected via external API calls, with Docker and Jenkins data being collected straight from your machine.
Besides displaying all your DevOps data neatly organized in the dashboard, you can send the data to a Webex space via message by clicking the 'Post to Webex' button in the menu.
## Prerequisites
GitHub, GitLab, Terraform, and Elastic-Cloud accounts must be created and the credentials placed in the .env file in order for the data from those platforms to display properly in the dashboard. Jenkins projects and Docker containers will also need to be present locally, for that data to be populated in the dashboard. The Docker Engine must be running for the Docker commands below to be successful.
- You will need [Python](https://www.python.org/downloads/) installed. This code has been successfully tested in Python 3.9.5
- Docker will need to be installed. I'm runnning [Docker Desktop](https://www.docker.com/products/docker-desktop/) on Mac.
## Installation
1. Create a virtual environment locally and activate it.
2. Clone this repo and cd into it.
```git clone https://github.com/xanderstevenson/diy-devops-dashboard.git```
```cd diy-devops-dashboard```
3. Make sure you have account set-up with [GitHub](https://github.com/), [GitLab](https://gitlab.com/), [Terraform](https://app.terraform.io/), and [Elastic Cloud](https://www.elastic.co/cloud/)
4. Create a file called .env in the same directory as app.py and place your credentials from those accounts into .env. The required credentials are listed in the [.env-example](https://github.com/xanderstevenson/diy-devops-dashboard/blob/main/.env-example) file. Do not place any credentials in .env-example!
`GITHUB_USERNAME="your_username"`
`GITHUB_ACCESS_TOKEN="your_access_token"`
`...`
`...`
_*** The .env file is listed in the [.gitignore](https://github.com/xanderstevenson/diy-devops-dashboard/blob/main/.gitignore) file, so .env will not be pushed to GitHub if you decide to fork this project. ***_
## Usage
1. Build the Docker image by running the following command in the project directory (make sure Docker Engine is running):
```docker build -t diy-devops-dashboard .```
2. Run the Docker container by executing the following. command:
```docker run --name diy-devops-dashboard -v /var/run/docker.sock:/var/run/docker.sock -p 8000:8000 diy-devops-dashboard```
This command starts the container and forwards the container's port 8000 to the host's port 8000, allowing you to access the web app at http://localhost:8000.
3. Navigate to http://127.0.0.1:8000 or http://localhost:8000 to view the dashboard
4. To stop the container, type Ctrl + C one or twice in the virtual directory in which you ran the docker commands.
### Functionality
- Text within each section that is surrounded by a box is clickable and will take you to the web page for that resource.
- By clicking on the hamburger menu icon on the top left, you can view the button to 'Post to Webex'. Push this once and it will send the data for this dashboard, truncated to five results per tool, to the Webex space indicated in the .env file. This will take up to 15 seconds. To make the button disappear, click on the hamburger menu icon again.
- The entire page will reload every 5 minutes, thanks to the JavaScript at the bottom of /templates/index.html. You can also refresh the page manually by clicking on the "Refresh" button under the marquee at the top of the page.
Both actions reload the data to be presented.
- More blocks for additional tools can be added to [templates/index.html](https://github.com/xanderstevenson/diy-devops-dashboard/blob/main/templates/index.html) and a additional functions would need to be added to [app.py](https://github.com/xanderstevenson/diy-devops-dashboard/blob/main/app.py)
## Disclaimer
This project is for demo purposes only and should not be used in a production environment.