# vespa-core

**Repository Path**: mirrors_Orange-OpenSource/vespa-core

## Basic Information

- **Project Name**: vespa-core
- **Description**: Vespa is a IaaS cloud security framework. It is based on security automation.
- **Primary Language**: Unknown
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2025-10-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## Synopsis

This project is the core of the VESPA framework. It can enable communications between heterogeneous components.

[![Build Status](https://travis-ci.org/Orange-OpenSource/vespa-core.svg?branch=master)](https://travis-ci.org/Orange-OpenSource/vespa-core) [![Build Status](https://readthedocs.org/projects/vespa-core/badge/?version=latest)](http://vespa-core.readthedocs.org/en/latest/) [![Coverage Status](https://img.shields.io/coveralls/Orange-OpenSource/vespa-core.svg)](https://coveralls.io/r/Orange-OpenSource/vespa-core)

## Getting started

The tutorial (branch tutorial) delivers the basic of agent implementation and how to manage alerts on the Vertical Orchestrator.

## Code Example

The politics are defined as Finite State Machine in Python. It enables easy parametrization and comprehensive view of autonomic loops. The ``alert`` function is the main component of the orchestration.

Agent nodes are linked to security components, such as firewalls and anti-viruses, and mediate vendor lock-ins with the framework orchestration APIs. The functions are exported to other nodes and can be called automatically. The ``sendRemote`` function is a primitive to communicate with other nodes.

## Motivation

The VESPA framework aims at giving the building block for an autonomic security on cloud computing environments.

## Installation

Grab the core files of the project with the following commands:

```bash
git clone https://github.com/Orange-OpenSource/vespa-core
cd vespa-core
pip install -r requirements.txt
```

A convenient way to start is to follow the tutorial (branch tutorial) and setup a local environment.

## Documentation

The [documentation](http://vespa-core.readthedocs.org/en/latest/) is available on readthedocs.org.

The API of nodes is described into the code as docstrings. It can be built with the following command in the root directory :

```bash
sphinx-apidoc2 -f -o docs vespa
```

Or to another format with a new project (-F option).

## Tests

Numerous unit tests are defined to test various code functionality. You can run the test suite with the following commands in the root directory :

```bash
python2 setup.py test
```

or

```bash
py.test2
```

## Contributors

Aurélien Wailly, Marc Lacoste, Kévin Grandemange, Aymerik Tabourin.

## License

The code is released as LGPL v2.1, and contains some third-party code under MIT license.