Building and Installing IPMCTL from Source on Linux
Building ipmctl from source code if your Linux package repository does not provide package or it contains a old version.
This procedure provides the steps for building and installing ipmctl on Fedora.
ipmctl has a dependency on libsafec-devel, libndctl-devel and rubygem-asciidoctor. Steps to install these packages is provided below.
This procedure requires the following utilities
wget
git
cmake
gcc
gcc-c++
glibc
glibc-static
sudo dnf install wget git cmake gcc gcc-c++ glibc glibc-static
libsafec is available as a package in the EPEL repository (Extra Packages for Enterprise Linux).
Alternately, when compiling ipmctl from source code, use the -DSAFECLIB_SRC_DOWNLOAD_AND_STATIC_LINK=ON option to download safelibc source and build it as a static library with ipmctl. See the Build section below for more information.
Verify the libsafec package can be found
dnf info libsafec libsafec-devel
Example:
$ dnf info libsafec libsafec-devel​Available PackagesName : libsafecVersion : 3.3Release : 5.fc31Architecture : i686Size : 82 kSource : libsafec-3.3-5.fc31.src.rpmRepository : fedoraSummary : Safec fork with all C11 Annex K functionsURL : https://github.com/rurban/safeclibLicense : MITDescription : Safec fork with all C11 Annex K functions​Name : libsafec-develVersion : 3.3Release : 5.fc31Architecture : i686Size : 19 kSource : libsafec-3.3-5.fc31.src.rpmRepository : fedoraSummary : Development packages for libsafecURL : https://github.com/rurban/safeclibLicense : MITDescription : Development files for libsafec
Install the libsafec and libsafec-devel packages
sudo dnf install libsafec libsafec-devel
The development files can be installed from source code or packages. See 'Installing NDCTL & DAXCTL' in the ndctl user guide for detailed instructions.
To install the package:
sudo dnf install ndctl-devel
The rubygem-asciidoctor package can be found in the EPEL (Extra Package for Enterprise Linux) repository.
Install the rubygem-asciidoctor and optional rubygem-asciidoctor-pdf packages
sudo dnf install rubygem-asciidoctor rubygem-asciidoctor-pdf
Create a temporary build area
mkdir ~/downloadscd ~/downloads
Clone the ipmctl GitHub repository
git clone https://github.com/intel/ipmctlcd ipmctl
Optional: To build a different release version, use git to checkout the version branch, eg:
List all available branches using the following. It shows a master_1_0 and master_2_0 for version 1.x and 2.x respectively. This represents the current version for each release.
$ # git branch -a | grep master* masterremotes/origin/HEAD -> origin/masterremotes/origin/masterremotes/origin/master_1_0remotes/origin/master_2_0
Example: Checkout the version 1.x branch and continue the build process:
$ git checkout remotes/origin/master_1_0Switched to a new branch 'remotes/origin/master_1_0'
To build a specific version, list the tags:
$ git tag[...]v01.00.00.3481v01.00.00.3494v01.00.00.3497[...]v02.00.00.3781v02.00.00.3785v02.00.00.3791
Create a new branch from a specific tagged version, use the following and continue with the build process:
$ git checkout tags/v02.00.00.3791 -b v02.00.00.3791Switched to a new branch 'v02.00.00.3791'
If you installed the safelibc package, use:
mkdir output && cd outputcmake -DRELEASE=ON -DCMAKE_INSTALL_PREFIX=/ ..make -j all
To have ipmctl cmake download and statically build safelibc, use:
mkdir output && cd outputcmake -DRELEASE=ON -DSAFECLIB_SRC_DOWNLOAD_AND_STATIC_LINK=ON -DCMAKE_INSTALL_PREFIX=/ ..make -j all
Install ipmctl using:
sudo make install
This procedure provides the steps for building and installing ipmctl on RHEL, CENTOS, and RHEL for SAP HANA 7.5 and later.
ipmctl has a dependency on libsafec-devel, libndctl-devel and rubygem-asciidoctor. Steps to install these packages is provided below.
Several packages required by ipmctl are available in the EPEL (Extra Packages for Enterprise Linux). The epel repository must be installed and enabled.
Verify the EPEL repository is available and enabled:
yum repolist
Example:
$ yum repolistrepo id repo name statusepel/x86_64 Extra Packages for Enterprise Linux 7 - x86_64 13,220
If the EPEL repository is not listed, install and enable it using:
sudo yum install epel-release
sudo yum config-manager --set-enabled PowerTools
This procedure requires the following utilities
wget
git
cmake
gcc
gcc-c++
glibc
glibc-static
sudo yum install wget git cmake gcc gcc-c++ glibc glibc-static
libsafec is available as a package in the EPEL repository (Extra Packages for Enterprise Linux).
Alternately, when compiling ipmctl from source code, use the -DSAFECLIB_SRC_DOWNLOAD_AND_STATIC_LINK=ON option to download safelibc source and build it as a static library with ipmctl. See the Build section below for more information.
Verify the libsafec package can be found
yum info libsafec libsafec-devel
Example:
$ yum info libsafec*​Available PackagesName : libsafecArch : x86_64Version : 3.3Release : 5.el7Size : 69 kRepo : epel/x86_64Summary : Safec fork with all C11 Annex K functionsURL : https://github.com/rurban/safeclibLicense : MITDescription : Safec fork with all C11 Annex K functions​Name : libsafec-develArch : x86_64Version : 3.3Release : 5.el7Size : 74 kRepo : installedFrom repo : epelSummary : Development packages for libsafecURL : https://github.com/rurban/safeclibLicense : MITDescription : Development files for libsafec
Install the libsafec and libsafec-devel packages
sudo yum install libsafec libsafec-devel
The development files can be installed from source code or packages. See 'Installing NDCTL & DAXCTL' in the ndctl user guide for detailed instructions.
To install the package:
sudo yum install ndctl-devel
The rubygem-asciidoctor package can be found in the EPEL (Extra Package for Enterprise Linux) repository.
Install the rubygem-asciidoctor package
sudo yum install rubygem-asciidoctor
[Optional] PDF documents can be built if asciidoctor-pdf is installed. This is completely optional. Warnings during the cmake make occur but can be ignored. Asciidoctor-pdf is installed using the gem utility. Asciidoctor-pdf requires Ruby 2.1 or later. CentOS 7 provides Ruby 2.0. See How to Install Ruby on CentOS/RHEL 7/6 for instructions to install a current Ruby version.
With Ruby >2.1 installed, install asciidoctor-pdf
sudo gem install asciidoctor-pdf
Create a temporary build area
mkdir ~/downloadscd ~/downloads
Clone the ipmctl GitHub repository
git clone https://github.com/intel/ipmctlcd ipmctl
Optional: To build a different release version, use git to checkout the version branch, eg:
List all available branches using the following. It shows a master_1_0 and master_2_0 for version 1.x and 2.x respectively. This represents the current version for each release.
$ # git branch -a | grep master* masterremotes/origin/HEAD -> origin/masterremotes/origin/masterremotes/origin/master_1_0remotes/origin/master_2_0
Example: Checkout the version 1.x branch and continue the build process:
$ git checkout remotes/origin/master_1_0Switched to a new branch 'remotes/origin/master_1_0'
To build a specific version, list the tags:
$ git tag[...]v01.00.00.3481v01.00.00.3494v01.00.00.3497[...]v02.00.00.3781v02.00.00.3785v02.00.00.3791
Create a new branch from a specific tagged version, use the following and continue with the build process:
$ git checkout tags/v02.00.00.3791 -b v02.00.00.3791Switched to a new branch 'v02.00.00.3791'
If you installed the safelibc package, use:
mkdir output && cd outputcmake -DRELEASE=ON -DCMAKE_INSTALL_PREFIX=/ ..make -j all
To have ipmctl cmake download and statically build safelibc, use:
mkdir output && cd outputcmake -DRELEASE=ON -DSAFECLIB_SRC_DOWNLOAD_AND_STATIC_LINK=ON -DCMAKE_INSTALL_PREFIX=/ ..make -j all
Install ipmctl using:
sudo make install
This procedure provides the steps for building and installing ipmctl on Ubuntu.
ipmctl has a dependency on libsafec-devel, libndctl-devel and ruby-asciidoctor. Steps to install these packages is provided below.
This procedure requires the following utilities
wget
git
cmake
pkg-config
autoconf
doxygen
libtool
gcc
gcc-c++
glibc
sudo apt updatesudo apt install wget git cmake pkg-config autoconf doxygen libtool build-essential
libsafec is available as a package in the default package repository for Ubuntu 19.10 (Eoan) or later. For earlier releases, use the -DSAFECLIB_SRC_DOWNLOAD_AND_STATIC_LINK=ON option to download safelibc source and build it as a static library with ipmctl. See the Build section below for more information.
Verify the libsafec package can be found
sudo apt info libsafec* libsafec-dev*
Install the libsafec and libsafec-devel packages
sudo apt install libsafec-3.5.3 libsafec-dev
​
The development files can be installed from source code or packages. See 'Installing NDCTL & DAXCTL' in the ndctl user guide for detailed instructions.
To install the package:
sudo apt install libndctl-dev
​
Ubuntu 16.04 & 18.04
Install asciidoctor using the ruby gems
sudo apt install rubysudo gem install asciidoctor asciidoctor-pdf --pre
Ubuntu 19.04 or later
The ruby-asciidoctor package can be found in the default package repository.
Install the ruby-asciidoctor and optional ruby-asciidoctor-pdf packages
sudo apt install ruby-asciidoctor ruby-asciidoctor-pdf
​
Create a temporary build area
mkdir ~/downloadscd ~/downloads
Clone the ipmctl GitHub repository
git clone https://github.com/intel/ipmctl
Optional: To build a different release version, use git to checkout the version branch, eg:
List all available branches using the following. It shows a master_1_0 and master_2_0 for version 1.x and 2.x respectively. This represents the current version for each release.
$ # git branch -a | grep master* masterremotes/origin/HEAD -> origin/masterremotes/origin/masterremotes/origin/master_1_0remotes/origin/master_2_0
Example: Checkout the version 1.x branch and continue the build process:
$ git checkout remotes/origin/master_1_0Switched to a new branch 'remotes/origin/master_1_0'
To build a specific version, list the tags:
$ git tag[...]v01.00.00.3481v01.00.00.3494v01.00.00.3497[...]v02.00.00.3781v02.00.00.3785v02.00.00.3791
Create a new branch from a specific tagged version, use the following and continue with the build process:
$ git checkout tags/v02.00.00.3791 -b v02.00.00.3791Switched to a new branch 'v02.00.00.3791'
If you installed the safelibc package, use:
mkdir output && cd outputcmake -DRELEASE=ON -DCMAKE_INSTALL_PREFIX=/ ..make -j all
To have ipmctl cmake download and statically build safelibc, use:
mkdir output && cd outputcmake -DRELEASE=ON -DSAFECLIB_SRC_DOWNLOAD_AND_STATIC_LINK=ON -DCMAKE_INSTALL_PREFIX=/ ..make -j all
​
Install ipmctl using:
sudo make install
​
​
Go to the Basic Usage section of this user guide for more information.
​
The following lists common issues and errors encountered during the cmake process and how to resolve them
You may see a warning during the cmake process referencing a missing asciidoctor-pdf binary.
-- Could NOT find asciidoctor-pdf (missing: ASCIIDOCTOR_PDF_BINARY)asciidoctor-pdf not found
PDF documents can be built if asciidoctor-pdf is installed. This is completely optional. Warnings during the cmake make occur but can be ignored. Asciidoctor-pdf is installed using the gem utility. Asciidoctor-pdf requires Ruby 2.1 or later. CentOS 7 provides Ruby 2.0. See How to Install Ruby on CentOS/RHEL 7/6 for instructions to install a later version of Ruby. With Ruby >2.1 installed, install asciidoctor-pdf:
sudo gem install asciidoctor-pdf
If asciidoctor is installed, ascidoc is not required. This message can be safely ignored.---
​
The a2x binary is delivered with the asciidoc package. a2x converts Asciidoc text file to PDF, XHTML, HTML Help, manpage or plain text. If the asciidoc package is not installed, this message can be safely ignored. Asciidoctor will be used instead to build the documentation.
Example:
-- package 'safec-3.3>=03032018.0-g570fa5' not foundCMake Error at /usr/share/cmake/Modules/FindPkgConfig.cmake:279 (message):A required package was not foundCall Stack (most recent call first):/usr/share/cmake/Modules/FindPkgConfig.cmake:333 (_pkg_check_modules_internal)CMakeLists.txt:87 (pkg_check_modules)
You should not encounter this message when using the -DSAFECLIB_SRC_DOWNLOAD_AND_STATIC_LINK=ON cmake option.
The issue can occur if the libsafec and libsafec-devel packages are not installed. See the 'Prerequisites' section at the top of this page.
If you installed the libsafec package from a repository other than EPEL, remove and re-install the libsafec package using the epel repository. Follow the instructions in the 'libsafec' section above.
If you built and installed libsafec from source code, the error is caused by a missing pkgconfig (pc) file. Update your LD_LIBRARY_PATH and PKG_CONFIG_PATH to include the path you installed libsafec to. For example, the following adds the common install locaitons to your shell environment. You will need to add these to your shell environment file (eg: ~/.bashrc) for them to become permanent.
export LD_LIBRARY_PATH=/usr/lib:/usr/lib64:/usr/local/lib:/usr/local/lib64:${LD_LIBRARY_PATH}export PKG_CONFIG_PATH=/usr/lib64/pkgconfig:/usr/lib/pkgconfig:usr/local/lib64/pkgconfig:/usr/local/lib/pkgconfig:/usr/share/pkgconfig:${PKG_CONFIG_PATH}
Alternatively, add -DSAFECLIB_SRC_DOWNLOAD_AND_STATIC_LINK=ONto the cmake file to download and build the static version of libsafec.
​
