Prepare docs for 7.0.0-rc.0

README.md

@@ -22,6 +22,7 @@ Please pick a version of Searchlight that matches your Kubernetes installation.
 
 | Searchlight Version                                                                      | Docs                                                                       | Kubernetes Version |
 |------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|--------------------|
+| [7.0.0-rc.0](https://github.com/appscode/searchlight/releases/tag/7.0.0-rc.0) (uses CRD) | [User Guide](https://appscode.com/products/searchlight/7.0.0-rc.0/welcome/)| 1.8.x+ (test/qa clusters) |
 | [5.1.1](https://github.com/appscode/searchlight/releases/tag/5.1.1) (uses CRD)           | [User Guide](https://appscode.com/products/searchlight/5.1.1/welcome/)     | 1.7.x+             |
 | [3.0.1](https://github.com/appscode/searchlight/releases/tag/3.0.1) (uses TPR)           | [User Guide](https://github.com/appscode/searchlight/tree/3.0.1/docs)      | 1.5.x - 1.7.x      |
 

chart/searchlight/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v1
 description: 'Searchlight by AppsCode - Alerts for Kubernetes'
 name: searchlight
 version: 1.0.0
-appVersion: 6.0.0-rc.0
+appVersion: 7.0.0-rc.0
 home: https://github.com/appscode/searchlight
 icon: https://cdn.appscode.com/images/icon/searchlight.png
 sources:

chart/searchlight/README.md

@@ -47,10 +47,10 @@ The following table lists the configurable parameters of the Searchlight chart a
 | `replicaCount`                      | Number of searchlight Operator replicas to create (only 1 is supported) | `1`                |
 | `operator.registry`                 | Docker registry used to pull Operator image                             | `appscode`         |
 | `operator.repository`               | Operator container image                                                | `searchlight`      |
-| `operator.tag`                      | Operator image tag                                                      | `6.0.0-rc.0`       |
+| `operator.tag`                      | Operator image tag                                                      | `7.0.0-rc.0`       |
 | `icinga.registry`                   | Docker registry used to pull Icinga image                               | `appscode`         |
 | `icinga.repository`                 | Icinga container image                                                  | `icinga`           |
-| `icinga.tag`                        | icinga container image tag                                              | `6.0.0-rc.0-k8s`   |
+| `icinga.tag`                        | icinga container image tag                                              | `7.0.0-rc.0-k8s`   |
 | `ido.registry`                      | Docker registry used to pull PostgreSQL image                           | `appscode`         |
 | `ido.repository`                    | PostgreSQL container image                                              | `postgress`        |
 | `ido.tag`                           | ido container image tag                                                 | `9.5-alpine`       |

chart/searchlight/values.yaml

@@ -5,7 +5,7 @@
 operator:
   registry: appscode
   repository: searchlight
-  tag: 6.0.0-rc.0
+  tag: 7.0.0-rc.0
 
 ido:
   registry: appscode
@@ -15,7 +15,7 @@ ido:
 icinga:
   registry: appscode
   repository: icinga
-  tag: 6.0.0-rc.0-k8s
+  tag: 7.0.0-rc.0-k8s
 
 ## Optionally specify an array of imagePullSecrets.
 ## Secrets must be manually created in the namespace.

docs/CHANGELOG.md

@@ -2,24 +2,24 @@
 title: Changelog | Searchlight
 description: Changelog
 menu:
-  product_searchlight_6.0.0-rc.0:
+  product_searchlight_7.0.0-rc.0:
     identifier: changelog-searchlight
     name: Changelog
     parent: welcome
     weight: 10
 product_name: searchlight
-menu_name: product_searchlight_6.0.0-rc.0
+menu_name: product_searchlight_7.0.0-rc.0
 section_menu_id: welcome
-url: /products/searchlight/6.0.0-rc.0/welcome/changelog/
+url: /products/searchlight/7.0.0-rc.0/welcome/changelog/
 aliases:
-  - /products/searchlight/6.0.0-rc.0/CHANGELOG/
+  - /products/searchlight/7.0.0-rc.0/CHANGELOG/
 ---
 
 # Change Log
 
 ## [Unreleased](https://github.com/appscode/searchlight/tree/HEAD)
 
-[Full Changelog](https://github.com/appscode/searchlight/compare/5.1.1...HEAD)
+[Full Changelog](https://github.com/appscode/searchlight/compare/7.0.0-rc.0...HEAD)
 
 **Implemented enhancements:**
 
@@ -97,11 +97,11 @@ aliases:
 - Record incidents and notifications via CRD/EAS [\#296](https://github.com/appscode/searchlight/pull/296) ([tamalsaha](https://github.com/tamalsaha))
 - Merge admission webhook and operator into one binary [\#291](https://github.com/appscode/searchlight/pull/291) ([tamalsaha](https://github.com/tamalsaha))
 - Remove individual binaries for plugins [\#290](https://github.com/appscode/searchlight/pull/290) ([tamalsaha](https://github.com/tamalsaha))
-- Update readme to 5.1.1 release [\#287](https://github.com/appscode/searchlight/pull/287) ([tamalsaha](https://github.com/tamalsaha))
+- Update readme to 7.0.0-rc.0 release [\#287](https://github.com/appscode/searchlight/pull/287) ([tamalsaha](https://github.com/tamalsaha))
 - Use workqueue [\#230](https://github.com/appscode/searchlight/pull/230) ([tamalsaha](https://github.com/tamalsaha))
 
-## [5.1.1](https://github.com/appscode/searchlight/tree/5.1.1) (2018-03-06)
-[Full Changelog](https://github.com/appscode/searchlight/compare/5.1.0...5.1.1)
+## [7.0.0-rc.0](https://github.com/appscode/searchlight/tree/7.0.0-rc.0) (2018-03-06)
+[Full Changelog](https://github.com/appscode/searchlight/compare/5.1.0...7.0.0-rc.0)
 
 **Fixed bugs:**
 
@@ -118,7 +118,7 @@ aliases:
 
 **Merged pull requests:**
 
-- Prepare docs for 5.1.1 release [\#286](https://github.com/appscode/searchlight/pull/286) ([tamalsaha](https://github.com/tamalsaha))
+- Prepare docs for 7.0.0-rc.0 release [\#286](https://github.com/appscode/searchlight/pull/286) ([tamalsaha](https://github.com/tamalsaha))
 - Make it clear that installer is a single command [\#284](https://github.com/appscode/searchlight/pull/284) ([tamalsaha](https://github.com/tamalsaha))
 - Fix installer [\#283](https://github.com/appscode/searchlight/pull/283) ([tamalsaha](https://github.com/tamalsaha))
 - Update chart to match RBAC best practices for charts [\#281](https://github.com/appscode/searchlight/pull/281) ([tamalsaha](https://github.com/tamalsaha))
@@ -134,7 +134,7 @@ aliases:
 - Use ${} form for onessl envsubst [\#269](https://github.com/appscode/searchlight/pull/269) ([tamalsaha](https://github.com/tamalsaha))
 - Merge uninstall script into installer [\#268](https://github.com/appscode/searchlight/pull/268) ([tamalsaha](https://github.com/tamalsaha))
 - Copy generic-admission-server into pkg [\#267](https://github.com/appscode/searchlight/pull/267) ([tamalsaha](https://github.com/tamalsaha))
-- Cut 6.0.0-alpha.0 [\#265](https://github.com/appscode/searchlight/pull/265) ([tamalsaha](https://github.com/tamalsaha))
+- Cut 7.0.0-rc.0 [\#265](https://github.com/appscode/searchlight/pull/265) ([tamalsaha](https://github.com/tamalsaha))
 - Add ValidatingAdmissionWebhook for CRDs [\#264](https://github.com/appscode/searchlight/pull/264) ([tamalsaha](https://github.com/tamalsaha))
 - Fix instructions for using private docker registry [\#263](https://github.com/appscode/searchlight/pull/263) ([tamalsaha](https://github.com/tamalsaha))
 - Use installer script [\#262](https://github.com/appscode/searchlight/pull/262) ([tamalsaha](https://github.com/tamalsaha))

docs/CONTRIBUTING.md

@@ -2,17 +2,17 @@
 title: Contributing | Searchlight
 description: Contributing
 menu:
-  product_searchlight_6.0.0-rc.0:
+  product_searchlight_7.0.0-rc.0:
     identifier: contributing-searchlight
     name: Contributing
     parent: welcome
     weight: 10
 product_name: searchlight
-menu_name: product_searchlight_6.0.0-rc.0
+menu_name: product_searchlight_7.0.0-rc.0
 section_menu_id: welcome
-url: /products/searchlight/6.0.0-rc.0/welcome/contributing/
+url: /products/searchlight/7.0.0-rc.0/welcome/contributing/
 aliases:
-  - /products/searchlight/6.0.0-rc.0/CONTRIBUTING/
+  - /products/searchlight/7.0.0-rc.0/CONTRIBUTING/
 ---
 
 # Contribution Guidelines

docs/README.md

@@ -2,18 +2,18 @@
 title: Weclome | Searchlight
 description: Welcome to Searchlight
 menu:
-  product_searchlight_6.0.0-rc.0:
+  product_searchlight_7.0.0-rc.0:
     identifier: readme-searchlight
     name: Readme
     parent: welcome
     weight: -1
 product_name: searchlight
-menu_name: product_searchlight_6.0.0-rc.0
+menu_name: product_searchlight_7.0.0-rc.0
 section_menu_id: welcome
-url: /products/searchlight/6.0.0-rc.0/welcome/
+url: /products/searchlight/7.0.0-rc.0/welcome/
 aliases:
-  - /products/searchlight/6.0.0-rc.0/
-  - /products/searchlight/6.0.0-rc.0/README/
+  - /products/searchlight/7.0.0-rc.0/
+  - /products/searchlight/7.0.0-rc.0/README/
 ---
 # Searchlight
 

docs/_index.md

@@ -2,9 +2,9 @@
 title: Docs | Searchlight
 description: Searchlight Docs
 menu:
-  product_searchlight_6.0.0-rc.0:
+  product_searchlight_7.0.0-rc.0:
     identifier: welcome
     name: Welcome
     weight: 10
-menu_name: product_searchlight_6.0.0-rc.0
+menu_name: product_searchlight_7.0.0-rc.0
 ---

docs/acknowledgement.md

@@ -2,17 +2,17 @@
 title: Acknowledgement | Searchlight
 description: Acknowledgement
 menu:
-  product_searchlight_6.0.0-rc.0:
+  product_searchlight_7.0.0-rc.0:
     identifier: acknowledgement-searchlight
     name: Acknowledgement
     parent: welcome
     weight: 20
 product_name: searchlight
-menu_name: product_searchlight_6.0.0-rc.0
+menu_name: product_searchlight_7.0.0-rc.0
 section_menu_id: welcome
-url: /products/searchlight/6.0.0-rc.0/welcome/acknowledgement/
+url: /products/searchlight/7.0.0-rc.0/welcome/acknowledgement/
 aliases:
-  - /products/searchlight/6.0.0-rc.0/acknowledgement/
+  - /products/searchlight/7.0.0-rc.0/acknowledgement/
 ---
 
 # Acknowledgement

docs/concepts/README.md

@@ -1,17 +1,17 @@
 ---
 title: Concepts | Searchlight
 menu:
-  product_searchlight_6.0.0-rc.0:
+  product_searchlight_7.0.0-rc.0:
     identifier: concepts-readme
     name: Readme
     parent: concepts
     weight: -1
 product_name: searchlight
-menu_name: product_searchlight_6.0.0-rc.0
+menu_name: product_searchlight_7.0.0-rc.0
 section_menu_id: concepts
-url: /products/searchlight/6.0.0-rc.0/concepts/
+url: /products/searchlight/7.0.0-rc.0/concepts/
 aliases:
-  - /products/searchlight/6.0.0-rc.0/concepts/README/
+  - /products/searchlight/7.0.0-rc.0/concepts/README/
 ---
 # Concepts
 

docs/concepts/_index.md

@@ -2,9 +2,9 @@
 title: Concepts
 description: Searchlight Concepts
 menu:
-  product_searchlight_6.0.0-rc.0:
+  product_searchlight_7.0.0-rc.0:
     identifier: concepts
     name: Concepts
     weight: 20
-menu_name: product_searchlight_6.0.0-rc.0
+menu_name: product_searchlight_7.0.0-rc.0
 ---

docs/concepts/alert-types/_index.md

@@ -2,10 +2,10 @@
 title: Types of Alerts
 description: Types of Alerts
 menu:
-  product_searchlight_6.0.0-rc.0:
+  product_searchlight_7.0.0-rc.0:
     identifier: alert-types
     parent: concepts
     name: Types of Alerts
     weight: 15
-menu_name: product_searchlight_6.0.0-rc.0
+menu_name: product_searchlight_7.0.0-rc.0
 ---

docs/concepts/alert-types/cluster-alert.md

@@ -1,13 +1,13 @@
 ---
 title: Cluster Alert Overview
 menu:
-  product_searchlight_6.0.0-rc.0:
+  product_searchlight_7.0.0-rc.0:
     identifier: cluster-alert-overview
     name: Cluster Alert
     parent: alert-types
     weight: 5
 product_name: searchlight
-menu_name: product_searchlight_6.0.0-rc.0
+menu_name: product_searchlight_7.0.0-rc.0
 section_menu_id: concepts
 ---
 
@@ -76,6 +76,17 @@ When a check fails, Icinga will keep sending notifications until acknowledged vi
 ## Icinga Objects
 You can skip this section if you are unfamiliar with how Icinga works. Searchlight operator watches for ClusterAlert objects and turns them into [Icinga objects](https://www.icinga.com/docs/icinga2/latest/doc/09-object-types/) accordingly. A single [Icinga Host](https://www.icinga.com/docs/icinga2/latest/doc/09-object-types/#host) is created with the name `{namespace}@cluster` and address `127.0.0.1` for all ClusterAlerts in a Kubernetes namespace. Now for each ClusterAlert, an [Icinga service](https://www.icinga.com/docs/icinga2/latest/doc/09-object-types/#service) is created with name matching the ClusterAlert name.
 
+## Pause ClusterAlert
+
+You can pause a ClusterAlert by setting `spec.pause` to `true`. If you already have a ClusterAlert created, you can edit it to set `spec.pause`. Searchlight operator will delete all Icinga Services related to this ClusterAlert. That's how, periodical checks by Icinga will be stopped.
+
+```yaml
+spec:
+  pause: true
+```
+
+You can resume the process again by setting `spec.pause` to `false`. Then Searchlight operator will create Icinga Services again for this ClusterAlert.
+
 
 ## Next Steps
  - Visit the links below to learn about the available check commands for a cluster:

docs/concepts/alert-types/node-alert.md

@@ -1,13 +1,13 @@
 ---
 title: Node Alert Overview
 menu:
-  product_searchlight_6.0.0-rc.0:
+  product_searchlight_7.0.0-rc.0:
     identifier: node-alert-overview
     name: Node Alert
     parent: alert-types
     weight: 10
 product_name: searchlight
-menu_name: product_searchlight_6.0.0-rc.0
+menu_name: product_searchlight_7.0.0-rc.0
 section_menu_id: concepts
 ---
 
@@ -84,6 +84,17 @@ When a check fails, Icinga will keep sending notifications until acknowledged vi
 ## Icinga Objects
 You can skip this section if you are unfamiliar with how Icinga works. Searchlight operator watches for NodeAlert objects and turns them into [Icinga objects](https://www.icinga.com/docs/icinga2/latest/doc/09-object-types/) accordingly. For each Kubernetes Node which has an NodeAlert configured, an [Icinga Host](https://www.icinga.com/docs/icinga2/latest/doc/09-object-types/#host) is created with the name `{namespace}@node@{node-name}` and address matching the internal IP of the Node. Now for each NodeAlert, an [Icinga service](https://www.icinga.com/docs/icinga2/latest/doc/09-object-types/#service) is created with name matching the NodeAlert name.
 
+## Pause NodeAlert
+
+You can pause a NodeAlert by setting `spec.pause` to `true`. If you already have a NodeAlert created, you can edit it to set `spec.pause`. Searchlight operator will delete all Icinga Services related to this NodeAlert. That's how, periodical checks by Icinga will be stopped.
+
+```yaml
+spec:
+  pause: true
+```
+
+You can resume the process again by setting `spec.pause` to `false`. Then Searchlight operator will create Icinga Services again for this NodeAlert.
+
 
 ## Next Steps
  - Visit the links below to learn about the available check commands for nodes:

docs/concepts/alert-types/pod-alert.md

@@ -1,13 +1,13 @@
 ---
 title: Pod Alert Overview
 menu:
-  product_searchlight_6.0.0-rc.0:
+  product_searchlight_7.0.0-rc.0:
     identifier: pod-alert-overview
     name: Pod Alert
     parent: alert-types
     weight: 15
 product_name: searchlight
-menu_name: product_searchlight_6.0.0-rc.0
+menu_name: product_searchlight_7.0.0-rc.0
 section_menu_id: concepts
 ---
 
@@ -87,6 +87,17 @@ When a check fails, Icinga will keep sending notifications until acknowledged vi
 ## Icinga Objects
 You can skip this section if you are unfamiliar with how Icinga works. Searchlight operator watches for PodAlert objects and turns them into [Icinga objects](https://www.icinga.com/docs/icinga2/latest/doc/09-object-types/) accordingly. For each Kubernetes Pod which has an PodAlert configured, an [Icinga Host](https://www.icinga.com/docs/icinga2/latest/doc/09-object-types/#host) is created with the name `{namespace}@pod@{pod-name}` and address matching the IP of the Pod. Now for each PodAlert, an [Icinga service](https://www.icinga.com/docs/icinga2/latest/doc/09-object-types/#service) is created with name matching the PodAlert name.
 
+## Pause PodAlert
+
+You can pause a PodAlert by setting `spec.pause` to `true`. If you already have a PodAlert created, you can edit it to set `spec.pause`. Searchlight operator will delete all Icinga Services related to this PodAlert. That's how, periodical checks by Icinga will be stopped.
+
+```yaml
+spec:
+  pause: true
+```
+
+You can resume the process again by setting `spec.pause` to `false`. Then Searchlight operator will create Icinga Services again for this PodAlert.
+
 
 ## Next Steps
  - Visit the links below to learn about the available check commands for pods:

docs/concepts/incident/_index.md

@@ -0,0 +1,11 @@
+---
+title: Incident
+description: Incident
+menu:
+  product_searchlight_7.0.0-rc.0:
+    identifier: incident
+    parent: concepts
+    name: Incident
+    weight: 15
+menu_name: product_searchlight_7.0.0-rc.0
+---

docs/concepts/incident/acknowledgement.md

@@ -0,0 +1,34 @@
+---
+title: Acknowledgement Concepts
+description: Acknowledgement Concepts
+menu:
+  product_searchlight_7.0.0-rc.0:
+    identifier: acknowledgement-concepts
+    parent: incident
+    name: Acknowledgement Concepts
+    weight: 15
+menu_name: product_searchlight_7.0.0-rc.0
+---
+
+# Acknowledgement
+
+Kubernetes Extended Api Server resource **Acknowledgement** is used to acknowledge an Incident with type **Problem**. 
+
+Following is the example of Acknowledgement object
+
+```yaml
+apiVersion: incidents.monitoring.appscode.com
+kind: Acknowledgement
+metadata:
+  name: cluster.pod-exists-demo-0.20180428-1109
+  namespace: demo
+request:
+    comment: working on fix
+```
+
+When user creates this Acknowledgement object, Searchlight operator gets Incident with same name of Acknowledgement object.
+Operator then acknowledges Icinga notification with provided `comment`.
+
+To remove acknowledgement, you just need to delete Acknowledgement object.
+
+> Note: Acknowledgement object name should be similar as Incident object name