9.1. Choosing a Release
9.1.1. Install only the latest release
Keep a single PMIx installation - the latest release - on each system. You do not need older releases alongside it.
PMIx is forward compatible. Every public API, macro, structure, and attribute is kept forever. A program built against an earlier PMIx release therefore builds and runs against a later one without change. Applications, libraries, and tools do not need to be rebuilt when you upgrade PMIx. (Two past exceptions, affecting programs built against PMIx v5.0, are listed in Version Numbers and Binary Compatibility.)
Fixes, including security fixes, are made only to the current release series (see OpenPMIx Security Policy). Staying on the latest release is how a system receives them.
9.1.2. The exception: host environments
A host environment - the resource manager or launcher that runs the PMIx server - must be built against the PMIx release it runs with. When you upgrade PMIx, rebuild the host environment, or install its vendor’s build for the new release.
The reason: a host gives the PMIx server library a table of functions
(its pmix_server_module_t) by passing a pointer to it. The table
grows as PMIx adds operations, and the library cannot tell from a
pointer which version of the table it was given. It assumes the table
matches its own. See What a Host Must Do.
PRRTE is a host environment, and is tied more closely still: see PMIx and PRRTE Releases.
9.1.3. Mixing versions at run time
Clients and servers of different PMIx releases work together:
a server accepts clients and tools from PMIx v2.1 on, when it is set up to take them (below);
a client or tool connects to servers from PMIx v3.2 on when PMIx was configured
--enable-legacy-servers. By default it connects only to servers of v7.0 or later, and refuses an earlier one with a message naming its release.
This matters most for containers, which carry their own copy of the PMIx client library.
A server takes clients and tools of releases before v7.0 only when both of these hold:
PMIx was configured with
--enable-legacy-clients. It is off by default.The server is told to take them: the
ptl_base_legacy_clientsMCA parameter set totruewhere the host environment’s servers read it (a parameter file, or their environment), or the host’sPMIX_SERVER_LEGACY_PEERSattribute.
Without them, such a client does not connect. It runs as a singleton - a process on its own, unaware of the rest of its job - after printing one error line. An application in a container built with an older PMIx release behaves this way under a default v7 server. Either set the server up to take earlier releases, or update the PMIx library in the container.
Configure --enable-legacy-servers wherever applications may carry
a PMIx v7 client library to a system whose resource manager runs an
earlier release - in a container image, for example. Without it, the
default, such an application’s PMIx_Init fails there. With neither
legacy option - the default - the library leaves out the TCP transport
and the wire formats of earlier releases altogether.
See Version Numbers and Binary Compatibility and Controlling Authentication.