← Back to branch summary

~openstack-charmers-archive/charms/trusty/neutron-gateway/trunk

« back to all changes in this revision

Viewing changes to README.md

  • Committer: James Page
  • Date: 2015-10-22 13:23:58 UTC
  • Revision ID: james.page@ubuntu.com-20151022132358-qin1nvlnqn4aezaz
Tags: 15.10
15.10 Charm release

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.md
4
4
Neutron provides flexible software defined networking (SDN) for OpenStack.
5
5
 
6
6
This charm is designed to be used in conjunction with the rest of the OpenStack
7
 
related charms in the charm store) to virtualized the network that Nova Compute
 
7
related charms in the charm store to virtualize the network that Nova Compute
8
8
instances plug into.
9
9
 
10
 
Its designed as a replacement for nova-network; however it does not yet
11
 
support all of the features as nova-network (such as multihost) so may not
 
10
It's designed as a replacement for nova-network; however it does not yet
 
11
support all of the features of nova-network (such as multihost) so may not
12
12
be suitable for all.
13
13
 
14
14
Neutron supports a rich plugin/extension framework for propriety networking
20
20
Usage
21
21
-----
22
22
 
23
 
In order to use Neutron with Openstack, you will need to deploy the
 
23
In order to use Neutron with OpenStack, you will need to deploy the
24
24
nova-compute and nova-cloud-controller charms with the network-manager
25
25
configuration set to 'Neutron':
26
26
 
27
27
    nova-cloud-controller:
28
28
        network-manager: Neutron
29
29
 
30
 
This decision must be made prior to deploying Openstack with Juju as
 
30
This decision must be made prior to deploying OpenStack with Juju as
31
31
Neutron is deployed baked into these charms from install onwards:
32
32
 
33
33
    juju deploy nova-compute
43
43
 
44
44
The gateway provides two key services; L3 network routing and DHCP services.
45
45
 
46
 
These are both required in a fully functional Neutron Openstack deployment.
 
46
These are both required in a fully functional Neutron OpenStack deployment.
47
47
 
48
48
See upstream [Neutron multi extnet](http://docs.openstack.org/trunk/config-reference/content/adv_cfg_l3_agent_multi_extnet.html)
49
49
 
53
53
External Port Configuration
54
54
===========================
55
55
 
56
 
If the port to be used for external traffic is consistent accross all physical
 
56
If the port to be used for external traffic is consistent across all physical
57
57
servers then is can be specified by simply setting ext-port to the nic id:
58
58
 
59
59
    neutron-gateway:
60
60
        ext-port: eth2
61
61
 
62
62
However, if it varies between hosts then the mac addresses of the external
63
 
nics for each host can be passed as a space seperated list:
 
63
nics for each host can be passed as a space separated list:
64
64
 
65
65
    neutron-gateway:
66
66
        ext-port: <MAC ext port host 1> <MAC ext port host 2> <MAC ext port host 3>
71
71
 
72
72
If multiple floating pools are needed then an L3 agent (which corresponds to
73
73
a neutron-gateway for the sake of this charm) is needed for each one. Each
74
 
gateway needs to be deployed as a seperate service so that the external
 
74
gateway needs to be deployed as a separate service so that the external
75
75
network id can be set differently for each gateway e.g.
76
76
 
77
77
    juju deploy neutron-gateway neutron-gateway-extnet1
100
100
 
101
101
    juju set neutron-gateway instance-mtu=1400
102
102
 
103
 
OpenStack upstream documentation recomments a MTU value of 1400:
104
 
[Openstack documentation](http://docs.openstack.org/admin-guide-cloud/content/openvswitch_plugin.html)
 
103
OpenStack upstream documentation recommends a MTU value of 1400:
 
104
[OpenStack documentation](http://docs.openstack.org/admin-guide-cloud/content/openvswitch_plugin.html)
105
105
 
106
106
Note that this option was added in Havana and will be ignored in older releases.
107
107
 
125
125
Note that there are only two 'name' values the charm knows about: 'requirements'
126
126
and 'neutron'. These repositories must correspond to these 'name' values.
127
127
Additionally, the requirements repository must be specified first and the
128
 
neutron repository must be specified last. All other repostories are installed
 
128
neutron repository must be specified last. All other repositories are installed
129
129
in the order in which they are specified.
130
130
 
131
131
The following is a full list of current tip repos (may not be up-to-date):