diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0a50836..88bd2fa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/README.md b/README.md index c3b155f..0794163 100644 --- a/README.md +++ b/README.md @@ -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