openstack
/
charm-openstack-loadbalancer
Code Issues Proposed changes

Merge "Update README"

This commit is contained in:
Zuul 2021-10-08 16:16:25 +00:00 committed by Gerrit Code Review
parent 2186fe2be2 cbd108d6c7
commit 52c8e1914a
1 changed files with 40 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -8,19 +8,52 @@ accross the loadbalancer units to provide HA.
## Configuration
See file `config.yaml` for the full list of options, along with their
descriptions and default values.
This section covers common and/or important configuration options. See file
`config.yaml` for the full list of options, along with their descriptions and
default values. See the [Juju documentation][juju-docs-config-apps] for details
on configuring applications.
#### `vips`
Sets the VIPs to use on the openstack-loadbalancer units to provide fault tolerant
access to a servce. The value should be a space seperated list of IPs.
## Deployment
Use the vip charm config option to specify the vips to be used by the
loadbalancer, normally one vip per network space that the charm is bound to.
The charm has `public`, `admin` and `internal` space bindings. These are the
spaces that the charm will create listeners on for ingress traffic. The charm
`vips` option should be used to provice an IP on each one of these network
spaces.
This charm needs to be related to the hacluster charm to manage vips and the
haproxy service.
juju deploy -n 3 openstack-loadbalancer
juju config openstack-loadbalancer vip="10.0.0.100 10.10.0.100 10.20.0.100"
juju deploy hacluster
juju relate openstack-loadbalancer:ha hacluster:ha
juju deploy hacluster openstack-loadbalancer-hacluster
juju relate openstack-loadbalancer:ha openstack-loadbalancer-hacluster:ha
Then relate the charm to a service that requires a loadbalancer
To provide a load balancer relate the charm to a service that supports the loadbalancer
interface.
juju add-relation openstack-loadbalancer:loadbalancer ceph-dashboard:loadbalancer
# Documentation
The OpenStack Charms project maintains two documentation guides:
* [OpenStack Charm Guide][cg]: for project information, including development
and support notes
* [OpenStack Charms Deployment Guide][cdg]: for charm usage information
# Bugs
Please report bugs on [Launchpad][lp-bugs-charm-openstack-loadbalancer].
<!-- LINKS -->
[juju-docs-actions]: https://juju.is/docs/working-with-actions
[juju-docs-config-apps]: https://juju.is/docs/configuring-applications
[cg]: https://docs.openstack.org/charm-guide
[cdg]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide
[lp-bugs-charm-openstack-loadbalancer]: https://bugs.launchpad.net/charm-openstack-loadbalancer