[chore] Minor docs tidy.

This commit is contained in:
James Page 2022-07-25 10:44:52 +01:00
parent 723c8a8216
commit 252db2f11b
2 changed files with 10 additions and 12 deletions

View File

@ -48,9 +48,7 @@ run:
To deploy the local test instance:
tox -e build
juju add-model neutron
juju deploy ./neutron-k8s_ubuntu-20.04-amd64.charm --resource neutron-server-image=kolla/ubuntu-binary-neutron-server:xena
juju deploy ./neutron-k8s_ubuntu-20.04-amd64.charm --trust --resource neutron-server-image=kolla/ubuntu-binary-neutron-server:xena
<!-- LINKS -->

View File

@ -2,8 +2,8 @@
## Description
The neutron-k8s is an operator to manage the networking service
on a kubernetes based environment.
neutron-k8s is an operator to manage the Neutron networking service
on a Kubernetes based environment.
## Usage
@ -13,8 +13,8 @@ neutron-k8s is deployed using below command:
juju deploy neutron-k8s neutron --trust
Now connect the nova application to an existing database,
amqp, keystone identity, ovn-central and vault for certificates.
Now connect the neutron operator to existing database,
messaging, identity, OVN and Vault operators:
juju relate mysql:database neutron:shared-db
juju relate rabbitmq:amqp neutron:amqp
@ -40,11 +40,11 @@ deployed then see file `actions.yaml`.
neutron-k8s requires the following relations:
`shared-db`: To connect to the database
`amqp`: To connect to rabbitmq
`identity-service`: To register endpoints in keystone
`ovsdb-cms`: To connect to OVN central
`certificates`: To retrieve generated certificates from vault
`shared-db`: To connect to MySQL
`amqp`: To connect to RabbitMQ
`identity-service`: To register endpoints in Keystone
`ovsdb-cms`: To connect to OVN
`certificates`: To retrieve generated certificates from Vault
`ingress-internal`: To expose service on underlying internal network
`ingress-public`: To expose service on public network