From fbe1cb0f28ee46dde5639663151c7de9b2f4abaa Mon Sep 17 00:00:00 2001 From: "Community Hass.io Add-ons Bot" Date: Thu, 28 May 2020 20:38:32 +0000 Subject: [PATCH] :arrow_up: Updating add-on Grafana to 3c5bbf7 --- README.md | 6 +- grafana/CHANGELOG.md | 3 + grafana/DOCS.md | 193 +++++++++++++++++++++++++++++++++++++++++++ grafana/README.md | 7 +- grafana/config.json | 2 +- 5 files changed, 202 insertions(+), 9 deletions(-) create mode 100644 grafana/DOCS.md diff --git a/README.md b/README.md index de2ba36ac..d124cc9f5 100644 --- a/README.md +++ b/README.md @@ -946,10 +946,10 @@ SOFTWARE. [glances-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [glances-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [glances-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-grafana]: https://github.com/hassio-addons/addon-grafana/tree/377d54b -[addon-doc-grafana]: https://github.com/hassio-addons/addon-grafana/blob/377d54b/README.md +[addon-grafana]: https://github.com/hassio-addons/addon-grafana/tree/3c5bbf7 +[addon-doc-grafana]: https://github.com/hassio-addons/addon-grafana/blob/3c5bbf7/README.md [grafana-issue]: https://github.com/hassio-addons/addon-grafana/issues -[grafana-version-shield]: https://img.shields.io/badge/version-377d54b-blue.svg +[grafana-version-shield]: https://img.shields.io/badge/version-3c5bbf7-blue.svg [grafana-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/grafana-amd64.svg [grafana-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [grafana-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/grafana/CHANGELOG.md b/grafana/CHANGELOG.md index 24df1e2b7..fa145923f 100644 --- a/grafana/CHANGELOG.md +++ b/grafana/CHANGELOG.md @@ -1,4 +1,7 @@ # Changelog since v4.2.1 +- ⬆ Upgrades Grafana to v7.0.1 +- 🔨 Switch add-on from Ubuntu to Debian +- ✏ Split add-on documentation - 🔨 Implement OCI image specification on labels - ⬆ Upgrades add-on base image to v5.2.0 - ⬆ Upgrades Grafana to v6.7.3 diff --git a/grafana/DOCS.md b/grafana/DOCS.md new file mode 100644 index 000000000..6bc30283d --- /dev/null +++ b/grafana/DOCS.md @@ -0,0 +1,193 @@ +# Home Assistant Community Add-on: Grafana + +The analytics platform for all your metrics. + +Grafana allows you to query, visualize, alert on and understand your metrics +no matter where they are stored. Create, explore, and share dashboards. Learn +about your Home Automation system using sexy and compelling graphs, and other +data visualizations. + +Combine this add-on with the InfluxDB add-on to get insanely powerful +insights to your home. + +## Installation + +The installation of this add-on is pretty straightforward and not different in +comparison to installing any other Home Assistant add-on. + +1. Search for the "Grafana" add-on in the Supervisor add-on store. +1. Install the "Grafana" add-on. +1. Start the "Grafana" add-on. +1. Check the logs of the "Grafana" to see if everything went well. +1. Open the Web UI. + +**Note**: As the addon now supports both Ingress and direct access, the default +`admin` user has a password of `hassio`. __Please ensure to change this.__ + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```yaml +log_level: info +grafana_ingress_user: frenck +plugins: + - ayoungprogrammer-finance-datasource + - grafana-clock-panel +env_vars: + - name: GF_DEFAULT_INSTANCE_NAME + value: Hassio +``` + +**Note**: _This is just an example, don't copy and paste it! Create your own!_ + +### Option: `log_level` + +The `log_level` option controls the level of log output by the addon and can +be changed to be more or less verbose, which might be useful when you are +dealing with an unknown issue. Possible values are: + +- `trace`: Show every detail, like all called internal functions. +- `debug`: Shows detailed debug information. +- `info`: Normal (usually) interesting events. +- `warning`: Exceptional occurrences that are not errors. +- `error`: Runtime errors that do not require immediate action. +- `fatal`: Something went terribly wrong. Add-on becomes unusable. + +Please note that each level automatically includes log messages from a +more severe level, e.g., `debug` also shows `info` messages. By default, +the `log_level` is set to `info`, which is the recommended setting unless +you are troubleshooting. + +### Option: `grafana_ingress_user` + +When using Ingress grafana will automatically log in by default with a username +of `admin`. If a different user is required this option can be set. + +### Option: `plugins` + +Allows you to specify additional Grafana plugins to be installed to your +Grafana setup. For a list of available plugins, see: + + + +**Note**: _Adding plugins will result in a longer start-up for the add-on._ + +### Option: `env_vars` + +This option allows you to tweak every aspect of Grafana by setting +configuration options using environment variables. See the example at the +start of this chapter to get an idea of how the configuration looks. + +For more information about using these variables, see the official Grafana +documentation: + + + +**Note**: _Only environment variables starting with `GF_` are accepted._ + +## Using it with the InfluxDB Community add-on + +Grafana does not come out of the box pre-configured, but letting it interact +with the community [InfluxDB add-on][influxdb-addon] is pretty easy. Please, +follow the instructions from the on how to [create a database][create-db] +for Home Assistant. + +1. Create a new user for Grafana on InfluxDB + (InfluxDB Admin -> Users and "+ Create User") +1. Login into Grafana +1. Create a new datasource: + - Name: Anything you want, e.g., Home Assistant + - Type: InfluxDB + - HTTP > URL: `http://a0d7b954-influxdb:8086` + - HTTP > Access: Server (Default) + - Auth: (leave them all disabled) + - InfluxDB Details > Database: _Your Home Assistant InfluxDB database_, + e.g., `homeassistant` + - InfluxDB Details > User: _Grafana InfluxDB username defined in step 1_ + - InfluxDB Details > Password: _Grafana InfluxDB user password defined_ + _in step 1_ +1. Hit Save & Test + +## Known issues and limitations + +- This add-on does support ARM-based devices, nevertheless, they must + at least be an ARMv7 device. (Raspberry Pi 1 and Zero is not supported). +- The ARM versions (e.g, Raspberry Pi) do not have support for PhantomJS, + since Grafana does not support it. The PhantomJS project has been + abandoned as well. + +## Changelog & Releases + +This repository keeps a change log using [GitHub's releases][releases] +functionality. The format of the log is based on +[Keep a Changelog][keepchangelog]. + +Releases are based on [Semantic Versioning][semver], and use the format +of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented +based on the following: + +- ``MAJOR``: Incompatible or major changes. +- ``MINOR``: Backwards-compatible new features and enhancements. +- ``PATCH``: Backwards-compatible bugfixes and package updates. + +## Support + +Got questions? + +You have several options to get them answered: + +- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on + support and feature requests. +- The [Home Assistant Discord chat server][discord-ha] for general Home + Assistant discussions and questions. +- The Home Assistant [Community Forum][forum]. +- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] + +You could also [open an issue here][issue] GitHub. + +## Authors & contributors + +The original setup of this repository is by [Franck Nijhof][frenck]. + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## License + +MIT License + +Copyright (c) 2018-2020 Franck Nijhof + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +[contributors]: https://github.com/hassio-addons/addon-grafana/graphs/contributors +[create-db]: https://github.com/hassio-addons/addon-influxdb#integrating-into-home-assistant +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-grafana/54674?u=frenck +[frenck]: https://github.com/frenck +[influxdb-addon]: https://github.com/hassio-addons/addon-influxdb +[issue]: https://github.com/hassio-addons/addon-grafana/issues +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-grafana/releases +[semver]: http://semver.org/spec/v2.0.0.htm diff --git a/grafana/README.md b/grafana/README.md index 2c4d19f8e..ceeeb33f3 100644 --- a/grafana/README.md +++ b/grafana/README.md @@ -22,8 +22,6 @@ data visualizations. Combine this add-on with the InfluxDB add-on to get insanely powerful insights to your home. -[Click here for the full documentation][docs] - ![Grafana in the Home Assistant Frontend][screenshot] ## WARNING! THIS IS AN EDGE VERSION! @@ -47,7 +45,6 @@ If you are more interested in stable releases of our add-ons: [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons -[docs]: https://github.com/hassio-addons/addon-grafana/blob/377d54b/README.md [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-grafana/54674?u=frenck [github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png @@ -56,6 +53,6 @@ If you are more interested in stable releases of our add-ons: [patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png [patreon]: https://www.patreon.com/frenck [project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg -[release-shield]: https://img.shields.io/badge/version-377d54b-blue.svg -[release]: https://github.com/hassio-addons/addon-grafana/tree/377d54b +[release-shield]: https://img.shields.io/badge/version-3c5bbf7-blue.svg +[release]: https://github.com/hassio-addons/addon-grafana/tree/3c5bbf7 [screenshot]: https://github.com/hassio-addons/addon-grafana/raw/master/images/screenshot.png \ No newline at end of file diff --git a/grafana/config.json b/grafana/config.json index 81e948246..72d1ef11a 100644 --- a/grafana/config.json +++ b/grafana/config.json @@ -1,6 +1,6 @@ { "name": "Grafana", - "version": "377d54b", + "version": "3c5bbf7", "slug": "grafana", "description": "The open platform for beautiful analytics and monitoring", "url": "https://github.com/hassio-addons/addon-grafana",