From 017ff6b5d1207cabfec5494b77e83b7a4f45467d Mon Sep 17 00:00:00 2001 From: James Page Date: Mon, 25 Jul 2022 10:53:29 +0100 Subject: [PATCH] [chore] Minor docs tidy. --- charms/ovn-central-k8s/CONTRIBUTING.md | 4 +--- charms/ovn-central-k8s/README.md | 15 +++++++++------ 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/charms/ovn-central-k8s/CONTRIBUTING.md b/charms/ovn-central-k8s/CONTRIBUTING.md index b803896a..c700c327 100644 --- a/charms/ovn-central-k8s/CONTRIBUTING.md +++ b/charms/ovn-central-k8s/CONTRIBUTING.md @@ -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 diff --git a/charms/ovn-central-k8s/README.md b/charms/ovn-central-k8s/README.md index af4d0554..2555c4d0 100644 --- a/charms/ovn-central-k8s/README.md +++ b/charms/ovn-central-k8s/README.md @@ -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`