Container Service Plugin

Container Service Compatibility Matrix

The original version of the Container Service plugin was made available and was compatible with XNAT 1.7.3. Since then, several breaking changes have been introduced that affect which versions of Container Service can be run on which versions of XNAT. There are also supporting utilities such as the Batch Launch Plugin that introduce their own version compatibility issues. Please reference this page whenever working through an upgrade process. 

For legacy versions of XNAT and the Container Service plugin, see Legacy Version Compatibility Matrix

Container Service Compatibility with XNAT

Note that compatible versions of the Batch Launch Plugin (BLP) have been indicated along with the XNAT version.

CS Version /
XNAT Version

3.0

3.1.x

3.2.x

3.3.x – 3.4.x

3.5.0

3.6.x

3.7.x

3.8.x

XNAT 1.8.0 – 1.8.2
(opt: BLP 0.4.0)

check mark








XNAT 1.8.3 – 1.8.4
(opt: BLP 0.5.0)


check mark







XNAT 1.8.5.x
(opt: BLP 0.6.0)



check mark






XNAT 1.8.6.x

(opt: BLP 0.6.0)




check mark





XNAT 1.8.7.x

(opt: BLP 0.6.0)




check mark





XNAT 1.8.8.x

(opt: BLP 0.6.0)




check mark





XNAT 1.8.9.x

(opt: BLP 0.6.0)




check mark





XNAT 1.8.10.x

(opt BLP 0.6.0)




check mark

check mark




XNAT 1.9.x

(opt BLP 0.7.0)






check mark




XNAT 1.9.2
(opt BLP 0.8.x – 0.9.x)







check mark

check mark

XNAT 1.9.3.x
(opt BLP 0.9.0)







check mark

check mark

XNAT 1.10.0
(opt BLP 0.9.0)








check mark

Container Service Internal Feature Compatibility

New versions of the Container Service have introduced new features. For instance, we have added new supported compute backends. But we also introduced new features internally to the Container Service, and not all the internal features work on all the supported backends.

Legend:

🐳 - Docker Standalone

🐝 - Docker Swarm

☸️ - Kubernetes


Backend Features

3.0

3.1.x

3.2.x – 3.6.x

3.7.x

3.8.x

Compute Backend

🐳 🐝

🐳 🐝

🐳 🐝 ☸️

🐳 🐝 ☸️

🐳 🐝 ☸️

Bulk / Batch Launch*

🐳 🐝

🐳 🐝

🐳 🐝 ☸️

🐳 🐝 ☸️

🐳 🐝 ☸️

Event Service Action Provider

🐳 🐝

🐳 🐝

🐳 🐝 ☸️

🐳 🐝 ☸️

🐳 🐝 ☸️

Container Orchestration


🐳 🐝

🐳 🐝 ☸️

🐳 🐝 ☸️

🐳 🐝 ☸️

Private Image / Private Registry Credentials

🐳

🐳

🐳 🐝

🐳 🐝

🐳 🐝

Set limits on concurrent container finalization


🐝

🐝

🐝

🐝

Scheduling Constraints

🐝

🐝

🐝 ☸️ **

🐝 ☸️ **

🐝 ☸️ **

Scheduling Taints and Tolerations





☸️

Private / Protected / Public Container Accessibility




🐳 🐝 ☸️

🐳 🐝 ☸️

Container Manager User Role




🐳 🐝 ☸️

🐳 🐝 ☸️

*Container Service 3.x uses the Batch Launch Plugin to extend multi-container-launch functionality.

**Docker Swarm constraints are supported on several node and engine properties; Kubernetes constraints are supported on node labels only.


Command Feature Compatibility

New versions of the Container Service have introduced new capabilities that XNAT-enabled command definitions can take advantage of. There are no breaking changes that cause issues with old command definitions being run on new versions of the Container Service, but if your command design requires certain features to execute properly, consult this table for version-specific notes.

Command Features

3.0-3.1.0

3.1.1-3.2

3.3-3.6.x

3.7.x-3.8.x

Setup Commands

check mark

check mark

check mark

check mark

Wrap-up Commands

check mark

check mark

check mark

check mark

Assessor Output Handler

check mark

check mark

check mark

check mark

Container name

check mark

check mark

check mark

check mark

Container labels

check mark

check mark

check mark

check mark

Generic Resources

check mark

check mark

check mark

check mark

Runtime

check mark

check mark

check mark

check mark

IPC Mode

check mark

check mark

check mark

check mark

Ulimits

check mark

check mark

check mark

check mark

Subject Assessor Inputs


check mark

check mark

check mark

Command Secrets



check mark

check mark

Command Metadata




check mark