StackStorm v1.4.0 Release Notes

Release Date: 2016-04-18 // about 8 years ago
  • โž• Added

    
    * ๐Ÿ‘ Passphrase support for the SSH runner. (improvement)
    * โž• Add ``extra`` field to the ActionAlias schema for adapter-specific parameters. (improvement)
    * ๐Ÿ‘ Allow user to pass a boolean value for the ``cacert`` st2client constructor argument. This way
      it now mimics the behavior of the ``verify`` argument of the ``requests.request`` method.
      (improvement)
    * โž• Add datastore access to Python runner actions via the ``action_service`` which is available
      to all the Python runner actions after instantiation. (new-feature) #2396 #2511
      [Kale Blankenship]
    * โšก๏ธ Update ``st2actions.runners.pythonrunner.Action`` class so the constructor also takes
      ``action_service`` as the second argument.
    * Display number of seconds which have elapsed for all the executions which have completed
      when using ``st2 execution get`` CLI command. (improvement)
    * Display number of seconds elapsed for all the child tasks of a workflow action when using
      ``st2 execution get`` CLI command. (improvement)
    * Various improvements in the ``linux.wait_for_ssh`` action:
    
      * Support for password based authentication.
      * Support for non-RSA SSH keys.
      * Support for providing a non-default (22) SSH server port.
      * Support for using default system user (stanley) ssh key if neither ``password`` nor
        ``keyfile`` parameter is provided.
    * ๐Ÿ‘Œ Support for leading and trailing slashes in the webhook urls. (improvement)
    * ๐Ÿ‘ Introduce new ``matchwildcard`` rule criteria operator. This operator provides supports for Unix
      shell-style wildcards (``*``, ``?``). (new feature)
    * ๐Ÿ‘ Allow user to pass ``verbose`` parameter to ``linux.rm`` action. For backward compatibility
      reasons it defaults to ``true``. (improvement)
    * โž• Add ``--output`` and ``--existing-file`` options to ``st2-submit-debug-info``. [Kale Blankenship]
    * ๐Ÿ‘ Allow user to specify a timezone in the CLI client config (``~/.st2/config``). If the timezone is
      specified, all the timestamps displayed by the CLI will be shown in the configured timezone
      instead of a default UTC display. (new feature)
    * โž• Add ``attachments`` parameter to the ``core.sendmail`` action. (improvement) [Cody A. Ray]
    * โž• Add ``--register-setup-virtualenvs`` flag to the ``register-content`` script and ``st2ctl``.
      When this flag is provided, Python virtual environments are created for all the registered packs.
      This option is to be used with distributed setup where action runner services run on multiple
      hosts to ensure virtual environments exist on all those hosts. (new-feature)
    * โšก๏ธ Update ``core.st2.CronTimer`` so it supports more of the cron-like expressions (``a-b``, ``*/a``,
      ``x,y,z``, etc.). (improvement)
    * โž• Add new ``regex`` and ``iregex`` rule criteria operator and deprecate ``matchregex`` in favor of
      those two new operators. (new-feature) [Jamie Evans]
    * โž• Add support for better serialization of the following parameter types for positional parameters
      used in the local and remote script runner actions: ``integer``, ``float``, ``boolean``,
      ``list``, ``object``. Previously those values were serialized as Python literals which made
      parsing them in the shell scripts very cumbersome. Now they are serialized based on the simple
      rules described in the documentation which makes it easy to use just by using simple shell
      primitives such as if statements and ``IFS`` for lists. (improvement, new feature)
    * โž• Add ``-v`` flag (verbose mode) to the ``st2-run-pack-tests`` script. (improvement)
    * โž• Add support for additional SSH key exchange algorithms to the remote runner via upgrade to
      paramiko 1.16.0. (new feature)
    * โž• Add initial code framework for writing unit tests for action aliases. For the usage, please refer
      to the "Pack Testing" documentation section. (new feature)
    * โž• Add custom ``use_none`` Jinja template filter which can be used inside rules when invoking an
      action. This filter ensures that ``None`` values are correctly serialized and is to be used when
      TriggerInstance payload value can be ``None`` and ``None`` is also a valid value for a particular
      action parameter. (improvement, workaround)
    
    ๐Ÿ”„ Changed
    
    • ๐Ÿ‘Œ Improvements to ChatOps deployments of packs via pack deploy [Jon Middleton]
    • ๐Ÿ‘ Allow /v1/webhooks API endpoint request body to either be JSON or url encoded form data. Request body type is determined and parsed accordingly based on the value of Content-Type header. Note: For backward compatibility reasons we default to JSON if Content-Type header is not provided. #2473 [David Pitman]
    • โšก๏ธ Update matchregex rule criteria operator so it uses "dot all" mode where dot (.) character will match any character including new lines. Previously * didn't match new lines. (improvement)
    • ๐Ÿšš Move stream functionality from st2api into a new standalone st2stream service. Similar to st2api and st2auth, stream is now a standalone service and WSGI app. (improvement)
    • Record failures to enforce rules due to missing actions or parameter validation errors. A RuleEnforcement object will be created for failed enforcements that do not lead to an ActionExecution creation. (improvement)
    • ๐Ÿ”ง The list of required and optional configuration arguments for the LDAP auth backend has changed. The LDAP auth backend supports other login name such as sAMAccountName. This requires a separate service account for the LDAP backend to query for the DN related to the login name for bind to validate the user password. Also, users must be in one or more groups specified in group_dns to be granted access.
    • For consistency rename deploy_pack alias to pack_deploy.

    ๐Ÿ—„ Deprecated

    
    * โฌ‡๏ธ Drop deprecated and unused ``system.admin_users`` config option which has been replaced with
      RBAC.
    * ๐Ÿ—„ The ``matchregex`` rule criteria operator has been deprecated in favor of ``regex`` and
      ``iregex``.
    * ๐Ÿ—„ Mistral has deprecated the use of task name (i.e. ``$.task1``) to reference task result. It is
      replaced with a ``task`` function that returns attributes of the task such as id, state, result,
      and additional information (i.e. ``task(task1).result``).
    
    ๐Ÿ›  Fixed
    ~~~~~
    
    * ๐Ÿ› Bug fixes to allow Sensors to have their own log files. #2487 [Andrew Regan]
    * ๐Ÿ‘‰ Make sure that the ``filename``, ``module``, ``funcName`` and ``lineno`` attributes which are
      available in the log formatter string contain the correct values. (bug-fix)
    
      Reported by Andrew Regan.
    * ๐Ÿ‘‰ Make sure that sensor container child processes take into account ``--use-debugger`` flag passed
      to the sensor container. This fixes support for remote debugging for sensor processes. (bug-fix)
    * ๐Ÿ›  Fix ``linux.traceroute`` action. (bug fix)
    * ๐Ÿ›  Fix a bug with positional argument handling in the local script runner. Now the arguments with a
      no value or value of ``None`` are correctly passed to the script. (bug fix)
    * ๐Ÿ›  Fix rule criteria comparison and make sure that false criteria pattern values such as integer
      ``0`` are handled correctly. (bug-fix)
    
      Reported by Igor Cherkaev.
    * ๐Ÿ›  Fix alias executions API endpoint and make sure an exception is thrown if the user provided
      command string doesn't match the provided format string. Previously, a non-match was silently
      ignored. (bug fix)