Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ See the License for the specific language governing permissions and
limitations under the License.
-->

# Morpheus Feedback API
# RHTPA exploit intelligence feedback API

The **Morpheus Feedback API** is a Python Flask-based microservice designed to serve as an integration layer between the Quarkus-based Morpheus application and the Argilla backend. Its primary goal is to accept user feedback data from the Morpheus clients and forward it to the hosted Argilla instance using the Argilla Python SDK.
The **RHTPA exploit intelligence feedback API** is a Python Flask-based microservice designed to serve as an integration layer between the Quarkus-based RHTPA exploit intelligence application and the Argilla backend. Its primary goal is to accept user feedback data from the RHTPA exploit intelligence clients and forward it to the hosted Argilla instance using the Argilla Python SDK.

---

Expand Down Expand Up @@ -42,7 +42,7 @@ The **Morpheus Feedback API** is a Python Flask-based microservice designed to s

## Architecture Overview

The Morpheus Feedback API is designed as part of a multi-container Pod on OpenShift. The Pod includes:
The RHTPA exploit intelligence feedback API is designed as part of a multi-container Pod on OpenShift. The Pod includes:

- **Flask Service:** Serves as the external entry point for feedback data.
- **Argilla Server & Dependencies:** The Argilla backend (including Argilla Server, Worker, Redis, PostgreSQL, and Elasticsearch) runs as sidecar containers.
Expand All @@ -53,7 +53,7 @@ The Morpheus Feedback API is designed as part of a multi-container Pod on OpenSh
## Project Structure

```plaintext
Morpheus Feedback API
RHTPA exploit intelligence feedback API
├── app/ # Flask application code
│ ├── __init__.py # Application factory
│ ├── routes.py # API route definitions
Expand Down Expand Up @@ -83,8 +83,8 @@ Morpheus Feedback API

1. Clone the Repository:
```
git clone https://github.com/your-repo/morpheus-feedback-api.git
cd morpheus-feedback-api
git clone https://github.com/your-repo/exploit-intelligence-feedback-api.git
cd exploit-intelligence-feedback-api
```
2. Create a Virtual Environment:

Expand All @@ -99,7 +99,7 @@ Morpheus Feedback API
pip install -r requirements.txt
```

**Note:** The configuration is set with default values, which can be viewed in the configuration file- `morpheus-feedback-api/app/config.py`
**Note:** The configuration is set with default values, which can be viewed in the configuration file- `exploit-intelligence-feedback-api/app/config.py`

To change the configuration, you must set the following environment variables before running the application.

Expand Down
2 changes: 1 addition & 1 deletion app/init_argilla.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ def create_dataset(api_url: str, api_key: str, workspace: str, dataset_name: str
questions=[
rg.LabelQuestion(
name="accuracy",
title="How accurate do you find ExploitIQ's assessment?",
title="How accurate do you find RHTPA exploit intelligence's assessment?",
labels=[
"Very Accurate",
"Mostly Accurate",
Expand Down
2 changes: 1 addition & 1 deletion deploy/argilla-service.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
app: argilla
spec:
selector:
app: morpheus-feedback-api
app: exploit-intelligence-feedback-api
ports:
- protocol: TCP
port: 6900
Expand Down
8 changes: 4 additions & 4 deletions deploy/deployment.yaml
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
apiVersion: apps/v1
kind: Deployment
metadata:
name: morpheus-feedback-api
name: exploit-intelligence-feedback-api
labels:
app: morpheus-feedback-api
app: exploit-intelligence-feedback-api
spec:
replicas: 1
selector:
matchLabels:
app: morpheus-feedback-api
app: exploit-intelligence-feedback-api
template:
metadata:
labels:
app: morpheus-feedback-api
app: exploit-intelligence-feedback-api
spec:
imagePullSecrets:
- name: argilla-user-feedback-ips
Expand Down
6 changes: 3 additions & 3 deletions deploy/service.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
apiVersion: v1
kind: Service
metadata:
name: morpheus-feedback-api
name: exploit-intelligence-feedback-api
labels:
app: morpheus-feedback-api
app: exploit-intelligence-feedback-api
spec:
selector:
app: morpheus-feedback-api
app: exploit-intelligence-feedback-api
ports:
- protocol: TCP
port: 5001
Expand Down