cloudstats #1

Supports: focal bionic xenial
Add to new model

Description

A nice long description of what the product does and any high level information about how the charm provides the product, on which platform, etc.


Introduction

Provide additional cloud capacity metrics (to complement other prometheus-exporters) Provide mechanism to send cloud capacity information to an external API.

This charm currently supports collecting and providing metrics for Openstack clouds.

Deployment

To deploy cloudstats, perform the following:

juju deploy cs:~bootstack-charmers/cloudstats
juju add-relation cloudstats:openstack-admin keystone:identity-admin
juju add-relation cloudstats:prometheus-scrape-target prometheus:scrape

Optionally, if you use self-signed certificates for your openstack endpoints, you'll need to add the openstack CA bundle to this charm's config (this should be configured before adding the keystone relation):

juju config cloudstats openstack_cert="$(base64 ca_bundle.pem)"

To enable reporting capacity metrics to an external API:

juju config cloudstats api_url="<url to external RESTful API>" \
    api_cloud_uuid="External API reference uuid for this model's cloud>" \
    api_refresh_token="Authentication token for external API"
juju add-relation cloudstats:prometheus-client prometheus:website

Experimental Feature

This charm can also provide a very basic dashboard to grafana to expose the stats reported to the external API. To enable this dashboard, add the following relation:

juju add-relation cloudstats:grafana-dashboard grafana:dashboards

Testing

For development and testing details, see TESTING.md

Contact


Configuration

api_cloud_uuid
(string) UUID of the cloud to update
api_refresh_token
(string) An initial refresh token for this cloud to push updates with
api_url
(string) The URL to post api updates to
exporter_collect_interval
(int) Interval to collect cloudstats data in minutes
30
exporter_port
(int) The port on which cloudstats-exporter should listen
9748
openstack_cert
(string) Base64 encoded certificate for use with openstack endpoints