# access-ci-org/ipf %VER%-%REL%
# README
## Overview
The Information Publishing Framework (IPF) is a generic framework used by resource operators to gather and publish
dynamic resource information in [GLUE 2 serialized format](http://www.ogf.org/documents/GFD.147.pdf). IPF was used
by the TeraGrid, XSEDE, and XSEDE 2 programs, and is currently being used by the ACCESS-CI program to publish
high-performance compute cluster information.
IPF gathers and publishes information using simple workflows. These workflows are defined using JSON (see the
etc/workflows directory) and steps in the workflows are implemented as Python classes. Each step in the
workflow can require input Data, can produce output Data, and can publish Representations of Data. A typical
workflow consists of a number of information gathering steps and a few steps that publish representations to
files or to remote services (e.g. REST, messaging).
Workflow steps specify what Data they require and what Data they produce. This allows IPF to construct
workflows based on partial information - in the case where there are not steps that produce the same Data, an
entire workflow can be constructed from a single publish step and its required input Data. At the other
extreme, workflows can be exactly specified with specific steps identified and the outputs of steps bound to
the inputs of other steps. A typical workflow (e.g. GLUE 2) specifies what steps to include but lets IPF
automatically link outputs to inputs of these steps.
Workflows can run to completion relatively quickly or they can continuously run. The first type of workflow
can be used to run a few commands or look at status files and publish that information. The second type of
workflow can be used to monitor log files and publish entries written to those files. Workflows are typically
run periodically as cron jobs. The program libexec/run_workflow.py is for executing workflows that complete
quickly and the program libexec/run_workflow_daemon.py is used to manage long-running workflows. The daemon
## License
This software is licensed the Apache License Version 2.0.
## Installation
Quickstart instructions are in [docs/Quickstart.md](docs/Quickstart.md).
More comprehensive instructions are in [docs/INSTALL.md](docs/INSTALL.md).
## Support Information
This software is currently maintained by the ACCESS CONECT project.
The source is maintained in the [ACCESS-CI GitHub](https://github.com/access-ci-org/ipf). ACCESS-CI resource
providers and other members of the ACCESS-CI community are encourage to contribute bug fixes and improvements.
Software bugs may be reported as GitHub issues. ACCESS-CI related support requests should be submitted through
the ACCESS-CI ticket system.
## Acknowledgements
This work was supported by the TeraGrid, XSEDE, FutureGrid, XSEDE 2, and ACCESS CONECT projects under
National Science Foundation grants 0503697, 1053575, 0910812, 1548562, and 2138307.
Raw data
{
"_id": null,
"home_page": "https://github.com/access-ci-org/ipf",
"name": "ipf",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "monitoring information gathering publishing glue2",
"author": "Eric Blau, Warren Smith",
"author_email": "blau@globus.org",
"download_url": "https://files.pythonhosted.org/packages/46/98/1ab3cdfb88e1bd7c5d4c3142a84a81f0a34cd0ed218410e0347c5da0f7d6/ipf-1.8.2.tar.gz",
"platform": null,
"description": "\n# access-ci-org/ipf %VER%-%REL%\n# README\n\n## Overview\n\nThe Information Publishing Framework (IPF) is a generic framework used by resource operators to gather and publish\ndynamic resource information in [GLUE 2 serialized format](http://www.ogf.org/documents/GFD.147.pdf). IPF was used\nby the TeraGrid, XSEDE, and XSEDE 2 programs, and is currently being used by the ACCESS-CI program to publish\nhigh-performance compute cluster information.\n\nIPF gathers and publishes information using simple workflows. These workflows are defined using JSON (see the\netc/workflows directory) and steps in the workflows are implemented as Python classes. Each step in the\nworkflow can require input Data, can produce output Data, and can publish Representations of Data. A typical\nworkflow consists of a number of information gathering steps and a few steps that publish representations to\nfiles or to remote services (e.g. REST, messaging).\n\nWorkflow steps specify what Data they require and what Data they produce. This allows IPF to construct\nworkflows based on partial information - in the case where there are not steps that produce the same Data, an\nentire workflow can be constructed from a single publish step and its required input Data. At the other\nextreme, workflows can be exactly specified with specific steps identified and the outputs of steps bound to\nthe inputs of other steps. A typical workflow (e.g. GLUE 2) specifies what steps to include but lets IPF\nautomatically link outputs to inputs of these steps.\n\nWorkflows can run to completion relatively quickly or they can continuously run. The first type of workflow\ncan be used to run a few commands or look at status files and publish that information. The second type of\nworkflow can be used to monitor log files and publish entries written to those files. Workflows are typically\nrun periodically as cron jobs. The program libexec/run_workflow.py is for executing workflows that complete\nquickly and the program libexec/run_workflow_daemon.py is used to manage long-running workflows. The daemon\n\n## License\n\nThis software is licensed the Apache License Version 2.0.\n\n## Installation\n\nQuickstart instructions are in [docs/Quickstart.md](docs/Quickstart.md).\nMore comprehensive instructions are in [docs/INSTALL.md](docs/INSTALL.md).\n\n## Support Information\n\nThis software is currently maintained by the ACCESS CONECT project.\n\nThe source is maintained in the [ACCESS-CI GitHub](https://github.com/access-ci-org/ipf). ACCESS-CI resource\nproviders and other members of the ACCESS-CI community are encourage to contribute bug fixes and improvements.\n\nSoftware bugs may be reported as GitHub issues. ACCESS-CI related support requests should be submitted through\nthe ACCESS-CI ticket system.\n\n## Acknowledgements\n\nThis work was supported by the TeraGrid, XSEDE, FutureGrid, XSEDE 2, and ACCESS CONECT projects under\nNational Science Foundation grants 0503697, 1053575, 0910812, 1548562, and 2138307.\n",
"bugtrack_url": null,
"license": "Apache",
"summary": "The Information Publishing Framework",
"version": "1.8.2",
"project_urls": {
"Homepage": "https://github.com/access-ci-org/ipf"
},
"split_keywords": [
"monitoring",
"information",
"gathering",
"publishing",
"glue2"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "05c73cc83ceffab2229a013ab773181d28f80013a9b1dbba2270d17b044d1141",
"md5": "71ef0356156e337bb82110d70f34a9d9",
"sha256": "ec8bccb70a25c9c70db3d9fd522b3ef506237d4231447baa291eb594b637d973"
},
"downloads": -1,
"filename": "ipf-1.8.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "71ef0356156e337bb82110d70f34a9d9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 205567,
"upload_time": "2024-10-25T15:36:33",
"upload_time_iso_8601": "2024-10-25T15:36:33.057451Z",
"url": "https://files.pythonhosted.org/packages/05/c7/3cc83ceffab2229a013ab773181d28f80013a9b1dbba2270d17b044d1141/ipf-1.8.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46981ab3cdfb88e1bd7c5d4c3142a84a81f0a34cd0ed218410e0347c5da0f7d6",
"md5": "5a0707c1ec84ad858c3d9493672abfa6",
"sha256": "12b942e82badd3e79a6072f5a45e26e5d98a95dd2fcf82918a9a27e94e5dd4fa"
},
"downloads": -1,
"filename": "ipf-1.8.2.tar.gz",
"has_sig": false,
"md5_digest": "5a0707c1ec84ad858c3d9493672abfa6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 149361,
"upload_time": "2024-10-25T15:36:34",
"upload_time_iso_8601": "2024-10-25T15:36:34.462141Z",
"url": "https://files.pythonhosted.org/packages/46/98/1ab3cdfb88e1bd7c5d4c3142a84a81f0a34cd0ed218410e0347c5da0f7d6/ipf-1.8.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-25 15:36:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "access-ci-org",
"github_project": "ipf",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ipf"
}
JSON
