Skip to content
This repository has been archived by the owner on Sep 7, 2023. It is now read-only.

Latest commit

 

History

History
87 lines (69 loc) · 4.6 KB

installation.md

File metadata and controls

87 lines (69 loc) · 4.6 KB
Raw

Installation Guide

A set of instructions that will help you get started with the Nautobot Grafana Plugin. This document is intended to serve as a guide for the requirements and installation on the plugin within a Nautobot environment.

Requirements

Prior to installing the Nautobot Grafana Plugin, you will need to have a minimum of the following installed:

Plug-In Installation

The plugin is available as a Python package in pypi and can be installed with pip

pip install nautobot-plugin-chatops-grafana

This plugin is compatible with Nautobot 1.0.0 and higher

To ensure Nautobot Chatops Extension Grafana is automatically re-installed during future upgrades, create a file named local_requirements.txt (if not already existing) in the Nautobot root directory (alongside requirements.txt) and list the nautobot-plugin-chatops-grafana package:

# echo nautobot-plugin-chatops-grafana >> local_requirements.txt

Once installed, the plugin needs to be enabled in your nautobot_configuration.py

Nautobot Server Configuration

As the nautobot user, you will now edit the nautobot_config.py file.

There are also some platform-specific requirements to configure. Some values from your chat platform-specific configuration in the prior section are configured in nautobot_config.py.

# In your configuration.py
PLUGINS = ["nautobot_plugin_chatops_grafana"]

# PLUGINS_CONFIG = {
#     "nautobot_plugin_chatops_grafana": {
#         "grafana_url": os.environ.get("GRAFANA_URL", ""),
#         "grafana_api_key": os.environ.get("GRAFANA_API_KEY", ""),
#         "default_width": 0,
#         "default_height": 0,
#         "default_theme": "dark",
#         "default_timespan": "0",
#         "grafana_org_id": 1,
#         "default_tz": "America/Denver",
#     },
# }

To make it more readable, the above settings example shows info for only the Grafana ChatOps Plugin; the Nautobot Plugin ChatOps will also have configurations in this section.

The plugin behavior can be controlled with the following list of settings

  • grafana_url: (REQUIRED)
    • This will be the base url that the Grafana application is hosted at.
  • grafana_api_key: (REQUIRED)
    • API key generated with Grafana, found in <grafana_base_url>/org/apikeys.
    • NOTE: The Grafana API key only needs to have Viewer permissions assigned!
  • default_width: (Default 0)
    • Grafana image width when rendered into the chat client. Default will render width dynamically.
  • default_height: (Default 0)
    • Grafana image height when rendered into the chat client. Default will render height dynamically.
  • default_theme: (Default dark)
    • Theme color to use when generating rendered Grafana images. Options are [dark, light]
  • default_timespan: (Default 0)
    • Timespan that data is collected on a panel in Grafana. Default action is to use the defined timespan in Grafana.
  • grafana_org_id: (Default 1)
    • Grafana organization Id to associate with this plugin. Found in <grafana_base_url>//admin/orgs.
  • default_tz: (Default America/Denver)
    • Timezone in which the renderer will render charts and graphs in.

As a sudo-enabled user, restart the nautobot and nautobot-worker process after updating nautobot_config.py.

Chat Client Configuration

As noted in the requirements section of this document, you will need to have the nautobot-plugin-chatops plugin installed prior to installing this plugin as it leverages the chatops abstract methods to communicate with your chat client.

To enable the /grafana chat command on your chat client, you may need to define a slash command within your chat configuration. See the item 3. on the Slack Chat Setup instructions in the nautobot-plugin-chatops documentation.