Python client/server for managing a pool of Bare Metal machines.
Go to file
Mark Hamzy 93f275a7a6 Fix up the tables and one example
Change-Id: Icda00a84c8c10f24615616fedcb63c96c1e10be1
2016-10-28 10:18:09 -05:00
doc/source Add files that were created running Python's cookiecutter program 2016-10-27 10:18:47 -05:00
molteniron Even more pep8 fixes that the gate is catching 2016-10-27 12:08:57 -05:00
releasenotes Add files that were created running Python's cookiecutter program 2016-10-27 10:18:47 -05:00
utils Add Continuous Integration (CI) example 2016-10-13 10:28:40 -05:00
.gitreview Add .gitreview file 2016-10-21 13:28:39 +00:00
CONTRIBUTING.rst Add files that were created running Python's cookiecutter program 2016-10-27 10:18:47 -05:00
HACKING.rst Add files that were created running Python's cookiecutter program 2016-10-27 10:18:47 -05:00
LICENSE Add files that were created running Python's cookiecutter program 2016-10-27 10:18:47 -05:00
MANIFEST.in Add files that were created running Python's cookiecutter program 2016-10-27 10:18:47 -05:00
README.rst Fix up the tables and one example 2016-10-28 10:18:09 -05:00
babel.cfg Add files that were created running Python's cookiecutter program 2016-10-27 10:18:47 -05:00
conf.yaml Add files that were created running Python's cookiecutter program 2016-10-27 10:18:47 -05:00
createDB.py Support both Python 2.x and Python 3.x 2016-10-27 10:45:29 -05:00
requirements.txt Add files that were created running Python's cookiecutter program 2016-10-27 10:18:47 -05:00
setup.cfg Add files that were created running Python's cookiecutter program 2016-10-27 10:18:47 -05:00
setup.py Add files that were created running Python's cookiecutter program 2016-10-27 10:18:47 -05:00
test-requirements.txt Add files that were created running Python's cookiecutter program 2016-10-27 10:18:47 -05:00
tox.ini Enable testcases 2016-10-28 07:44:13 -05:00

README.rst

MoltenIron overview

MoltenIron maintains a pool of bare metal nodes.

Starting

Before starting the server for the first time, the createDB.py script must be run.

To start the server:

moltenirond-helper start

To stop the server:

moltenirond-helper stop

MoltenIron client

Use the molteniron client (molteniron) to communicate with the server. For usage information type:

molteniron -h

For usage of a specific command use:

molteniron [command] -h

MoltenIron commands

command description
add Add a node
allocate Allocate a node
release Release a node
get_field Get a specific field in a node
set_field Set a specific field with a value in a node
status Return the status of every node
delete_db Delete every database entry

Configuration of MoltenIron

Configuration of MoltenIron is specified in the file conf.yaml.

"B)" means that this configuration option is required for both the client and the server. "C)" means that it is required only for the client. "S)" means it is only required for the server.

usage key description
B) mi_port the port that the server uses to respond to commands.
C) serverIP The IP address of the server. This is only used by clients.
S) maxTime The maximum amount of time, in seconds, that a node is allowed to be allocated to a particular BM node.
S) logdir The path to the directory where the logs should be stored.
S) maxLogDays The amount of time, in days, to keep old logs.
S) sqlUser The username to use for the MI server. This user will automatically be generated when createDB.py is run.
S) sqlPass The password of sqlUser

Running testcases

The suite of testcases is checked by tox. But, before you can run tox, you need to change the local yaml configuration file to point to the log directory. An example:

(LOG=$(pwd)/testenv/log; sed -i -r -e 's,^(logdir: )(.*)$,\1'${LOG}',' conf.yaml; rm -rf testenv/; tox -e testenv)

Running inside a Continuous Integration environment

During the creation of a job, in the pre_test_hook.sh, add the following snippet of bash code:

# Setup MoltenIron and all necessary prerequisites.
# And then call the MI script to allocate a node.
(
  REPO_DIR=/opt/stack/new/third-party-ci-tools
  MI_CONF_DIR=/usr/local/etc/molteniron/
  MI_IP=10.1.2.3 # @TODO - Replace with your IP addr here!

  # Grab molteniron and install it
  git clone https://git.openstack.org/openstack/third-party-ci-tools ${REPO_DIR} || exit 1

  cd ${REPO_DIR}/nodepool/molteniron

  # @BUG Install prerequisite before running pip to install the requisites
  hash mysql_config || sudo apt install -y libmysqlclient-dev

  # Install the requisites for this package
  sudo pip install --upgrade --force-reinstall --requirement requirements.txt

  # Run the python package installation program
  sudo python setup.py install

  if [ -n "${MI_IP}" ]
  then
    # Set the molteniron server IP in the conf file
    sudo sed -i "s/127.0.0.1/${MI_IP}/g" ${MI_CONF_DIR}/conf.yaml
  fi

  export dsvm_uuid
  # NOTE: dsvm_uuid used in the following script, hence the -E
  sudo -E ${REPO_DIR}/nodepool/molteniron/utils/test_hook_configure_mi.sh
) || exit $?

and change the MI_IP environment variable to be your MoltenIron server!

During the destruction of a job, in the post_test_hook.sh, add the following snippet of bash code:

DSVM_UUID="$(</etc/nodepool/uuid)"
echo "Cleaning up resources associated with node: ${DSVM_UUID}"
molteniron release ${DSVM_UUID}