x/charm-ovn-dedicated-chassis
Code Issues Proposed changes

README improvements

Browse Source 
* Fix links
* Add general improvements

Change-Id: Iba8a51c9a41e39ddd5bc8713dcf685948e6f905e
This commit is contained in:
Peter Matulis 2020-06-22 22:57:26 -04:00
parent 662c34b564
commit fe10c5c274
1 changed files with 48 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
src/README.md
View File

@ -1,5 +1,35 @@
# Overview
The ovn-dedicated-chassis charm provides the Open Virtual Network (OVN) local
controller, Open vSwitch Database and Switch. It is used in conjunction with
the [ovn-central][ovn-central-charm] charm.
Open vSwitch bridges for integration, external Layer2 and Layer3 connectivity
is managed by the charm.
On successful deployment the unit will be enlisted as a Chassis in the OVN
network.
The ovn-dedicated-chassis charm is a principle charm that sets up a software
gateway on a dedicated host. Alternatively, the subordinate
[ovn-chassis][ovn-chassis-charm] charm can be used.
> **Note**: The OVN charms are supported starting with OpenStack Train.
# Usage
The [OpenStack Base bundle][openstack-base-bundle] gives an example of how you
can deploy OpenStack and OVN with [Vault][vault-charm] to automate certificate
lifecycle management.
OVN makes use of Public Key Infrastructure (PKI) to authenticate and authorize
control plane communication. The charm therefore requires a Certificate
Authority to be present in the model as represented by the `certificates`
relation.
Refer to [Open Virtual Network (OVN)][cdg-ovn] in the [OpenStack Charms
Deployment Guide][cdg] for details, including deployment steps.
This charm provides the Open Virtual Network (OVN) local controller, Open
vSwitch Database and Switch.
@ -9,22 +39,9 @@ network.
Open vSwitch bridges for integration, external Layer2 and Layer3 connectivity
is managed by the charm.
# Usage
## Network spaces
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.
The [OpenStack Base bundle][openstack-base-bundle] gives an example of how you
can deploy OpenStack and OVN with [Vault][charm-vault] to automate certificate
lifecycle management.
Please refer to the [OVN Appendix][ovn-cdg] in the
[OpenStack Charms Deployment Guide][cdg] for details.
## Network Spaces support
This charm supports the use of Juju Network Spaces.
This charm supports the use of Juju network spaces.
By binding the `ovsdb` endpoint you can influence which interface will be used
for communication with the OVN Southbound DB as well as overlay traffic.
@ -36,20 +53,20 @@ used for overlay traffic.
juju deploy ovn-dedicated-chassis --bind "data=overlay-space"
## Port Configuration
## Port configuration
Chassis port configuration is composed of a mapping between physical network
names to bridge names (`ovn-bridge-mappings`) and individual interface to
bridge names (`bridge-interface-mappings`). There must be a match in both
bridge names (`bridge-interface-mappings`). There must be a match in both
configuration options before the charm will configure bridge and interfaces on
a unit.
The physical network name can be referenced when the administrator programs the
OVN logical flows, either by talking directly to the Northbound database, or by
interfaceing with a Cloud Management System (CMS).
interfacing with a Cloud Management System (CMS).
Networks for use with external Layer3 connectivity should have mappings on
chassis located in the vicinity of the datacenter border gateways. Having two
chassis located in the vicinity of the datacenter border gateways. Having two
or more chassis with mappings for a Layer3 network will have OVN automatically
configure highly available routers with liveness detection provided by the
Bidirectional Forwarding Detection (BFD) protocol.
@ -58,10 +75,10 @@ Chassis without direct external mapping to a external Layer3 network will
forward traffic through a tunnel to one of the chassis acting as a gateway for
that network.
> **Note**: It is not necessary nor recommended to add mapping for external
Layer3 networks to all chassis. Doing so will create a scaling problem at
the physical network layer that needs to be resolved with globally shared
Layer2 (does not scale) or tunneling at the top-of-rack switch layer (adds
> **Note**: It is not necessary, nor recommended, to add mapping for external
Layer3 networks to all chassis. Doing so will create a scaling problem at the
physical network layer that needs to be resolved with globally shared Layer2
(does not scale) or tunneling at the top-of-rack switch layer (adds
complexity) and is generally not a recommended configuration.
Networks for use with external Layer2 connectivity should have mappings present
@ -69,16 +86,17 @@ on all chassis with potential to host the consuming payload.
# Bugs
Please report bugs on [Launchpad][lp-ovn-chassis].
Please report bugs on [Launchpad][lp-ovn-dedicated-chassis].
For general questions please refer to the OpenStack [Charm Guide][cg].
For general questions please refer to the [OpenStack Charm Guide][cg].
<!-- LINKS -->
[cdg]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/
[ovn-cdg]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/app-ovn.html
[cg]: https://docs.openstack.org/charm-guide/latest/
[charm-nova-compute]: https://jaas.ai/nova-compute
[charm-vault]: https://jaas.ai/vault/
[lp-ovn-chassis]: https://bugs.launchpad.net/charm-ovn-chassis/+filebug
[cdg]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/
[cdg-ovn]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/app-ovn.html
[vault-charm]: https://jaas.ai/vault/
[lp-ovn-dedicated-chassis]: https://bugs.launchpad.net/charm-ovn-dedicated-chassis/+filebug
[ovn-central-charm]: https://jaas.ai/ovn-central
[ovn-chassis-charm]: https://jaas.ai/ovn-chassis
[openstack-base-bundle]: https://github.com/openstack-charmers/openstack-bundles/blob/master/development/openstack-base-bionic-ussuri-ovn/bundle.yaml