From b3852e1fd52fa0471555004f14e8e9448480c935 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Javier=20B=C3=A9rtoli?= Date: Fri, 15 Jan 2021 09:36:07 -0300 Subject: [PATCH] Documentation: Explain that the canonical salt installer is hosted in Arvados' github account MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Arvados-DCO-1.1-Signed-off-by: Javier Bértoli --- doc/install/salt-multi-host.html.textile.liquid | 16 ++++++++-------- doc/install/salt.html.textile.liquid | 4 ++-- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/install/salt-multi-host.html.textile.liquid b/doc/install/salt-multi-host.html.textile.liquid index 4ba153faf9..50de6e439b 100644 --- a/doc/install/salt-multi-host.html.textile.liquid +++ b/doc/install/salt-multi-host.html.textile.liquid @@ -40,25 +40,25 @@ The formulas we use are: * "docker":https://github.com/saltstack-formulas/docker-formula.git * "locale":https://github.com/saltstack-formulas/locale-formula.git -There are example Salt pillar files for each of those formulas in the "arvados-formula's test/salt/pillar/examples":https://github.com/saltstack-formulas/arvados-formula/tree/master/test/salt/pillar/examples directory. As they are, they allow you to get all the main Arvados components up and running. +There are example Salt pillar files for each of those formulas in the "arvados-formula's test/salt/pillar/examples":https://github.com/arvados/arvados-formula/tree/master/test/salt/pillar/examples directory. As they are, they allow you to get all the main Arvados components up and running. h2(#saltstack). Install Arvados using Saltstack This is a package-based installation method. The Salt scripts are available from the "tools/salt-install":https://github.com/arvados/arvados/tree/master/tools/salt-install directory in the Arvados git repository. -The Arvados formula we maintain is located in the Saltstack's community repository of formulas: +The Arvados formula we maintain is located in Arvados' Github account and should be considered the canonical place to download its most up-to-date version: -* "arvados-formula":https://github.com/saltstack-formulas/arvados-formula.git +* "arvados-formula":https://github.com/arvados/arvados-formula.git -The @development@ version lives in our own repository +As the Saltstack's community keeps a "repository of formulas":https://github.com/saltstack-formulas/ in Github, we also provide -* "arvados-formula development":https://github.com/arvados/arvados-formula.git +* "a copy of the formula":https://github.com/saltstack-formulas/arvados-formula.git -This last one might break from time to time, as we try and add new features. Use with caution. +there, and do our best effort to keep it in sync with ours. -As much as possible, we try to keep it up to date, with example pillars to help you deploy Arvados. +A @development@ branch exists which uses Arvados' development repositories. This last one might break from time to time, as we try and add new features. As much as possible, we try to keep it up to date, with example pillars to help you deploy Arvados. Use with caution. -For those familiar with Saltstack, the process to get it deployed is similar to any other formula: +For those familiar with Saltstack, the process to get Arvados deployed is similar to any other formula: 1. Fork/copy the formula to your Salt master host. 2. Edit the Arvados, nginx, postgres, locale and docker pillars to match your desired configuration. diff --git a/doc/install/salt.html.textile.liquid b/doc/install/salt.html.textile.liquid index 8f5ecc8c65..2b7aa66028 100644 --- a/doc/install/salt.html.textile.liquid +++ b/doc/install/salt.html.textile.liquid @@ -14,7 +14,7 @@ SPDX-License-Identifier: CC-BY-SA-3.0 h2(#introduction). Introduction -To ease the installation of the various Arvados components, we have developed a "Saltstack":https://www.saltstack.com/ 's "arvados-formula":https://github.com/saltstack-formulas/arvados-formula which can help you get an Arvados cluster up and running. +To ease the installation of the various Arvados components, we have developed a "Saltstack":https://www.saltstack.com/ 's "arvados-formula":https://github.com/arvados/arvados-formula which can help you get an Arvados cluster up and running. Saltstack is a Python-based, open-source software for event-driven IT automation, remote task execution, and configuration management. It can be used in a master/minion setup or master-less. @@ -24,6 +24,6 @@ h2(#installmethod). Choose an installation method The salt formulas can be used in different ways. Choose one of these three options to install Arvados: -* "Use Vagrant to install Arvados in a virtual machine":salt-vagrant.html * "Arvados on a single host":salt-single-host.html +* "Use Vagrant to install Arvados in a virtual machine":salt-vagrant.html * "Arvados across multiple hosts":salt-multi-host.html -- 2.30.2