X-Git-Url: https://git.arvados.org/arvados-formula.git/blobdiff_plain/fa49dbe833c7867ac95da84f9b36c8114cd89039..HEAD:/docs/README.rst diff --git a/docs/README.rst b/docs/README.rst index d05d5e8..b756aaa 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -1,19 +1,13 @@ .. _readme: +.. + # Copyright (C) The Arvados Authors. All rights reserved. + # + # SPDX-License-Identifier: Apache-2.0 + arvados-formula ================ -|img_travis| |img_sr| - -.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/arvados-formula.svg?branch=master - :alt: Travis CI Build Status - :scale: 100% - :target: https://travis-ci.com/saltstack-formulas/arvados-formula -.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg - :alt: Semantic Release - :scale: 100% - :target: https://github.com/semantic-release/semantic-release - A SaltStack formula to install and configure an `Arvados cluster `_. .. contents:: **Table of Contents** @@ -24,14 +18,6 @@ General notes See the full `SaltStack Formulas installation and usage instructions `_. -If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section -`_. - -If you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``, -which contains the currently released version. This formula is versioned according to `Semantic Versioning `_. - -See `Formula Versioning Section `_ for more details. - If you need (non-default) configuration, please pay attention to the ``pillar.example`` file and/or `Special notes`_ section. Contributing to this repo @@ -44,7 +30,7 @@ Please see `How to contribute `_ you can find `a provision script `_ +In the `Arvados repository `_ you can find `a provision script `_ 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). The `single-node` install does not include SLURM: it is intended for an `all-in-one-host` installation, @@ -57,7 +43,7 @@ provided you configure the pillars the way you need them. Arvados currently has three dispatchers: -* **crunch-dispatch-local** (for single node installations), +* **crunch-dispatch-local** (for single node installations and testing purposes, not suitable for production), * **arvados-dispatch-cloud** (for dynamic compute on AWS or Azure) and * **crunch-dispatch-slurm** (for SLURM integration).