Merge lp:~ce-infrastructure/capomastro/capomastro-debug-1385217 into lp:~ubuntuone-hackers/capomastro/charm

[Caio Begotti]

The comments in the original bug report are pretty self-explanatory but I hope this is not much different from how other charms turn on/off debugging :-)

[lp:~ce-infrastructure/capomastro/capomastro-debug-1385217]

50. By Caio Begotti on 2014-11-03

in case it is not so obvious how this bug affects new deployments

[Daniel Manrique (roadmr)]

Awesome!

I wonder if we could generate the django secret key automatically in the install charm, thus freeing the user from creating it manually. The key should be unique per-installation so that would make life a bit easier.

But if not, it's OK as long as we at least provide instructions on generating said django key, as otherwise we'll have the deployer waste 10 minutes googling how to do this :(

review: Needs Information

[lp:~ce-infrastructure/capomastro/capomastro-debug-1385217]

51. By Caio Begotti on 2014-11-03

generates the app key only once per deployment and store it in its own config file

52. By Caio Begotti on 2014-11-03

since it is an one time generation we can simply do it ourselves and avoid waiting for the user to figure it out or whatever, so this is one more automation in the charm that saves time, but hopefully do not compromise any security

53. By Caio Begotti on 2014-11-03

argh!

Unmerged revisions

=== modified file 'README'
--- README	2014-10-31 16:42:21 +0000
+++ README	2014-11-03 17:53:56 +0000
@@ -67,6 +67,11 @@
 
 TODO: support the --config={capomastro,jenkins}.yaml option and document it.
 
+Before deploying the charm please take a moment to update the sitename and the secret
+key used inside it as without them your new Capomastro instance won't be totally
+operational. Also, note that having the debug flag on will affect Django's default
+security of the app because of a more flexible ALLOWED_HOSTS being used instead.
+
 Setup and deploy:
 
 $ export JUJU_REPOSITORY=${PWD}/charms

=== modified file 'config.yaml'
--- config.yaml	2014-11-01 02:17:17 +0000
+++ config.yaml	2014-11-03 17:53:56 +0000
@@ -1,8 +1,16 @@
 options:
   debug:
     type: boolean
-    default: True
+    default: False
     description: "Whether we should run on debug mode or not (avoid this in production)"
+  sitename:
+    default: "capomastro.canonical.com"
+    type: string
+    description: "Domain name that Capomastro will be accessed through"
+  secretkey:
+    default: ""
+    type: string
+    description: "Django's default secret key for the site"
   port:
     type: int
     default: 80

=== modified file 'hooks/config-changed'
--- hooks/config-changed	2014-11-01 02:21:51 +0000
+++ hooks/config-changed	2014-11-03 17:53:56 +0000
@@ -17,7 +17,7 @@
 	fi
 
 	# jenkins' notification plugin's callback setting
-	sed -i --follow-symlinks "/NOTIFICATION_HOST/s/localhost/${private_address}/;s/8000/${port}/" ${app_config}
+	jenkins_notification_host="${private_address}:${port}"
 
 	open-port ${port:=80}
 fi
@@ -63,6 +63,22 @@
 
 #---------- django
 
+export t_app_debug=${debug}
+export t_app_secretkey=${django_secretkey}
+export t_app_notification_host=${jenkins_notification_host}
+
+# this way we can force deployments to production
+# without having the debugging flag turned on, or else
+# it'll need some manual intervention anyway
+if [ ${debug} = 'True' ]; then
+	export t_app_allowed_hosts="'*', '${sitename}'"
+else
+	# if deploying into production but sitename is empty, assume a sane default
+	export t_app_allowed_hosts="'${sitename}'"
+fi
+
+cheetah fill --env --stdout templates/capomastro_local_settings.tmpl > ${app_config}
+
 if [ -x $(which capomastro) ]; then
 	juju-log "Initial database sync through Django (skipping superuser creation)..."
 	$(which capomastro) syncdb --noinput

=== modified file 'inc/common'
--- inc/common	2014-11-01 02:16:35 +0000
+++ inc/common	2014-11-03 17:53:56 +0000
@@ -8,6 +8,7 @@
 # apache's site config
 port=$(config-get port)
 name=$(config-get name)
+sitename=$(config-get sitename)
 
 # misc, if needed
 private_address=$(unit-get private-address)
@@ -30,3 +31,6 @@
 amqp_config="/etc/capomastro/amqp_settings"
 app_config="/etc/capomastro/local_settings"
 db_config="/etc/capomastro/db_settings"
+
+# capomastro stuff
+django_secretkey=$(config-get secretkey)

=== added file 'templates/capomastro_local_settings.tmpl'
--- templates/capomastro_local_settings.tmpl	1970-01-01 00:00:00 +0000
+++ templates/capomastro_local_settings.tmpl	2014-11-03 17:53:56 +0000
@@ -0,0 +1,11 @@
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = '${t_app_secretkey}'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = ${t_app_debug}
+TEMPLATE_DEBUG = ${t_app_debug}
+
+ALLOWED_HOSTS = [${t_app_allowed_hosts}]
+
+# Note this should be a URL that Jenkins can access your Django application.
+NOTIFICATION_HOST = "${t_app_notification_host}"