SIENTIAPDE-1017
Enhance OPC ingestor with Redis authentication and update Helm chart configurations. Improve README for clarity on Docker and Kubernetes setup.
This commit is contained in:
44
README.md
44
README.md
@@ -3,58 +3,58 @@ OPC gateway to manage Scouter pipelines
|
||||
|
||||
## Local tests
|
||||
### Generate your ssh key to Docker
|
||||
'''
|
||||
```
|
||||
ssh-keygen -t ed25519 -C "docker-access" -f ~/.ssh/id_ed25519_docker
|
||||
'''
|
||||
```
|
||||
Add the public key to yout Git SSH keys
|
||||
|
||||
### Enable Docker BuildKit
|
||||
'''
|
||||
```
|
||||
export DOCKER_BUILDKIT=1
|
||||
'''
|
||||
```
|
||||
or make it permanent:
|
||||
'''
|
||||
```
|
||||
echo '{ "features": { "buildkit": true } }' | sudo tee /etc/docker/daemon.json
|
||||
sudo systemctl restart docker
|
||||
'''
|
||||
```
|
||||
|
||||
### Run docker compose
|
||||
'''
|
||||
```
|
||||
docker compose down -v
|
||||
docker compose build --ssh default=$HOME/.ssh/id_ed25519_docker
|
||||
docker compose up -d
|
||||
'''
|
||||
```
|
||||
|
||||
### Populate redis server
|
||||
Create venv with python3.11
|
||||
'''
|
||||
```
|
||||
python3.11 -m venv venv
|
||||
source ./venv/bin/activate
|
||||
'''
|
||||
```
|
||||
Install requirements
|
||||
'''
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
'''
|
||||
```
|
||||
Run feeder
|
||||
'''
|
||||
```
|
||||
python simulator/redis-feeder.py
|
||||
'''
|
||||
```
|
||||
|
||||
## Unit tests
|
||||
### Install pytest
|
||||
'''
|
||||
```
|
||||
pip install pytest
|
||||
'''
|
||||
```
|
||||
### Run pytest
|
||||
'''
|
||||
```
|
||||
pytest
|
||||
'''
|
||||
```
|
||||
### Get current coverage
|
||||
'''
|
||||
```
|
||||
pip install pytest-cov
|
||||
pytest --cov=ingestor
|
||||
'''
|
||||
```
|
||||
### Generate complete report
|
||||
'''
|
||||
```
|
||||
pytest --cov=ingestor --cov-report=html
|
||||
'''
|
||||
```
|
||||
Reference in New Issue
Block a user