aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMilo Casagrande <milo.casagrande@linaro.org>2014-06-10 18:25:07 +0200
committerMilo Casagrande <milo.casagrande@linaro.org>2014-06-10 18:25:07 +0200
commit123aa016f3c2fc8991e3b03bb3514eac426089bd (patch)
tree7f9427f65e4ee80c033257f32f77ecd46ac19af9
parent86aabce70f10ca357e1ef1089fd11bbcfe310cf7 (diff)
downloadlinaro-bugzilla-tools-123aa016f3c2fc8991e3b03bb3514eac426089bd.tar.gz
Update README file.
Change-Id: I7c9e3d2b51f76d4380b3ce246967914da1413ea6
-rw-r--r--README27
1 files changed, 26 insertions, 1 deletions
diff --git a/README b/README
index 5d5f1d9..b4401a5 100644
--- a/README
+++ b/README
@@ -12,8 +12,33 @@ Deploy or Update Linaro Bugzilla
To apply the ansible playbook:
cd ansible/
- ansible-playbook -i hosts site.yml -K -u REMOTE_USER
+ ansible-playbook -i hosts site.yml -K -u REMOTE_USER -e "@secrets.yml"
If the REMOTE_USER is a password-less sudo user, remove the `-K` option.
If you do not specify the `-u` option, the actual user name will be used
to connect to the remote server.
+
+The `-e "@secrets.yml"` option is needed to pass secrets to the configuration.
+`secrets.yml` must be the absolute path to a YAML file that defines the following
+variables:
+
+ db_pass
+ site_wide_secret
+
+There is only one task that requires those variables, and it is possible to
+skip it using:
+
+ --skip-tags=secrets
+
+At the end of the playbook execution it is necessary to manually run a command
+on the remote server. Unfortunately, the command requires user input and it
+is not possible to automate that via ansible. The command that needs to be run
+is located in the installation directory and is:
+
+ ./checksetup.pl
+
+Caveats
+-------
+
+ * The command that creates the documentation, is run only once. If you update
+ the code, it is necessary to manually run the command again on the server.