Merge pull request #1621 from StackStorm/v0.11.2

Cutting branch for release - 0.11.2
StackStorm · Jun 12, 2015 · 0c15fc2 · 0c15fc2
2 parents 7349095 + 88ca99a
commit 0c15fc2
Show file tree

Hide file tree

Showing 25 changed files with 237 additions and 81 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,15 +1,20 @@
 Changelog
 =========
 
+0.11.2 - June 12, 2015
+----------------------
+
+* Fix a bug with ``start_timestamp`` and ``end_timestamp`` sometimes returning an invalid value in
+  a local instead of UTC timezone. (bug-fix)
+* Fix to get PollingSensor working again. Sensors of type PollingSensor were not being treated
+  as such and as a result would fail after the 1st poll. (bug-fix)
+
 0.11.1 - June 8, 2015
 ---------------------
 
-* Allow user to filter executions on trigger instance id.
-  [Sayli Karmarkar]
 * Action aliases are registered by default. (improvement)
 * Repair failing pack installation. (bug-fix)
 
-
 0.11.0 - June 5, 2015
 ---------------------
 

diff --git a/contrib/core/rules/notify_hubot.yaml b/contrib/core/rules/notify_hubot.yaml
@@ -0,0 +1,16 @@
+---
+name: "chatops.notify_hubot"
+enabled: true
+description: "Notification rule to send messages to Hubot"
+trigger:
+  type: "core.st2.generic.notifytrigger"
+criteria:
+  trigger.channel:
+    type: "equals"
+    pattern: "test2"
+action:
+  ref: hubot.post_result
+  parameters:
+    channel: "{{trigger.data.source_channel}}"
+    user: "{{trigger.data.user}}"
+    result: "{{trigger}}"
diff --git a/docs/README.md b/docs/README.md
@@ -25,11 +25,12 @@ The docs are build with Sphinx. It's integrated with the main project Makefile.
 
 * Referencing an arbitrary section: for instance, there's examples section in sensors.rst. Define a reference on `examples` section in sensors.rst:
 
-         .. _sensors-examples
+         .. _sensors-examples:
 
     and point to it as from this, or from other documensts as:
 
        :ref:`sensors-examples`
+       :ref:`My examples <sensors-examples>`
 
     Note that the leading `_` underscore is gone, and the reference is quoted.
 

diff --git a/docs/source/authentication.rst b/docs/source/authentication.rst
@@ -109,7 +109,7 @@ The path to the st2auth module is different depending on how |st2| is installed.
 +================+========================================================+
 | source         | /path/to/st2/git/clone/st2auth/st2auth                 |
 +----------------+--------------------------------------------------------+
-| st2express     | /usr/lib/python2.7/dist-packages/st2auth               |  
+| st2express     | /usr/lib/python2.7/dist-packages/st2auth               |
 +----------------+--------------------------------------------------------+
 | debian package | /usr/lib/python2.7/dist-packages/st2auth               |
 +----------------+--------------------------------------------------------+
@@ -139,15 +139,15 @@ formatted file. To manage this file you can use `htpasswd`_ utility which comes
 with a standard Apache httpd distribution or by installing apache2-utils.
 
     **Backend configuration options:**
-    
+
     * ``file_path`` - Path to the file containing credentials.
 
 Example htpasswd command to generate a password file with a user entry. ::
 
     htpasswd -cm /path/to/.htpasswd stark
 
 Example ``auth`` section in the |st2| configuration file. ::
- 
+
     [auth]
     mode = standalone
     backend = flat_file
@@ -178,7 +178,7 @@ the MongoDB collection and the user entries will have to be generated manually.
     * ``db_port`` - MongoDB server port.
     * ``db_name`` - Name of the database to use.
 
-Example ``auth`` section in the |st2| configuration file. :: 
+Example ``auth`` section in the |st2| configuration file. ::
 
     [auth]
     mode = standalone
@@ -213,6 +213,8 @@ Run the following curl commands to test. ::
     # The following will verify the SSL cert, succeed, and return a valid token.
     curl -X POST --cacert /path/to/cacert.pem -u yourusername:yourpassword https://myhost.example.com:9100/tokens
 
+.. _authentication-usage:
+
 Usage
 -----
 

diff --git a/docs/source/cheatsheet.rst b/docs/source/cheatsheet.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -72,7 +72,10 @@ def previous_version(ver):
     # XXX: on incrementing major version, minor version counter is lost!
     major, minor = ver.split('.')
     minor = int("".join(itertools.takewhile(str.isdigit, minor)))
-    return ".".join([major, str(minor - 1)])
+    prev = minor - 1
+    # Note(dzimine): work around CI/CD bug on v 0.10
+    prev = 9 if prev == 10 else prev
+    return ".".join([major, str(prev)])
 
 # The short versions of two previous releases, e.g. 0.8 and 0.7
 version_minus_1 = previous_version(version)

diff --git a/docs/source/engage.rst b/docs/source/engage.rst
@@ -1,5 +1,6 @@
 .. rubric:: Questions? Problems? Suggestions? Engage!
 
 * IRC: `#stackstorm on irc.freenode.org <http://webchat.freenode.net/?channels=stackstorm>`_
+* Twitter: https://twitter.com/Stack_Storm
+* Support: support@stackstorm.com
 * Google Group: `stackstorm@googlegroups.com <https://groups.google.com/forum/#!forum/stackstorm>`_
-* Support: support@stackstorm.com
diff --git a/docs/source/install/config.rst b/docs/source/install/config.rst
@@ -71,8 +71,8 @@ Follow these steps on a remote box to setup `stanley` user on remote boxes.
     mkdir -p /home/stanley/.ssh
     chmod 0700 /home/stanley/.ssh
 
-    # generate ssh keys on |st2| box and copy over public key into remote box.
-    # ssh-keygen -f /home/stanley/.ssh/stanley_rsa -P ""
+    # generate ssh keys on StackStorm box and copy over public key into remote box.
+    ssh-keygen -f /home/stanley/.ssh/stanley_rsa -P ""
     cp ${KEY_LOCATION}/stanley_rsa.pub /home/stanley/.ssh/stanley_rsa.pub
 
     # authorize key-base acces.

diff --git a/docs/source/install/index.rst b/docs/source/install/index.rst
@@ -1,7 +1,10 @@
 Installation
 ============
+There are a few methods to deploys StackStorm. The easiest is all-in-one install
+on Ubuntu/Debian or RedHat/Fedora which we explain next. Skip below if you want to learn about
+:doc:`docker` or :doc:`vagrant`, or other installations approaches.
 
-To install and run |st2| on Ubuntu/Debian or RedHat/Fedora with all dependencies,
+To install and run |st2| on a single Ubuntu/Debian or RedHat/Fedora box, with all dependencies,
 download and run the deployment script.
 
 ::
@@ -14,6 +17,35 @@ This will download and install the stable release of |st2| (currently |release|)
 If you want to install the latest development version, run ``sudo ./st2_deploy.sh latest``.
 Installation should take about 5 min. Grab a coffee and watch :doc:`/video` while it is being installed.
 
+At the end of the installation, you will see a nice big **ST2 OK**, the default username and password,
+and WebUI url:
+
+::
+
+    WebUI at http://my-host:8080/
+    ==========================================
+
+              _   ___     ____  _  __
+             | | |__ \   / __ \| |/ /
+          ___| |_   ) | | |  | | ' /
+         / __| __| / /  | |  | |  <
+         \__ \ |_ / /_  | |__| | . \
+         |___/\__|____|  \____/|_|\_\
+
+      st2 is installed and ready to use.
+    ==========================================
+
+    Test StackStorm user account details
+
+    Username: testu
+    Password: testp
+
+    Test account credentials were also written to the default CLI config at .
+
+    To login and obtain an authentication token, run the following command:
+
+    st2 auth testu -p testp
+
 .. include:: on_complete.rst
 
 .. rubric:: More Installations
@@ -32,13 +64,13 @@ Installation should take about 5 min. Grab a coffee and watch :doc:`/video` whil
     StackStorm Repositories <stackstorm_repos>
 
 .. note::
-    We compile, build and test on Fedora 20 and Ubuntu 14.04. The `st2_deploy.sh </~https://github.com/StackStorm/st2sandbox/blob/master/scripts/st2_deploy.sh>`_ 
+    We compile, build and test on Fedora 20 and Ubuntu 14.04. The `st2_deploy.sh </~https://github.com/StackStorm/st2sandbox/blob/master/scripts/st2_deploy.sh>`_
     script should work for other versions, but if you find a problem, let us know. Fixes welcome :)
-  
+
     st2_deploy.sh script allows you to easily install and run |st2| with all the
-    dependencies on a single server. It's only intended to be used for testing,
-    evaluation and demonstration purposes (it doesn't use HTTPS, it uses flat file
-    htpasswd based authentication, etc.) - you should **not** use it for production
+    dependencies on a single server. It's intended to be used for testing,
+    evaluation and POC. It doesn't use HTTPS, uses flat file
+    htpasswd based authentication, etc. - you should **not** use it 'as is' for production
     deployments.
 
-    For production deployments you follow deb / rpm installation methods, or use our puppet modules.
+    For production deployments follow deb / rpm installation methods, or use our puppet modules.
diff --git a/docs/source/install/on_complete.rst b/docs/source/install/on_complete.rst
@@ -1,20 +1,15 @@
-|st2| package-based installations have authentication enabled by default, therefore in the end of
-installation you will be provided with the default username and password.
-
-In order to use |st2|, including the commands below, you need to include a token, generated for the
-user, as a CLI argument or be provided as an environment variable.
-
-.. include:: ../auth_usage.rst
-
-Commands below assume that the token was either specified in the :ref:`CLI
-config file <cli-configuration>` or provided as an environment variable.
-
 Check that |st2| installation works OK: ::
 
     st2ctl status
 
     st2 --version
     st2 --help
+
+    # If AUTH enabled: authenticate and export the token env variable
+    # so you don't need to pass it as parameter on every command.
+    st2 auth testu -p testp
+    export ST2_AUTH_TOKEN=`st2 auth -t -p testp testu`
+
     st2 action list
     st2 run core.local uname
 
@@ -25,6 +20,7 @@ Use the supervisor script to manage |st2| services: ::
 .. rubric:: What's Next?
 
 * **Get going with** :doc:`/start`.
+* **How to configure and use** :doc:`authentication </authentication>`
 
 .. include:: /engage.rst
 
diff --git a/docs/source/install/webui.rst b/docs/source/install/webui.rst
@@ -41,7 +41,8 @@ On a UI side, there is a file ``config.js`` in a root of the project which conta
      auth: true
    },{
      name: 'Development Environment',
-     url: 'http://172.168.50.50:9101'
+     url: 'http://:9101'
+     auth: 'https://:9100'
    }]
 
 
@@ -75,6 +76,4 @@ Authentication
 
 To configure st2web to support authentication, edit ``config.js`` and add ``auth:true`` to every server that supports authentication. To enable authentication on a server side, please refer to :doc:`/authentication`.
 
-For now, UI assumes st2auth is running on the same server with st2api on the port 9100. This is known issue and will be fixed in the next release.
-
 It is highly recommended to only use authentication alongside with SSL encryption (for st2web, st2api and st2auth) to mitigate possible MITM attacks and avoid sending passwords and auth tokens in plain text.
diff --git a/docs/source/roadmap.rst b/docs/source/roadmap.rst
@@ -4,22 +4,32 @@ Roadmap
 StackStorm is new and under active development. We are opening it early to engage community, get  feedback, and refine directions, and welcome contributions. Below are key next items we see as top priorities.
 
 
-* **ChatOps:** two-way chat integration beyond imagination.
-* **Web UI complete basics:** rule create/edit/delete in UI.
-* **Pack management:** Improve support for pack creation lifecycle. REST API to manage and configure packs installed in the system. Smoother integration with community content.
+* **RBAC:** Role based access control for actions, triggers, rules, and datastore keys.
+* **Web UI advanced functionality:** visual workflow design representation, drag&drop workflow designer.
 * **Scale improvements:** refactoring and fixes to scale out better to manage large volumes of events and actions.
+* **Pack management:** Improve support for pack creation lifecycle. REST API to manage and configure packs installed in the system. Smoother integration with community content.
 * **Reliability:** Focus on availability of services and improve system reliability.
 * **Tags:** tag any resources, to handle actions, triggers and rules as their number grows to hundreds.
-* **RBAC:** Role based access control for actions, triggers, rules, and datastore keys.
-* **Web UI advanced functionality:** visual workflow design representation, drag&drop workflow designer.
+* **Action Output Structure Definition**: enable optional definition of action payload, so that it can be introspected and used when passing data between actions in worfklows.
 * **Database:** move away from Mongo to Postgres and/or MySQL.
 * **Pluggable runners:** We have heard that a Ruby runner would be great.
-* **Windows support:** via pluggable runners.
 * **Datastore:**  Hierarchical, pluggable and secure datastore to bring together all the gnarly config and key spread in operations environments.
 * **Bugs and smaller improvements**
 * **Documentation:** generate REST API docs.
 * **More integration packs:** push more content to the community to help work with most common and widely used tool. Tell us if there is tool you love and think we should integrate with or better yet write a pack yourself.
 
+See :doc:`/changelog` for details on what is done.
+
+.. rubric:: Done in v0.11
+
+* **ChatOps:** two-way chat integration beyond imagination.
+* **More integration packs**: Major integrations - Salt, Ansible, some significant others. `Check the full list </~https://github.com/StackStorm/st2contrib/tree/master/packs>`_.
+
+.. rubric:: Done in v0.9
+
+* **Experimental windows support:** windows runner, and windows commands.
+* **Web UI complete basics:** rule create/edit/delete in UI.
+
 .. rubric:: Done in v0.8
 
 * **Web UI:** refactor history view, create and edit rules and workflows, add graphical representations for workflow definitions and executions.
@@ -34,7 +44,6 @@ StackStorm is new and under active development. We are opening it early to engag
 * **Plugin isolation and management:** Improved managements of sensors, action runners and provide isolated environments.
 * **Reliability:** improvements on sensor and action isolation and reliability
 
-See :doc:`/changelog` for details on what is done.
 
 
 .. include:: engage.rst
diff --git a/docs/source/start.rst b/docs/source/start.rst
@@ -16,6 +16,8 @@ The best way to explore |st2| is to use CLI. Start by firing a few commands:
     st2 --version
     # Get help. It's a lot. Explore.
     st2 -h
+    # Authenticate and export the token
+    export ST2_AUTH_TOKEN=`st2 auth -t -p testp testu`
     # List the actions from a 'core' pack
     st2 action list --pack=core
     st2 trigger list
@@ -35,6 +37,18 @@ Check the :doc:`CLI and Python Client </reference/cli>` reference for details.
 From v0.8, |st2| ships with WebUI. With the default "all-in-one" installation, you can access it at
 http://hostname:8080/.
 
+Authenticate
+----------------
+If :doc:`authentication </authentication>` enabled, obtain authentication token with ``st2 auth <username>``,
+and supply it with each command using ``--token`` parameter. For convenience,
+keep credentials in CLI config file, or put it to environment variable ``ST2_AUTH_TOKEN``.
+:ref:`Details here <authentication-usage>`, a nice shortcut for now is:
+
+.. code-block:: bash
+
+    export ST2_AUTH_TOKEN=`st2 auth -t -p testp testu`
+
+
 Work with Actions
 ---------------------
 

diff --git a/st2client/st2client/__init__.py b/st2client/st2client/__init__.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = '0.11.1'
+__version__ = '0.11.2'
diff --git a/st2common/st2common/__init__.py b/st2common/st2common/__init__.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = '0.11.1'
+__version__ = '0.11.2'