Skip to content
View defactops's full-sized avatar

Block or report defactops

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Maximum 250 characters. Please don't include any personal information such as legal names or email addresses. Markdown supported. This note will be visible to only you.
Report abuse

Contact GitHub support about this user’s behavior. Learn more about reporting abuse.

Report abuse
defactops/README.md

De factOps

Welcome to the De factOps project! Using the provided docker-compose files, you will be able to generate a server to monitor the devops metrics of your development team.

This project connects to your existing CI/CD platform as well as your bug-tracker and creates a live dashboard for the Dora 4 keys:

  • Lead Time for Changes
  • Deployment Frequency
  • Change Failure Rate
  • Time to Restore Service

Getting started

Requirements

Any server with Docker already installed

Docker compose

  1. Copy both files from the ./docker-compose folder to a folder on your server
  2. Fill the .env.client file with the values from your system
Value Description
LICENSE_TOKEN Create an account on defactops.com and follow the instructions to start a free trial or paid subscription.
POSTGRES_PASSWORD Make sure to change that one to anything else
GITLAB_API_TOKEN In Gitlab, go to your icon > Preferences > Access Tokens. Add a new token and give it the read_api permission.
GITLAB_PROJECT_ID From the project you wish to monitor in Gitlab, go to Settings > General. The project ID is available at the top of the page
GITLAB_ENVIRONMENT_NAME This is your "production" environment, from the Operate > Environment section in Gitlab
JIRA_TOKEN In Jira, go to your icon > Profile > Manage your account > Security. From there select "Create API token" and follow the instructions
JIRA_FAILURE_LABEL This is a label to indicate that an issue was found after a release was launched in production. Simply add the label you choose to any issue.
LEADTIME_START_EVENT Select how the leatime should be calculated. Choices are "commit" or "ticket-in-progress"
  1. Launch the server:
    docker compose --file docker-compose-defactops.yml --env-file .env.client up

Helm

  1. Create a folder on your PC and copy the content of the ./helm folder
  2. Fill the values.yaml file with the values from your system. The variables definitions can be found in the docker-compose section above.
  3. Add the CloudNative postgres operator to postgres
helm repo add cloudnative-pg https://cloudnative-pg.github.io/charts
helm repo update
helm install cnpg cloudnative-pg/cloudnative-pg --namespace cloudnative-test --create-namespace
  1. Start the helm distribution with the following command
kubectl create namespace defactops
helm repo add defactops https://defactops.github.io/defactops-helm
helm repo update
helm install -n defactops -f ./values.yaml defactops-release defactops/defactops

Supported platforms

For the moment, only Gitlab and Jira are supported as CI/CD and issue trackers. We are working on adding other platforms, please let us know what would suit your needs.

For any question or comments, contact us at info@defactops.com

Popular repositories Loading

  1. defactops defactops Public

    This repo contains the procedure to setup a De factOps server

  2. defactops-helm defactops-helm Public

    Helm charts for the defactops server