Skip to content

Latest commit

 

History

History
197 lines (126 loc) · 4.83 KB

README.rst

File metadata and controls

197 lines (126 loc) · 4.83 KB
Raw

Tendrl Node Agent

Tendrl node agent resides on every node managed by tendlr. It is responsible for operating system level operations such as hardware inventory, service management, process monitoring etc. The node agent also serves as the provisioning controller and can invoke provisioning operations on the node.

Build status Coverage

Features

  • Provide Node hardware inventory (cpu, memory, processes etc) details in central store.
  • Implements operations Ceph/Gluster cluster import .

Installation from Source on CentOS 7

Important

Node agent needs to be installed on every node of the storage cluster that is to be managed by tendrl.

Note

All the commands are run as a regular user that has sudo privileges. The commands are all assumed to be run from a single directory, which by default could be the user’s home directory. If different, the required current directory is indicated in [] before the shell prompt $.

Deployment Requirements

  1. Ensure that etcd is running on a node in the network and is reachable from the node you’re about to install the node agent on. Note it’s address and port.

System Setup

  1. Install the build toolchain and other development packages.

    $ sudo yum groupinstall 'Development Tools'
$ sudo yum install libffi-devel openssl-devel

  2. Install virtualenvwrapper.

    $ sudo yum install epel-release
$ sudo yum install python-virtualenv python-virtualenvwrapper python-devel pip

  3. Create system directories.

    $ sudo mkdir -p /etc/tendrl/node-agent \
  /etc/tendrl/{ceph,gluster}-integration \
  /var/log/tendrl/node-agent \
  /var/log/tendrl/{ceph,gluster}-integration

Environment Setup

  1. Configure virtualenvwrapper.

    Setup the shell startup files based on the virtualenvwrapper documentation at: https://virtualenvwrapper.readthedocs.io/en/latest/install.html#shell-startup-file

    Be sure to adjust the value of source to the output of:

    $ which virtualenvwrapper.sh # Should be /usr/bin/virtualenvwrapper.sh

  2. Create and load the virtual environment for the node agent.

    $ mkvirtualenv tendrl-node-agent
$ workon tendrl-node-agent

Install Tendrl commons and node_agent

  1. Install the commons library.

    $ git clone https://github.com/Tendrl/commons.git commons
$ pushd commons
[commons] $ workon tendrl-node-agent
[commons] $ pip install .
[commons] $ popd

  2. Install the node agent.

    $ git clone https://github.com/Tendrl/node-agent.git
$ pushd node-agent
[node-agent] $ workon tendrl-node-agent
[node-agent] $ pip install .
[node-agent] $ popd

Configuration

  1. Create the tendrl configuration file /etc/tendrl/node-agent/node-agent.conf.yaml.

    $ cp node-agent/etc/tendrl/node-agent/node-agent-dev.conf.yaml /etc/tendrl/node-agent/node-agent.conf.yaml
    • Configure the following etcd_port and etcd_connection directives in /etc/tendrl/node-agent/node-agent.conf.yaml to point to the etcd instance discussed in the first step.

  2. Install the node agent logging configuration file /etc/tendrl/node-agent_logging.yaml.

    $ cp node-agent/etc/tendrl/node-agent/logging.yaml.syslog.sample \
  /etc/tendrl/node-agent/node-agent_logging.yaml

    Note

    There are other sample configuration files in the node-agent/etc directory which could be used to setup logging for different system configuration such as via syslog and journald.

Run

$ workon tendrl-node-agent
$ tendrl-node-agent

Release process

When you are ready to cut a new version:

  1. Bump the version number in tendrl/node_agent/__init__.py and commit your changes.

    python setup.py bumpversion

  2. Tag and push to GitHub.

    python setup.py release

  3. Make an SRPM.

    make srpm

  4. Build SRPM in Copr.

Developer documentation

There’s additional sphinx documentation in docs/source. To build it, run:

$ python setup.py build_sphinx