Iris core, API, UI and sender service
Project description
Iris
Iris core, API, UI and sender service. For third-party integration support, see iris-relay, a stateless proxy designed to sit at the edge of a production network and allow external traffic to pass through.
Setup database
- remove
ONLY_FULL_GROUP_BY
from MySQL configsql_mode
- create mysql schema:
mysql -u USER -p < ./db/schema_0.sql
- import dummy data:
mysql -u USER -p -o iris < ./db/dummy_data.sql
dummy_data.sql
contains the following entities:
- user
demo
with passworddemo
- team
demo_team
- application
Autoalerts
with key:a7a9d7657ac8837cd7dfed0b93f4b8b864007724d7fa21422c24f4ff0adb2e49
Setup dev environment
- create & source your virtualenv
- install build dependencies:
libssl-dev libxml2-dev libxslt1-dev libsasl2-dev python-dev libldap2-dev
- run
pip install -e '.[dev,kazoo]'
- edit ./configs/config.dev.yaml to setup database credential and other settings
To install iris with extra features, you can pass in feature flag with pip:
pip install -e '.[prometheus]'
For list of extra features, please see extras_require
setting in setup.py
.
Run everything
forego start
Run web server
make serve
Run sender
iris-sender configs/config.dev.yaml
Tests
Run tests:
make test # all tests, e2e + unit
make e2e # e2e tests
make unit # unit tests
Generate test coverage reports:
make e2e-cov
make unit-cov
Adding new plugins
- create the plugin file under
src/iris/plugins
dir - edit
src/iris/plugins/__init__.py
to add plugin module to__all__
list
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
irisapi-0.0.4.tar.gz
(900.5 kB
view details)
Built Distribution
irisapi-0.0.4-py2-none-any.whl
(937.4 kB
view details)
File details
Details for the file irisapi-0.0.4.tar.gz
.
File metadata
- Download URL: irisapi-0.0.4.tar.gz
- Upload date:
- Size: 900.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/2.7.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c1647300c40301130d2ceec4f61a59a427198e484983d6b5ec3c5ae72938b92 |
|
MD5 | ca39e23f4dc9a647c04e492ecafb3993 |
|
BLAKE2b-256 | 7bd8cf9ceb80af5e17400dd926d2c62f6c73481df70140b7b82aa4b3d42dd82e |
File details
Details for the file irisapi-0.0.4-py2-none-any.whl
.
File metadata
- Download URL: irisapi-0.0.4-py2-none-any.whl
- Upload date:
- Size: 937.4 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/2.7.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4aa677c1a39c6d257dea62e2d4ad858364051cb92f6d913d485473a77f7013ad |
|
MD5 | 09f785b438773a9b6c65ab52ca9aed39 |
|
BLAKE2b-256 | 0866d2e2d615237993cbbc4cc12f683532c390f051b1888816a1ef7879681e19 |