From 525583680b668412a1faa88e8306e27695178429 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Javier=20B=C3=A9rtoli?= Date: Tue, 20 Oct 2020 08:12:26 -0300 Subject: [PATCH] docs(salt): some minor fixes in the Salt-based installation documentation. MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit refs #16471: Arvados-DCO-1.1-Signed-off-by: Javier Bértoli --- .../salt-multi-host.html.textile.liquid | 25 +++++++++++++------ .../salt-single-host.html.textile.liquid | 2 +- doc/install/salt-vagrant.html.textile.liquid | 2 +- doc/install/salt.html.textile.liquid | 2 +- 4 files changed, 20 insertions(+), 11 deletions(-) diff --git a/doc/install/salt-multi-host.html.textile.liquid b/doc/install/salt-multi-host.html.textile.liquid index 0747b7271f..4ba153faf9 100644 --- a/doc/install/salt-multi-host.html.textile.liquid +++ b/doc/install/salt-multi-host.html.textile.liquid @@ -40,11 +40,11 @@ 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 "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/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. h2(#saltstack). Install Arvados using Saltstack -This is a source-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. +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: @@ -66,20 +66,29 @@ For those familiar with Saltstack, the process to get it deployed is similar to h2(#final_steps). DNS configuration -After the setup is done, you need to set up your DNS to be able to access the cluster. +After the setup is done, you need to set up your DNS to be able to access the cluster's nodes. -The simplest way to do this is to edit your @/etc/hosts@ file (as root): +The simplest way to do this is to add entries in the @/etc/hosts@ file of every host: 
export CLUSTER="arva2"
 export DOMAIN="arv.local"
-export HOST_IP="127.0.0.2"    # This is valid either if installing in your computer directly
-                              # or in a Vagrant VM. If you're installing it on a remote host
-                              # just change the IP to match that of the host.
-echo "${HOST_IP} api keep keep0 collections download ws workbench workbench2 ${CLUSTER}.${DOMAIN} api.${CLUSTER}.${DOMAIN} keep.${CLUSTER}.${DOMAIN} keep0.${CLUSTER}.${DOMAIN} collections.${CLUSTER}.${DOMAIN} download.${CLUSTER}.${DOMAIN} ws.${CLUSTER}.${DOMAIN} workbench.${CLUSTER}.${DOMAIN} workbench2.${CLUSTER}.${DOMAIN}" >> /etc/hosts
+
+echo A.B.C.a  api ${CLUSTER}.${DOMAIN} api.${CLUSTER}.${DOMAIN} >> /etc/hosts
+echo A.B.C.b  keep keep.${CLUSTER}.${DOMAIN} >> /etc/hosts
+echo A.B.C.c  keep0 keep0.${CLUSTER}.${DOMAIN} >> /etc/hosts
+echo A.B.C.d  collections collections.${CLUSTER}.${DOMAIN} >> /etc/hosts
+echo A.B.C.e  download download.${CLUSTER}.${DOMAIN} >> /etc/hosts
+echo A.B.C.f  ws ws.${CLUSTER}.${DOMAIN} >> /etc/hosts
+echo A.B.C.g  workbench workbench.${CLUSTER}.${DOMAIN} >> /etc/hosts
+echo A.B.C.h  workbench2 workbench2.${CLUSTER}.${DOMAIN}" >> /etc/hosts
+Replacing in each case de @A.B.C.x@ IP with the corresponding IP of the node. + +If your infrastructure uses another DNS service setup, add the corresponding entries accordingly. + h2(#initial_user). Initial user and login At this point you should be able to log into the Arvados cluster. diff --git a/doc/install/salt-single-host.html.textile.liquid b/doc/install/salt-single-host.html.textile.liquid index fc883501af..139366179a 100644 --- a/doc/install/salt-single-host.html.textile.liquid +++ b/doc/install/salt-single-host.html.textile.liquid @@ -31,7 +31,7 @@ For more information check "Saltstack's documentation":https://docs.saltstack.co h2(#single_host). Single host install using the provision.sh script -This is a source-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. +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. Use the @provision.sh@ script to deploy Arvados, which is implemented with the @arvados-formula@ in a Saltstack master-less setup: diff --git a/doc/install/salt-vagrant.html.textile.liquid b/doc/install/salt-vagrant.html.textile.liquid index e80e678345..41f32e51cd 100644 --- a/doc/install/salt-vagrant.html.textile.liquid +++ b/doc/install/salt-vagrant.html.textile.liquid @@ -15,7 +15,7 @@ SPDX-License-Identifier: CC-BY-SA-3.0 h2(#vagrant). Vagrant -This is a source-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. +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. A @Vagrantfile@ is provided to install Arvados in a virtual machine on your computer using "Vagrant":https://www.vagrantup.com/. diff --git a/doc/install/salt.html.textile.liquid b/doc/install/salt.html.textile.liquid index 4b3a9b42c9..8f5ecc8c65 100644 --- a/doc/install/salt.html.textile.liquid +++ b/doc/install/salt.html.textile.liquid @@ -18,7 +18,7 @@ To ease the installation of the various Arvados components, we have developed a 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. -This is a source-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. +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. h2(#installmethod). Choose an installation method -- 2.30.2