Skip to content

Commit eab941c

Browse files
committed
Adding a README to the project so it can be blogged and used in the wild
1 parent 2bc788f commit eab941c

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
hubot-elasticsearch
2+
==
3+
4+
A Hubot script for interacting with an [elasticsearch](http://www.elasticsearch.org/x) cluster
5+
6+
Installation
7+
---
8+
9+
In hubot project repo, run:
10+
11+
npm install hubot-elasticsearch --save
12+
13+
Then add hubot-etcd to your external-scripts.json:
14+
15+
```
16+
[
17+
"hubot-elasticsearch"
18+
]
19+
```
20+
21+
Commands
22+
---
23+
24+
* hubot: elasticsearch cluster health [cluster] - Gets the cluster health for the given server or alias
25+
* hubot: elasticsearch cat nodes [cluster] - Gets the information from the cat nodes endpoint for the given server or alias
26+
* hubot: elasticsearch cat indexes [cluster] - Gets the information from the cat indexes endpoint for the given server or alias
27+
* hubot: elasticsearch cat allocation [cluster] - Gets the information from the cat allocation endpoint for the given server or alias
28+
* hubot: elasticsearch clear cache [cluster] - Clears the cache for the specified cluster
29+
* hubot: elasticsearch cluster settings [cluster] - Gets a list of all of the settings stored for the cluster
30+
* hubot: elasticsearch index settings [cluster] [index] - Gets a list of all of the settings stored for a particular index
31+
* hubot: elasticsearch disable allocation [cluster] - disables shard allocation to allow nodes to be taken offline
32+
* hubot: elasticsearch enable allocation [cluster] - renables shard allocation
33+
* hubot: elasticsearch show aliases - shows the aliases for the list of ElasticSearch instances
34+
* hubot: elasticsearch add alias [alias name] [url] - sets the alias for a given url
35+
* hubot: elasticsearch clear alias [alias name] - please note that this needs to include any port numbers as appropriate

0 commit comments

Comments
 (0)