Changing Description and README

This commit is contained in:
Bilal Baqar 2015-07-02 02:52:28 -07:00
parent a41ff72e68
commit d7165da02e
3 changed files with 67 additions and 27 deletions

62
README.ex Normal file
View File

@ -0,0 +1,62 @@
# Overview
This charm is responsible for configuring a node as a PLUMgrid Gateway.
Once deployed the charm triggers the necessary services for a PLUMgrid Gateway and configures the IO Visor kernel module as a PLUMgrid Software Gateway. It also configures additional interfaces on the node for external connectivity.
# Usage
Step by step instructions on using the charm:
juju deploy neutron-api
juju deploy neutron-plumgrid-plugin neutron-api
juju deploy neutron-iovisor
juju deploy plumgrid-director --to <Machince No of neutron-iovisor>
juju add-unit neutron-iovisor
juju deploy plumgrid-edge --to <Machice No of 2nd unit of neutron-iovisor>
juju add-unit neutron-iovisor
juju deploy plumgrid-gateway --to <Machice No of 3rd unit of neutron-iovisor>
juju add-relation neutron-api neutron-plumgrid-plugin
juju add-relation neutron-plumgrid-plugin neutron-iovisor
juju add-relation neutron-iovisor plumgrid-director
juju add-relation neutron-iovisor plumgrid-edge
juju add-relation neutron-iovisor plumgrid-gateway
juju add-relation plumgrid-director plumgrid-edge
juju add-relation plumgrid-director plumgrid-gateway
For plumgrid-gateway to work make the configuration in the neutron-api, neutron-plumgrid-plugin, neutron-iovisor, plumgrid-director and plumgrid-edge charms as specified in the configuration section below.
## Known Limitations and Issues
This is an early access version of the PLUMgrid Gateway charm and it is not meant for production deployments. The charm currently only supports JUNO. This charm needs to be deployed on a node where a unit of neutron-iovisor charm exists. Also plumgrid-director and plumgrid-edge charms should not be deployed on the same node.
# Configuration
plumgrid-edge charm does not require any configuration itself but the following config is required in the other charms.
Example Config
plumgrid-gateway:
external-interface: eth1
plumgrid-director:
plumgrid-virtual-ip: "192.168.100.250"
neutron-iovisor:
install_sources: 'ppa:plumgrid-team/stable'
install_keys: 'null'
neutron-plumgrid-plugin:
install_sources: 'ppa:plumgrid-team/stable'
install_keys: 'null'
enable-metadata: False
neutron-api:
neutron-plugin: "plumgrid"
plumgrid-virtual-ip: "192.168.100.250"
The "external-interface" config parameter should be the interface that will provide external connectivity.
The virtual IP passed on in the neutron-api charm has to be same as the one passed in the plumgrid-director charm.
# Contact Information
Bilal Baqar <bbaqar@plumgrid.com>
Bilal Ahmad <bilal@plumgrid.com>

View File

@ -1,16 +0,0 @@
# Overview
This charm provides the PLUMgrid Gateway configuration for a node.
# Usage
To deploy (partial deployment of linked charms only):
juju deploy neutron-api
juju deploy neutron-iovisor
juju deploy plumgrid-director
juju deploy plumgrid-gateway
juju add-relation plumgrid-gateway neutron-iovisor
juju add-relation plumgrid-gateway plumgrid-director

View File

@ -1,18 +1,12 @@
name: plumgrid-gateway
subordinate: false
maintainer: Bilal Baqar <bbaqar@plumgrid.com>
summary: "OpenStack Neutron OpenvSwitch Agent"
summary: "PLUMgrid IO Visor Gateway"
description: |
Neutron is a virtual network service for Openstack, and a part of
Netstack. Just like OpenStack Nova provides an API to dynamically
request and configure virtual servers, Neutron provides an API to
dynamically request and configure virtual networks. These networks
connect "interfaces" from other OpenStack services (e.g., virtual NICs
from Nova VMs). The Neutron API supports extensions to provide
advanced network capabilities (e.g., QoS, ACLs, network monitoring,
etc.)
.
This charm provides the Plumgrid Gateway
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.
tags:
- openstack
requires: