{ "info": { "author": "Dan Leehr", "author_email": "dan.leehr@duke.edu", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Topic :: Scientific/Engineering :: Bio-Informatics", "Topic :: System :: Distributed Computing" ], "description": "# Calrissian\n\nCWL on Kubernetes\n\n[![CircleCI](https://circleci.com/gh/Duke-GCB/calrissian.svg?style=svg)](https://circleci.com/gh/Duke-GCB/calrissian)\n\n## Overview\n\nCalrissian is a [CWL](https://www.commonwl.org) implementation designed to run inside a Kubernetes cluster. Its goal is to be highly efficient and scalable, taking advantage of high capacity clusters to run many steps in parallel.\n\n## Cluster Requirements\n\nCalrissian requires a [Kubernetes](https://kubernetes.io) or [Openshift](https://www.openshift.com)/[OKD](https://www.okd.io) cluster, configured to provision [PersistentVolumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) with the `ReadWriteMany` access mode. Kubernetes installers and cloud providers don't usually include this type of storage, so it may require additional configuration.\n\nCalrissian has been tested with NFS using the [nfs-client-provisioner](https://github.com/kubernetes-incubator/external-storage/tree/master/nfs-client) and with GlusterFS using [OKD Containerized GlusterFS](https://docs.okd.io/3.11/install_config/persistent_storage/persistent_storage_glusterfs.html). Many cloud providers have an NFS offering, which integrates easily using the nfs-client-provisioner.\n\n## Scalability / Resource Requirements\n\nCalrissian is designed to issue tasks in parallel if they are independent, and thanks to Kubernetes, should be able to run very large parallel workloads.\n\nWhen running `calrissian`, you must provide a limit the the number of CPU cores (`--max-cores`) and RAM megabytes (`--max-ram`) to use concurrently. Calrissian will use CWL [ResourceRequirements](https://www.commonwl.org/v1.0/CommandLineTool.html#ResourceRequirement) to track usage and stay within the limits provided. We highly recommend using accurate ResourceRequirements in your workloads, so that they can be scheduled efficiently and are less likely to be terminated or refused by the cluster.\n\n## CWL Conformance\n\nCalrissian leverages [cwltool](https://github.com/common-workflow-language/cwltool) heavily and most conformance tests for CWL v1.0. Please see [conformance](conformance) for further details and processes.\n\nTo view open issues related to conformance, see the [conformance](https://github.com/Duke-GCB/calrissian/issues?q=is%3Aopen+is%3Aissue+label%3Aconformance) label on the issue tracker.\n\n## Setup\n\nPlease see [examples](examples) for installation and setup instructions.\n\n## Environment Variables\n\nCalrissian's behaviors can be customized by setting the following environment variables in the container specification.\n\n### Pod lifecycle\n\nBy default, pods for a job step will be deleted after termination\n\n- `CALRISSIAN_DELETE_PODS`: Default `true`. If `false`, job step pods will not be deleted.\n\n### Kubernetes API retries\n\nWhen encountering a Kubernetes API exception, Calrissian uses a library to retry API calls with an exponential backoff. See the [tenacity documentation](https://tenacity.readthedocs.io/en/latest/index.html#waiting-before-retrying) for details.\n\n- `RETRY_MULTIPLIER`: Default `5`. Unit for multiplying the exponent interval.\n- `RETRY_MIN`: Default `5`. Minimum interval between retries.\n- `RETRY_MAX`: Default `1200`. Maximum interval between retries.\n- `RETRY_ATTEMPTS`: Default `10`. Max number of retries before giving up.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Duke-GCB/calrissian", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "calrissian", "package_url": "https://pypi.org/project/calrissian/", "platform": "", "project_url": "https://pypi.org/project/calrissian/", "project_urls": { "Homepage": "https://github.com/Duke-GCB/calrissian" }, "release_url": "https://pypi.org/project/calrissian/0.9.0/", "requires_dist": [ "urllib3 (<1.25,>=1.24.2)", "kubernetes (==10.0.1)", "cwltool (==1.0.20190621234233)", "tenacity (==5.1.1)" ], "requires_python": "", "summary": "CWL runner for Kubernetes", "version": "0.9.0" }, "last_serial": 5971679, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "e4171d1cb99a186e9cd56c1410db3cbb", "sha256": "68e8f4d05f400d7e6f23a2050e21935b92cfc3f3c845da344d756120e5c14bb2" }, "downloads": -1, "filename": "calrissian-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "e4171d1cb99a186e9cd56c1410db3cbb", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 14598, "upload_time": "2019-02-06T19:24:09", "url": "https://files.pythonhosted.org/packages/65/a3/a57d09b514810ac8c93d13a18c55563e31a346f2506432d81d63c6c591aa/calrissian-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3da8f04d5143d9011e12c2808c620382", "sha256": "1de52a2764dfcbfe02b7b5a9acc52e4f33748031f71a28a26e71490317eece3a" }, "downloads": -1, "filename": "calrissian-0.1.0-py3.6.egg", "has_sig": false, "md5_digest": "3da8f04d5143d9011e12c2808c620382", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 27907, "upload_time": "2019-02-06T19:24:11", "url": "https://files.pythonhosted.org/packages/a0/6b/2f53fc02c41c102e47ab41a7c0ee62cfe143da4c41b409f6f6fc207f123f/calrissian-0.1.0-py3.6.egg" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "c08006ad4e20fe066c1b66c678563c10", "sha256": "0ed923781f134e5d276db6eb095b94713fdc04bf6573cf9520fdfcb108473cd9" }, "downloads": -1, "filename": "calrissian-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c08006ad4e20fe066c1b66c678563c10", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 14635, "upload_time": "2019-02-07T02:48:07", "url": "https://files.pythonhosted.org/packages/8f/9c/4c77e82d7dd8aa30264cdc80a5ae93a07991dd960b3ddf62ae3ff9f38007/calrissian-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a46962e86020c26860c8e8a512b73170", "sha256": "2ed90c4e1cfdc4631541069974243e6559cf29b1421eeacf347fe7b5933310bf" }, "downloads": -1, "filename": "calrissian-0.1.1-py3.6.egg", "has_sig": false, "md5_digest": "a46962e86020c26860c8e8a512b73170", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 27854, "upload_time": "2019-02-07T02:48:08", "url": "https://files.pythonhosted.org/packages/ef/7d/6fa186aa825f4968c2d0aff27c4604e3598f47877a56cb536bdab194d4ac/calrissian-0.1.1-py3.6.egg" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "180dca33c7a788bdf4804bd6759820d2", "sha256": "f5da1a44e2dc0191aa8b10406ba1fc32a1dd1d169f4c447c074f6aa2afb4884d" }, "downloads": -1, "filename": "calrissian-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "180dca33c7a788bdf4804bd6759820d2", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15687, "upload_time": "2019-02-12T14:46:11", "url": "https://files.pythonhosted.org/packages/f4/43/4cf55a26da3df1e6f689afff2f83947080caf1c538da2dec582cf30ae7d4/calrissian-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cf7d533448734fbb6c032fc27d9ce1bc", "sha256": "982bca083e173c90330d1b524c72bf48b7366e7fa424d748f93befc15a92c181" }, "downloads": -1, "filename": "calrissian-0.2.0-py3.6.egg", "has_sig": false, "md5_digest": "cf7d533448734fbb6c032fc27d9ce1bc", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 30431, "upload_time": "2019-02-12T14:46:13", "url": "https://files.pythonhosted.org/packages/f3/ff/ce4616db48960efc401944b0446b13183046da124eb5b97ca44498e0c799/calrissian-0.2.0-py3.6.egg" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "6a09f6748a97ba37a2605f399a53a0ee", "sha256": "e5e168af1d90404506178d3e6dcf39607862362f41eaa031d62963f22911e2b6" }, "downloads": -1, "filename": "calrissian-0.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "6a09f6748a97ba37a2605f399a53a0ee", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16044, "upload_time": "2019-02-14T21:44:15", "url": "https://files.pythonhosted.org/packages/bf/f0/09c1a7affbcab4dd1c0647e68a15f23d2e1919e82aa97c7df8928be1d578/calrissian-0.2.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b33dbc0f4ab1f727bbf2bcfeff85aaf3", "sha256": "030707eb48fdd71d52b67d462585853b1aedcd1c3c8d2e07ced1198bdcb81dc8" }, "downloads": -1, "filename": "calrissian-0.2.1-py3.6.egg", "has_sig": false, "md5_digest": "b33dbc0f4ab1f727bbf2bcfeff85aaf3", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 31315, "upload_time": "2019-02-14T21:44:17", "url": "https://files.pythonhosted.org/packages/10/08/be4a09623720166924ea9e1992cddeb928d54710c06979e0c248abb6b7a8/calrissian-0.2.1-py3.6.egg" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "cd38de12ec63902f5c9841de468ad09d", "sha256": "c2fef1483774600991c1dbe68bbf7056181e048679b74fa0a71fd7a984082cc3" }, "downloads": -1, "filename": "calrissian-0.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "cd38de12ec63902f5c9841de468ad09d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 20030, "upload_time": "2019-03-04T21:02:02", "url": "https://files.pythonhosted.org/packages/16/3c/98163fd24c3d3f8cedd70a1dce064f5ee63a79b0bb679261113fdec6a328/calrissian-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "bad9328c81af5bab4d46ad3747fc0df5", "sha256": "7143da220e94f0124990a849acfdcb13d20d24278c86dc0770a463bc25957eb1" }, "downloads": -1, "filename": "calrissian-0.3.0-py3.6.egg", "has_sig": false, "md5_digest": "bad9328c81af5bab4d46ad3747fc0df5", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 41860, "upload_time": "2019-03-04T21:02:04", "url": "https://files.pythonhosted.org/packages/48/f3/ee6658bf0a7a13bf798a898f93978e16208f483cfb692996dfa8d6aa7051/calrissian-0.3.0-py3.6.egg" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "6bccd22a6ea16c9feb57628031fa85b7", "sha256": "b01ed8793d0ac559c479dfa99fb3c3f58f73d853bc5c819db497d1601c7c1c5d" }, "downloads": -1, "filename": "calrissian-0.3.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "6bccd22a6ea16c9feb57628031fa85b7", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 20015, "upload_time": "2019-03-08T15:56:09", "url": "https://files.pythonhosted.org/packages/81/1a/414893370e16fbbf4ebf34297affff9f7434f928689dbdde7b67bc1b28e7/calrissian-0.3.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "79d3acb308a56e378c4ab9000c177777", "sha256": "f5998739e6c145f0373704140e2370183ccc82caa14feda25024631b567a1a48" }, "downloads": -1, "filename": "calrissian-0.3.1-py3.6.egg", "has_sig": false, "md5_digest": "79d3acb308a56e378c4ab9000c177777", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 41839, "upload_time": "2019-03-08T15:56:10", "url": "https://files.pythonhosted.org/packages/ad/d9/4eef5aaed1defa68e3d96df7bf99c89acd467023bf26a387f6997663e778/calrissian-0.3.1-py3.6.egg" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "d1c23c8efdef439724b7f0b12cdd981e", "sha256": "e6db075c0dd3d41ff94229b9e4c7f393b427f9438668c85ece05c9eb274d194c" }, "downloads": -1, "filename": "calrissian-0.4.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d1c23c8efdef439724b7f0b12cdd981e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 20947, "upload_time": "2019-03-14T19:46:44", "url": "https://files.pythonhosted.org/packages/28/9e/0faf472fd7d47c7ef54be1b22344cbab19f23e0e6a1f99fe68c51dcae838/calrissian-0.4.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "56525ab2de89e4303c1841d5f5c77f44", "sha256": "2acc0b102921f30205bef0057187cf749baaaa94b7d198422a2981729f5c2710" }, "downloads": -1, "filename": "calrissian-0.4.0-py3.6.egg", "has_sig": false, "md5_digest": "56525ab2de89e4303c1841d5f5c77f44", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 43629, "upload_time": "2019-03-14T19:46:45", "url": "https://files.pythonhosted.org/packages/97/00/8a3a300dfe4cd44a06cc137dc5c354df5860ee22141b5250d90b0ba50088/calrissian-0.4.0-py3.6.egg" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "84cda83ba28847e9f0cfcafadfd8be51", "sha256": "0357c74026a070da66f4e3fde977818a811525c2ae7b849c3610dd609a5bea9b" }, "downloads": -1, "filename": "calrissian-0.5.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "84cda83ba28847e9f0cfcafadfd8be51", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 21789, "upload_time": "2019-03-20T17:49:47", "url": "https://files.pythonhosted.org/packages/f6/6a/cdfd1b5b60a5c00f0273b6b61c2f7fe7670b02130c1ccede92a84315e446/calrissian-0.5.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "046c79883fe26adcab700562ae1954f1", "sha256": "7b7fae9006925eb47941e08971c679166f541408725baf19afc28bcdd9f72a80" }, "downloads": -1, "filename": "calrissian-0.5.0-py3.6.egg", "has_sig": false, "md5_digest": "046c79883fe26adcab700562ae1954f1", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 45520, "upload_time": "2019-03-20T17:49:49", "url": "https://files.pythonhosted.org/packages/e7/90/e96cf6e9991ce489f5bee1e0268cecba77037cf6ec188bdc2df977e63fb4/calrissian-0.5.0-py3.6.egg" } ], "0.6.0": [ { "comment_text": "", "digests": { "md5": "0a4c37f9283616ae9daefa68b68f5469", "sha256": "f02b09417b6bc2307ebe0eda1ea4d704237e2d913ed1d912adfcde7f3ea73428" }, "downloads": -1, "filename": "calrissian-0.6.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "0a4c37f9283616ae9daefa68b68f5469", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 21934, "upload_time": "2019-07-22T19:30:55", "url": "https://files.pythonhosted.org/packages/1e/e6/9f99e9a4ca9d829f194baaae48a1e08a0e77a26ddacd73bd1d6226e60676/calrissian-0.6.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "75c641586dfb2bc5e52f69dbadb4c409", "sha256": "dfb57c93375783c104ea71964fe640b0092e78254a29e7a817737a403990aae0" }, "downloads": -1, "filename": "calrissian-0.6.0-py3.6.egg", "has_sig": false, "md5_digest": "75c641586dfb2bc5e52f69dbadb4c409", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 45871, "upload_time": "2019-07-22T19:30:56", "url": "https://files.pythonhosted.org/packages/d1/47/ea12dcc19c63e525bf712d0dce0be31c1ae5c4d8c840a670abdfc2ad2e9d/calrissian-0.6.0-py3.6.egg" } ], "0.7.0": [ { "comment_text": "", "digests": { "md5": "15d3e9f1f4396586b56beb5647cafde6", "sha256": "3652876bb4674aa9407687083263b8c1f0d3a5485ee05c390fdf6bf52856b7d6" }, "downloads": -1, "filename": "calrissian-0.7.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "15d3e9f1f4396586b56beb5647cafde6", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 22441, "upload_time": "2019-08-02T13:56:05", "url": "https://files.pythonhosted.org/packages/86/7c/17aad51f920aba1afb4566e6a94c39231e9bc717112d10db11ca61d1b028/calrissian-0.7.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "276eab48bf12dcb51a751b4361614625", "sha256": "caed5c2d1c2b8324fde141608fa77a0600b7e33993f63b619f80c9eefa2e6368" }, "downloads": -1, "filename": "calrissian-0.7.0-py3.6.egg", "has_sig": false, "md5_digest": "276eab48bf12dcb51a751b4361614625", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 46973, "upload_time": "2019-08-02T13:56:06", "url": "https://files.pythonhosted.org/packages/38/f2/2bde6d5a8b3ce30d91c31a28a00ed68147ab3bad5895933199da5b1078c9/calrissian-0.7.0-py3.6.egg" } ], "0.8.0": [ { "comment_text": "", "digests": { "md5": "d56eaf371d038b307419fab5b7e5a4f8", "sha256": "d589284c561dcd7336e741474dcb271fe8250c500e60ac0c63c611d99e9a93f5" }, "downloads": -1, "filename": "calrissian-0.8.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d56eaf371d038b307419fab5b7e5a4f8", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 27107, "upload_time": "2019-09-17T20:35:48", "url": "https://files.pythonhosted.org/packages/36/60/66f03c7539bf47d495b4b3c439a9008434f83fe0a14016c0a08f71267593/calrissian-0.8.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d8fea2f0dd4fd4b4db10e31bfda6312f", "sha256": "0a914b512b7c09daf00ef376d6df176ce0a96b22262effb4630bff579e4be955" }, "downloads": -1, "filename": "calrissian-0.8.0-py3.7.egg", "has_sig": false, "md5_digest": "d8fea2f0dd4fd4b4db10e31bfda6312f", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 57624, "upload_time": "2019-09-17T20:35:58", "url": "https://files.pythonhosted.org/packages/67/9b/f4f98a5f87d802321cc948b1fc8f22f98dd694ab0caa0f46f2985d8661e2/calrissian-0.8.0-py3.7.egg" } ], "0.9.0": [ { "comment_text": "", "digests": { "md5": "52fbbc6e10554d546113b969f519d7ed", "sha256": "4c84493f567df71e45c68646aab8e4f9358d4377e5af085bbe45dc0674d268aa" }, "downloads": -1, "filename": "calrissian-0.9.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "52fbbc6e10554d546113b969f519d7ed", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 28362, "upload_time": "2019-10-14T13:50:42", "url": "https://files.pythonhosted.org/packages/79/56/886cc5a8a382550b7957b28ee0a6fafbe7234fe500603b9f203c55a0cf98/calrissian-0.9.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ffc97d48b281416ae4c3a2d9037eedd4", "sha256": "aaf2e04c8e23e41eb143580f3807791af6073e495642aae6c41b1279130d9c09" }, "downloads": -1, "filename": "calrissian-0.9.0-py3.7.egg", "has_sig": false, "md5_digest": "ffc97d48b281416ae4c3a2d9037eedd4", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 59978, "upload_time": "2019-10-14T13:50:44", "url": "https://files.pythonhosted.org/packages/63/7c/7ba855592d50f88029fc026c08fbec2411e018a8c6cb012dd5f3672a4ea9/calrissian-0.9.0-py3.7.egg" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "52fbbc6e10554d546113b969f519d7ed", "sha256": "4c84493f567df71e45c68646aab8e4f9358d4377e5af085bbe45dc0674d268aa" }, "downloads": -1, "filename": "calrissian-0.9.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "52fbbc6e10554d546113b969f519d7ed", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 28362, "upload_time": "2019-10-14T13:50:42", "url": "https://files.pythonhosted.org/packages/79/56/886cc5a8a382550b7957b28ee0a6fafbe7234fe500603b9f203c55a0cf98/calrissian-0.9.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ffc97d48b281416ae4c3a2d9037eedd4", "sha256": "aaf2e04c8e23e41eb143580f3807791af6073e495642aae6c41b1279130d9c09" }, "downloads": -1, "filename": "calrissian-0.9.0-py3.7.egg", "has_sig": false, "md5_digest": "ffc97d48b281416ae4c3a2d9037eedd4", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 59978, "upload_time": "2019-10-14T13:50:44", "url": "https://files.pythonhosted.org/packages/63/7c/7ba855592d50f88029fc026c08fbec2411e018a8c6cb012dd5f3672a4ea9/calrissian-0.9.0-py3.7.egg" } ] }