21388: Modernize Debian install instructions
authorBrett Smith <brett.smith@curii.com>
Thu, 30 May 2024 21:05:54 +0000 (17:05 -0400)
committerBrett Smith <brett.smith@curii.com>
Fri, 31 May 2024 03:30:09 +0000 (23:30 -0400)
* Prefer `apt` over `apt-get`
* Prefer deb822-style sources format over one-line
* Use /etc/apt/keyrings instead of `apt-key`
* Link to NVIDIA's Container Toolkit install instructions

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

doc/_includes/_install_cuda.liquid
doc/_includes/_install_debian_key.liquid
doc/_includes/_install_packages.liquid
doc/_includes/_install_ruby_and_bundler.liquid
doc/admin/maintenance-and-upgrading.html.textile.liquid
doc/install/install-postgresql.html.textile.liquid
doc/install/nginx.html.textile.liquid
doc/install/packages.html.textile.liquid
doc/install/salt-single-host.html.textile.liquid
doc/sdk/cli/install.html.textile.liquid
doc/sdk/ruby/index.html.textile.liquid

index cb1519a61678e345e67570ed7bc613f47353da45..394a58c94c95731fb0b808ed6af4ec1c17da96dd 100644 (file)
@@ -6,16 +6,4 @@ SPDX-License-Identifier: CC-BY-SA-3.0
 
 h2(#cuda). Install NVIDA CUDA Toolkit (optional)
 
-If you want to use NVIDIA GPUs, "install the CUDA toolkit.":https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html
-
-In addition, you also must install the NVIDIA Container Toolkit:
-
-<pre>
-DIST=$(. /etc/os-release; echo $ID$VERSION_ID)
-curl -s -L https://nvidia.github.io/libnvidia-container/gpgkey | \
-  sudo apt-key add -
-curl -s -L https://nvidia.github.io/libnvidia-container/$DIST/libnvidia-container.list | \
-  sudo tee /etc/apt/sources.list.d/libnvidia-container.list
-sudo apt-get update
-apt-get install libnvidia-container1 libnvidia-container-tools nvidia-container-toolkit
-</pre>
+If you want to use NVIDIA GPUs, "install the CUDA toolkit":https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html and the "NVIDIA Container Toolkit":https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html.
index 91b24a8a8d02bac853a64c6615438b40d6776cd5..84937e839851a6322ea18cb705beedbf2c39ece3 100644 (file)
@@ -5,13 +5,7 @@ SPDX-License-Identifier: CC-BY-SA-3.0
 {% endcomment %}
 
 <notextile>
-<pre><code># <span class="userinput">apt-get --no-install-recommends install curl gnupg2 ca-certificates</span>
-# <span class="userinput">curl https://apt.arvados.org/pubkey.gpg -o /etc/apt/trusted.gpg.d/arvados.asc</span>
+<pre><code># <span class="userinput">install -d /etc/apt/keyrings</span>
+# <span class="userinput">curl -fsSL -o /etc/apt/keyrings/arvados.asc https://apt.arvados.org/pubkey.gpg</span>
 </code></pre>
 </notextile>
-
-The Arvados package signing GPG key is also available via the keyservers, though they can be unreliable. To retrieve the signing key via keyserver.ubuntu.com:
-
-<notextile>
-<pre><code># <span class="userinput">/usr/bin/apt-key adv --keyserver keyserver.ubuntu.com --recv 1078ECD7</code></pre>
-</notextile>
index 595b0a8b71667d17987d2aa5fa7b1ece6332a5b4..07e406720a72ebae67f471e00140270db422212e 100644 (file)
@@ -23,6 +23,6 @@ h3. Alma/CentOS/Red Hat/Rocky
 h3. Debian and Ubuntu
 
 <notextile>
-<pre><code># <span class="userinput">apt-get install {{packages_to_install  | join " "}}</span>
+<pre><code># <span class="userinput">apt install {{packages_to_install  | join " "}}</span>
 </code></pre>
 </notextile>
index cb220f569a7fc94d035dc6f668dc9944a33b63ca..59ea86a56073e61c9ddf0ec79b48440d65ed0f31 100644 (file)
@@ -20,5 +20,5 @@ h2. Debian and Ubuntu
 All supported versions of Debian and Ubuntu include a version of Ruby you can use with Arvados.
 
 <notextile>
-<pre><code># <span class="userinput">apt-get --no-install-recommends install ruby ruby-dev</span></code></pre>
+<pre><code># <span class="userinput">apt --no-install-recommends install ruby ruby-dev</span></code></pre>
 </notextile>
index 2ec1700fc93e0a605cf4595a2c06d40b4f3b3c31..ed1e1e412c570883d94b024c04a8e73346667138 100644 (file)
@@ -65,7 +65,7 @@ Upgrading Arvados typically involves the following steps:
 # Update compute nodes
 ## (cloud) Rebuild and deploy the "compute node image":{{site.baseurl}}/install/crunch2-cloud/install-compute-node.html
 ## (slurm/LSF) Upgrade the @python3-arvados-fuse@ package used on your compute nodes
-# Install new packages using @apt-get upgrade@ or @yum upgrade@.
+# Install new packages using @apt upgrade@ or @yum upgrade@.
 # Wait for package installation scripts as they perform any necessary data migrations.
 # Run @arvados-server config-check@ to detect configuration errors or deprecated entries.
 # Verify that the Arvados services were restarted as part of the package upgrades.
index 300bdeb5407ceb86a3c43708c716e439f823509f..7771adb874d5a83ee08836d353669cbdd6352438 100644 (file)
@@ -41,7 +41,7 @@ h3(#debian). Debian or Ubuntu
 All supported versions of Debian and Ubuntu include a version of PostgreSQL you can use with Arvados.
 
 # Install PostgreSQL
-<notextile><pre># <span class="userinput">apt-get --no-install-recommends install postgresql postgresql-contrib</span></pre></notextile>
+<notextile><pre># <span class="userinput">apt --no-install-recommends install postgresql postgresql-contrib</span></pre></notextile>
 # Configure PostgreSQL to accept password connections from the local network (replace @10.9.8.0/24@ with your private network mask)
 <notextile><pre># <span class="userinput">echo 'host all all 10.9.8.0/24 md5' | tee -a /etc/postgresql/*/main/pg_hba.conf</span></pre></notextile>
 # Configure the database to launch at boot and start now
index 853f3ce056d8f1b17d5c2f81509bcc22b03fdf49..b5734d70b7071ba4906bec704347fc3bfd140e08 100644 (file)
@@ -18,5 +18,5 @@ h3. Alma/CentOS/Red Hat/Rocky 8
 h3. Debian and Ubuntu
 
 <notextile>
-<pre><code># <span class="userinput">apt-get --no-install-recommends install nginx</span></code></pre>
+<pre><code># <span class="userinput">apt --no-install-recommends install nginx</span></code></pre>
 </notextile>
index 7fb0419ceb51a229e3357a5b2eae161f3f1e7ff3..ad480012e2daa5a3c7cad885d96c518b7b67f690 100644 (file)
@@ -50,14 +50,18 @@ First, register the Arvados signing key in apt's database:
 
 {% include 'gpg_key_fingerprint' %}
 
-As root, add the Arvados package repository to your sources.  This command depends on your OS vendor and version:
+Then set up the package source by running this command:
 
-table(table table-bordered table-condensed).
-|_. OS version|_. Command|
-|Debian 12 ("bookworm")|<notextile><code><span class="userinput">echo "deb http://apt.arvados.org/bookworm bookworm main" &#x7c; tee /etc/apt/sources.list.d/arvados.list</span></code></notextile>|
-|Debian 11 ("bullseye")|<notextile><code><span class="userinput">echo "deb http://apt.arvados.org/bullseye bullseye main" &#x7c; tee /etc/apt/sources.list.d/arvados.list</span></code></notextile>|
-|Ubuntu 22.04 ("jammy")[1]|<notextile><code><span class="userinput">echo "deb http://apt.arvados.org/jammy jammy main" &#x7c; tee /etc/apt/sources.list.d/arvados.list</span></code></notextile>|
-|Ubuntu 20.04 ("focal")[1]|<notextile><code><span class="userinput">echo "deb http://apt.arvados.org/focal focal main" &#x7c; tee /etc/apt/sources.list.d/arvados.list</span></code></notextile>|
+<notextile>
+<pre><code># <span class="userinput">tee /etc/apt/sources.list.d/arvados.sources &gt;/dev/null &lt;&lt;EOF
+Types: deb
+URIs: https://apt.arvados.org/$(lsb_release -cs)
+Suites: $(lsb_release -cs)
+Components: main
+Signed-by: /etc/apt/keyrings/arvados.asc
+EOF
+</span></code></pre>
+</notextile>
 
 {% include 'notebox_begin' %}
 
@@ -68,6 +72,6 @@ fn1. Arvados packages for Ubuntu may depend on third-party packages in Ubuntu's
 Retrieve the package list:
 
 <notextile>
-<pre><code># <span class="userinput">apt-get update</span>
+<pre><code># <span class="userinput">apt update</span>
 </code></pre>
 </notextile>
index 92c1aa2645b6493bc14e83bd1503d0531e050682..285b49ebde6ef506c5c5934157ba4c1f5241ad7e 100644 (file)
@@ -171,7 +171,7 @@ h2(#test-install). Confirm the cluster is working
 When everything has finished, you can run the diagnostics.  This requires the `arvados-client` package:
 
 <pre>
-apt-get install arvados-client
+apt install arvados-client
 </pre>
 
 Depending on where you are running the installer, you need to provide @-internal-client@ or @-external-client@.
index e0d50b874b9251ea3074e31a3f91538bb282f4ab..8baa32c6eaffa1c5b38d698ef4a2eb4c39d70f11 100644 (file)
@@ -17,11 +17,13 @@ h2. Prerequisites
 # "Install Ruby":../../install/ruby.html
 # "Install the Python SDK":../python/sdk-python.html
 
-The SDK uses @curl@ which depends on the @libcurl@ C library.  To build the module you may have to install additional packages.  On Debian 10 this is:
+The SDK uses @curl@ which depends on the @libcurl@ C library.  To build the module you may have to install additional packages.  On supported versions of Debian and Ubuntu, run:
 
-<pre>
-$ apt-get install build-essential libcurl4-openssl-dev
-</pre>
+<notextile>
+<pre><code>
+# <span class="userinput">apt install build-essential libcurl4-openssl-dev
+</code></pre>
+</notextile>
 
 h2. Install from RubyGems
 
index b3b97244bad15f643b1d434163c231acc4269d9b..ea0fc78797bc6166ff9b2ec341e35ff9ff3c1308 100644 (file)
@@ -22,11 +22,13 @@ h3. Prerequisites
 
 # "Install Ruby":../../install/ruby.html
 
-The SDK uses @curl@ which depends on the @libcurl@ C library.  To build the module you may have to install additional packages.  On Debian 10 this is:
+The SDK uses @curl@ which depends on the @libcurl@ C library.  To build the module you may have to install additional packages.  On supported versions of Debian and Ubuntu, run:
 
-<pre>
-$ apt-get install build-essential libcurl4-openssl-dev
-</pre>
+<notextile>
+<pre><code>
+# <span class="userinput">apt install build-essential libcurl4-openssl-dev
+</code></pre>
+</notextile>
 
 h3. Install with RubyGems