← Back to branch summary

~ionutbalutoiu/charms/trusty/neutron-api/next

« back to all changes in this revision

Viewing changes to README.md

  • Committer: James Page
  • Date: 2014-06-24 14:11:30 UTC
  • Revision ID: james.page@ubuntu.com-20140624141130-lna9tlo8xa1kwsa2
Tweak docs to look nicer

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.md
1
 
Overview                                                                                                                                                                                                      
2
 
--------
3
 
 
4
 
This principle charm provides the Neutron API service which was previously
5
 
provided by the nova-cloud-controller charm. When this charm is joined with
6
 
the nova-cc charm the nova-cc charm will shutdown its api service, deregister
7
 
it from neutron and inform the compute nodes of the new neutron url. This
8
 
charm expects the following relations:
9
 
 
10
 
1) neutron-plugin-api relation with subordinate neutron plugin charms
11
 
   (such as neutron-openvswitch)
12
 
2) neutron-api relation with nova-cloud-controller
13
 
3) Database backend
14
 
4) amqp relation with message broker. If a single message broker is being used for 
15
 
   the openstack deployemnt then it can relat to that. If a seperate neutron 
16
 
   message broker is being used it should relate to that.
17
 
5) identity-service relation
18
 
6) ha relation with ha subordinate
 
1
# Overview 
 
2
 
 
3
This principle charm provides the OpenStack Neutron API service which was previously provided by the nova-cloud-controller charm.
 
4
 
 
5
When this charm is related to the nova-cloud-controller charm the nova-cloud controller charm will shutdown its api service, de-register it from keystone and inform the compute nodes of the new neutron url.
 
6
 
 
7
# Usage
 
8
 
 
9
To deploy (partial deployment only):
 
10
 
 
11
    juju deploy neutron-api
 
12
    juju deploy neutron-openvswitch
 
13
 
 
14
    juju add-relation neutron-api mysql
 
15
    juju add-relation neutron-api rabbitmq-server
 
16
    juju add-relation neutron-api neutron-openvswitch
 
17
    juju add-relation neutron-api nova-cloud-controller
 
18
 
 
19
This charm also supports scale out and high availability using the hacluster charm:
 
20
 
 
21
    juju deploy hacluster neutron-hacluster
 
22
    juju add-unit neutron-api
 
23
    juju set neutron-api vip=<VIP FOR ACCESS>
 
24
    juju add-relation neutron-hacluster neutron-api
 
25
 
 
26
# Restrictions
 
27
 
 
28
This charm only support deployment with OpenStack Icehouse or better.