tsg-tsg-diagnose/README.md

# TSG Diagnose
TSG Diagnose is a tool designed to check the basic functionality and availability of TSG.
## Introduction
TSG Diagnose comprises multiple test cases, each simulating real user requests. The outcome of these requests determines whether a case is successful. 
TSG Diagnose uses containers to construct realistic client and server environments for these tests. 
Currently, the TSG Diangose feature supports running in both Docker and k3s environments.
## Installation
You can install TSG Diagnose RPM on a TSG-OS machine. Ensure that you install the TSG-OS YUM repository before proceeding with the installation.
```bash
dnf install tsg-diagnose
```
### Docker
If you have installed TSG Diagnose with Docker support, you can use the following command to build the TSG Diagnose runtime environment.
```bash
docker load < /opt/tsg/tsg-diagnose/images/tsg-diagnose-images.tar
docker-compose down --remove-orphans; docker-compose up -d --remove-orphans
```
### k3s
If you have installed TSG Diagnose with k3s support, you can use the following command to build the TSG Diagnose runtime environment.
```bash
k3s ctr image import /opt/tsg/tsg-diagnose/images/tsg-diagnose-images.tar
kubectl apply -f /opt/tsg/tsg-diagnose/k8s-resource/tsg-diagnose.yaml
```
## Usage
There are two commands available to run TSG Diagnose:
1. tsg-diagnose-oneshot: Runs the test cases in a one-shot mode.
2. tsg-diagnose-periodical: Runs the test cases periodically.
```bash
# Run test cases once
tsg-diagnose-oneshot
# Run test cases periodically
tsg-diagnose-periodical
```