8 .. |img_travis| image:: https://travis-ci.com/saltstack-formulas/arvados-formula.svg?branch=master
9 :alt: Travis CI Build Status
11 :target: https://travis-ci.com/saltstack-formulas/arvados-formula
12 .. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
13 :alt: Semantic Release
15 :target: https://github.com/semantic-release/semantic-release
17 A SaltStack formula to install and configure an `Arvados cluster <https://arvados.org>`_.
19 .. contents:: **Table of Contents**
24 See the full `SaltStack Formulas installation and usage instructions
25 <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.
27 If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section
28 <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#writing-formulas>`_.
30 If you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``,
31 which contains the currently released version. This formula is versioned according to `Semantic Versioning <http://semver.org/>`_.
33 See `Formula Versioning Section <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning>`_ for more details.
35 If you need (non-default) configuration, please pay attention to the ``pillar.example`` file and/or `Special notes`_ section.
37 Contributing to this repo
38 -------------------------
40 **Commit message formatting is significant!!**
42 Please see `How to contribute <https://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst>`_ for more details.
47 In the `Arvados repository <https://github.com/arvados/arvados/>`_ you can find `a provision script <https://github.com/arvados/arvados/tree/master/tools/salt-install>`_
48 to deploy a single-node, all-in-one Arvados cluster (The script uses this formula to get a cluster up and running in Saltstack's master-less mode).
50 The `single-node` install does not include SLURM: it is intended for an `all-in-one-host` installation,
51 so it uses `crunch-dispatch-local` to run containers in the same instance.
53 The provision script can be run anywhere, so you can run it in an AWS instance and you'll get a `single-node` Arvados cluster there.
55 The Arvados formula allows you to `install any dispatcher available <https://github.com/saltstack-formulas/arvados-formula/blob/master/pillar.example#L182-L191>`_,
56 provided you configure the pillars the way you need them.
58 Arvados currently has three dispatchers:
60 * **crunch-dispatch-local** (for single node installations),
61 * **arvados-dispatch-cloud** (for dynamic compute on AWS or Azure) and
62 * **crunch-dispatch-slurm** (for SLURM integration).
67 Arvados **requires** a Postgres database for its API server and SSL for communications. If you don't satisfy these two requirements, things
68 won't work. It also uses an Nginx server as a redirector but probably almost any other webserver/redirector can be used instead.
70 We suggest you use the `postgres-formula <https://github.com/saltstack-formulas/postgres-formula/>`_,
71 the `nginx-formula <https://github.com/saltstack-formulas/nginx-formula/>`_ and the
72 `letsencrypt-formula <https://github.com/saltstack-formulas/letsencrypt-formula/>`_ to satisfy these dependencies.
73 In the **test/salt/pillar/examples/** directory there are example pillar YAMLs to set up these packages, using the mentioned formulas
74 as Arvados needs them.a
76 In the **test/salt/states/examples/** directory there are some example helper states to set up a few requirements for single-node
77 (all-in-one) Arvados host.
82 As Arvados is a *suite* of tools that can be installed in different hosts and configured to interact, this formula is split in
83 those components, which can be installed or removed independently of the other components. This means that you'll get flexibility
84 to install your cluster as you prefer at the expense of having to take care on some steps:
86 The formula has the following components/submodules available:
88 * `api <https://doc.arvados.org/install/install-api-server.html>`_: installs the Arvados API server packages. Requires a running
89 Postgres database and an Nginx+Passenger server.
90 * `config <https://doc.arvados.org/v2.0/admin/config.html>`_: creates and deploys a valid Arvados config file. This state is automatically
91 include in all the components that require it (at the moment, all but `shell`), so you will rarely need to invoke this state manually.
92 * `controller <https://doc.arvados.org/v2.0/install/install-api-server.html>`_: installs the Arvados API controller.
93 * `keepproxy <https://doc.arvados.org/v2.0/install/install-keepproxy.html>`_: installs and configures the Arvados Keepproxy gateway
95 * `keepstore <https://doc.arvados.org/v2.0/install/install-keepstore.html>`_: installs and configures an Arvados Keep storages.
96 * `keepweb <https://doc.arvados.org/v2.0/install/install-keep-web.html>`_: installs and configures the WebDAV access to the Keep storages.
97 * `repo <https://doc.arvados.org/v2.0/install/packages.html>`_: configures the repositories to install arvados. It's enabled by default.
98 * `shell <https://doc.arvados.org/v2.0/install/install-shell-server.html>`_: installs the user CLI apps to communicate with the cluster.
99 * `websocket <https://doc.arvados.org/v2.0/install/install-ws.html>`_: installs the websocket notifcations gateway.
100 * `workbench <https://doc.arvados.org/v2.0/install/install-workbench-app.html>`_: installs the webUI to communicate with the cluster.
101 * `workbench2 <https://doc.arvados.org/v2.0/install/install-workbench2-app.html>`_: installs the next generation webUI for Arvados.
103 If you just use the `arvados` meta-state, it will install all the components in a single host.
105 Also, please note that the individual subcomponents' `clean` states **won't remove the config file**: as the config is common to all the suite
106 components and they can be installed in the same host, removing it with a subcomponent might break others.
108 If you want to remove the config in a host where you're removing a subcomponent, use the `arvados.config.clean` state after the
109 `arvados.<subcomponent>.clean` state.
111 Finally, the `arvados.clean` meta-state will remove everything, config included, and can be used in any host to remove all of arvados files.
116 For each of the components, there are *meta-states* named after the component that will include other states in the component subdir
117 that perform the actual work.
119 For example, using *arvados.keepstore* will include, in order:
121 * arvados.keepstore.package.install
122 * arvados.config.file
123 * arvados.keepstore.service.running
125 while using *arvados.keepstore.clean* will include, in order:
127 * arvados.keepstore.service.clean
128 * arvados.keepstore.package.clean
130 Or you can use individual states, like
132 * arvados.keepstore.package.install
133 * arvados.keepstore.service.clean
135 to get the *keepstore* package installed with the service stopped.
137 The generic description for the states is
145 *Meta-state (This is a state that includes other states)*.
147 This installs the *WHOLE* arvados suite in a single host,
148 manages the arvados configuration file and then
149 starts the associated arvados services.
154 *Meta-state (This is a state that includes other states)*.
156 This state will undo everything performed in the ``arvados`` meta-state in reverse order, i.e.
157 stops the services, removes the configuration file and then uninstalls the packages.
163 This state will configure the arvados cluster. As all the arvados components use the same config
164 file, any of the following components will include this state and you will rarely need to call it
165 independently. You can still do, ie, to get a parsed config file to use somewhere else.
167 ``arvados.config.clean``
168 ^^^^^^^^^^^^^^^^^^^^^^^^^
170 This state will remove the configuration of the arvados node.
175 This state will configure the arvados repository.
177 ``arvados.repo.clean``
178 ^^^^^^^^^^^^^^^^^^^^^^
180 This state will remove the arvados repository configuration.
183 ``arvados.<component>``
184 ^^^^^^^^^^^^^^^^^^^^^^^
186 *Meta-state (This is a state that includes other states)*.
188 This state will install the package, configure the component (if applicable) and start the service (if applicable).
190 ``arvados.<component>.clean``
191 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
193 *Meta-state (This is a state that includes other states)*.
195 This state will undo everything performed in the ``arvados.<component>`` meta-state in reverse order, i.e.
196 stop the service and uninstall the package/s.
198 ``arvados.<component>.package``
199 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
201 This state will install the arvados <component> package/s only.
203 ``arvados.<component>.package.clean``
204 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
206 This state will remove the packages of the arvados <component> node and has a depency on
207 ``arvados.<component>.service.clean`` via include list (if applicable).
209 ``arvados.<component>.service``
210 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
212 This state will start the arvados service and has a dependency on ``arvados.config``
215 ``arvados.<component>.service.clean``
216 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
218 This state will stop the arvados service and disable it at boot time.
224 Linux testing is done with ``kitchen-salt``.
234 $ gem install bundler
236 $ bin/kitchen test [platform]
238 Where ``[platform]`` is the platform name defined in ``kitchen.yml``,
239 e.g. ``debian-10-3000-1-py3``.
241 ``bin/kitchen converge``
242 ^^^^^^^^^^^^^^^^^^^^^^^^
244 Creates the docker instance and runs the ``arvados`` main state, ready for testing.
246 ``bin/kitchen verify``
247 ^^^^^^^^^^^^^^^^^^^^^^
249 Runs the ``inspec`` tests on the actual instance.
251 ``bin/kitchen destroy``
252 ^^^^^^^^^^^^^^^^^^^^^^^
254 Removes the docker instance.
259 Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.
261 ``bin/kitchen login``
262 ^^^^^^^^^^^^^^^^^^^^^
264 Gives you SSH access to the instance for manual testing.