diff --git a/README b/README deleted file mode 100644 index ae26d8a..0000000 --- a/README +++ /dev/null @@ -1,12 +0,0 @@ -Basic instructions... - -vim /home/ubuntu/switchconfig.ini - - -cd src -charm build - -juju deploy /home/ubuntu/charm-neutron-api-genericswitch/src/builds/neutron-api-genericswitch --resource genericswitch-ml2-config=/home/ubuntu/switchconfig.ini -//juju config neutron-api-genericswitch pip-requirement-line=alternative-package-name - -juju add-relation neutron-api neutron-api-genericswitch diff --git a/README.md b/README.md new file mode 100644 index 0000000..a06ae9d --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +Getting started +=============== + +Generate a config ini file with switch configuration, similar to the one below: + + [ml2] + mechanism_drivers = openvswitch,hyperv,genericswitch + + [genericswitch:my_switch] + device_type = netmiko_cisco + ip = 192.168.1.12 + port = 22 + username = admin + password = admin + + +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 add-relation neutron-api neutron-api-genericswitch