diff --git a/docs/source/actionchain.rst b/docs/source/actionchain.rst index b7bb6405e..f1a669d06 100644 --- a/docs/source/actionchain.rst +++ b/docs/source/actionchain.rst @@ -67,7 +67,7 @@ For a user to provide input to an ActionChain the input parameters must be defin --- # ... - params: + parameters: input1: type: "string" required: true @@ -83,7 +83,7 @@ The input parameter ``input1`` can now be referenced in the parameters field of - name: "action1" ref: "core.local" - params: + parameters: action1_input: "{{input1}}" # ... @@ -154,13 +154,13 @@ and prints it to standard output. - name: "task1" ref: "core.local" - params: + parameters: cmd: "date" on-success: "task2" - name: "task2" ref: "mypack.workflow2" - params: + parameters: date: "{{ task1.stdout }}" # Here we pass result from "task1" as a "date" action parameter to the action "workflow2" ``workflow2.meta.yaml`` @@ -188,7 +188,7 @@ and prints it to standard output. - name: "task1" ref: "core.local" - params: + parameters: cmd: "echo {{ date }}" # Here we echo the variable "date" which was passed to the workflow as an action parameter The example above applies to a scenario where you have two related workflows diff --git a/docs/source/actions.rst b/docs/source/actions.rst index 85b2b8e48..18f7a89e3 100644 --- a/docs/source/actions.rst +++ b/docs/source/actions.rst @@ -219,7 +219,7 @@ shown below: - name: "c2" ref: "core.local" - params: + parameters: cmd: "echo \"c2: parent exec is {{action_context.parent.execution_id}}.\"" on-success: "c3" on-failure: "c4" diff --git a/docs/source/chatops/notifications.rst b/docs/source/chatops/notifications.rst index 0323b879a..34d292c01 100644 --- a/docs/source/chatops/notifications.rst +++ b/docs/source/chatops/notifications.rst @@ -159,7 +159,7 @@ action with task notify is shown below. - name: "make_reqmnts" ref: "core.remote" - params: + parameters: cmd: "cd {{repo_target}} && make requirements" hosts: "{{build_server}}" timeout: 300 @@ -172,7 +172,7 @@ action with task notify is shown below. - name: "make_lint" ref: "core.remote" - params: + parameters: cmd: "cd {{repo_target}} && make .lint" # .flake8 and .pylint hosts: "{{build_server}}" timeout: 180 diff --git a/docs/source/install/vagrant.rst b/docs/source/install/vagrant.rst index 5ebc1f5b6..c99ad8dde 100644 --- a/docs/source/install/vagrant.rst +++ b/docs/source/install/vagrant.rst @@ -1,46 +1,7 @@ Vagrant ======= -|st2| provides pre-built Vagrant boxes for both `VirtualBox `_ and `VMWare `_ providers. By default, the setup will install the lastest stable release of |st2|. These boxes are hosted on the `Hashicorp Atlas `_ website. - -Using these vagrant images, it is possible to setup: - -* Spin up a test environment to play with StackStorm (`st2`) -* Spin up a development environment to work with StackStorm (`st2dev`) -* Begin building infrastructure patterns using pre-configured Config Management tools - -Quick Start ------------ - -If you are new to Vagrant, or to StackStorm, we have made a repository all setup with the necessary configuration to run a Vagrant box. This includes pre-configured virtual machine settings out of the box. This is a great way to get started quickly and easily. - -:: - - git clone https://github.com/StackStorm/st2workroom.git st2workroom - cd st2workroom - vagrant up st2 - - -If you have previously used deployed |st2| and downloaded the st2express box it might be a good idea to update the box. If this is your absolute first install of |st2| then skip this step. - -:: - - vagrant box update st2 - - -This will boot up a fresh |st2| installation along with the Mistral workflow engine on Ubuntu 14.04 LTS. While loading, some console output in red is expected and can be safely ignored. Once completed, you will see the following console output. - -.. include:: /_includes/install/ok.rst - -Once installed, you have the option of logging into the virtual machine with this command: - -:: - - vagrant ssh st2 - -Likewise, you have the option to run the All-in-one GUI setup. Using this tool, you can quickly configure your StackStorm system including user accounts, ChatOps support, and enable Enterprise Features. Refer to :ref:`all_in_one-running_the_setup` section of :doc:`./all_in_one` for more information. - -NOTE: the `st2express/Vagrant `__ is deprecated in _v0.13_. +Here is how to get |st2| up and running with Vagrant. Requirements ~~~~~~~~~~~~