Update README usage instructions
Project: http://git-wip-us.apache.org/repos/asf/cloudstack-gcestack/repo Commit: http://git-wip-us.apache.org/repos/asf/cloudstack-gcestack/commit/d4126d5e Tree: http://git-wip-us.apache.org/repos/asf/cloudstack-gcestack/tree/d4126d5e Diff: http://git-wip-us.apache.org/repos/asf/cloudstack-gcestack/diff/d4126d5e Branch: refs/heads/master Commit: d4126d5e83b7266c12a0c096fb35cae26fa905f0 Parents: a33d466 Author: BroganD1993 <darrenbro...@hotmail.com> Authored: Tue Jun 24 18:47:11 2014 +0100 Committer: BroganD1993 <darrenbro...@hotmail.com> Committed: Tue Jun 24 18:47:11 2014 +0100 ---------------------------------------------------------------------- README.rst | 44 +++++++++++++++++++++++++------------------- 1 file changed, 25 insertions(+), 19 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cloudstack-gcestack/blob/d4126d5e/README.rst ---------------------------------------------------------------------- diff --git a/README.rst b/README.rst index cf50727..f4d90a6 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,6 @@ -======== +====== GSTACK -======== +====== A Google Compute Engine Interface For Cloudstack ################################################ @@ -76,15 +76,17 @@ Users can grab the package from Pypi Configuration ############# -Before running `gstack` you must configure it. To do so run +Before running gstack you must configure it. To do so run $ gstack-configure -You can configure a profile of your choice with the optional ``-p`` flag +You can configure a profile of your choice with the optional ``-p`` or ``--profile`` flag - $ gstack-configure -p testprofile + $ gstack-configure -p exampleprofile -And enter your configuration information as prompted. +If you don't specify a profile, ``gstack-configure`` will default to ``initial`` + +Enter your configuration information as prompted. Install the stand alone `gcutil <https://developers.google.com/compute/docs/gcutil/#gcutilupgrade/>`_ @@ -94,18 +96,6 @@ At this stage your CloudStack apikey and secretkey need to be entered in the gcu This is far from ideal and we opened a feature request with google to pass the ``client_id`` and ``client_secret`` as options to gcutil, hopefully future release of gcutil will allow us to do so. -Start gstack: - - $ gstack - -You can launch ``gstack`` using a configuration profile created earlier using the optional ``-p`` or ``--profile`` flag - - $ gstack -p testprofile - -You can start ``gstack`` in debug mode using the optional ``-d`` or ``--debug`` flag - - $ gstack -d True - Create a cached parameters file for gcutil: - Make a flagfile to store required flags, something like ``~/.gcutil_params`` @@ -130,12 +120,28 @@ Create a cached parameters file for gcutil: `--nocheck_for_new_version` + `--permit_root_ssh` + gcutil will issue auth requests to the local Flask application, get an OAuth token and then issue requests to the CloudStack endpoint you specified when cofiguring gstack. Usage ##### -You can start issuing standard gcutil commands. +Start gstack: + + $ gstack + +You can launch gstack using a configuration profile created earlier using the optional ``-p`` or ``--profile`` flag + + $ gstack -p exampleprofile + +If you don't specify a profile, gstack will default to ``initial`` + +You can start gstack in debug mode using the optional ``-d`` or ``--debug`` flag + + $ gstack -d True + +You can now start issuing standard gcutil commands to gstack. $ ./gcutil --flag_file=~/.gcutil_params --project=brogan...@darrenbrogan.ie listzones
