grafana-cloud plugin

Contents

Usage

This section documents the behavior of the grafana-cloud plugin when using the CLI.

Before using the grafana-cloud plugin you must have 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

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

© 2022 Dave Moore.
Licensed under the Apache License, Version 2.0.
This website uses Google Analytics.

microbs is a project of the open source community. microbs is not officially supported by any vendors named in this documentation or the software (e.g. Cloud Native Computing Foundation, Amazon, Google, Microsoft, Elastic, Grafana), though employees or partners of those vendors may contribute to the project.