Merge lp:~frankban/juju-quickstart/bundle-debugging-docs into lp:juju-quickstart

[Francesco Banconi]

Document bundle debugging and releasing.

https://codereview.appspot.com/28490043/

[Francesco Banconi (frankban)]

Reviewers: mp+195650_code.launchpad.net,

Message:
Please take a look.

Description:
Document bundle debugging and releasing.

https://code.launchpad.net/~frankban/juju-quickstart/bundle-debugging-docs/+merge/195650

(do not edit description out of merge proposal)

Please review this at https://codereview.appspot.com/28490043/

Affected files (+46, -1 lines):
   M HACKING.rst
   A [revision details]

Index: HACKING.rst
=== modified file 'HACKING.rst'
--- HACKING.rst 2013-11-14 12:20:44 +0000
+++ HACKING.rst 2013-11-18 18:01:22 +0000
@@ -76,10 +76,36 @@
  Creating PPA releases
  ~~~~~~~~~~~~~~~~~~~~~

+The packaging repository (including the ``debian`` directory) can be
checked
+out from lp:~juju-gui/juju-quickstart/packaging/, e.g.::
+
+ $ bzr branch lp:~juju-gui/juju-quickstart/packaging/ packaging
+ $ cd packaging
+
+Check that the packaging version reflects the latest Quickstart version.
The
+packaging version can be found in the ``debian/changelog`` file present in
the
+packaging branch root. To print the version of the current Quickstart,
from the
+juju-quickstart branch root, run the following::
+
+ $ .venv/bin/python juju-quickstart --version
+
+If the ``debian/changelog`` file is outdated, install the ``devscripts``
+package and use ``dch`` to update the changelog, e.g.::
+
+ $ sudo apt-get install devscripts
+ $ dch -i # Executed from the packaging branch root.
+
+At this point, edit the changelog as required, commit and push the changes
back
+to the packaging branch trunk, and follow the instructions below.
+
  The recipe for creating packages is in

<https://code.launchpad.net/~juju-gui-charmers/+recipe/juju-quickstart-daily>.
-We currently publish releases on the Juju Quickstart Beta PPA: see
+We currently publish beta releases on the Juju Quickstart Beta PPA: see
  <https://launchpad.net/~juju-gui/+archive/quickstart-beta/+packages>.
+When a beta release is ready to be published, we move over the packages
from
+the Juju Quickstart Beta PPA to the juju stable packages PPA in
+<https://launchpad.net/~juju/+archive/stable>.
+
  Packages depend on `python-jujuclient` and `python-websocket-client` to be
  available. They are available in saucy, and they are also stored in our
PPA in
  order to support previous Ubuntu releases.
@@ -99,3 +125,20 @@
  are available in the main Ubuntu repositories for the series we support
(from
  precise to saucy), or in the Juju Quickstart Beta PPA: see
  <https://launchpad.net/~juju-gui/+archive/quickstart-beta/+packages>.
+
+Debugging bundle support
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+When deploying a bundle, Quickstart just start the import process sending
an
+API request to the GUI charm builtin server, and then lets the user observe
+the deployment process using the GUI.
+
+Under the hood, a bundle deployment is executed by the GUI builtin server,
+which in turn leverages the juju-deployer library. Sometimes, when an error
+occurs, it is not obvious where to retrieve information about what is
going on.
+The GUI builtin server exposes some bundle information in two places:
+
+- https://<juju-gui-url>/gui-server-info displays in JSON format the
current
+ status ...

[Madison Scott-Clary (makyo)]

LGTM, Thanks!

https://codereview.appspot.com/28490043/

[Francesco Banconi (frankban)]

*** Submitted:

Document bundle debugging and releasing.

R=matthew.scott
CC=
https://codereview.appspot.com/28490043

https://codereview.appspot.com/28490043/

=== modified file 'HACKING.rst'
--- HACKING.rst	2013-11-14 12:20:44 +0000
+++ HACKING.rst	2013-11-18 18:03:06 +0000
@@ -76,10 +76,36 @@
 Creating PPA releases
 ~~~~~~~~~~~~~~~~~~~~~
 
+The packaging repository (including the ``debian`` directory) can be checked
+out from lp:~juju-gui/juju-quickstart/packaging/, e.g.::
+
+    $ bzr branch lp:~juju-gui/juju-quickstart/packaging/ packaging
+    $ cd packaging
+
+Check that the packaging version reflects the latest Quickstart version. The
+packaging version can be found in the ``debian/changelog`` file present in the
+packaging branch root. To print the version of the current Quickstart, from the
+juju-quickstart branch root, run the following::
+
+    $ .venv/bin/python juju-quickstart --version
+
+If the ``debian/changelog`` file is outdated, install the ``devscripts``
+package and use ``dch`` to update the changelog, e.g.::
+
+    $ sudo apt-get install devscripts
+    $ dch -i  # Executed from the packaging branch root.
+
+At this point, edit the changelog as required, commit and push the changes back
+to the packaging branch trunk, and follow the instructions below.
+
 The recipe for creating packages is in
 <https://code.launchpad.net/~juju-gui-charmers/+recipe/juju-quickstart-daily>.
-We currently publish releases on the Juju Quickstart Beta PPA: see
+We currently publish beta releases on the Juju Quickstart Beta PPA: see
 <https://launchpad.net/~juju-gui/+archive/quickstart-beta/+packages>.
+When a beta release is ready to be published, we move over the packages from
+the Juju Quickstart Beta PPA to the juju stable packages PPA in
+<https://launchpad.net/~juju/+archive/stable>.
+
 Packages depend on `python-jujuclient` and `python-websocket-client` to be
 available. They are available in saucy, and they are also stored in our PPA in
 order to support previous Ubuntu releases.
@@ -99,3 +125,20 @@
 are available in the main Ubuntu repositories for the series we support (from
 precise to saucy), or in the Juju Quickstart Beta PPA: see
 <https://launchpad.net/~juju-gui/+archive/quickstart-beta/+packages>.
+
+Debugging bundle support
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+When deploying a bundle, Quickstart just start the import process sending an
+API request to the GUI charm builtin server, and then lets the user observe
+the deployment process using the GUI.
+
+Under the hood, a bundle deployment is executed by the GUI builtin server,
+which in turn leverages the juju-deployer library. Sometimes, when an error
+occurs, it is not obvious where to retrieve information about what is going on.
+The GUI builtin server exposes some bundle information in two places:
+
+- https://<juju-gui-url>/gui-server-info displays in JSON format the current
+  status of all scheduled/started/completed bundle deployments;
+- /var/log/upstart/guiserver.log is the builtin server log file, which includes
+  logs output from the juju-deployer library.