Update documentation

Change-Id: I0be9beb7b938ccd0c01c6fa9964abbfd39f9adcf
Frode Nordahl 2019-10-24 15:55:08 +02:00
parent 967ea9b41b
commit c32e82e236
No known key found for this signature in database
GPG Key ID: 6A5D59A3BA48373F
2 changed files with 28 additions and 0 deletions

README.md Symbolic link
View File

@ -0,0 +1 @@

View File

@ -6,8 +6,35 @@ Subordinate charm that deploys the ``networking-ovn`` component on
``neutron-api`` units and augments Neutron's configuration for use with
the OVN ML2 plugin.
> **Note**: The OVN charms are considered preview charms.
# Usage
OVN makes use of Public Key Infrastructure (PKI) to authenticate and authorize
control plane communication. The charm requires a Certificate Authority to be
present in the model as represented by the `certificates` relation.
There is an [OVN overlay bundle](https://github.com/openstack-charmers/openstack-bundles/blob/master/development/overlays/openstack-base-ovn.yaml)
for use in conjunction with the [OpenStack Base bundle](https://github.com/openstack-charmers/openstack-bundles/blob/master/development/openstack-base-bionic-train/bundle.yaml)
which give an example of how you can automate certificate lifecycle management
with the help from [Vault](https://jaas.ai/vault/).
To deploy (partial deployment of linked charms only):
juju config neutron-api manage-neutron-plugin-legacy-mode=false
juju deploy neutron-api-plugin-ovn
juju deploy ovn-central -n 3 --config source=cloud:bionic-train
juju deploy ovn-chassis
juju add-relation neutron-api-plugin-ovn:certificates vault:certificates
juju add-relation neutron-api-plugin-ovn:neutron-plugin \
juju add-relation ovn-central:certificates vault:certificates
juju add-relation ovn-chassis:ovsdb ovn-central:ovsdb
juju add-relation ovn-chassis:certificates vault:certificates
juju add-relation ovn-chassis:nova-compute nova-compute:neutron-plugin
# Bugs
Please report bugs on [Launchpad](https://bugs.launchpad.net/charm-neutron-api-plugin-ovn/+filebug).