← Back to branch summary

~plumgrid-team/charms/bundles/plumgrid-ons/single-controller

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Julian Neytchev
  • Date: 2015-05-28 05:26:19 UTC
  • Revision ID: juliann@plumgrid.com-20150528052619-ofog38gwlwcsqw5i
Removed juju-gui

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.md
1
 
# Basic OpenStack Cloud with PLUMgrid Open Networking Suite (ONS)
 
1
================
 
2
PLUMgrid ONS
 
3
================
2
4
 
3
5
PLUMgrid Open Networking Suite (ONS) helps enterprises and service providers operationalize their OpenStack cloud’s virtual network and SDN deployments.
4
6
 
6
8
 
7
9
The distributed architecture can scale to multi-rack or geographically distributed OpenStack deployments while the high availability features ensure maximum service uptime while minimizing downtime during maintenance windows. The product suite also simplifies ongoing operations with built-in monitoring, analytics and troubleshooting tools. By providing a comprehensive suite of capabilities, PLUMgrid ONS for OpenStack overcomes the scale, availability, feature set and lifecycle limitations of OpenStack Networking.
8
10
 
9
 
This bundle deploys a OpenStack Cloud (Kilo release) on Ubuntu 14.04 LTS, providing Dashboard, Compute, Network (PLUMgrid), Block Storage (Cinder), Identity and Image services.
10
 
 
11
 
## PLUMgrid Components
12
 
 
13
 
Neutron Api PLUMgrid
14
 
  PLUMgrid Neutron Plugin enables PLUMgrid Open Networking Suite in Openstack. Once deployed, the charm enables the necessary actions in the neutron-server container that allows the PLUMgrid plugin to take over networking for the OpenStack environment.
 
11
Installing PLUMgrid ONS along with OpenStack using Juju charms consists of
 
12
        Installing the various required components for OpenStack
 
13
        Installing the PLUMgrid software components using the provided charms
 
14
 
 
15
 
 
16
Neutron IOvisor
 
17
---------------
 
18
TODO: Blurb describing the charm
 
19
 
 
20
Neutron PLUMgrid plugin
 
21
---------------
 
22
TODO: Blurb describing the charm
15
23
 
16
24
PLUMgrid Director
17
 
  The PLUMgrid Director is the control plane of PLUMgrid ONS for OpenStack. The configuration of the virtual network infrastructure for tenants is done through the PLUMgrid Director.
 
25
---------------
 
26
TODO: Blurb describing the charm
18
27
 
19
28
PLUMgrid Edge
20
 
  A PLUMgrid Edge is an OpenStack compute node running IO Visor. IO Visor provides the data plane and network connectivity for OpenStack tenant instances. Communication between instances on compute nodes is enabled by creation of VXLAN based overlay tunnels and networks.
 
29
---------------
 
30
TODO: Blurb describing the charm
21
31
 
22
32
PLUMgrid Gateway
23
 
  A PLUMgrid Gateway provides connectivity from the VXLAN based virtual fabric to external IP networks (such as for internet access). The PLUMgrid Gateway can be deployed as a pair in Active/ Active mode for load balancing of traffic and high availability of external connectivity.
24
 
 
25
 
## Requirements
26
 
 
27
 
This bundle is designed to run on bare metal using Juju with [MAAS][] (Metal-as-a-Service); you will need to have setup a [MAAS][] deployment with a minimum of 3 physical servers prior to using this bundle.
28
 
 
29
 
Servers should have:
30
 
 
31
 
 - A minimum of 8GB of physical RAM.
32
 
 - Enough CPU cores to support your capacity requirements.
33
 
 - Two cabled network ports on eth0 and eth1 (see below).
34
 
 - MTU of atleast 1580 needs to be supported by the managment network of MAAS.
35
 
 
36
 
Servers should have two physical network ports cabled; the first is used for general communication between services in the Cloud, the second is used for 'public' network traffic to and from instances (North/South traffic) running within the Cloud.
37
 
 
38
 
## Deployment
39
 
 
40
 
    juju quickstart bundle:plumgrid-ons
41
 
    juju set neutron-api plumgrid-virtual-ip="<Any IP in subnet>"
42
 
    juju set plumgrid-director plumgrid-virtual-ip="<Same IP as above>"
43
 
 
44
 
### Accessing Openstack Dashboard
45
 
 
46
 
Get Horizon IP from openstack-dashboard charm.
47
 
 
48
 
    juju status openstack-dashboard
49
 
 
50
 
### Accessing PLUMgrid Console
51
 
 
52
 
Get PLUMgrid Console IP from the plumgrid-director charm config.
53
 
 
54
 
    juju get plumgrid-director
55
 
 
56
 
### Post PLUMgrid License
57
 
In order to configure networking, PLUMgrid License needs to be posted.
58
 
 
59
 
    juju set plumgrid-director plumgrid-license-key="$LICENSE_KEY"
60
 
 
61
 
## Components
62
 
 
63
 
 - 1 Node for PLUMgrid Director and Mysql, Rabbitmq Server, Keystone, Nova Cloud Controller, Glance, Horizon and Cinder under LXC containers.
64
 
 - 1 Node for Nova Compute and PLUMgrid Edge.
65
 
 - 1 Node for PLUMgrid Gateway.
66
 
 
67
 
PLUMgrid Open Networking Suite (ONS) is built with the ability to scale and support high availability across the PLUMgrid Platform. PLUMgrid ONS supports high availability across multiple components within a PLUMgrid Zone. PLUMgrid Director, PLUMgrid edge running on Nova Compute and PLUMgrid Gateway are designed to be horizontally scalable.
68
 
 
69
 
To horizontally scale PLUMgrid Director:
70
 
 
71
 
    juju add-unit -n2 plumgrid-director #Note that PLUMgrid Director HA works with 3 units only.
72
 
    juju set neutron-api plumgrid-virtual-ip="<Any IP in subnet>"
73
 
    juju set plumgrid-director plumgrid-virtual-ip="<Same IP as above>"
74
 
 
75
 
To horizontally scale Nova Compute running with PLUMgrid Edge:
76
 
 
77
 
    juju add-unit nova-compute # Add one more unit
78
 
    juju add-unit -n5 nova-compute # Add 5 more units
79
 
 
80
 
To horizontally scale PLUMgrid Gateway:
81
 
 
82
 
    juju add-unit plumgrid-gateway # Add one more unit
83
 
    juju add-unit -n2 plumgrid-gateway # Add 2 more units
84
 
 
85
 
 
86
 
##Contact Information
87
 
 
88
 
Bilal Baqar <bbaqar@plumgrid.com>
89
 
Bilal Ahmad <bilal@plumgrid.com>
90
 
 
91
 
PLUMgrid, Inc.
92
 
5155 Old Ironsides Dr, Suite 200, Santa Clara, CA 95054, U.S.A | Ph:+1-408-800-7586
93
 
Web: [www.plumgrid.com][]
94
 
Email: info@plumgrid.com
95
 
 
96
 
[MAAS]: http://maas.ubuntu.com/docs
97
 
[www.plumgrid.com]: http://www.plumgrid.com/
 
33
---------------
 
34
TODO: Blurb describing the charm
 
35
 
 
36
#Usage
 
37
TODO: juju deploy X, etc.
 
38
 
 
39
TODO: incompatible stuff here
 
40
 
 
41
#Contact Information
 
42
PLUMgrid, Inc. 
 
43
350 Oakmead Parkway, Suite 250 
 
44
Sunnyvale, CA 94085