Skip to content

Commit

Permalink
added issue templates / readme hint
Browse files Browse the repository at this point in the history
  • Loading branch information
raffis committed Mar 1, 2019
1 parent 834d21a commit 8d2d1c8
Show file tree
Hide file tree
Showing 4 changed files with 68 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

#### Describe the bug
A clear and concise description of what the bug is.

#### To Reproduce
Steps to reproduce the behavior:

#### Expected behavior
A clear and concise description of what you expected to happen.

#### Environment
- kube-icinga version: [e.g. v1.0.0]
- kubernetes version: [e.g. v1.0.0]
- icinga2 version: [e.g. Linux Mint 19.2]

#### Additional context
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/change-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Change request
about: Propose a change for an already implemented solution
title: ''
labels: change
assignees: ''

---

#### Describe the change
A clear and concise description of what the change is about.

#### Current situation
Describe the current situation.

#### Should
Describe the changes you would like to propose.

#### Additional context
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: feature
assignees: ''

---

#### Is your feature request related to a problem? Please describe
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

#### Describe the solution you'd like
A clear and concise description of what you want to happen.

#### Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

#### Additional context
Add any other context or screenshots about the feature request here.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,13 +85,16 @@ Since a persistent volume is not directly attached to namespace the namespace fo
>**Note** Volume services are created by default with the dummy check_command. Since there is no way for kube-icinga to specify the correct command automatically. You need to either overwrite the check_command in annotations, set the command
in the serviceDefinition for volumes or disable service provisioning, enable host provisioning (set hostName to `null`) and create icinga apply rule based services manually.


You may wonder where your pods are in this setup. Well it does not make any sense to monitor single pods. Pods are mortal and (always) moving. The important thing is to monitor your services as an entity.


## Requirements
* A running kubernetes cluster
* Icinga2 server with enabled API module

**Note**: Icinga2 does not have to be running on kubernetes! You may just use your icinga2 server outside your kubernetes cluster.

## Setup icinga2 api user
kube-icina requires an [icinga api user](https://icinga.com/docs/icinga2/latest/doc/12-icinga2-api/#authentication) which first must be created.

Expand Down

0 comments on commit 8d2d1c8

Please sign in to comment.