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 systems
  49 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  50
  51 1. Add this Arvados repository to your sources list::
  52
  53      deb http://apt.arvados.org/buster buster main
  54
  55 2. Update your package list.
  56
  57 3. Install the ``python3-arvados-fuse`` package.
  58
  59 Configuration
  60 -------------
  61
  62 This driver needs two pieces of information to connect to
  63 Arvados: the DNS name of the API server, and an API authorization
  64 token.  You can set these in environment variables, or the file
  65 ``$HOME/.config/arvados/settings.conf``.  `The Arvados user
  66 documentation
  67 <http://doc.arvados.org/user/reference/api-tokens.html>`_ describes
  68 how to find this information in the Arvados Workbench, and install it
  69 on your system.
  70
  71 Testing and Development
  72 -----------------------
  73
  74 Debian packages you need to build llfuse:
  75
  76 $ apt-get install python-dev pkg-config libfuse-dev libattr1-dev
  77
  78 This package is one part of the Arvados source package, and it has
  79 integration tests to check interoperability with other Arvados
  80 components.  Our `hacking guide
  81 <https://dev.arvados.org/projects/arvados/wiki/Hacking_Python_SDK>`_
  82 describes how to set up a development environment and run tests.