ovishpc/ldms-maestro repository overview

⁠LDMS Maestro Docker Image

This docker image contains maestro, a program for configuring a cluster of ldmsd.

⁠References

• LDMS source code: https://github.com/ovis-hpc/ovis⁠
• Maestro source code: https://github.com/ovis-hpc/maestro⁠
• LDMS Docker Images source code: https://github.com/ovis-hpc/ldms-containers⁠

⁠SYNOPSIS

$ docker run -d --name=<CONTAINER_NAME> --network=host --privileged
         [ -v /run/munge:/run/munge:ro ] # expose host's munge to the container
         [ -v /on-host/munge.key:/etc/munge/munge.key:ro ] # use container's munged with custom key
         -v /on-host/ldms_cfg.yaml:/etc/ldms_cfg.yaml:ro # bind ldms_cfg.yaml, used by maestro_ctrl
         ovishpc/ldms-maestro # the image name

⁠DESCRIPTION

ovishpc/ldms-maestro containers will run at the least two daemons: etcd and maestro. It may also run munged if host's munge is not used (i.e. -v /run/munge:/run/munge:ro is not given to docker run). The entrypoint script does the following:

1. starts etcd
2. starts munged if host's munge is not used.
3. execute maestro_ctrl with --ldms_config /etc/ldms_cfg.yaml. Notice that the ldms_cfg.yaml file is given by the user by the -v option.
4. execute maestro process. maestro will periodically connect to all ldmsd specified by ldms_cfg.yaml and send the corresponding configuration.

REMARK: For now, the etcd and maestro processes in the ovishpc/ldms-maestro container run as stand-alone processes. We will support a cluster of ovishpc/ldms-maestro containers in the future.

⁠EXAMPLES

## On a service node

# Pull the container image
$ docker pull ovishpc/ldms-maestro

# Start maestro container, using host network namespace, and using host's munge
$ docker run -d --network=host --privileged \
         -v /run/munge:/run/munge:ro \
         -v /my/ldms_cfg.yaml:/etc/ldms_cfg.yaml:rw \
         ovishpc/ldms-maestro

Please see ldms_cfg.yaml⁠ for an example.