https://github.com/redhatinsights/yuptoo
The Yupana Upload Processor II
https://github.com/redhatinsights/yuptoo
Last synced: about 2 months ago
JSON representation
The Yupana Upload Processor II
- Host: GitHub
- URL: https://github.com/redhatinsights/yuptoo
- Owner: RedHatInsights
- License: apache-2.0
- Created: 2022-02-03T12:32:08.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-14T01:24:48.000Z (about 2 months ago)
- Last Synced: 2025-04-14T01:35:39.121Z (about 2 months ago)
- Language: Python
- Size: 406 KB
- Stars: 6
- Watchers: 21
- Forks: 23
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Yupana Upload Processor II
## How it Works
See more details in this [Yuptoo Documentation](https://inscope.corp.redhat.com/docs/default/Component/yuptoo/).
## What is different in yuptoo compared to legacy yupana
- No database.
- No explicit state-machine.
- No django service for readiness and liveness probes.
- More robust and decoupled code.
## Usage
```python
pipenv install --dev
pipenv run python main.py
```
## Modifiers
Yuptoo has the concept of modifiers which are used for manipulating host data before sending it to host inventory.
Read more about modifiers - [yuptoo/modifiers](https://github.com/RedHatInsights/yuptoo/tree/main/yuptoo/modifiers)
## Testing and Linting
To run pytest hit the below command in yuptoo root directory
```
pipenv run python -m pytest
```
For linting run the below command.
```
pipenv run flake8
```
## Running with Docker Compose
Two docker-compose files are made available in this repo for standing up a local dev environment. The `full-stack.yml` file stands up ingress, kafka, yuptoo, minio, and inventory components so that the entire first bits of the platform pipeline can be tested. The `docker-compose.yml` file stands up services without yuptoo, the yuptoo can be run manaully in local for development tests.
Stand Up Full Stack
```sh
cd scripts && source .env && sudo docker-compose -f full-stack.yml up
```
Stand Up Yuptoo Manually outside the docker-compose
```sh
cd scripts && source .env && sudo docker-compose up
```
Read more about local development tests env - [docs/local_environment.md](https://github.com/RedHatInsights/yuptoo/tree/main/docs/local_environment.md)
**NOTE**: The full stack expects you to have an ingress and inventory image available, by default, those will be pulled from quay.io. See those projects for steps for building the images needed.