X-Git-Url: https://gerrit.mcp.mirantis.com/gitweb?p=salt-formulas%2Felasticsearch.git;a=blobdiff_plain;f=README.rst;h=21be912a18760c1feb733382a56380f782839c13;hp=8c4bddcf19138ec0147849dba91d8f29b3bde454;hb=f2a9d51664e767df998a5659822abfa6c8ec544f;hpb=ee64bd1814afaa35241dd5c7c907e43ea6b9f6ac diff --git a/README.rst b/README.rst index 8c4bddc..21be912 100644 --- a/README.rst +++ b/README.rst @@ -145,7 +145,7 @@ Client with host and port: host: elasticsearch.host port: 9200 -Client where you download an index template that is stored in the direcotry +Client where you download an index template that is stored in the directory *files/*: .. code-block:: yaml @@ -161,6 +161,46 @@ Client where you download an index template that is stored in the direcotry enabled: true template: elasticsearch/files/my_index_template.json +Client where you download an index template from the metadata definition and force index creation: + +.. code-block:: yaml + + elasticsearch: + client: + enabled: true + server: + host: elasticsearch.host + port: 9200 + index: + my_index: + enabled: true + force_operation: true + definition: + template: notifications + settings: + number_of_shards: 5 + number_of_replicas: 1 + mappings: + notification: + properties: + applicationId: + type: long + content: + type: text + fields: + keyword: + type: keyword + ignore_above: 256 + +Upgrade operations +------------------ + +Default elasticsearch client state can only create index temlates. To update exisiting ones according to pillar dedicated state should be run explicitly: + +.. code-block:: bash + + salt -C 'I@elasticsearch:client' state.sls elasticsearch.client.update_index_templates + Read more ========= @@ -169,36 +209,3 @@ Read more * http://alex.nederlof.com/blog/2012/11/19/installing-elasticsearch-with-jenkins-on-ubuntu/ * http://websightdesigns.com/wiki/Setting_up_Centralized_Event_Parsing_on_Ubuntu_12.04 * https://gist.github.com/wingdspur/2026107 - -Documentation and Bugs -====================== - -To learn how to install and update salt-formulas, consult the documentation -available online at: - - http://salt-formulas.readthedocs.io/ - -In the unfortunate event that bugs are discovered, they should be reported to -the appropriate issue tracker. Use Github issue tracker for specific salt -formula: - - https://github.com/salt-formulas/salt-formula-elasticsearch/issues - -For feature requests, bug reports or blueprints affecting entire ecosystem, -use Launchpad salt-formulas project: - - https://launchpad.net/salt-formulas - -You can also join salt-formulas-users team and subscribe to mailing list: - - https://launchpad.net/~salt-formulas-users - -Developers wishing to work on the salt-formulas projects should always base -their work on master branch and submit pull request against specific formula. - - https://github.com/salt-formulas/salt-formula-elasticsearch - -Any questions or feedback is always welcome so feel free to join our IRC -channel: - - #salt-formulas @ irc.freenode.net