| Name | lrzcc JSON |
| Version |
0.8.0
JSON |
| download |
| home_page | None |
| Summary | Command line client for LRZ specific features of the Compute Cloud (cc.lrz.de). |
| upload_time | 2024-05-08 19:51:20 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Leibniz Supercomputing Centre Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
lrz
cloud
compute cloud
api client
cli
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# README
Command line tool for LRZ-specific features of the LRZ Compute Cloud
[https://cc.lrz.de](https://cc.lrz.de), first and foremost the budgeting system.
## Installation
Install the tool via pip:
```bash
pip install lrzcc
```
## Usage
As a general note, use the `-h/--help` to find out more about the specific
commands of the tool.
### API Access
As with the normal Openstack CLI client you need to source your Openstack RC
file to access the API. You can download it when clicking on you username
in the top-right corner in the webui and then "OpenStack RC File v3".
Source it via:
```bash
. di12abc-openrc.sh
```
replacing `di12abc` with you own username, and then enter your password.
Note: this stores you credentials in environment variables starting with
`OS_` for OpenStack.
### User Workflows
#### Get Own User
```bash
lrzcc user me
```
Note: role 1 indicates that you are a normal user, role 2 means you are a
master user.
#### List Flavor Prices
```bash
lrzcc flavor-price list
```
#### Calculate Own Consumption and Cost
```bash
lrzcc server-consumption
lrzcc server-cost
```
#### View User and Project Budget
```bash
lrzcc user-budget list
lrzcc project-budget list
```
#### Check of Budget is Over
```bash
lrzcc user-budget over -dc
```
#### Show Budget Over Tree
This hierarchical view also shows a breakdown of the cost down to the
individual servers and is what the webui uses:
```bash
lrzcc -f json budget-over-tree
```
Note: the `-f json` tells the tool to simply output the JSON response from
the API.
### Master User Workflows
#### List Own Project and Users
```bash
lrzcc project list
lrzcc user list -p <project_id/name>
```
#### List Budgets of Own Project
```bash
lrzcc user-budget list -p <project_id/name>
```
#### List Budget Over Status of Project's Users
```bash
lrzcc user-budget over -p <project_id/name> -dc
```
#### Show Budget Over Tree of Project's Users
This hierarchical view also shows a breakdown of the cost down to the
individual users and servers and is what the webui uses:
```bash
lrzcc -f json budget-over-tree -p <project_id/name>
```
Note: the `-f json` tells the tool to simply output the JSON response from
the API.
#### Modify Budgets
```bash
lrzcc user-budget modify <user_budget_id> -a <amount>
lrzcc project-budget modify <project_budget_id> -a <amount>
```
Note: you cannot set a budget below the already acrued costs or modify the
budget of a past year.
## Warning
Don't rely on the fact that this is written in Python at the moment, this is
going to be replaced by a corresponding Rust library + CLI application in
the not so distant future.
Raw data
{
"_id": null,
"home_page": null,
"name": "lrzcc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Sandro-Alessio Gierens <gierens@lrz.de>, Niels Fallenbeck <fallenbeck@lrz.de>",
"keywords": "lrz, cloud, compute cloud, api client, cli",
"author": null,
"author_email": "Sandro-Alessio Gierens <gierens@lrz.de>",
"download_url": "https://files.pythonhosted.org/packages/73/60/08a537b4b3e6b3ebeab5eec9f332083c4222848a3b53d2dddfb9b34c3199/lrzcc-0.8.0.tar.gz",
"platform": null,
"description": "# README\n\nCommand line tool for LRZ-specific features of the LRZ Compute Cloud\n[https://cc.lrz.de](https://cc.lrz.de), first and foremost the budgeting system.\n\n## Installation\nInstall the tool via pip:\n```bash\npip install lrzcc\n```\n\n## Usage\nAs a general note, use the `-h/--help` to find out more about the specific\ncommands of the tool.\n\n### API Access\nAs with the normal Openstack CLI client you need to source your Openstack RC\nfile to access the API. You can download it when clicking on you username\nin the top-right corner in the webui and then \"OpenStack RC File v3\".\n\nSource it via:\n```bash\n. di12abc-openrc.sh\n```\nreplacing `di12abc` with you own username, and then enter your password.\nNote: this stores you credentials in environment variables starting with\n`OS_` for OpenStack.\n\n### User Workflows\n\n#### Get Own User\n```bash\nlrzcc user me\n```\nNote: role 1 indicates that you are a normal user, role 2 means you are a\nmaster user.\n\n#### List Flavor Prices\n```bash\nlrzcc flavor-price list\n```\n\n#### Calculate Own Consumption and Cost\n```bash\nlrzcc server-consumption\nlrzcc server-cost\n```\n\n#### View User and Project Budget\n```bash\nlrzcc user-budget list\nlrzcc project-budget list\n```\n\n#### Check of Budget is Over\n```bash\nlrzcc user-budget over -dc\n```\n\n#### Show Budget Over Tree\nThis hierarchical view also shows a breakdown of the cost down to the\nindividual servers and is what the webui uses:\n```bash\nlrzcc -f json budget-over-tree\n```\nNote: the `-f json` tells the tool to simply output the JSON response from\nthe API.\n\n### Master User Workflows\n\n#### List Own Project and Users\n```bash\nlrzcc project list\nlrzcc user list -p <project_id/name>\n```\n\n#### List Budgets of Own Project\n```bash\nlrzcc user-budget list -p <project_id/name>\n```\n\n#### List Budget Over Status of Project's Users\n```bash\nlrzcc user-budget over -p <project_id/name> -dc\n```\n\n#### Show Budget Over Tree of Project's Users\nThis hierarchical view also shows a breakdown of the cost down to the\nindividual users and servers and is what the webui uses:\n```bash\nlrzcc -f json budget-over-tree -p <project_id/name>\n```\nNote: the `-f json` tells the tool to simply output the JSON response from\nthe API.\n\n#### Modify Budgets\n```bash\nlrzcc user-budget modify <user_budget_id> -a <amount>\nlrzcc project-budget modify <project_budget_id> -a <amount>\n```\nNote: you cannot set a budget below the already acrued costs or modify the\nbudget of a past year.\n\n## Warning\nDon't rely on the fact that this is written in Python at the moment, this is\ngoing to be replaced by a corresponding Rust library + CLI application in\nthe not so distant future.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Leibniz Supercomputing Centre Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Command line client for LRZ specific features of the Compute Cloud (cc.lrz.de).",
"version": "0.8.0",
"project_urls": {
"Bug Tracker": "https://github.com/LRZ-BADW/lrzcc/issues",
"Changelog": "https://github.com/LRZ-BADW/lrzcc/blob/master/CHANGELOG.md",
"Documentation": "https://doku.lrz.de/compute-cloud-10333232.html",
"Homepage": "https://github.com/LRZ-BADW/lrzcc/",
"Repository": "https://github.com/LRZ-BADW/lrzcc.git"
},
"split_keywords": [
"lrz",
" cloud",
" compute cloud",
" api client",
" cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5fdc9a127f8183702a37db836b107d718f3efe2ee6e6bb7bbe705edc4f875a56",
"md5": "fcdb36afcb7aa73ca49107e64fc90097",
"sha256": "5ba2c2f7516015c968b8f650973d4502c50803b52f52fc80f14665d91cab99c4"
},
"downloads": -1,
"filename": "lrzcc-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fcdb36afcb7aa73ca49107e64fc90097",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 24530,
"upload_time": "2024-05-08T19:51:18",
"upload_time_iso_8601": "2024-05-08T19:51:18.957213Z",
"url": "https://files.pythonhosted.org/packages/5f/dc/9a127f8183702a37db836b107d718f3efe2ee6e6bb7bbe705edc4f875a56/lrzcc-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "736008a537b4b3e6b3ebeab5eec9f332083c4222848a3b53d2dddfb9b34c3199",
"md5": "e7ac60d8c7052778161ac5a609a71994",
"sha256": "be5fec405470ab4fb50a37b148823133563b8e8398e1e8c97aa145f2790136e2"
},
"downloads": -1,
"filename": "lrzcc-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "e7ac60d8c7052778161ac5a609a71994",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 21525,
"upload_time": "2024-05-08T19:51:20",
"upload_time_iso_8601": "2024-05-08T19:51:20.812828Z",
"url": "https://files.pythonhosted.org/packages/73/60/08a537b4b3e6b3ebeab5eec9f332083c4222848a3b53d2dddfb9b34c3199/lrzcc-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-08 19:51:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "LRZ-BADW",
"github_project": "lrzcc",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "lrzcc"
}
