Merge lp:~evarlast/charms/trusty/kibana/add-port-path-config into lp:charms/trusty/kibana

[Jay R. Wren]

Adds nginx tcp port configuration option and a path option for configuring it to be proxy fronted with a path. e.g. /kibana and not at the root of a url.

[lp:~evarlast/charms/trusty/kibana/add-port-path-config]

19. By Jay R. Wren on 2015-04-08

fix port and path config settings

add config-changed hook

20. By Jay R. Wren on 2015-04-09

fix config-changed error

reload nginx after setting port

21. By Jay R. Wren on 2015-04-16

I've been tired.

[Charles Butler (lazypower)]

Greetings Jay,

Thanks for this contribution. I've taken some time to look this over, and I have a few comments:

There's nothing that stands out about the code - however it would be nice to have the tests updated to flex the configuration option and validate that the resulting service is available on the port/path specified with the new configuration options. This will prevent us from breaking it in the future.

I did however notice that the charm when deployed via the tests results in failure. You can view the results here: http://reports.vapour.ws/charm-test-details/charm-bundle-test-parent-229

The Install hook is the culprit for the deployment failure. DEBUG:runner: unit: kibana/0: machine: 1 agent-state: error details: hook failed: "install" So I cannot block on this - but I will block on the lack of test coverage of the new options.

I'm happy to work with you on updating the tests if you need assistance to cover the new options. Feel free to reach out via IRC.

Otherwise, this MP looks good and aside from the minor feedback above is nearly ready for inclusion in the charm.

Thanks again for the submission. I'm going to change status of this MP to "needs work" and when you're ready switch merge status to 'needs review' and someone will be along shortly to review your work.

If you have any questions/comments/concerns about the review contact us in #juju on irc.freenode.net or email the mailing list <email address hidden>, or ask a question tagged with "juju" on http://askubuntu.com.

review: Needs Fixing

[Michael Foley (foli)]

elasticsearch sed line needs fixing as noted inline.

review: Needs Fixing

[lp:~evarlast/charms/trusty/kibana/add-port-path-config]

22. By Jay R. Wren on 2015-04-20

use protocol relative url

[Whit Morriss (whitmo)]

-1. I issued a merge proposal adding a test for configuring the port and a fix for opening a port. The original port will still need to be cleaned up.

review: Disapprove

[Whit Morriss (whitmo)]

Changing to appropriate status. Still waiting on port fixes.

review: Needs Fixing

[lp:~evarlast/charms/trusty/kibana/add-port-path-config]

23. By Jay R. Wren on 2015-06-18

close and open port on change

[Jay R. Wren (evarlast)]

Updated with closing previous port and opening new port. Added amulet test to test requests to configured port.

review: Needs Resubmitting

[lp:~evarlast/charms/trusty/kibana/add-port-path-config]

24. By Jay R. Wren on 2015-06-18

close port only if previously opened

25. By Jay R. Wren on 2015-06-18

fix idempotency problems

26. By Jay R. Wren on 2015-06-18

explicitly define empty env var

=== modified file 'config.yaml'
--- config.yaml	2014-11-05 05:21:37 +0000
+++ config.yaml	2015-06-18 20:53:39 +0000
@@ -11,3 +11,12 @@
         type: string
         default: '74c6b8b79d1bfc7e4d5376e3c9ecb0fa1e79c986'
         description: the sha1sum of the kibana_source
+    port:
+        type: int
+        default: 80
+        description: The tcp port on which nginx will listen.
+    path:
+        type: string
+        default: ''
+        description: 'The url path of kibana. This is required if kibana is
+        proxied at a non root path. e.g. http://example.com/kibana/'

=== added file 'hooks/config-changed'
--- hooks/config-changed	1970-01-01 00:00:00 +0000
+++ hooks/config-changed	2015-06-18 20:53:39 +0000
@@ -0,0 +1,18 @@
+#!/bin/bash
+set -eux
+
+PORT=$(config-get port)
+KIBANA_PATH=$(config-get path)
+
+sed -i "s/listen.*/listen *:$PORT;/" /etc/nginx/sites-available/kibana
+
+sed -i "s@elasticsearch: .*@elasticsearch: '//'+window.location.hostname+'$KIBANA_PATH',@" /srv/kibana3/config.js
+
+service nginx reload
+
+[[ -r .PREVOPENPORT ]] && PREVOPENPORT=$(cat .PREVOPENPORT) || PREVOPENPORT=''
+[[ -z "$PREVOPENPORT" ]] || close-port $PREVOPENPORT/tcp
+
+open-port $PORT/tcp
+echo $PORT > .PREVOPENPORT
+

=== modified file 'hooks/install'
--- hooks/install	2015-04-01 19:38:58 +0000
+++ hooks/install	2015-06-18 20:53:39 +0000
@@ -26,8 +26,10 @@
 
 pushd /srv
 
-tar xzvf /tmp/kibana.tgz
-mv ${KIBANA_SOURCE_UNPACK_DIRECTORY} kibana3
+if [[ ! -d kibana3 ]]; then
+    tar xzvf /tmp/kibana.tgz
+    mv ${KIBANA_SOURCE_UNPACK_DIRECTORY} kibana3
+fi
 
 rm -f /etc/nginx/sites-enabled/default
 
@@ -36,6 +38,7 @@
 rm -f /srv/kibana3/config.js
 install -o root -g root -m 0644 files/charm/config.js /srv/kibana3/config.js
 
+hooks/config-changed
 
 ln -s /etc/nginx/sites-available/kibana /etc/nginx/sites-enabled/kibana
 ln -s /etc/nginx/sites-available/es_cluster /etc/nginx/sites-enabled/es_cluster

=== modified file 'hooks/start' (properties changed: +x to -x)
--- hooks/start	2013-09-29 21:58:50 +0000
+++ hooks/start	2015-06-18 20:53:39 +0000
@@ -3,6 +3,4 @@
 # Note that currently this is run directly after install
 # i.e. 'service apache2 start'
 
-initctl start nginx
-#open-port 5601/tcp
-open-port 80/tcp
+service nginx start

=== modified file 'hooks/stop'
--- hooks/stop	2013-09-29 21:58:50 +0000
+++ hooks/stop	2015-06-18 20:53:39 +0000
@@ -6,5 +6,6 @@
 # balancer to stop sending traffic.
 # rm /srv/webroot/server-live.txt && sleep 30
 
-initctl stop nginx
-close-port 80/tcp
+service nginx stop
+[[ -r .PREVOPENPORT ]] && PREVOPENPORT=$(cat .PREVOPENPORT) || PREVOPENPORT=''
+[[ -z "$PREVOPENPORT" ]] || close-port $PREVOPENPORT/tcp

=== modified file 'hooks/web-relation-joined'
--- hooks/web-relation-joined	2013-11-26 08:51:58 +0000
+++ hooks/web-relation-joined	2015-06-18 20:53:39 +0000
@@ -2,6 +2,8 @@
 set -eux
 juju-log $JUJU_REMOTE_UNIT joined
 
+PORT=$(config-get port)
+
 # Set ip/port for web relation
-relation-set port="80"
+relation-set port="$PORT"
 relation-set host=`unit-get private-address`

=== modified file 'metadata.yaml'
--- metadata.yaml	2014-10-29 15:52:18 +0000
+++ metadata.yaml	2015-06-18 20:53:39 +0000
@@ -7,7 +7,7 @@
   - applications  
 provides:
   web:
-    interface: kibana
+    interface: http
 requires:
   rest:
     interface: elasticsearch

=== added file 'tests/12-port-change.py'
--- tests/12-port-change.py	1970-01-01 00:00:00 +0000
+++ tests/12-port-change.py	2015-06-18 20:53:39 +0000
@@ -0,0 +1,32 @@
+#!/usr/bin/python3
+
+import amulet
+import requests
+
+seconds = 20000
+
+d = amulet.Deployment(series='trusty')
+
+d.add('kibana')
+d.configure('kibana', {'port': 81})
+
+d.expose('kibana')
+
+try:
+    d.setup(timeout=seconds)
+except amulet.helpers.TimeoutError:
+    amulet.raise_status(amulet.SKIP, msg="Environment wasn't stood up in time")
+except:
+    raise
+
+
+def test_web_interface():
+    kibana_unit = d.sentry.unit['kibana/0']
+    url = 'http://%s:81/' % kibana_unit.info['public-address']
+    r = requests.get(url)
+    if not r.ok:
+        amulet.raise_status(amulet.FAIL,
+                            msg="Error getting kibana page.")
+
+
+test_web_interface()