The Romana Project - Installation scripts, documentation, issue tracker and wiki. Start here.
Shell Go Ruby
Latest commit ab9ff80 Aug 11, 2017 @chrismarino chrismarino committed on GitHub Added reference to preview release.
Added reference to preview release.

README.md

The Romana Project

Romana is a new network and security automation solution for Cloud Native applications. Romana automates the creation of isolated Cloud Native Networks and secures applications with a distributed firewall that applies access control policies consistently across all endpoints and services, wherever they run.

A preview release of Romana v2.0 is availble here. It includes important new features, including topology aware IPAM for multi-network deployment and ways to build large and HA Kubernetes clusters with native VPC networking in EC2. More details here

Code

This repository contains the installer and documentation. The Romana source code, however, is contained in these repositories:

  • core: A number of micro services written in Go, which comprise the core components of the Romana system.
  • networking-romana: The Romana ML2 plugin and IPAM driver for OpenStack

The READMEs of those repos contain more information about the source code and how to run and test it.

Installation

To get up and running with Romana, some scripts and Ansible playbooks have been provided to automate the setup and deployment. This can be used to set up a cluster for experimenting with Romana, exploring how it works and learning how it interacts with Kubernetes and/or Openstack.

The installer is currently capable of setting up a stand-alone Kubernetes or OpenStack-Devstack cluster. As deployment targets for those clusters, it supports Amazon EC2, local Vagrant VMs, or user-provided ("static") hosts.

See the romana-setup page for details about the installer and the full set of command-line options available.

If you wish to install Romana as a Kubernetes add-on using kubeadm, or use kops for installation on EC2, see the README file in the containerize directory.

Additional installation platforms are being targeted. You can express your interest in specific platforms or get help with manually installing Romana by contacting us.

Using Romana

Once you have Romana installed and running in a cluster, you might like to test its capabilities and see it in action. The two links below give you cluster specific suggestions of what to try and what to explore and look at.

Contact Us

There are a number of ways in which you can contact us if you have any questions about deploying or using Romana, or about contributing to our code.