openstack
/
charm-neutron-api-genericswitch
Code Issues Proposed changes

Improve project readme

This commit is contained in:
Mathieu Mitchell 2018-01-07 10:40:02 -05:00
parent acec3bb932
commit 07c16aa8a9
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,3 +1,9 @@
Introduction
============
This is the Juju charm for [openstack/networking-generic-switch](https://git.openstack.org/cgit/openstack/networking-generic-switch).
Getting started
===============
@ -13,6 +19,15 @@ Generate a config ini file with switch configuration, similar to the one below:
username = admin
password = admin
`[genericswitch]` blocks should follow the syntax described in [networking-generic-switch documentation](https://git.openstack.org/cgit/openstack/networking-generic-switch/tree/README.rst)
Limitations
===========
Since neutron-api-genericswitch is not part of Ubuntu Cloud Archive, the package has to be built
manually. Build instructions exist in a [manufacturer's specific extension](https://bitbucket.org/kci1/openstack-networking-generic-switch-fastpath) of generic switch.
Deploying locally
=================
@ -20,5 +35,8 @@ Deploying locally
cd src
charm build
juju deploy $PATH_TO_CHECKOUT/src/builds/neutron-api-genericswitch --resource genericswitch-ml2-config=/full/path/to/switchconfig.ini
juju deploy $PATH_TO_CHECKOUT/src/builds/neutron-api-genericswitch \
--resource genericswitch-ml2-config=/full/path/to/switchconfig.ini \
--resource package=/full/path/to/neutron-api-genericswitch.deb
juju add-relation neutron-api neutron-api-genericswitch