Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tamalsaha committed Apr 20, 2018
1 parent 99f8c6d commit 0c94e12
Show file tree
Hide file tree
Showing 125 changed files with 413 additions and 579 deletions.
2 changes: 1 addition & 1 deletion chart/searchlight/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: v1
description: 'Searchlight by AppsCode - Alerts for Kubernetes'
name: searchlight
version: 1.0.0
appVersion: 6.0.0-alpha.0
appVersion: 6.0.0-rc.0
home: https:/appscode/searchlight
icon: https://cdn.appscode.com/images/icon/searchlight.png
sources:
Expand Down
5 changes: 2 additions & 3 deletions chart/searchlight/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,15 @@ The command removes all the Kubernetes components associated with the chart and

The following table lists the configurable parameters of the Searchlight chart and their default values.


| Parameter | Description | Default |
| ----------------------------------- | ----------------------------------------------------------------- | ------------------ |
| `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-alpha.0` |
| `operator.tag` | Operator image tag | `6.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-alpha.0-k8s`|
| `icinga.tag` | icinga container image tag | `6.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` |
Expand Down
4 changes: 2 additions & 2 deletions chart/searchlight/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
operator:
registry: appscode
repository: searchlight
tag: 6.0.0-alpha.0
tag: 6.0.0-rc.0

ido:
registry: appscode
Expand All @@ -15,7 +15,7 @@ ido:
icinga:
registry: appscode
repository: icinga
tag: 6.0.0-alpha.0-k8s
tag: 6.0.0-rc.0-k8s

## Optionally specify an array of imagePullSecrets.
## Secrets must be manually created in the namespace.
Expand Down
56 changes: 51 additions & 5 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,61 @@
title: Changelog | Searchlight
description: Changelog
menu:
product_searchlight_6.0.0-alpha.0:
product_searchlight_6.0.0-rc.0:
identifier: changelog-searchlight
name: Changelog
parent: welcome
weight: 10
product_name: searchlight
menu_name: product_searchlight_6.0.0-alpha.0
menu_name: product_searchlight_6.0.0-rc.0
section_menu_id: welcome
url: /products/searchlight/6.0.0-alpha.0/welcome/changelog/
url: /products/searchlight/6.0.0-rc.0/welcome/changelog/
aliases:
- /products/searchlight/6.0.0-alpha.0/CHANGELOG/
- /products/searchlight/6.0.0-rc.0/CHANGELOG/
---

# Change Log

## [Unreleased](https:/appscode/searchlight/tree/HEAD)

[Full Changelog](https:/appscode/searchlight/compare/5.1.1...HEAD)
[Full Changelog](https:/appscode/searchlight/compare/6.0.0-rc.0...HEAD)

**Implemented enhancements:**

- Support webhook based custom plugin [\#336](https:/appscode/searchlight/pull/336) ([aerokite](https:/aerokite))

**Closed issues:**

- Support user provided plugin [\#293](https:/appscode/searchlight/issues/293)

**Merged pull requests:**

- Generate non-namespaced client for plugins [\#355](https:/appscode/searchlight/pull/355) ([aerokite](https:/aerokite))
- add patch permission [\#354](https:/appscode/searchlight/pull/354) ([aerokite](https:/aerokite))
- Various fixes to searchlight installer [\#352](https:/appscode/searchlight/pull/352) ([tamalsaha](https:/tamalsaha))
- Remove jessie icinga [\#349](https:/appscode/searchlight/pull/349) ([aerokite](https:/aerokite))
- Introduce properties for plugins vars [\#348](https:/appscode/searchlight/pull/348) ([aerokite](https:/aerokite))
- Migrate builtin check commands to Plugin crd [\#347](https:/appscode/searchlight/pull/347) ([aerokite](https:/aerokite))
- Add RBAC instructions for GKE cluster [\#346](https:/appscode/searchlight/pull/346) ([tamalsaha](https:/tamalsaha))
- Update chart repository location [\#345](https:/appscode/searchlight/pull/345) ([tamalsaha](https:/tamalsaha))
- Support installing from local installer scripts [\#344](https:/appscode/searchlight/pull/344) ([tamalsaha](https:/tamalsaha))
- Move swagger.json to openapi-spec folder [\#343](https:/appscode/searchlight/pull/343) ([tamalsaha](https:/tamalsaha))
- Regenerate swagger.json [\#342](https:/appscode/searchlight/pull/342) ([tamalsaha](https:/tamalsaha))
- Generate swagger.json [\#341](https:/appscode/searchlight/pull/341) ([tamalsaha](https:/tamalsaha))
- Add install pkg for crds [\#340](https:/appscode/searchlight/pull/340) ([tamalsaha](https:/tamalsaha))
- Skip setting ListKind [\#339](https:/appscode/searchlight/pull/339) ([tamalsaha](https:/tamalsaha))
- Add CRD Validation [\#338](https:/appscode/searchlight/pull/338) ([tamalsaha](https:/tamalsaha))
- Generate openapi spec [\#337](https:/appscode/searchlight/pull/337) ([tamalsaha](https:/tamalsaha))
- Fix install script for minikube 0.24.x \(Kube 1.8.0\) [\#335](https:/appscode/searchlight/pull/335) ([tamalsaha](https:/tamalsaha))
- Fix comment for LastNotificationType in IncidentStatus [\#334](https:/appscode/searchlight/pull/334) ([aerokite](https:/aerokite))
- fix typo [\#333](https:/appscode/searchlight/pull/333) ([aerokite](https:/aerokite))
- Garbage collect incidents older than 90 days [\#332](https:/appscode/searchlight/pull/332) ([tamalsaha](https:/tamalsaha))
- Document user roles [\#331](https:/appscode/searchlight/pull/331) ([tamalsaha](https:/tamalsaha))
- Update docs for json\_path [\#330](https:/appscode/searchlight/pull/330) ([tamalsaha](https:/tamalsaha))
- Correctly install validation webhook [\#329](https:/appscode/searchlight/pull/329) ([tamalsaha](https:/tamalsaha))

## [6.0.0-rc.0](https:/appscode/searchlight/tree/6.0.0-rc.0) (2018-03-29)
[Full Changelog](https:/appscode/searchlight/compare/5.1.1...6.0.0-rc.0)

**Implemented enhancements:**

Expand All @@ -43,6 +80,15 @@ aliases:

**Merged pull requests:**

- Fix : No such file or directory: '$GOPATH/src/github.com/appscode/sea… [\#327](https:/appscode/searchlight/pull/327) ([YangYongZhi](https:/YangYongZhi))
- Add docs for adding check command [\#326](https:/appscode/searchlight/pull/326) ([aerokite](https:/aerokite))
- Fix build on mac [\#325](https:/appscode/searchlight/pull/325) ([tamalsaha](https:/tamalsaha))
- Skip downloading onessl is already exists [\#324](https:/appscode/searchlight/pull/324) ([tamalsaha](https:/tamalsaha))
- Fix installer script [\#323](https:/appscode/searchlight/pull/323) ([tamalsaha](https:/tamalsaha))
- Use server cert for icinga [\#322](https:/appscode/searchlight/pull/322) ([tamalsaha](https:/tamalsaha))
- Write auto-generated icinga certs to disk [\#321](https:/appscode/searchlight/pull/321) ([tamalsaha](https:/tamalsaha))
- Revendor kutil and jsonpatch library [\#319](https:/appscode/searchlight/pull/319) ([tamalsaha](https:/tamalsaha))
- Add changelog [\#318](https:/appscode/searchlight/pull/318) ([tamalsaha](https:/tamalsaha))
- Reorg objects deleted in uninstall command [\#317](https:/appscode/searchlight/pull/317) ([tamalsaha](https:/tamalsaha))
- Add tests for plugins [\#316](https:/appscode/searchlight/pull/316) ([tamalsaha](https:/tamalsaha))
- Add e2e test for notifier [\#315](https:/appscode/searchlight/pull/315) ([aerokite](https:/aerokite))
Expand Down
8 changes: 4 additions & 4 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
title: Contributing | Searchlight
description: Contributing
menu:
product_searchlight_6.0.0-alpha.0:
product_searchlight_6.0.0-rc.0:
identifier: contributing-searchlight
name: Contributing
parent: welcome
weight: 10
product_name: searchlight
menu_name: product_searchlight_6.0.0-alpha.0
menu_name: product_searchlight_6.0.0-rc.0
section_menu_id: welcome
url: /products/searchlight/6.0.0-alpha.0/welcome/contributing/
url: /products/searchlight/6.0.0-rc.0/welcome/contributing/
aliases:
- /products/searchlight/6.0.0-alpha.0/CONTRIBUTING/
- /products/searchlight/6.0.0-rc.0/CONTRIBUTING/
---

# Contribution Guidelines
Expand Down
10 changes: 5 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
title: Weclome | Searchlight
description: Welcome to Searchlight
menu:
product_searchlight_6.0.0-alpha.0:
product_searchlight_6.0.0-rc.0:
identifier: readme-searchlight
name: Readme
parent: welcome
weight: -1
product_name: searchlight
menu_name: product_searchlight_6.0.0-alpha.0
menu_name: product_searchlight_6.0.0-rc.0
section_menu_id: welcome
url: /products/searchlight/6.0.0-alpha.0/welcome/
url: /products/searchlight/6.0.0-rc.0/welcome/
aliases:
- /products/searchlight/6.0.0-alpha.0/
- /products/searchlight/6.0.0-alpha.0/README/
- /products/searchlight/6.0.0-rc.0/
- /products/searchlight/6.0.0-rc.0/README/
---
# Searchlight

Expand Down
4 changes: 2 additions & 2 deletions docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Docs | Searchlight
description: Searchlight Docs
menu:
product_searchlight_6.0.0-alpha.0:
product_searchlight_6.0.0-rc.0:
identifier: welcome
name: Welcome
weight: 10
menu_name: product_searchlight_6.0.0-alpha.0
menu_name: product_searchlight_6.0.0-rc.0
---
8 changes: 4 additions & 4 deletions docs/acknowledgement.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
title: Acknowledgement | Searchlight
description: Acknowledgement
menu:
product_searchlight_6.0.0-alpha.0:
product_searchlight_6.0.0-rc.0:
identifier: acknowledgement-searchlight
name: Acknowledgement
parent: welcome
weight: 20
product_name: searchlight
menu_name: product_searchlight_6.0.0-alpha.0
menu_name: product_searchlight_6.0.0-rc.0
section_menu_id: welcome
url: /products/searchlight/6.0.0-alpha.0/welcome/acknowledgement/
url: /products/searchlight/6.0.0-rc.0/welcome/acknowledgement/
aliases:
- /products/searchlight/6.0.0-alpha.0/acknowledgement/
- /products/searchlight/6.0.0-rc.0/acknowledgement/
---

# Acknowledgement
Expand Down
8 changes: 4 additions & 4 deletions docs/concepts/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
title: Concepts | Searchlight
menu:
product_searchlight_6.0.0-alpha.0:
product_searchlight_6.0.0-rc.0:
identifier: concepts-readme
name: Readme
parent: concepts
weight: -1
product_name: searchlight
menu_name: product_searchlight_6.0.0-alpha.0
menu_name: product_searchlight_6.0.0-rc.0
section_menu_id: concepts
url: /products/searchlight/6.0.0-alpha.0/concepts/
url: /products/searchlight/6.0.0-rc.0/concepts/
aliases:
- /products/searchlight/6.0.0-alpha.0/concepts/README/
- /products/searchlight/6.0.0-rc.0/concepts/README/
---
# Concepts

Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Concepts
description: Searchlight Concepts
menu:
product_searchlight_6.0.0-alpha.0:
product_searchlight_6.0.0-rc.0:
identifier: concepts
name: Concepts
weight: 20
menu_name: product_searchlight_6.0.0-alpha.0
menu_name: product_searchlight_6.0.0-rc.0
---
4 changes: 2 additions & 2 deletions docs/concepts/alert-types/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: Types of Alerts
description: Types of Alerts
menu:
product_searchlight_6.0.0-alpha.0:
product_searchlight_6.0.0-rc.0:
identifier: alert-types
parent: concepts
name: Types of Alerts
weight: 15
menu_name: product_searchlight_6.0.0-alpha.0
menu_name: product_searchlight_6.0.0-rc.0
---
28 changes: 14 additions & 14 deletions docs/concepts/alert-types/cluster-alert.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Cluster Alert Overview
menu:
product_searchlight_6.0.0-alpha.0:
product_searchlight_6.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-alpha.0
menu_name: product_searchlight_6.0.0-rc.0
section_menu_id: concepts
---

Expand All @@ -27,7 +27,7 @@ metadata:
name: pod-exists-demo-0
namespace: demo
spec:
check: pod_exists
check: pod-exists
vars:
selector: app=nginx
count: '2'
Expand All @@ -43,7 +43,7 @@ spec:
This object will do the followings:
- This Alert is set at cluster level in `demo` namespace.
- Check command `pod_exists` will check for 2 pods matching the label `app=nginx` in `demo` namespace.
- Check command `pod-exists` will check for 2 pods matching the label `app=nginx` in `demo` namespace.
- Icinga will check for the existence of pods every 60s.
- Notifications will be sent every 3m if any problem is detected, until acknowledged.
- When the number of pods with label app=nginx is not 2, it will reach `Critical` state and SMSes will be sent to _+1-234-567-8901_ via Twilio as notification.
Expand All @@ -54,12 +54,12 @@ Any ClusterAlert object has 2 main sections:
### Check Command
Check commands are used by Icinga to periodically test some condition. If the test return positive appropriate notifications are sent. The following check commands are supported for pods:

- [ca_cert](/docs/guides/cluster-alerts/ca_cert.md) - To check expiration of CA certificate used by Kubernetes api server.
- [component_status](/docs/guides/cluster-alerts/component_status.md) - To check Kubernetes component status.
- [ca-cert](/docs/guides/cluster-alerts/ca-cert.md) - To check expiration of CA certificate used by Kubernetes api server.
- [component-status](/docs/guides/cluster-alerts/component-status.md) - To check Kubernetes component status.
- [event](/docs/guides/cluster-alerts/event.md) - To check Kubernetes Warning events.
- [json_path](/docs/guides/cluster-alerts/json_path.md) - To check any JSON HTTP response using [jq](https://stedolan.github.io/jq/).
- [node_exists](/docs/guides/cluster-alerts/node_exists.md) - To check existence of Kubernetes nodes.
- [pod_exists](/docs/guides/cluster-alerts/pod_exists.md) - To check existence of Kubernetes pods.
- [json-path](/docs/guides/cluster-alerts/json-path.md) - To check any JSON HTTP response using [jq](https://stedolan.github.io/jq/).
- [node-exists](/docs/guides/cluster-alerts/node-exists.md) - To check existence of Kubernetes nodes.
- [pod-exists](/docs/guides/cluster-alerts/pod-exists.md) - To check existence of Kubernetes pods.

Each check command has a name specified in `spec.check` field. Optionally each check command can take one or more parameters. These are specified in `spec.vars` field. To learn about the available parameters for each check command, please visit their documentation. `spec.checkInterval` specifies how frequently Icinga will perform this check. Some examples are: 30s, 5m, 6h, etc.

Expand All @@ -79,12 +79,12 @@ You can skip this section if you are unfamiliar with how Icinga works. Searchlig

## Next Steps
- Visit the links below to learn about the available check commands for a cluster:
- [ca_cert](/docs/guides/cluster-alerts/ca_cert.md) - To check expiration of CA certificate used by Kubernetes api server.
- [component_status](/docs/guides/cluster-alerts/component_status.md) - To check Kubernetes component status.
- [ca-cert](/docs/guides/cluster-alerts/ca-cert.md) - To check expiration of CA certificate used by Kubernetes api server.
- [component-status](/docs/guides/cluster-alerts/component-status.md) - To check Kubernetes component status.
- [event](/docs/guides/cluster-alerts/event.md) - To check Kubernetes Warning events.
- [json_path](/docs/guides/cluster-alerts/json_path.md) - To check any JSON HTTP response using [jq](https://stedolan.github.io/jq/).
- [node_exists](/docs/guides/cluster-alerts/node_exists.md) - To check existence of Kubernetes nodes.
- [pod_exists](/docs/guides/cluster-alerts/pod_exists.md) - To check existence of Kubernetes pods.
- [json-path](/docs/guides/cluster-alerts/json-path.md) - To check any JSON HTTP response using [jq](https://stedolan.github.io/jq/).
- [node-exists](/docs/guides/cluster-alerts/node-exists.md) - To check existence of Kubernetes nodes.
- [pod-exists](/docs/guides/cluster-alerts/pod-exists.md) - To check existence of Kubernetes pods.
- To periodically run various checks on nodes in a Kubernetes cluster, use [NodeAlerts](/docs/concepts/alert-types/node-alert.md).
- To periodically run various checks on pods in a Kubernetes cluster, use [PodAlerts](/docs/concepts/alert-types/pod-alert.md).
- See the list of supported notifiers [here](/docs/guides/notifiers.md).
Expand Down
Loading

0 comments on commit 0c94e12

Please sign in to comment.