x/charm-ovn-central-k8s
Code Issues Proposed changes

[chore] Minor docs tidy.

Browse Source
This commit is contained in:
James Page 2022-07-25 10:53:29 +01:00
parent a0c14894a4
commit 3bbc710cce
2 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -48,9 +48,7 @@ run:
To deploy the local test instance:
tox -e build
juju add-model ovn-central
juju deploy ./ovn-central-k8s_ubuntu-20.04-amd64.charm --resource ovn-northd-image=registry.jujucharms.com/charm/kau2b145zhaeuj5ly4w4m30qiq8qzspf93tnd/ovn-northd-image ovn-nb-db-server-image=registry.jujucharms.com/charm/kau2b145zhaeuj5ly4w4m30qiq8qzspf93tnd/ovn-nb-db-server-image ovn-sb-db-server-image=registry.jujucharms.com/charm/kau2b145zhaeuj5ly4w4m30qiq8qzspf93tnd/ovn-sb-db-server-image
juju deploy ./ovn-central-k8s_ubuntu-20.04-amd64.charm --trust --resource ovn-northd-image=registry.jujucharms.com/charm/kau2b145zhaeuj5ly4w4m30qiq8qzspf93tnd/ovn-northd-image ovn-nb-db-server-image=registry.jujucharms.com/charm/kau2b145zhaeuj5ly4w4m30qiq8qzspf93tnd/ovn-nb-db-server-image ovn-sb-db-server-image=registry.jujucharms.com/charm/kau2b145zhaeuj5ly4w4m30qiq8qzspf93tnd/ovn-sb-db-server-image
<!-- LINKS -->

15
README.md
View File

@ -2,8 +2,8 @@
## Description
The ovn-central-k8s is an operator to manage the OVN central
services northd, ovsdb-nb, ovsdb-sb on a kubernetes based
ovn-central-k8s is an operator to manage the OVN central
services (northd, ovsdb-nb, ovsdb-sb) on a Kubernetes based
environment.
## Usage
@ -14,8 +14,8 @@ ovn-central-k8s is deployed using below command:
juju deploy ovn-central-k8s ovn-central
Now connect the ovn-central application to vault to generate
certificates.
Now connect the ovn-central operator to Vault to generate
certificates for secure authentication and communication:
juju relate vault:certificates ovn-central:certificates
@ -36,14 +36,17 @@ deployed then see file `actions.yaml`.
## Relations
ovn-central-k8s requires the following relations:
`certificates`: To retrieve generated certificates from vault
ovn-central-k8s provides the following relations:
`ovsdb-cms`: Used by neutron to get ovn-central IPs.
`ovsdb-cms`: Used by Neutron to get ovn-central IPs.
## OCI Images
The charm by default uses following images.
The charm by default uses following images:
`registry.jujucharms.com/charm/kau2b145zhaeuj5ly4w4m30qiq8qzspf93tnd/ovn-northd-image`
`registry.jujucharms.com/charm/kau2b145zhaeuj5ly4w4m30qiq8qzspf93tnd/ovn-nb-db-server-image`
`registry.jujucharms.com/charm/kau2b145zhaeuj5ly4w4m30qiq8qzspf93tnd/ovn-sb-db-server-image`