# Shinigami
[](https://app.codacy.com/gh/pitt-crc/shinigami/dashboard)
[](https://app.codacy.com/gh/pitt-crc/shinigami/dashboard)
Shinigami is a stand alone Python application for killing errant processes on Slurm based compute nodes.
The application scans for and terminates any running processes not associated with a currently running Slurm job.
Processes associated with whitelisted users (root, administrators, service accounts, etc.) are ignored.
## Installation and Setup
The `shinigami` command line utility is installable via the pip (or pipx) package manager:
```bash
pipx install shinigami
```
To be of maximal use, it is recommended to run the utility every half hour.
However, you may find a different cadence more appropriate depending on your cluster size and use case.
Running the utility automatically is accomplished via a simple cron job:
```cron
0,30 * * * * shinigami
```
You may wish to configure the cron job to run under a dedicated service account.
When doing so, ensure the user is added to the admin list and satisfies the following criteria:
- Exists on all compute nodes
- Has appropriate permissions to terminate system processes on compute nodes
- Has established SSH keys for connecting to compute nodes
Raw data
{
"_id": null,
"home_page": "https://github.com/pitt-crc/shinigami",
"name": "crc-shinigami",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.9.0",
"maintainer_email": null,
"keywords": "process, terminate, slurm",
"author": "Pitt Center for Research Computing",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/29/f2/0de8621161435279575791eb8bd6cc001eeb1a56ef612ff7131cde43ce46/crc_shinigami-0.6.1.tar.gz",
"platform": null,
"description": "# Shinigami\n[](https://app.codacy.com/gh/pitt-crc/shinigami/dashboard)\n[](https://app.codacy.com/gh/pitt-crc/shinigami/dashboard)\n\nShinigami is a stand alone Python application for killing errant processes on Slurm based compute nodes.\nThe application scans for and terminates any running processes not associated with a currently running Slurm job.\nProcesses associated with whitelisted users (root, administrators, service accounts, etc.) are ignored.\n\n## Installation and Setup\n\nThe `shinigami` command line utility is installable via the pip (or pipx) package manager:\n\n```bash\npipx install shinigami\n```\n\nTo be of maximal use, it is recommended to run the utility every half hour.\nHowever, you may find a different cadence more appropriate depending on your cluster size and use case.\nRunning the utility automatically is accomplished via a simple cron job:\n\n```cron\n0,30 * * * * shinigami\n```\n\nYou may wish to configure the cron job to run under a dedicated service account.\nWhen doing so, ensure the user is added to the admin list and satisfies the following criteria:\n\n- Exists on all compute nodes\n- Has appropriate permissions to terminate system processes on compute nodes\n- Has established SSH keys for connecting to compute nodes\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A stand alone Python application for killing errant processes on Slurm based compute nodes.",
"version": "0.6.1",
"project_urls": {
"Homepage": "https://github.com/pitt-crc/shinigami",
"Repository": "https://github.com/pitt-crc/shinigami"
},
"split_keywords": [
"process",
" terminate",
" slurm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c95be684d9fca7159419c2bbb1d3b0c11cdfb56617b8b26edd10b50a7227968d",
"md5": "acc2760c4f2b297f08648c9b5c32f1e8",
"sha256": "4243a04fcb9195645b44000e1baaf2f327f5d23cc8eda517aef1007ffa02969a"
},
"downloads": -1,
"filename": "crc_shinigami-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "acc2760c4f2b297f08648c9b5c32f1e8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.9.0",
"size": 19953,
"upload_time": "2024-10-01T14:12:06",
"upload_time_iso_8601": "2024-10-01T14:12:06.973586Z",
"url": "https://files.pythonhosted.org/packages/c9/5b/e684d9fca7159419c2bbb1d3b0c11cdfb56617b8b26edd10b50a7227968d/crc_shinigami-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "29f20de8621161435279575791eb8bd6cc001eeb1a56ef612ff7131cde43ce46",
"md5": "c592ef3b149754ab727ac45e006b7dab",
"sha256": "160e55a8dfc401ad43da563138737ed821bbf4897f4b80d926c45b924d2edb16"
},
"downloads": -1,
"filename": "crc_shinigami-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "c592ef3b149754ab727ac45e006b7dab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.9.0",
"size": 18497,
"upload_time": "2024-10-01T14:12:08",
"upload_time_iso_8601": "2024-10-01T14:12:08.002027Z",
"url": "https://files.pythonhosted.org/packages/29/f2/0de8621161435279575791eb8bd6cc001eeb1a56ef612ff7131cde43ce46/crc_shinigami-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-01 14:12:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pitt-crc",
"github_project": "shinigami",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "crc-shinigami"
}
JSON
