Skip to content
This repository has been archived by the owner on Nov 15, 2018. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Mention that scaling is required.

Describe how to scale.

Describe how to install plugins.
  • Loading branch information
ncdc committed Feb 10, 2014
1 parent 93d35a0 commit 3f50238
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,25 @@
openshift-elasticsearch-cartridge
OpenShift ElasticSearch Cartridge
=================================
Downloadable cartridge for OpenShift for ElasticSearch.
Downloadable ElasticSearch cartridge for OpenShift.

To create your scalable ElasticSearch app, run:

rhc app create <your app name> http://cartreflect-claytondev.rhcloud.com/github/ncdc/openshift-elasticsearch-cartridge -s

**NOTE:** your app currently must be a scalable app or this cartridge will not run.


Adding additional cluster nodes
===============================
To add more nodes to the cluster, simply add more gears:

rhc cartridge scale -a <your app name> elasticsearch <number of total gears you want>


Plugins
=======
To install ElasticSearch plugins, edit the `plugins.txt` file, commit, and push your changes.

TODO add more info

License
=======
Expand Down

0 comments on commit 3f50238

Please sign in to comment.