Skip to content

Latest commit

 

History

History
256 lines (159 loc) · 9.43 KB

Quick-Start-Guide.rst

File metadata and controls

256 lines (159 loc) · 9.43 KB
Raw

Quick Start Guide

This guide provides information on how to get Motr ready and test it. After following this guide, if you would like to actually run a motr cluster, please follow the cortx-hare quick start guide.

Prerequisites

  • CentOS 7.9/8.3+ or Rocky Linux 8.4+ (supported) or Ubuntu 18.04+ / Debian 10+ (experimental) OS on x86_64 (supported) or arm64 (experimental) platform.
  • At least 4 CPU Cores with 6GB RAM.

Get the Sources

git clone --recursive https://github.com/Seagate/cortx-motr.git

Build

  1. Install the necessary build dependencies first. On RHEL-based OSes:

    cd cortx-motr && sudo ./scripts/install-build-deps

    On Ubuntu / Debian OSes:

    sudo apt install devscripts equivs # enable mk-build-deps
cd cortx-motr && sudo mk-build-deps --install debian/control

  2. Choose the networking transport.

    Currently there are two options: Lustre LNet and libfabric. LNet is the legacy transport in Motr used for years. libfabric was added recently, but it's the mainline transport now in CORTX. If libfabric is installed in the system and detected by configure, Motr will be built to work with libfabric only (no matter whether LNet is installed or not).

    In LNet case, check the network interface configuration at /etc/modprobe.d/lnet.conf, make sure the interface name is correct there and matches with the one you have in your system. Here is an example configuration line:

    options lnet networks=tcp(eth0) config_on_load=1

    Notes:

    • LNet transport option requires support from Motr kernel module and it implies the kernel version dependency. Thus, this option won't fit for contrainer-based deployments. For container-based deployments, consider using libfabric, and use --with-user-mode-only configure option during the build (see below).
    • Make sure libfabric package is not installed for LNet-transport builds. If it is installed, uninstall it manually using sudo yum remove libfabric or sudo apt purge libfabric, depending on your Linux distribution.

    In libfabric case, download and install the packages from:

    Currently, there is a performance issue with default libfabric versions provided by Linux distributions on tcp. That's why we build customised version of the library. Hopefully, the issue will be resolved soon. For more information about our changes to libfabric refer to https://seagate-systems.atlassian.net/wiki/spaces/PUB/pages/711230113/Libfabric+setup+and+using+libfabric+with+motr

    Verify that libfabric package is installed with fi_info --version cmd. Make sure the network interface name is correctly set at /etc/libfab.conf. Here is an example configuration line:

    networks=tcp(eth1)

  3. Build it:

    ./autogen.sh && ./configure && make

    This will build the development version of the binaries. To evaluate the performance of Motr, use --enable-release configure option:

    ./autogen.sh && ./configure --enable-release && make

    or build and use the distribution packages. For RHEL-based OSes:

    make rpms

    For Ubuntu / Debian based OSes:

    make deb

    (The generated rpms will be placed at ~/rpmbuild/RPMS/, .deb packages will be placed at the current folder.)

    Note: use --with-user-mode-only configure option to avoid kernel module build, if you intend to use libfabric transport. This is the default mode for .deb packages build.

Running Tests

Unit Test

  • To run unit tests, use this command:

    sudo scripts/m0 run-ut

    Note: running Time (approximate) - 20 to 30 minutes

  • To list all available unit tests:

    sudo scripts/m0 run-ut -l

  • To run some specific unit test(s):

    sudo scripts/m0 run-ut -t libm0-ut,be-ut

Kernel Space Unit Test

  • To run kernel space unit tests, use this command:

    sudo scripts/m0 run-kut

System Tests

  • To list all available system tests, run the following command:

    sudo scripts/m0 run-st -l

  • To run Motr sanity test, use the following command:

    sudo scripts/m0 run-st 52motr-singlenode-sanity

  • To run all system tests:

    sudo scripts/m0 run-st

    Note: it might take several hours to finish.

Unit Benchmark

  • To run unit benchmarks, use the following command:

    sudo scripts/m0 run-ub

    Running Time (approximate) - 60 to 70 minutes

  • To list all available unit benchmarks:

    sudo scripts/m0 run-ub -l

  • To run some specific unit benchmark(s), e.g. "ad-ub":

    sudo scripts/m0 run-ub -t ad-ub

Troubleshooting

  • If pip fails to install a package while installing build dependencies, try installing packages using pip installer. run the following commands if package is ipaddress:

    sudo pip install ipaddress
sudo scripts/install-build-deps

  • If an installation failure occurs due to the dependency of pip3 , run the following commands:

    sudo yum install -y python36-setuptools
sudo easy_install-3.6 pip

  • If an installation failure occurs due to ply dependency, run the following command:

    pip3 install ply

  • If lctl list_nids does not render an output, do the following:

    1. Create the lnet.conf file, if it does not exist. And make sure the interface name is specified correctly there:

      $ cat /etc/modprobe.d/lnet.conf
options lnet networks=tcp(eth1) config_on_load=1

      Check the network interfaces in your system with ip a command.

    2. Restart the lnet service, and check LNet NIDs:

      sudo systemctl restart lnet
sudo lctl list_nids

  • For other errors, please check our FAQs.

  • After following this guide, if you would like to actually run a motr cluster, please follow the cortx-hare quick start guide.

Build the documentation

To create Motr documentation files, make sure you first install latex and ghostscript:

sudo yum install doxygen
sudo yum install texlive-pdftex texlive-latex-bin texlive-texconfig* texlive-latex* texlive-metafont* texlive-cmap* texlive-ec texlive-fncychap* texlive-pdftex-def texlive-fancyhdr* texlive-titlesec* texlive-multirow texlive-framed* texlive-wrapfig* texlive-parskip* texlive-caption texlive-ifluatex* texlive-collection-fontsrecommended texlive-collection-latexrecommended
sudo yum install ghostscript

Then in Motr folder run:

make doc

The files will be generated at doc/html/ folder.

Tested by:

  • April 22, 2022: Bhargav Dekivadiya ([email protected]) Rocky Linux version 8.4 verified with git (#7d8c19574e9d7748faa3e008f72f2eac8f139ab9)
  • February 4, 2022: Bhargav Dekivadiya ([email protected]) Rocky Linux version 8.4 verified with git (#f7d2eb4710c297709662c0de2a011ed22d9c238b)
  • January 31, 2022: Bhargav Dekivadiya ([email protected]) CentOS Linux release 7.9 verified with git (#e998dff5bd00d20654a250edc6042e5f7b5e52a0)
  • December 01, 2021: Naga Kishore Kommuri ([email protected]) CentOS Linux release 7.9.2009 verified with git (#43a75c54d15b23532d883b6065a201b5d6a7f385)
  • September 20, 2021: Yixuan Li ([email protected]) in Red Hat Enterprise Linux Server release 7.7 (Maipo) (#5aac28633a149d2c7e6f8d4c502d80dabf7ebb7e)
  • Sep 20, 2021: Liana Valdes Rodriguez ([email protected] / [email protected]) tested in CentOS 7.8.2003 x86_64 using CORTX-2.0.0-77 tag on main branch
  • September 15, 2021: Jugal Patil ([email protected]) tested using CentOS Linux release 7.9.2009 and 7.8.2003 verified with git tag CORTX-2.0.0-77 (#7d4d09cc9fd32ec7690c94298136b372069f3ce3) on main branch
  • Sep 6, 2021: Rose Wambui ([email protected]) in CentOS 7.8.2003 on a Mac running VirtualBox 6.1.
  • June 21, 2021: Daniar Kurniawan ([email protected]) in CentOS 7.9.2003 on a Chameleon node (type=compute_skylake).
  • May 23, 2021: Bo Wei ([email protected]) in CentOS 7.9.2009 on a Windows laptop running VirtualBox 6.1.
  • May 2, 2021: Christina Ku ([email protected]) in Red Hat Enterprise Linux Server release 7.7 (Maipo)
  • Apr 16, 2021: Jalen Kan ([email protected]) in CentOS 7.9.2009 on a windows laptop running VMware Workstation Pro 16
  • Mar 12, 2021: Yanqing Fu ([email protected]) in Red Hat Enterprise Linux Server release 7.7 (Maipo)
  • Jan 27, 2021: Patrick Hession ([email protected]) in CentOS 7.8.2003 on a Windows laptop running VMWare Workstation Pro 16
  • Jan 20, 2021: Mayur Gupta ([email protected]) on a Windows laptop running VMware Workstation Pro 16.
  • Dec 1, 2020: Huang Hua ([email protected]) in CentOS 7.7.1908
  • Nov 25, 2020: Philippe Daniel (CEA)
  • Oct 11, 2020: Saumya Sunder ([email protected]) on a Windows laptop running VMWare Workstation Pro 16
  • Oct 02, 2020: Venkataraman Padmanabhan ([email protected]) on a Windows laptop running VMWare Workstation Pro 16
  • Aug 09, 2020: Venkataraman Padmanabhan ([email protected]) on a Windows laptop running VMWare Workstation Pro 16