Skip to content

Commit

Permalink
Update FAQ.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lmangani committed Mar 1, 2018
1 parent 9135767 commit efa3b04
Showing 1 changed file with 19 additions and 16 deletions.
35 changes: 19 additions & 16 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,58 @@
## Frequently Asked Questions

##### Q: Is SENTINL a Watcher clone?
SENTINL is not a Watcher clone per-se, but it does share generic concepts and configuration style with Elastic Watcher to ease the pain of users migrating between the two solutions and could potentially be used to manage Elastic Watcher alerts.
##### Is SENTINL just a Watcher clone?
SENTINL is not just a Watcher clone per-se, but it does share generic concepts and configuration style with Elastic Watcher to ease the pain of users migrating between the two solutions and could potentially be used to manage Elastic Watcher alerts.

SENTINL is a Kibi application and its core scheduler runs within the Kibi/Kibana server and is controlled with a dedicated UI, while Elastic Watcher is a head-less, Elasticsearch plugin and runs inside of Elasticsearch _(and requires a commercial license to function past trial)_
SENTINL is a Kibana application and its core scheduler runs within the Kibi/Kibana server, controlled with a dedicated UI, while Elastic Watcher is a head-less, Elasticsearch plugin and runs inside of Elasticsearch servers as part of the X-Pack commercial offer _(under a nasty proprietary commercial license under false "free" pretenses to lock-in users)_

SENTINL is truly and completely Open-Source. The Elastic watcher is NOT and appears unsafe to be trusted as Elastic might change their mind again in the future, locking in users to their paid services.

---

##### How can I help or contribute?
SENTINL is Open-Source and anyone can tremendously help the project by contributing code, testing, hunting bugs and extending documentation. Non technical user? Help us by improving documentation, adding examples you find valuable, or just spreading the word about our solutions with a blog post, tweet promoting the project to potential users.

---

##### Q: How can I help?
SENTINL is Open-Source and anyone can tremendously help the project by contributing code, testing, hunting bugs and extending documentation. Non technical user? Help us by spreading the word about our solutions with a blog post, tweet or by sharing your experience using it.
##### Is version 6.x supported?
SENTINL will support all modern versions of Kibana and Elasticsearch. Version 6.x is already available for testing in our releases and will bring a new wave of native integration with Kibana tools, enhancing the experience.

---
### Technical

##### Q: Emails are not being sent - Why?
##### Emails are not being sent - Why?
SENTINL uses the ```emailjs``` npm module to ship out emails. The module requires a correct message formed, so make sure your configuration includes a valid FROM and TO as well as proper authentication method for your mail relay. In case of doubts, please refer to the [documentation](https://github.com/eleith/emailjs)

---

##### Q: Reports are not being generated - Why?
##### Reports are not being generated - Why?
SENTINL uses the ```node-horseman``` npm module to control ```PhantomJS``` at the core of this feature. The module requires ```PhantomJS``` being pre-installed on the system running KaaE and Reports.

---

##### Q: Can I disable a watcher without deleting it?
##### Can I disable a watcher without deleting it?
Sure! Just set watcher parameter ```_source.disable: true``` and SENTINL will bypass it entirely.

---

##### Q: How many concurrent watcher can SENTINL handle?
##### How many concurrent watcher can SENTINL handle?
Sentinl relies on Elasticsearch search thread pool. By default, it is 1000 concurrent requests (if server hardware is powerful enough), also this value can be configured. Thus theoretically, by default, we can support 1000 watchers running at the same time.

---


##### Q: Watchers are not running in my timezone - Why?
##### Watchers are not running in my timezone - Why?
SENTINL uses the UTC timezone internally to execute schedule - While rolling watchers are not effected _(every x minutes)_ UTC timezone will be used for absolute timed executions. Future versions will allow adapting to localTimezone of the server executing Kibana/Kibi.

---

##### Q: How can I avoid string encoding in mustache templates output?
##### How can I avoid string encoding in mustache templates output?
When using mustache templates, all variables are HTML escaped by default. If you want to return unescaped HTML, use the triple mustache: {{{name}}}. You can also use & to unescape a variable: {{& name}}. This may be useful when changing delimiters (see [documentation](https://mustache.github.io/mustache.5.html))



---

##### Q: How can I use SENTINL with readonlyRest authentication?
##### How can I use SENTINL with readonlyRest authentication?
When using ```readonlyRest```, the following SENTINL exceptions should be added to its configuration:
```
- name: ALLOWPOST
Expand All @@ -69,7 +72,7 @@ When using ```readonlyRest```, the following SENTINL exceptions should be added
---


##### Q: How can I use SENTINL with SearchGuard authentication?
##### How can I use SENTINL with SearchGuard authentication?
Here's an example provided by our Community to use SENTINL + SearchGuard. [Full demo configuration](Sentinl-in-Kibana-Searchguard-5.5.2-demo).

1. Edit the `sg_kibana_server` role in sg_roles.yml:
Expand Down Expand Up @@ -99,14 +102,14 @@ elasticsearch-5.4.0$ ./plugins/search-guard-5/tools/sgadmin.sh -cd plugins/searc
```
---

##### Q: Why are prebuilt SENTINL packages so big?
##### Why are prebuilt SENTINL packages so big?
SENTINL prebuilt packages include PhantomJS binaries, occupying most of the archive space.


---


##### Q: How can I secure sensitive passwords and values in SENTINL configuration?
##### How can I secure sensitive passwords and values in SENTINL configuration?
When using Kibana 6.2+ the [Secure Settings](https://www.elastic.co/guide/en/kibana/current/secure-settings.html) feature can be leveraged to encrypt sensitive details. An example to protect the Email password:
```
bin/kibana-keystore create
Expand Down

0 comments on commit efa3b04

Please sign in to comment.