Skip to content
Snippets Groups Projects
Commit 4580fdf3 authored by Helen Koike's avatar Helen Koike
Browse files

add a README.md

parent 047f866d
No related branches found
No related tags found
No related merge requests found
# KCIDB Triage Tool
## Overview
The KCIDB Triage Tool provides a server and client interface to submit issues and incidents to the KernelCI Database (KCIDB). It allows users to report issues and create incidents associated with existing issues via a REST API or a command-line interface.
## Installation of the server
```bash
git clone https://github.com/yourusername/kcidb-triage.git
cd kcidb-triage
pip install -r requirements.txt
```
### Google Cloud Credentials
Set the GOOGLE_APPLICATION_CREDENTIALS environment variable to point to your Google Cloud credentials JSON file:
```bash
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/your/credentials.json
```
### Running the Server
```bash
cd server
python3 ./kcidb-triage-server.py
```
The web interface will be available at http://localhost:5000.
## Usage of kcidb-triage.py Tool
The kcidb-triage.py tool allows you to interact with the KCIDB Triage server from the command line.
### Configuration file
Create a file named `~/.kcidb-triage.conf` with the following content:
```ini
[user]
name = Your Name
email = your.email@example.com
[server]
url = http://localhost
port = 5000
```
### Creating an Issue
```bash
./kcidb-triage.py issues create --report_subject "Issue Subject" --culprit-type "code" --report_url "http://example.com" --comment "This is a comment" --misc '{"key": "value"}' --dry-run
```
Remove the `--dry-run` option to actually create the issue
### Creating Incidents
To create incidents associated with an existing issue:
```bash
cat file-with-ids-list.txt | ./kcidb-triage.py incidents create --issue_id "issue_id" --issue_version 1 --incident_type "build" --comment "This is a comment" --misc '{"key": "value"}' --dry-run
```
Remove the `--dry-run` option to actually create the incidents
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment