diff --git a/charms/ovn-central-k8s/CONTRIBUTING.md b/charms/ovn-central-k8s/CONTRIBUTING.md index f8205395..b803896a 100644 --- a/charms/ovn-central-k8s/CONTRIBUTING.md +++ b/charms/ovn-central-k8s/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# sunbeam-ovn-central-operator +# ovn-central-k8s ## Developing @@ -10,21 +10,27 @@ Create and activate a virtualenv with the development requirements: ## Code overview -TEMPLATE-TODO: -One of the most important things a consumer of your charm (or library) -needs to know is what set of functionality it provides. Which categories -does it fit into? Which events do you listen to? Which libraries do you -consume? Which ones do you export and how are they used? +Get familiarise with [Charmed Operator Framework](https://juju.is/docs/sdk) +and [Sunbeam documentation](sunbeam-docs). + +ovn-central-k8s charm uses the ops_sunbeam library and extends +OSBaseOperatorAPICharm from the library. + +ovn-central-k8s charm consumes certificates to get generated +certificates from vault and provides ovsdb-cms relation to +provide ovn-central endpoints for external services to connect to. + +ovn-central-k8s starts northd, ovsdb-sb-server, ovsdb-nb-server +services by creating separate pebble handlers for each service. ## Intended use case -TEMPLATE-TODO: -Why were these decisions made? What's the scope of your charm? +ovn-central-k8s charm deploys and configures OVN Central services +on a kubernetes based environment. ## Roadmap -If this Charm doesn't fulfill all of the initial functionality you were -hoping for or planning on, please add a Roadmap or TODO here +TODO ## Testing @@ -32,3 +38,20 @@ The Python operator framework includes a very nice harness for testing operator behaviour without full deployment. Just `run_tests`: ./run_tests + +## Deployment + +This project uses tox for building and managing. To build the charm +run: + + tox -e build + +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 + + + +[sunbeam-docs]: https://github.com/openstack-charmers/advanced-sunbeam-openstack/blob/main/README.rst diff --git a/charms/ovn-central-k8s/README.md b/charms/ovn-central-k8s/README.md index a96e5afe..af4d0554 100644 --- a/charms/ovn-central-k8s/README.md +++ b/charms/ovn-central-k8s/README.md @@ -1,24 +1,66 @@ -# sunbeam-ovn-central-operator +# ovn-central-k8s ## Description -TODO: Describe your charm in a few paragraphs of Markdown +The ovn-central-k8s is an operator to manage the OVN central +services northd, ovsdb-nb, ovsdb-sb on a kubernetes based +environment. ## Usage -TODO: Provide high-level usage, such as required config or relations +### Deployment +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. + + juju relate vault:certificates ovn-central:certificates + +### Configuration + +This section covers common and/or important configuration options. See file +`config.yaml` for the full list of options, along with their descriptions and +default values. See the [Juju documentation][juju-docs-config-apps] for details +on configuring applications. + +### Actions + +This section covers Juju [actions][juju-docs-actions] supported by the charm. +Actions allow specific operations to be performed on a per-unit basis. To +display action descriptions run `juju actions ovn-central`. If the charm is not +deployed then see file `actions.yaml`. ## Relations -TODO: Provide any relations which are provided or required by your charm +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. ## OCI Images -TODO: Include a link to the default image your charm uses +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` ## Contributing -Please see the [Juju SDK docs](https://juju.is/docs/sdk) for guidelines +Please see the [Juju SDK docs](https://juju.is/docs/sdk) for guidelines on enhancements to this charm following best practice guidelines, and -`CONTRIBUTING.md` for developer guidance. +[CONTRIBUTING.md](contributors-guide) for developer guidance. + +## Bugs + +Please report bugs on [Launchpad][lp-bugs-charm-ovn-central-k8s]. + + + +[contributors-guide]: https://github.com/openstack-charmers/charm-ovn-central-operator/blob/main/CONTRIBUTING.md +[juju-docs-actions]: https://jaas.ai/docs/actions +[juju-docs-config-apps]: https://juju.is/docs/configuring-applications +[lp-bugs-charm-ovn-central-k8s]: https://bugs.launchpad.net/charm-ovn-central-k8s/+filebug diff --git a/charms/ovn-central-k8s/fetch-libs.sh b/charms/ovn-central-k8s/fetch-libs.sh new file mode 100755 index 00000000..4c9b464e --- /dev/null +++ b/charms/ovn-central-k8s/fetch-libs.sh @@ -0,0 +1,4 @@ +#!/bin/bash + +echo "INFO: Fetching libs from charmhub." +charmcraft fetch-lib charms.observability_libs.v0.kubernetes_service_patch diff --git a/charms/ovn-central-k8s/metadata.yaml b/charms/ovn-central-k8s/metadata.yaml index a28d78a5..2f029f6f 100644 --- a/charms/ovn-central-k8s/metadata.yaml +++ b/charms/ovn-central-k8s/metadata.yaml @@ -1,4 +1,4 @@ -name: sunbeam-ovn-central-operator +name: ovn-central-k8s summary: Open Virtual Network for Open vSwitch maintainer: OpenStack Charmers description: | diff --git a/charms/ovn-central-k8s/requirements.txt b/charms/ovn-central-k8s/requirements.txt index d521ef19..592fb03a 100644 --- a/charms/ovn-central-k8s/requirements.txt +++ b/charms/ovn-central-k8s/requirements.txt @@ -3,10 +3,9 @@ jinja2 # Get resources from github until cacerts issue is charmbuild image is fixed. # git+https://opendev.org/openstack/charm-ops-openstack#egg=ops_openstack # git+https://opendev.org/openstack/charm-ops-interface-tls-certificates#egg=interface_tls_certificates -git+https://github.com/openstack/charm-ops-openstack#egg=ops_openstack git+https://github.com/openstack/charm-ops-interface-tls-certificates#egg=interface_tls_certificates -git+https://github.com/openstack-charmers/advanced-sunbeam-openstack#egg=advanced_sunbeam_openstack +git+https://github.com/openstack-charmers/advanced-sunbeam-openstack#egg=ops_sunbeam lightkube lightkube-models cryptography < 3.4 diff --git a/charms/ovn-central-k8s/run_tests b/charms/ovn-central-k8s/run_tests index 90db638b..985f7472 100755 --- a/charms/ovn-central-k8s/run_tests +++ b/charms/ovn-central-k8s/run_tests @@ -1,5 +1,5 @@ #!/bin/sh -e -# Copyright 2022 liam +# Copyright 2021 Canonical Ltd. # See LICENSE file for licensing details. if [ -z "$VIRTUAL_ENV" -a -d venv/ ]; then diff --git a/charms/ovn-central-k8s/src/charm.py b/charms/ovn-central-k8s/src/charm.py index 38992892..8350f0e0 100755 --- a/charms/ovn-central-k8s/src/charm.py +++ b/charms/ovn-central-k8s/src/charm.py @@ -13,13 +13,13 @@ import ops.charm from ops.framework import StoredState from ops.main import main -import advanced_sunbeam_openstack.charm as sunbeam_charm -import advanced_sunbeam_openstack.core as sunbeam_core -import advanced_sunbeam_openstack.relation_handlers as sunbeam_rhandlers -import advanced_sunbeam_openstack.config_contexts as sunbeam_ctxts -import advanced_sunbeam_openstack.ovn.container_handlers as ovn_chandlers -import advanced_sunbeam_openstack.ovn.config_contexts as ovn_ctxts -import advanced_sunbeam_openstack.ovn.relation_handlers as ovn_rhandlers +import ops_sunbeam.charm as sunbeam_charm +import ops_sunbeam.core as sunbeam_core +import ops_sunbeam.relation_handlers as sunbeam_rhandlers +import ops_sunbeam.config_contexts as sunbeam_ctxts +import ops_sunbeam.ovn.container_handlers as ovn_chandlers +import ops_sunbeam.ovn.config_contexts as ovn_ctxts +import ops_sunbeam.ovn.relation_handlers as ovn_rhandlers import charms.sunbeam_ovn_central_operator.v0.ovsdb as ovsdb diff --git a/charms/ovn-central-k8s/tox.ini b/charms/ovn-central-k8s/tox.ini index 987807e9..5741249f 100644 --- a/charms/ovn-central-k8s/tox.ini +++ b/charms/ovn-central-k8s/tox.ini @@ -18,7 +18,7 @@ skip_missing_interpreters = False requires = pip < 20.3 virtualenv < 20.0 # NOTE: https://wiki.canonical.com/engineering/OpenStack/InstallLatestToxOnOsci -minversion = 3.2.0 +minversion = 3.18.0 [testenv] setenv = VIRTUAL_ENV={envdir} @@ -35,6 +35,12 @@ whitelist_externals = passenv = HOME TERM CS_* OS_* TEST_* deps = -r{toxinidir}/test-requirements.txt +[testenv:fetch] +basepython = python3 +deps = +commands = + ./fetch-libs.sh + [testenv:py3.8] basepython = python3.8 deps = -r{toxinidir}/requirements.txt @@ -83,6 +89,7 @@ omit = .tox/* */charmhelpers/* unit_tests/* + src/templates/* [testenv:venv] basepython = python3 diff --git a/charms/ovn-central-k8s/unit_tests/test_ovn_central_charm.py b/charms/ovn-central-k8s/unit_tests/test_ovn_central_charm.py index 00fb9867..b691cdcd 100644 --- a/charms/ovn-central-k8s/unit_tests/test_ovn_central_charm.py +++ b/charms/ovn-central-k8s/unit_tests/test_ovn_central_charm.py @@ -21,7 +21,7 @@ sys.path.append('lib') # noqa sys.path.append('src') # noqa import charm -import advanced_sunbeam_openstack.test_utils as test_utils +import ops_sunbeam.test_utils as test_utils class _OVNCentralXenaOperatorCharm(charm.OVNCentralXenaOperatorCharm):