Merge lp:~michael.nelson/charms/trusty/elasticsearch/update-readme into lp:~charmers/charms/trusty/elasticsearch/trunk

[Michael Nelson]

Fix issues in readme, update default to elasticsearch 1.2.

* Simplify and correct README.
* Edit out local deployment info into a separate HACKING.md.
* Remove the install-ansible-from-ppa option since this charm is trusty
  only and a suitable version of ansible is in trusty.
* Update the default repo to the 1.2 elasticsearch repo.

[Charles Butler (lazypower)]

+1 LGTM

review: Approve

=== added file 'HACKING.md'
--- HACKING.md	1970-01-01 00:00:00 +0000
+++ HACKING.md	2014-07-07 10:33:22 +0000
@@ -0,0 +1,17 @@
+# Local development
+
+To deploy ElasticSearch locally, pull the bzr branch into your
+local charm repository and deploy from there:
+
+    mkdir -p ~/charms/trusty && cd ~/charms/trusty
+    charm-get trusty/elasticsearch
+    juju bootstrap
+    juju deploy --repository=../.. local:elasticsearch
+
+
+# Testing the ElasticSearch charm
+
+Run the unit-tests with `make test`.
+
+Run the functional tests with `juju test`.
+
 
=== modified file 'Makefile'
--- Makefile	2014-06-06 14:40:08 +0000
+++ Makefile	2014-07-07 10:33:22 +0000
@@ -12,6 +12,12 @@
 	@echo Starting unit tests...
 	@PYTHONPATH=./hooks $(PYTHON) /usr/bin/nosetests3 --nologcapture unit_tests
 
+deploy:
+	@echo Deploying local elasticsearch charm
+	@juju deploy --num-units=2 --repository=../.. local:trusty/elasticsearch
+
+
+# The following targets are used for charm maintenance only.
 bin/charm_helpers_sync.py:
 	@bzr cat lp:charm-helpers/tools/charm_helpers_sync/charm_helpers_sync.py \
 		> bin/charm_helpers_sync.py
@@ -19,8 +25,3 @@
 sync-charm-helpers: bin/charm_helpers_sync.py
 	@$(PYTHON) bin/charm_helpers_sync.py -c charm-helpers.yaml
 
-deploy:
-	@echo Deploying local elasticsearch charm
-	@juju deploy --num-units=3 --repository=../.. local:precise/elasticsearch
-	@juju deploy nrpe-external-master
-	@juju add-relation nrpe-external-master elasticsearch
 
=== modified file 'README.md'
--- README.md	2014-05-27 14:23:50 +0000
+++ README.md	2014-07-07 10:33:22 +0000
@@ -1,24 +1,38 @@
-# Getting started with ElasticSearch
-
-To deploy ElasticSearch locally:
-
-    juju bootstrap
-    juju deploy --repository=../.. local:elasticsearch
-
-You can add more units and they will discover each other and
-join the cluster.
+# Overview
+
+Elasticsearch is a flexible and powerful open source, distributed, real-time
+search and analytics engine. Architected from the ground up for use in
+distributed environments where reliability and scalability are must haves,
+Elasticsearch gives you the ability to move easily beyond simple full-text
+search. Through its robust set of APIs and query DSLs, plus clients for the
+most popular programming languages, Elasticsearch delivers on the near
+limitless promises of search technology.
+
+Except from [elasticsearch.org](http://www.elasticsearch.org/overview/ "Elasticsearch Overview")
+
+
+# Usage
+
+Deploy two units from the charmstore with:
+
+    juju deploy --num-units 2 cs:trusty/elasticsearch
+
+And when they have started you can inspect the cluster health:
+
+    juju ssh elasticsearch/0 "curl http://localhost:9200/_cat/health?v"
+    epoch      timestamp cluster       status node.total node.data shards ...
+    1404728290 10:18:10  elasticsearch green           2         2      0
+
+See the separate HACKING.md for information about deploying this charm
+from a local repository.
 
 
 ## Relating to the Elasticsearch cluster
 
-This charm currently provides the website http interface to the
-consuming service, ie. the private address of an elasticsearch unit. The
-consuming service can use this on the website-relation-joined
-relation to query the cluster for the list of nodes (many client
-elasticsearch apis will do this for you [1]).
-
-If it's needed, we can add an elasticsearch cluster interface that
-returns the lists of hosts in the cluster.
+This charm currently provides the elasticsearch client interface to the
+consuming service (cluster-name, host and port). Normally the other service
+will only need this data from one elasticsearch unit to start as most client
+libraries then query for the list of backends [1].
 
 [1] http://elasticsearch-py.readthedocs.org/en/latest/api.html#elasticsearch
 
@@ -26,21 +40,14 @@
 ## Discovery
 
 This charm uses unicast discovery which utilises the orchestration
-of juju so that the discovery method is the same whether you deploy
-on EC2, lxc or any other cloud provider.
+of juju so that whether you deploy on ec2, lxc or any other cloud
+provider, the functionality for discovering other nodes remains the same.
 
 When a new unit first joins the cluster, it will update its config
 with the other units in the cluster (via the peer-relation-joined
 hook), after which ElasticSearch handles the rest.
 
 
-## Testing the ElasticSearch charm
-
-Run the unit-tests with `make test`.
-
-Run the functional tests with `juju test`.
-
-
 ## Downloading ElasticSearch
 
 This charm installs elasticsearch from a configured apt repository.
 
=== modified file 'config.yaml'
--- config.yaml	2014-05-26 14:47:16 +0000
+++ config.yaml	2014-07-07 10:33:22 +0000
@@ -1,7 +1,7 @@
 options:
   apt-repository:
     type: string
-    default: "deb http://packages.elasticsearch.org/elasticsearch/1.0/debian stable main"
+    default: "deb http://packages.elasticsearch.org/elasticsearch/1.2/debian stable main"
     description: |
       A deb-line for the apt archive which contains the elasticsearch package.
       This is necessary until elasticsearch gets into the debian/ubuntu archives.
@@ -15,9 +15,3 @@
     default: "elasticsearch"
     description: |
       This sets the elasticsearch cluster name.
-  install-ansible-from-ppa:
-    type: boolean
-    default: true
-    description: |
-      By default ansible will be installed from the Ansible ppa. You can
-      set this to false for your deployments if you have ansible available
 
=== modified file 'hooks/hooks.py'
--- hooks/hooks.py	2014-05-27 08:05:37 +0000
+++ hooks/hooks.py	2014-07-07 10:33:22 +0000
@@ -27,9 +27,8 @@
     """Install ansible before running the tasks tagged with 'install'."""
     # Allow charm users to run preinstall setup.
     charmhelpers.payload.execd.execd_preinstall()
-    config = charmhelpers.core.hookenv.config()
     charmhelpers.contrib.ansible.install_ansible_support(
-        from_ppa=config['install-ansible-from-ppa'])
+        from_ppa=False)
 
 
 if __name__ == "__main__":
 
=== modified file 'unit_tests/test_hooks.py'
--- unit_tests/test_hooks.py	2014-02-18 13:46:55 +0000
+++ unit_tests/test_hooks.py	2014-07-07 10:33:22 +0000
@@ -19,9 +19,6 @@
         patcher = mock.patch('hooks.charmhelpers')
         self.mock_charmhelpers = patcher.start()
         self.addCleanup(patcher.stop)
-        self.mock_charmhelpers.core.hookenv.config.return_value = {
-            'install-ansible-from-ppa': True,
-        }
 
         patcher = mock.patch('charmhelpers.contrib.ansible.apply_playbook')
         self.mock_apply_playbook = patcher.start()
@@ -32,17 +29,6 @@
 
         ansible = self.mock_charmhelpers.contrib.ansible
         ansible.install_ansible_support.assert_called_once_with(
-            from_ppa=True)
-
-    def test_no_ppa_for_ansible_support(self):
-        self.mock_charmhelpers.core.hookenv.config.return_value = {
-            'install-ansible-from-ppa': False,
-        }
-
-        hooks.execute(['install'])
-
-        ansible = self.mock_charmhelpers.contrib.ansible
-        ansible.install_ansible_support.assert_called_once_with(
             from_ppa=False)
 
     def test_applies_install_playbook(self):