13647: Add AccessViaHosts doc comment.

[arvados.git] / doc / install / install-shell-server.html.textile.liquid

diff --git a/doc/install/install-shell-server.html.textile.liquid b/doc/install/install-shell-server.html.textile.liquid
index 08ac57f5ba474a131381fb2d34460f051eda8a2e..1cbe74997213ad24379085a6fd74a1d31e374654 100644 (file)
--- a/doc/install/install-shell-server.html.textile.liquid
+++ b/doc/install/install-shell-server.html.textile.liquid
@@ -3,6 +3,11 @@ layout: default
 navsection: installguide
 title: Install a shell server
 ...
 navsection: installguide
 title: Install a shell server
 ...

+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
+
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}

 
 There is nothing inherently special about an Arvados shell server. It is just a GNU/Linux machine with Arvados utilites and SDKs installed. For optimal performance, the Arvados shell server should be on the same LAN as the Arvados cluster, but that is not required.
 
 
 There is nothing inherently special about an Arvados shell server. It is just a GNU/Linux machine with Arvados utilites and SDKs installed. For optimal performance, the Arvados shell server should be on the same LAN as the Arvados cluster, but that is not required.
 


@@ -12,7 +17,21 @@ Please follow the "API token guide":../user/reference/api-tokens.html to get API
 
 h2. Install the Ruby SDK and utilities
 
 
 h2. Install the Ruby SDK and utilities
 

-If you're using RVM:
+First, install the curl development libraries necessary to build the Arvados Ruby SDK.  On Debian-based systems:
+
+<notextile>
+<pre><code>~$ <span class="userinput">sudo apt-get install libcurl4-openssl-dev</span>
+</code></pre>
+</notextile>
+
+On Red Hat-based systems:
+
+<notextile>
+<pre><code>~$ <span class="userinput">sudo yum install libcurl-devel</span>
+</code></pre>
+</notextile>
+
+Next, install the arvados-cli Ruby gem.  If you're using RVM:

 
 <notextile>
 <pre><code>~$ <span class="userinput">sudo /usr/local/rvm/bin/rvm-exec default gem install arvados-cli</span>
 
 <notextile>
 <pre><code>~$ <span class="userinput">sudo /usr/local/rvm/bin/rvm-exec default gem install arvados-cli</span>


@@ -22,28 +41,30 @@ If you're using RVM:
 If you're not using RVM:
 
 <notextile>
 If you're not using RVM:
 
 <notextile>

-<pre><code>~$ <span class="userinput">sudo gem install arvados-cli</span>
+<pre><code>~$ <span class="userinput">sudo -i gem install arvados-cli</span>

 </code></pre>
 </notextile>
 
 h2. Install the Python SDK and utilities
 
 </code></pre>
 </notextile>
 
 h2. Install the Python SDK and utilities
 

-On Debian-based systems:
+{% assign rh_version = "7" %}
+{% include 'note_python_sc' %}
+
+On Red Hat-based systems:

 
 <notextile>
 
 <notextile>

-<pre><code>~$ <span class="userinput">sudo apt-get install python-arvados-python-client python-arvados-fuse</span>
+<pre><code>~$ <span class="userinput">echo 'exclude=python2-llfuse' | sudo tee -a /etc/yum.conf</span>
+~$ <span class="userinput">sudo yum install python-arvados-python-client python-arvados-fuse crunchrunner</span>

 </code></pre>
 </notextile>
 
 </code></pre>
 </notextile>
 

-On Red Hat-based systems:
+On Debian-based systems:

 
 <notextile>
 
 <notextile>

-<pre><code>~$ <span class="userinput">sudo yum install python27-python-arvados-python-client python27-python-arvados-fuse</span>
+<pre><code>~$ <span class="userinput">sudo apt-get install python-arvados-python-client python-arvados-fuse crunchrunner</span>

 </code></pre>
 </notextile>
 
 </code></pre>
 </notextile>
 

-{% include 'note_python27_sc' %}
-

 h2. Install Git and curl
 
 {% include 'install_git_curl' %}
 h2. Install Git and curl
 
 {% include 'install_git_curl' %}


@@ -67,7 +88,7 @@ Create an Arvados virtual_machine object representing this shell server. This wi
 
 <notextile>
 <pre>
 
 <notextile>
 <pre>

-<code>apiserver:~$ <span class="userinput">arv --format=uuid virtual_machine create --virtual-machine '{"hostname":"<b>your.shell.server.hostname</b>"}'</span>
+<code>apiserver:~$ <span class="userinput">arv --format=uuid virtual_machine create --virtual-machine '{"hostname":"<b>your.shell.server.hostname.without.domain</b>"}'</span>

 zzzzz-2x53u-zzzzzzzzzzzzzzz</code>
 </pre>
 </notextile>
 zzzzz-2x53u-zzzzzzzzzzzzzzz</code>
 </pre>
 </notextile>


@@ -107,17 +128,19 @@ If you're not using RVM:
 
 Install cron.
 
 
 Install cron.
 

-On Debian-based systems:
+On Red Hat-based distributions:

 
 <notextile>
 
 <notextile>

-<pre><code>~$ <span class="userinput">sudo apt-get install cron</span>
+<pre><code>~$ <span class="userinput">sudo yum install cronie</span>
+~$ <span class="userinput">sudo systemctl enable crond</span>
+~$ <span class="userinput">sudo systemctl start crond</span>

 </code></pre>
 </notextile>
 
 </code></pre>
 </notextile>
 

-On Red Hat-based systems:
+On Debian-based systems:

 
 <notextile>
 
 <notextile>

-<pre><code>~$ <span class="userinput">sudo yum install cron</span>
+<pre><code>~$ <span class="userinput">sudo apt-get install cron</span>

 </code></pre>
 </notextile>
 
 </code></pre>
 </notextile>