Documentation fixes

Fix README.md
Change default OCI image url

Change-Id: Id1aa843fa31648bacbd226857fb867ea34b3c703

charms/gnocchi-k8s/README.md

@@ -1,24 +1,66 @@
-<!--
-Avoid using this README file for information that is maintained or published elsewhere, e.g.:
-
-* metadata.yaml > published on Charmhub
-* documentation > published on (or linked to from) Charmhub
-* detailed contribution guide > documentation or CONTRIBUTING.md
-
-Use links instead.
--->
-
 # gnocchi-k8s
 
-Charmhub package name: gnocchi-k8s
-More information: https://charmhub.io/gnocchi-k8s
+## Description
 
-Operator for OpenStack Gnocchi.
+gnocchi-k8s is an operator to manage the gnocchi services gnocchi api,
+and gnocchi metricd on a Kubernetes based environment.
 
-## Other resources
+## Usage
 
-<!-- If your charm is documented somewhere else other than Charmhub, provide a link separately. -->
+### Deployment
 
-- [Contributing](CONTRIBUTING.md) <!-- or link to other contribution documentation -->
+gnocchi-k8s is deployed using below command:
 
-- See the [Juju SDK documentation](https://juju.is/docs/sdk) for more information about developing and improving charms.
+    juju deploy gnocchi-k8s gnocchi --trust
+
+Now connect the gnocchi operator to existing database, keystone identity,
+and rabbitmq operators:
+
+    juju relate mysql:database gnocchi:database
+    juju relate keystone:identity-service gnocchi:identity-service
+
+### 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 gnocchi`. If the charm is not
+deployed then see file `actions.yaml`.
+
+## Relations
+
+gnocchi-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
+
+## OCI Images
+
+The charm by default uses following images:
+
+    ghcr.io/canonical/gnocchi-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-gnocchi-k8s].
+
+<!-- LINKS -->
+
+[contributors-guide]: https://opendev.org/openstack/charm-gnocchi-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-gnocchi-k8s]: https://bugs.launchpad.net/charm-gnocchi-k8s/+filebug

charms/gnocchi-k8s/metadata.yaml

@@ -28,11 +28,13 @@ resources:
   gnocchi-api-image:
     type: oci-image
     description: OCI image for OpenStack Gnocchi api service
-    upstream-source: ghcr.io/openstack-snaps/gnocchi-consolidated:2023.1
+    # ghcr.io/canonical/gnocchi-api:2023.1
+    upstream-source: ghcr.io/canonical/gnocchi-consolidated:2023.1
   gnocchi-metricd-image:
     type: oci-image
     description: OCI image for OpenStack Gnocchi Metric service
-    upstream-source: ghcr.io/openstack-snaps/gnocchi-consolidated:2023.1
+    # ghcr.io/canonical/gnocchi-metricd:2023.1
+    upstream-source: ghcr.io/canonical/gnocchi-consolidated:2023.1
 
 requires:
   database:

charms/gnocchi-k8s/tests/bundles/smoke.yaml

@@ -12,13 +12,13 @@ applications:
   # If this isn't present, the units will hang at "installing agent".
   traefik:
     charm: ch:traefik-k8s
-    channel: 1.0/stable
+    channel: 1.0/candidate
     scale: 1
     trust: true
 
   traefik-public:
     charm: ch:traefik-k8s
-    channel: 1.0/stable
+    channel: 1.0/candidate
     scale: 1
     trust: true
     options:
@@ -40,8 +40,8 @@ applications:
     scale: 1
     trust: true
     resources:
-      gnocchi-api-image: ghcr.io/openstack-snaps/gnocchi-api:2023.1
-      gnocchi-metricd-image: ghcr.io/openstack-snaps/gnocchi-metricd:2023.1
+      gnocchi-api-image: ghcr.io/canonical/gnocchi-consolidated:2023.1
+      gnocchi-metricd-image: ghcr.io/canonical/gnocchi-consolidated:2023.1
 
 relations:
 - - traefik:ingress