keyrequest_monitor/readme.md

1.2 KiB

Key Request Monitor

This repository holds the code to generate the Key Request Report.

Ouput is an excel file of all key requests used in slos, which has no data for 1M and 1W.

Prerequisites

Python packages

Before executing scripts, python requirements have to be satisfied. To do so, execute following command: pip install -r requirements.txt

.env file

To provide authentication for API calls, create ".env" file in the script directory with following definition:

<ENV NAME>=<ENV TOKEN>
	<ENV NAME> is name of environment variable. This name should be passed to "environment.yaml" file as "env-token-name" parameter
	Example:
	environment.yaml file: "- env-token-name: "GLOBAL_CONFIG_TOKEN"
	.env file: "GLOBAL_CONFIG_TOKEN=XXXXXXXXXXX"

Usage

python createKeyRequestReport.py

Files

createKeyRequestReport.py

This scripts generates the report.

environment.yaml

File containing environments to execute --auto-upload

Environment name:
	name: string										#name ov environment
	env-url: str										#url of environment
	env-token-name: str								#name of environment variable containing API token

requirements.txt

File containing required python packages