Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 0 additions & 47 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "needs-triage"]
body:
- type: checkboxes
id: terms
attributes:
label: Please try to fill out as much of the information below as you can. Thank you!
options:
- label: Yes, I've searched similar issues on GitHub and didn't find any.
required: true
- type: input
id: app_version
attributes:
label: Which version contains the bug?
placeholder: 1.0.0
- type: textarea
id: description
attributes:
label: Describe the bug
description: Please provide a concise description of the bug, add any relevant output or error messages. You can use markdown.
- type: textarea
id: recreate
attributes:
label: How to recreate the bug?
description: Please provide the steps to recreate the issue.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Documentation
description: Suggest documentation improvements
title: "[Documentation]: "
labels: ["documentation"]
body:
- type: textarea
id: description
attributes:
label: Describe the improvements you'd like.
description: Please provide as much context as possible. You can use markdown.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Feature Request
description: Request a feature or enhancement
title: "[Feature]: "
labels: ["feature", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Please try to fill out as much of the information below as you can. Thank you!
**Note:** If you want to sponsor new features, contact us at info@netways.de
- type: textarea
id: description
attributes:
label: Describe the feature request
description: Please provide a concise description of the feature. You can use markdown.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Question
description: Ask a question
title: "[Question]: "
labels: ["question"]
body:
- type: textarea
id: description
attributes:
label: Ask a question
description: Please provide as much context as possible. You can use markdown.
35 changes: 15 additions & 20 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ bug reports and features requests or writing code to add enhancements or fix bug

## <a id="contributing-intro"></a> Introduction

Please consider our [roadmap](https://github.com/Icinga/icingaweb2/milestones) and
[open issues](https://github.com/icinga/icingaweb2/issues) when you start contributing
Please consider the milestones and
open issues when you start contributing
to the project.

Before starting your work on this Icinga Web 2 for Grafana, you should [fork the project](https://help.github.com/articles/fork-a-repo/)
Expand All @@ -37,20 +37,15 @@ Please continue reading in the following sections for a step by step guide.
## <a id="contributing-fork"></a> Fork the Project

[Fork the project](https://help.github.com/articles/fork-a-repo/) to your GitHub account
and clone the repository:

```
git clone git@github.com:dnsmichi/icingaweb2-module-grafana.git
cd icingaweb2-module-grafana
```
and clone the repository.

Add a new remote `upstream` with this repository as value.

```
git remote add upstream https://github.com/Mikesch-mp/icingaweb2-module-grafana.git
git remote add upstream https://github.com/NETWAYS/icingaweb2-module-grafana.git
```

You can pull updates to your fork's master branch:
You can pull updates to your fork's main branch:

```
git fetch --all
Expand Down Expand Up @@ -104,15 +99,15 @@ Don't worry, you can squash those changes into a single commit later on.

## <a id="contributing-pull-requests"></a> Pull Requests

Once you've committed your changes, please update your local master
Once you've committed your changes, please update your local main
branch and rebase your fix/feature branch against it before submitting a PR.

```
git checkout master
git checkout main
git pull upstream HEAD

git checkout fix/style-detail-view
git rebase master
git rebase main
```

Once you've resolved any conflicts, push the branch to your remote repository.
Expand Down Expand Up @@ -148,22 +143,22 @@ Thanks a lot for your contribution!

### <a id="contributing-rebase"></a> Rebase a Branch

If you accidentally sent in a PR which was not rebased against the upstream master,
If you accidentally sent in a PR which was not rebased against the upstream main,
developers might ask you to rebase your PR.

First off, fetch and pull `upstream` master.
First off, fetch and pull `upstream` main.

```
git checkout master
git checkout main
git fetch --all
git pull upstream HEAD
```

Then change to your working branch and start rebasing it against master:
Then change to your working branch and start rebasing it against main:

```
git checkout fix/style-detail-view
git rebase master
git rebase main
```

If you are running into a conflict, rebase will stop and ask you to fix the problems.
Expand Down Expand Up @@ -196,7 +191,7 @@ If you fear to break things, do the rebase in a backup branch first and later re
git checkout fix/style-detail-view
git checkout -b fix/style-detail-view-rebase

git rebase master
git rebase main

git branch -D fix/style-detail-view
git checkout -b fix/style-detail-view
Expand Down Expand Up @@ -237,7 +232,7 @@ git push -f origin fix/style-detail-view

## <a id="contributing-testing"></a> Testing

You can help test-drive the Git master inside the
You can help test-drive the Git main inside the
[Icinga 2 Vagrant boxes](https://github.com/icinga/icinga-vagrant).

$ git clone https://github.com/Icinga/icinga-vagrant.git
Expand Down
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,20 @@
6. [Contributing](#contributing)
7. [Donations](#donations)


## About

Add Grafana graphs into Icinga Web 2 to display performance metrics.

<table border="0">
<tr>
<td><img src="https://github.com/Mikesch-mp/icingaweb2-module-grafana/raw/master/doc/images/icingaweb2_grafana_screenshot_01.png"></td>
<td rowspan="2"><img src="https://github.com/Mikesch-mp/icingaweb2-module-grafana/raw/master/doc/images/icingaweb2_grafana_screenshot_05.png"></td>
<td><img src="https://github.com/NETWAYS/icingaweb2-module-grafana/raw/main/doc/images/icingaweb2_grafana_screenshot_01.png"></td>
<td rowspan="2"><img src="https://github.com/NETWAYS/icingaweb2-module-grafana/raw/main/doc/images/icingaweb2_grafana_screenshot_05.png"></td>
</tr>
<tr>
<td><img src="https://github.com/Mikesch-mp/icingaweb2-module-grafana/raw/master/doc/images/icingaweb2_grafana_screenshot_01.png"></td>
<td><img src="https://github.com/NETWAYS/icingaweb2-module-grafana/raw/main/doc/images/icingaweb2_grafana_screenshot_01.png"></td>
</tr>
</table>




## License

Icinga Web 2 and this Icinga Web 2 module are licensed under the terms of the GNU
Expand All @@ -48,17 +44,18 @@ Join the [Icinga community channels](https://icinga.com/community/) for question

## Documentation

You can find the complete documentation inside the [doc](https://github.com/Mikesch-mp/icingaweb2-module-grafana/raw/master/doc) folder.
You can find the complete documentation inside the [doc](doc/) folder.

## Thanks

This module borrows a lot from https://github.com/Icinga/icingaweb2-module-generictts & https://github.com/Icinga/icingaweb2-module-pnp.

This is a fork of https://github.com/Mikesch-mp/icingaweb2-module-grafana/

## Contributing

There are many ways to contribute to the Icinga Web module for Grafana --
whether it be sending patches, testing, reporting bugs, or reviewing and
updating the documentation. Every contribution is appreciated!

Please continue reading in the [contributing chapter](CONTRIBUTING.md).

14 changes: 7 additions & 7 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ VERSION=1.2.1

## Issues

Check issues at https://github.com/Mikesch-mp/icingaweb2-module-grafana/milestones
Check issues at https://github.com/NETWAYS/icingaweb2-module-grafana/milestones

## Version

Expand All @@ -30,18 +30,18 @@ Ensure to have [github_changelog_generator](https://github.com/skywinder/github-
installed and set the GitHub token to avoid rate limiting.

```
github_changelog_generator -u mikesch-mp -p icingaweb2-module-grafana --future-release=$VERSION
github_changelog_generator -u netways -p icingaweb2-module-grafana --future-release=$VERSION
```

## Git Tag

Commit these changes to the "master" branch:
Commit these changes to the "main" branch:

```
$ git commit -v -a -m "Release version $VERSION"
```

Create a signed tag (tags/v<VERSION>) on the "master" branch.
Create a signed tag (tags/v<VERSION>) on the "main" branch.

```
$ git tag -m "Version $VERSION" v$VERSION
Expand All @@ -56,7 +56,7 @@ $ git push --tags

## Release Tests

* Provision the vagrant boxes and pull the master in `/usr/share/icingaweb2/modules/grafana`
* Provision the vagrant boxes and pull the main in `/usr/share/icingaweb2/modules/grafana`

Example:

Expand All @@ -70,7 +70,7 @@ $ vagrant ssh -c "cd /usr/share/icingaweb2/modules/grafana && sudo git pull"
## GitHub Release

Create a new release for the newly created Git tag.
https://github.com/Mikesch-mp/icingaweb2-module-grafana/releases
https://github.com/NETWAYS/icingaweb2-module-grafana/releases

Note: A new GitHub release will be synced by Icinga Exchange automatically.

Expand All @@ -81,4 +81,4 @@ Note: A new GitHub release will be synced by Icinga Exchange automatically.

# After the release

* Close the released version at https://github.com/Mikesch-mp/icingaweb2-module-grafana/milestones
* Close the released version at https://github.com/NETWAYS/icingaweb2-module-grafana/milestones
2 changes: 1 addition & 1 deletion doc/01-about.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ LICENSE file included in the source package.

## Support

[Github Issues](https://github.com/Mikesch-mp/icingaweb2-module-grafana/issues)
[GitHub Issues](https://github.com/NETWAYS/icingaweb2-module-grafana/issues)
12 changes: 6 additions & 6 deletions doc/02-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ to the latest version, please [read on here](05-update.md).
## Install the Grafana module

As with any Icinga Web 2 module, installation is pretty straight-forward. In
case you're installing it from source all you have to do is to drop the grafana
case you're installing it from source all you have to do is to drop the Grafana
module in one of your module paths. You can examine (and set) the module path(s)
in `Configuration / Application`. In a typical environment you'll probably drop the
module to `/usr/share/icingaweb2/modules/grafana`. Please note that the directory
Expand All @@ -28,30 +28,30 @@ Use this only if you want to use/test the latest developer version of the module

```
ICINGAWEB_MODULEPATH="/usr/share/icingaweb2/modules"
REPO_URL="https://github.com/Mikesch-mp/icingaweb2-module-grafana"
REPO_URL="https://github.com/NETWAYS/icingaweb2-module-grafana"
TARGET_DIR="${ICINGAWEB_MODULEPATH}/grafana"
git clone "${REPO_URL}" "${TARGET_DIR}"
```

### Tarball

Replace the version number with the lates available version from [Latest Release](https://github.com/Mikesch-mp/icingaweb2-module-grafana/releases/latest)
Replace the version number with the latest available version from [Latest Release](https://github.com/NETWAYS/icingaweb2-module-grafana/releases/latest)

```
MODULE_VERSION="2.0.1"
ICINGAWEB_MODULEPATH="/usr/share/icingaweb2/modules"
REPO_URL="https://github.com/Mikesch-mp/icingaweb2-module-grafana"
REPO_URL="https://github.com/NETWAYS/icingaweb2-module-grafana"
TARGET_DIR="${ICINGAWEB_MODULEPATH}/grafana"
URL="${REPO_URL}/archive/v${MODULE_VERSION}.tar.gz"
install -d -m 0755 "${TARGET_DIR}"
wget -q -O - "$URL" | tar xfz - -C "${TARGET_DIR}" --strip-components 1
```

### Enable the module
### Enable the module

In the Icinga Web 2 frontend in `Configuration -> Modules -> grafana -> enable`.

![iEnable grafana module](images/02-installation-01.png)
![enable Grafana module](images/02-installation-01.png)

You can also enable the module by using the `icingacli` command:

Expand Down
Loading