21305: Refactor piwik and GA tracking a little bit

[arvados.git] / doc / _includes / _download_installer.liquid

diff --git a/doc/_includes/_download_installer.liquid b/doc/_includes/_download_installer.liquid
index 5690820086a714a9f2ce2516d8a347bb6c1bae79..461debd4928a949a8cc014a8e9f7fa297a738f4b 100644 (file)
--- a/doc/_includes/_download_installer.liquid
+++ b/doc/_includes/_download_installer.liquid
@@ -6,15 +6,42 @@ SPDX-License-Identifier: CC-BY-SA-3.0
 
 {% include 'branchname' %}
 
-This procedure will install all the main Arvados components to get you up and running in a single host.
-
-This is a package-based installation method, however the installation script is currently distributed in source form via @git@:
+This is a package-based installation method, however the installation script is currently distributed in source form via @git@. We recommend checking out the git tree on your local workstation, not directly on the target(s) where you want to install and run Arvados.
 
 <notextile>
-<pre><code>git clone https://git.arvados.org/arvados.git
+<pre><code class="userinput">git clone https://github.com/arvados/arvados.git
+cd arvados
 git checkout {{ branchname }}
-cd arvados/tools/salt-install
+cd tools/salt-install
+</code></pre>
+</notextile>
+
+The @install.sh@ and @provision.sh@ scripts will help you deploy Arvados by preparing your environment to be able to run the installer, then running it. The actual installer is located in the "arvados-formula git repository":https://git.arvados.org/arvados-formula.git/tree/refs/heads/{{ branchname }} and will be cloned during the running of the @provision.sh@ script.  The installer is built using "Saltstack":https://saltproject.io/ and @provision.sh@ performs the install using masterless mode.
+
+h2(#copy_config). Initialize the installer
+
+Replace "xarv1" with the cluster id you selected earlier.
+
+This creates a git repository in @~/setup-arvados-xarv1@.  The @installer.sh@ will record all the configuration changes you make, as well as using @git push@ to synchronize configuration edits if you have multiple nodes.
+
+Important!  Once you have initialized the installer directory, all further commands must be run with @~/setup-arvados-${CLUSTER}@ as the current working directory.
+
+h3. Using Terraform (AWS specific)
+
+If you are going to use Terraform to set up the infrastructure on AWS, you first need to install the "Terraform CLI":https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli and the "AWS CLI":https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html tool.  Then you can initialize the installer.
+
+<notextile>
+<pre><code class="userinput">CLUSTER=xarv1
+./installer.sh initialize ~/setup-arvados-${CLUSTER} {{local_params_src}} {{config_examples_src}} {{terraform_src}}
+cd ~/setup-arvados-${CLUSTER}
 </code></pre>
 </notextile>
 
-The @provision.sh@ script will help you deploy Arvados by preparing your environment to be able to run the installer, then running it. The actual installer is located in the "arvados-formula git repository":https://git.arvados.org/arvados-formula.git/tree/refs/heads/{{ branchname }} and will be cloned during the running of the @provision.sh@ script.  The installer is built using "Saltstack":https://saltproject.io/ and @provision.sh@ performs the install using master-less mode.
+h3. Without Terraform
+
+<notextile>
+<pre><code class="userinput">CLUSTER=xarv1
+./installer.sh initialize ~/setup-arvados-${CLUSTER} {{local_params_src}} {{config_examples_src}}
+cd ~/setup-arvados-${CLUSTER}
+</code></pre>
+</notextile>