Add a README

This commit is contained in:
James Page 2016-07-01 10:15:04 +01:00
parent 86d37b6bbe
commit 9d8a6aa23c
1 changed files with 18 additions and 0 deletions

18
README.md Normal file
View File

@ -0,0 +1,18 @@
# Overview
This layer provides the base layer for OpenStack charms that are will deploy
API services, and provides all of the core functionality for:
- HA (using the hacluster charm)
- SSL (using configuration options or keystone for certificates)
- Juju 2.0 network space support for API endpoints
- Configuration based network binding of API endpoints
To use this layer, including the following in the layer.yaml of your charm:
include: ['layer:openstack-principle']
And then read the [new API charm](https://github.com/openstack/charm-guide/blob/master/doc/source/new-charm.rst)
guide for details on how to use this layer in-conjuction with the
charms.openstack Python module to quickly and easily put together a
new API charm.