Skip to content
GitLab

Admin guide · Changes

Page history
Wiki EAR4.3 authored by Oriol Vidal's avatar Oriol Vidal
Hide whitespace changes
Inline Side-by-side
Admin-guide.md
View page @ 7ff3e622
[[_TOC_]] [[_TOC_]]
# EAR Components ## EAR Components
EAR is composed of five main components: EAR is composed of five main components:
- **Node Manager (EARD)**. The Node Manager must have root access to the node where it will be running. - **Node Manager (EARD)**. The Node Manager must have root access to the node where it will be running.
- **Database Manager (EARDBD)**. The database manager requires access to the DB server (we support MariaDB and Postgress). Documentation for Postgress is still under development. - **Database Manager (EARDBD)**. The database manager requires access to the DB server (we support MariaDB and Postgress). Documentation for Postgress is still under development.
...@@ -17,11 +17,11 @@ The following image shows the main interactions between components: ...@@ -17,11 +17,11 @@ The following image shows the main interactions between components:
For a more detailed information about EAR components, visit the [Architecture](Architecture) page. For a more detailed information about EAR components, visit the [Architecture](Architecture) page.
# Quick Installation Guide ## Quick Installation Guide
This section provides a, summed up, step by step installation and execution guide for EAR. For a more in depth explanation of the necessary steps see the [Installation from source](Installation from source) page or the [Installing from RPM](#installing-from-rpm) section, following the [Configuration](Configuration) guide, or contact us at ear-support@bsc.es This section provides a, summed up, step by step installation and execution guide for EAR. For a more in depth explanation of the necessary steps see the [Installation from source](Installation from source) page or the [Installing from RPM](#installing-from-rpm) section, following the [Configuration](Configuration) guide, or contact us at ear-support@bsc.es
## EAR Requirements ### EAR Requirements
Requirements to compile EAR are: Requirements to compile EAR are:
- C compiler. - C compiler.
...@@ -43,14 +43,15 @@ Lastly, but not less important: ...@@ -43,14 +43,15 @@ Lastly, but not less important:
Run `./configure --help` to see all the flags and options. Run `./configure --help` to see all the flags and options.
## Compiling and installing EAR ### Compiling and installing EAR
Once downloaded the code from repository, execute: Once downloaded the code from repository, execute:
- `autoreconf -i`. - `autoreconf -i`.
``` ```
./configure --prefix=ear-install-path \ ./configure --prefix=ear-install-path \
EAR_TMP=ear-tmp-path \EAR_ETC=ear-etc-path \ EAR_TMP=ear-tmp-path \
EAR_ETC=ear-etc-path \
CC=c-compiler-path \ CC=c-compiler-path \
MPICC=mpi-compiler-path \ MPICC=mpi-compiler-path \
CC_FLAGS=c-flags-compiler \ CC_FLAGS=c-flags-compiler \
...@@ -90,9 +91,9 @@ commands and tools, the sbin includes EAR services, the lib includes all the ...@@ -90,9 +91,9 @@ commands and tools, the sbin includes EAR services, the lib includes all the
libraries and plugins, and etc includes templates and examples for EAR service libraries and plugins, and etc includes templates and examples for EAR service
files, ear.conf file, the EAR module, etc. files, ear.conf file, the EAR module, etc.
## Deployment and validation ### Deployment and validation
### Monitoring: Compute node and DB #### Monitoring: Compute node and DB
**Prepare the configuration** **Prepare the configuration**
...@@ -151,7 +152,7 @@ In case there are problems when running econtrol, you can also find this file at ...@@ -151,7 +152,7 @@ In case there are problems when running econtrol, you can also find this file at
Check that EARDs are reporting metrics to database with ereport. `ereport -n all` Check that EARDs are reporting metrics to database with ereport. `ereport -n all`
should report the total energy sent by each daemon since the setup. should report the total energy sent by each daemon since the setup.
### Monitoring: EAR plugin #### Monitoring: EAR plugin
- Set up EAR's SLURM plugin (see the [configuration](Configuration) section for - Set up EAR's SLURM plugin (see the [configuration](Configuration) section for
more information). more information).
...@@ -226,7 +227,7 @@ For the coefficients to be active, restart daemons. ...@@ -226,7 +227,7 @@ For the coefficients to be active, restart daemons.
> **Important** Reloading daemons will NOT make them load coefficients, restarting the service is the only way. > **Important** Reloading daemons will NOT make them load coefficients, restarting the service is the only way.
## EAR Library versions: MPI vs. Non-MPI ### EAR Library versions: MPI vs. Non-MPI
As commented in the overview, the EAR Library is loaded next to the user MPI As commented in the overview, the EAR Library is loaded next to the user MPI
application by the EAR Loader. application by the EAR Loader.
...@@ -275,7 +276,7 @@ If your MPI version is not fully compatible, please contact ear-support@bsc.es. ...@@ -275,7 +276,7 @@ If your MPI version is not fully compatible, please contact ear-support@bsc.es.
See the [User guide](User guide) to check the use cases supported and how to submit jobs with EAR. See the [User guide](User guide) to check the use cases supported and how to submit jobs with EAR.
# Installing from RPM ## Installing from RPM
EAR includes the specification files to create an rpm from an already existing EAR includes the specification files to create an rpm from an already existing
installation. installation.
...@@ -298,7 +299,7 @@ Once you have the rpm file, execute the following steps: ...@@ -298,7 +299,7 @@ Once you have the rpm file, execute the following steps:
for more information. for more information.
- Type `rpm -e ear.version` to uninstall. - Type `rpm -e ear.version` to uninstall.
## Installation content ### Installation content
The `*.in` configuration files are compiled into `etc/ear/ear.conf.template` The `*.in` configuration files are compiled into `etc/ear/ear.conf.template`
and `etc/ear/ear.full.conf.template`, `etc/module/ear`, `etc/slurm/ear.plugstack.conf` and `etc/ear/ear.full.conf.template`, `etc/module/ear`, `etc/slurm/ear.plugstack.conf`
...@@ -320,7 +321,7 @@ Below table describes the complet heriarchy of the EAR installation: ...@@ -320,7 +321,7 @@ Below table describes the complet heriarchy of the EAR installation:
| `/etc/slurm` | EAR SLURM plugin configuration file. | | `/etc/slurm` | EAR SLURM plugin configuration file. |
| `/etc/systemd` | EAR service files. | | `/etc/systemd` | EAR service files. |
# Updating EAR with a new installation ## Updating EAR with a new installation
In some cases, it might be a good idea to create a new install instead of updating your current one, like trying new configurations or when a big update is released. In some cases, it might be a good idea to create a new install instead of updating your current one, like trying new configurations or when a big update is released.
...@@ -333,6 +334,6 @@ The steps to do so are: ...@@ -333,6 +334,6 @@ The steps to do so are:
Once all that is done, one should have two complete EAR installs that can be switched by changing the binaries that are executed by the services and changing the path in ```plugstag.conf```. Once all that is done, one should have two complete EAR installs that can be switched by changing the binaries that are executed by the services and changing the path in ```plugstag.conf```.
# Next steps ## Next steps
For a better overview of the installation process, return to the [installation guide](#quick-installation-guide). For a better overview of the installation process, return to the [installation guide](#quick-installation-guide).
To continue the installation, visit the [configuration page](Configuration) to set up properly the EAR configuration file and the EAR SLURM plugin stack file. To continue the installation, visit the [configuration page](Configuration) to set up properly the EAR configuration file and the EAR SLURM plugin stack file.
\ No newline at end of file