services/fuse/README.rst

   1 .. Copyright (C) The Arvados Authors. All rights reserved.
   2 ..
   3 .. SPDX-License-Identifier: AGPL-3.0
   4
   5 ========================
   6 Arvados Keep FUSE Driver
   7 ========================
   8
   9 Overview
  10 --------
  11
  12 This package provides a FUSE driver for Keep, the Arvados_ storage
  13 system.  It allows you to read data from your collections as if they
  14 were on the local filesystem.
  15
  16 .. _Arvados: https://arvados.org/
  17
  18 Installation
  19 ------------
  20
  21 Installing under your user account
  22 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  23
  24 This method lets you install the package without root access.  However,
  25 other users on the same system will need to reconfigure their shell in order
  26 to be able to use it. Run the following to install the package in an
  27 environment at ``~/arvclients``::
  28
  29   python3 -m venv ~/arvclients
  30   ~/arvclients/bin/pip install arvados_fuse
  31
  32 Command line tools will be installed under ``~/arvclients/bin``. You can
  33 test one by running::
  34
  35   ~/arvclients/bin/arv-mount --version
  36
  37 You can run these tools by specifying the full path every time, or you can
  38 add the directory to your shell's search path by running::
  39
  40   export PATH="$PATH:$HOME/arvclients/bin"
  41
  42 You can make this search path change permanent by adding this command to
  43 your shell's configuration, for example ``~/.bashrc`` if you're using bash.
  44 You can test the change by running::
  45
  46   arv-mount --version
  47
  48 Installing on Debian and Ubuntu systems
  49 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  50
  51 Arvados publishes packages for Debian 11 "bullseye," Debian 12 "bookworm," Ubuntu 20.04 "focal," and Ubuntu 22.04 "jammy." You can install the Python SDK package on any of these distributions by running the following commands::
  52
  53   sudo install -d /etc/apt/keyrings
  54   sudo curl -fsSL -o /etc/apt/keyrings/arvados.asc https://apt.arvados.org/pubkey.gpg
  55   sudo tee /etc/apt/sources.list.d/arvados.sources >/dev/null <<EOF
  56   Types: deb
  57   URIs: https://apt.arvados.org/$(lsb_release -cs)
  58   Suites: $(lsb_release -cs)
  59   Components: main
  60   Signed-by: /etc/apt/keyrings/arvados.asc
  61   EOF
  62   sudo apt update
  63   sudo apt install python3-arvados-fuse
  64
  65 Configuration
  66 -------------
  67
  68 This driver needs two pieces of information to connect to
  69 Arvados: the DNS name of the API server, and an API authorization
  70 token.  `The Arvados user
  71 documentation
  72 <http://doc.arvados.org/user/reference/api-tokens.html>`_ describes
  73 how to find this information in the Arvados Workbench, and install it
  74 on your system.
  75
  76 Testing and Development
  77 -----------------------
  78
  79 Debian packages you need to build llfuse::
  80
  81   sudo apt install python-dev pkg-config libfuse-dev libattr1-dev
  82
  83 This package is one part of the Arvados source package, and it has
  84 integration tests to check interoperability with other Arvados
  85 components.  Our `hacking guide
  86 <https://dev.arvados.org/projects/arvados/wiki/Hacking_Python_SDK>`_
  87 describes how to set up a development environment and run tests.