microbs-plugin-grafana-cloud
Contents
Usage
Before using the grafana-cloud plugin you must meet its prerequisites.
setup
Grafana Cloud has a free tier that works for most usage of microbs (more info).
When running microbs setup [-o], the
grafana-cloud plugin creates a Grafana Cloud stack using the
Grafana Cloud API. Then it deploys a grafana-agent service to the Kubernetes cluster. This agent
autodiscovers logs and metrics from the Kubernetes nodes and pods, and collects
OpenTelemetry traces and metrics from the application running on Kubernetes, and
ships that data to the Grafana Cloud stack.
rollout
The grafana-cloud plugin is unaffected by microbs rollout.
destroy
When running microbs destroy [-o], the
grafana-cloud plugin destroys your Grafana Cloud stack using the
Grafana Cloud API.
Prerequisites
Install the plugin
microbs installs this plugin automatically when you install microbs.
To reinstall this plugin, run this command:
microbs plugins install grafana-cloud
To upgrade this plugin to the latest version, run this command:
microbs plugins update grafana-cloud
Create Grafana Cloud resources
You must create a Grafana Cloud account
and obtain a Grafana Cloud API Key before using the grafana-cloud plugin.
Configuration
This section documents the grafana-cloud plugin configurations for config.yaml.
Required fields
plugins.grafana-cloud.api_key
The value of your Grafana Cloud API Key.
Example: eyJrIjoiZTlkNmY5MDdjYTlmZTMxNDYxZDZmZGUwMTdhYzJhZGE5ZDE1MGI2NCIsIm4iOiJjaGFuZ2VtZSIsImlkIjo5OTk5OTl9
plugins.grafana-cloud.org_slug
The slug of your organization name as it exists on Grafana Cloud.
If you're unsure what this is, sign in to
Grafana Cloud and look at the value of URL after /orgs/:
https://grafana.com/orgs/acmecorp
Example: acmecorp
plugins.grafana-cloud.region
The slug of the region in which to deploy your Grafana Cloud stack.
See the
available regions and refer to the
slug fields for a list of acceptable values.
Examples: us, eu, au