diff --git a/charms/aodh-k8s/README.md b/charms/aodh-k8s/README.md index 49d04fbd..4fda94c8 100644 --- a/charms/aodh-k8s/README.md +++ b/charms/aodh-k8s/README.md @@ -1,26 +1,69 @@ - - # aodh-k8s -Charmhub package name: operator-template -More information: https://charmhub.io/aodh-k8s +## Description -Describe your charm in one or two sentences. +aodh-k8s is an operator to manage the alarm services aodh api, +aodh evaluator, aodh notifier, aodh listener and aodh expirer +on a Kubernetes based environment. -## Other resources +## Usage - +### Deployment -- [Read more](https://example.com) +aodh-k8s is deployed using below command: -- [Contributing](CONTRIBUTING.md) + juju deploy aodh-k8s aodh --trust -- See the [Juju SDK documentation](https://juju.is/docs/sdk) for more information about developing and improving charms. +Now connect the aodh operator to existing database, keystone identity, +and rabbitmq operators: + + juju relate mysql:database aodh:database + juju relate keystone:identity-service aodh:identity-service + juju relate rabbitmq:amqp aodh:amqp + +### 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 aodh`. If the charm is not +deployed then see file `actions.yaml`. + +## Relations + +aodh-k8s requires the following relations: + +`database`: To connect to MySQL +`identity-service`: To register endpoints in Keystone +`ingress-internal`: To expose service on underlying internal network +`ingress-public`: To expose service on public network +`amqp`: To connect to Rabbitmq + +## OCI Images + +The charm by default uses following images: + + ghcr.io/canonical/aodh-consolidated:2023.1 + +## Contributing + +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](contributors-guide) for developer guidance. + +## Bugs + +Please report bugs on [Launchpad][lp-bugs-charm-aodh-k8s]. + + + +[contributors-guide]: https://opendev.org/openstack/charm-aodh-k8s/src/branch/main/CONTRIBUTING.md +[juju-docs-actions]: https://jaas.ai/docs/actions +[juju-docs-config-apps]: https://juju.is/docs/configuring-applications +[lp-bugs-charm-aodh-k8s]: https://bugs.launchpad.net/charm-aodh-k8s/+filebug diff --git a/charms/aodh-k8s/metadata.yaml b/charms/aodh-k8s/metadata.yaml index 10410998..bad44c75 100644 --- a/charms/aodh-k8s/metadata.yaml +++ b/charms/aodh-k8s/metadata.yaml @@ -33,25 +33,30 @@ containers: resources: aodh-api-image: type: oci-image - description: OCI image for OpenStack aodh - upstream-source: ghcr.io/openstack-snaps/aodh-consolidated:2023.1 + description: OCI image for OpenStack aodh api service + # ghcr.io/canonical/aodh-consolidated:2023.1 + upstream-source: ghcr.io/canonical/aodh-consolidated:2023.1 aodh-evaluator-image: type: oci-image - description: OCI image for OpenStack aodh - upstream-source: ghcr.io/openstack-snaps/aodh-consolidated:2023.1 + description: OCI image for OpenStack aodh evaluator service + # ghcr.io/canonical/aodh-consolidated:2023.1 + upstream-source: ghcr.io/canonical/aodh-consolidated:2023.1 aodh-notifier-image: type: oci-image - description: OCI image for OpenStack aodh - upstream-source: ghcr.io/openstack-snaps/aodh-consolidated:2023.1 + description: OCI image for OpenStack aodh notifier service + # ghcr.io/canonical/aodh-consolidated:2023.1 + upstream-source: ghcr.io/canonical/aodh-consolidated:2023.1 aodh-listener-image: type: oci-image - description: OCI image for OpenStack aodh - upstream-source: ghcr.io/openstack-snaps/aodh-consolidated:2023.1 + description: OCI image for OpenStack aodh listener service + # ghcr.io/canonical/aodh-consolidated:2023.1 + upstream-source: ghcr.io/canonical/aodh-consolidated:2023.1 aodh-expirer-image: type: oci-image - description: OCI image for OpenStack aodh - upstream-source: ghcr.io/openstack-snaps/aodh-consolidated:2023.1 - + description: OCI image for OpenStack aodh expirer service + # ghcr.io/canonical/aodh-consolidated:2023.1 + upstream-source: ghcr.io/canonical/aodh-consolidated:2023.1 + requires: database: interface: mysql_client diff --git a/charms/aodh-k8s/tests/bundles/smoke.yaml b/charms/aodh-k8s/tests/bundles/smoke.yaml index d9d99076..5f93ae3d 100644 --- a/charms/aodh-k8s/tests/bundles/smoke.yaml +++ b/charms/aodh-k8s/tests/bundles/smoke.yaml @@ -57,11 +57,11 @@ applications: scale: 1 trust: true resources: - aodh-api-image: ghcr.io/openstack-snaps/aodh-consolidated:2023.1 - aodh-evaluator-image: ghcr.io/openstack-snaps/aodh-consolidated:2023.1 - aodh-notifier-image: ghcr.io/openstack-snaps/aodh-consolidated:2023.1 - aodh-listener-image: ghcr.io/openstack-snaps/aodh-consolidated:2023.1 - aodh-expirer-image: ghcr.io/openstack-snaps/aodh-consolidated:2023.1 + aodh-api-image: ghcr.io/canonical/aodh-consolidated:2023.1 + aodh-evaluator-image: ghcr.io/canonical/aodh-consolidated:2023.1 + aodh-notifier-image: ghcr.io/canonical/aodh-consolidated:2023.1 + aodh-listener-image: ghcr.io/canonical/aodh-consolidated:2023.1 + aodh-expirer-image: ghcr.io/canonical/aodh-consolidated:2023.1 relations: - - traefik:ingress