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

[chore] Minor docs tidy.

Browse Source
This commit is contained in:
James Page 2022-07-25 11:01:20 +01:00
parent 1f5700d922
commit ab34ec6f63
2 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -13,7 +13,7 @@ Create and activate a virtualenv with the development requirements:
Get familiarise with [Charmed Operator Framework](https://juju.is/docs/sdk)
and [Sunbeam documentation](sunbeam-docs).
ovn-relay-k8s charm uses the ops_sunbeam library and extends
ovn-relay-k8s charm uses the ops\_sunbeam library and extends
OSBaseOVNOperatorCharm from the library.
ovn-relay-k8s charm consumes certificates to get generated
@ -45,8 +45,6 @@ run:
To deploy the local test instance:
tox -e build
juju add-model ovn-relay
juju deploy ./ovn-relay-k8s_ubuntu-20.04-amd64.charm --resource ovn-sb-db-server-image=registry.jujucharms.com/charm/kau2b145zhaeuj5ly4w4m30qiq8qzspf93tnd/ovn-sb-db-server-image
<!-- LINKS -->

8
README.md
View File

@ -2,8 +2,8 @@
## Description
The ovn-relay-k8s is an operator to manage the OVN ovsdb
relay service on a kubernetes based environment.
ovn-relay-k8s is an operator to manage the OVN ovsdb relay service
on a Kubernetes based environment.
## Usage
@ -13,8 +13,8 @@ ovn-relay-k8s is deployed using below command:
juju deploy ovn-relay-k8s ovn-relay
Now connect the ovn-relay application to vault to generate
certificates.
Now connect the ovn-relay operator to Vault to generate
certificates for secure authentication and communication:
juju relate vault:certificates ovn-relay:certificates