Client tools for accessing various client APIs of IT4I portals
Project description
it4i-portal-clients provides simple user-friendly shell interface to call IT4I API requests and display their respond.
Python 2.7 is required.
Limits are placed on the number of requests you may make to IT4I API. Rate limit can be changed without any warning at any time, but the default is 6 requests per minute. Exceeding the limit will lead to your ip address being temporarily blocked from making further requests. The block will automatically be lifted by waiting an hour.
List of available utilities
it4icheckaccess - Shows if IT4I account and/or related project has the access to specified cluster and queue.
it4idedicatedtime - Shows IT4I dedicated time.
it4ifree - Shows some basic information from IT4I PBS accounting.
it4ifsusage - Shows filesystem usage of IT4I cluster storage systems.
it4iuserfsusage - Shows user filesystem usage of IT4I cluster storage systems.
it4projectifsusage - Shows project filesystem usage of IT4I cluster storage systems.
it4imotd - Shows IT4I messages of the day into formatted text or HTML page (using TAL / Zope Page Template).
Installation / upgrading
pip install --upgrade it4i.portal.clientsSample config file main.cfg
[main]
# IT4I API
api_url = https://scs.it4i.cz/api/v1/
it4ifreetoken = <your_token>Username is taken from OS, therefore the script has to be run under the same user login name as you use to log into clusters.
System-wide config file path: /usr/local/etc/it4i-portal-clients/main.cfg
Local user’s config file path: ~/.it4ifree
it4icheckaccess
Help of IT4ICHECKACCESS
$ it4icheckaccess -h
usage: it4icheckaccess [-h] -l LOGIN -c CLUSTER -q QUEUE [-p PROJECT]
The command shows if an IT4I account and/or related project has the access to
specified cluster and queue. Return exit code 99 if access is not granted.
optional arguments:
-h, --help show this help message and exit
-l LOGIN, --login LOGIN
user login
-c CLUSTER, --cluster CLUSTER
cluster name
-q QUEUE, --queue QUEUE
queue
-p PROJECT, --project PROJECT
project id, not required if querying projectless queueExample of IT4ICHECKACCESS
$ it4icheckaccess -l XXX -c barbora -q qexp
OK Access granted for projectless queue.it4idedicatedtime
Help of IT4IDEDICATEDTIME
$ it4idedicatedtime -h
usage: it4idedicatedtime [-h] [-m {active,planned}]
[-c {anselm,salomon,barbora}]
The command shows IT4I dedicated time. By default all planned and active
outages of all clusters are displayed. Return exit code 99 if there is no
outage, otherwise return 0.
optional arguments:
-h, --help show this help message and exit
-m {active,planned}, --message {active,planned}
select type of dedicated time. Planned contains also
active
-c {anselm,salomon,barbora}, --cluster {anselm,salomon,barbora}
select clusterExample of IT4IDEDICATEDTIME
$ it4idedicatedtime
Cluster Start End Last update
--------- ------------------- ------------------- -------------------
anselm 2019-03-19 08:00:00 2019-03-19 09:30:00 2019-03-08 08:24:33
salomon 2019-03-19 08:00:00 2019-03-19 09:30:00 2019-03-08 08:23:40it4ifree
Help of IT4IFREE
$ it4ifree -h
usage: it4ifree [-h] [-p] [-a]
The command shows some basic information from IT4I PBS accounting. The
data is related to the current user and to all projects in which user
participates.
optional arguments:
-h, --help show this help message and exit
-p, --percent
show values in percentage. Projects with unlimited resources are not displayed
-a, --all Show all resources include inactive and future ones.
Columns of "Projects I am participating in":
PID: Project ID/account string.
Type: Standard or multiyear project.
Days left: Days till the given project expires.
Total: Core-hours allocated to the given project.
Used: Sum of core-hours used by all project members.
My: Core-hours used by the current user only.
Free: Core-hours that haven't yet been utilized.
Columns of "Projects I am Primarily Investigating" (if present):
PID: Project ID/account string.
Type: Standard or multiyear project.
Login: Project member's login name.
Used: Project member's used core-hours.Example of IT4IFREE
$ it4ifree
Projects I am participating in
==============================
PID Resource type Days left Total Used By me Free
---------- --------------- ------------- -------- -------- -------- --------
OPEN-XX-XX Karolina GPU 249 42 0 0 42
Barbora CPU 249 42 5 5 37
Legacy NCH 249 100 0 0 100
Projects I am Primarily Investigating
=====================================
PID Resource type Login Usage
---------- -------------- ------- --------
OPEN-XX-XX Barbora CPU user1 3
Barbora CPU user2 2
Karolina GPU N/A 0
Legacy NCH N/A 0
Legend
======
N/A = No one used this resource yet
Legacy Normalized core hours are in NCH
Everything else is in Node Hoursit4ifsusage
Help of IT4IFSUSAGE
$ it4ifsusage -h
usage: it4ifsusage [-h]
The command shows filesystem usage of IT4I cluster storage systems
optional arguments:
-h, --help show this help message and exitExample of IT4IFSUSAGE
$ it4ifsusage
Quota Type Cluster / PID File System Space used Space limit Entries used Entries limit Last update
------------- --------------- ------------- ------------ ------------- -------------- --------------- -------------------
User barbora /home 69.6 kB 25.0 GB 17 500,000 2021-03-22 16:50:10
User salomon /home 278.5 kB 250.0 GB 94 500,000 2021-03-22 17:00:07
User barbora /scratch 0 Bytes 10.0 TB 0 10,000,000 2021-03-22 16:50:28
User salomon /scratch 0 Bytes 100.0 TB 0 10,000,000 2021-03-22 17:00:43
User salomon /scratch/temp 0 Bytes N/A 0 2021-03-22 17:00:57
User salomon /scratch/work 0 Bytes N/A 0 2021-03-22 17:00:50
Project service proj3 3.1 GB 1.0 TB 5 100,000 2021-03-22 17:00:02it4iuserfsusage
Help of IT4IUSERFSUSAGE
$ it4iuserfsusage -h
usage: it4iuserfsusage [-h] [-c {all,barbora, karolina}]
The command shows user filesystem usage of IT4I cluster storage systems
optional arguments:
-h, --help show this help message and exitExample of IT4IUSERFSUSAGE
$ it4iuserfsusage
Cluster File System Space used Space limit Entries used Entries limit Last update
--------------- ------------- ------------ ------------- -------------- --------------- -------------------
barbora /home 69.6 kB 25.0 GB 17 500,000 2021-03-22 16:50:10
salomon /home 278.5 kB 250.0 GB 94 500,000 2021-03-22 17:00:07
barbora /scratch 0 Bytes 10.0 TB 0 10,000,000 2021-03-22 16:50:28
salomon /scratch 0 Bytes 100.0 TB 0 10,000,000 2021-03-22 17:00:43
salomon /scratch/temp 0 Bytes N/A 0 2021-03-22 17:00:57
salomon /scratch/work 0 Bytes N/A 0 2021-03-22 17:00:50it4iprojectfsusage
Help of IT4IPROJECTFSUSAGE
$ it4iprojectfsusage -h
usage: it4iprojectfsusage [-h] [-p {PID, all}]
The command shows project filesystem usage of IT4I cluster storage systems
optional arguments:
-h, --help show this help message and exitExample of IT4IPROJECTFSUSAGE
$ it4iprojectfsusage
PID File System Space used Space limit Entries used Entries limit Last update
--------------- ------------- ------------ ------------- -------------- --------------- -------------------
service proj3 3.1 GB 1.0 TB 5 100,000 2021-03-22 17:00:02
it4i-x-y proj1 3.1 TB 2.0 TB 5 100,000 2021-03-22 17:00:02
dd-13-5 proj3 2 GB 3.0 TB 5 100,000 2021-03-22 17:00:02
projectx proj2 150 TB 4.0 TB 5 100,000 2021-03-22 17:00:02it4imotd
Help of IT4IMOTD
$ it4imotd -h
usage: it4imotd [-h] [-t TEMPLATE] [-w WIDTH] [-c]
The command shows IT4I messages of the day into formatted text or HTML page.
optional arguments:
-h, --help show this help message and exit
-t TEMPLATE, --template TEMPLATE
path to TAL / Zope Page Template, output will be
formatted into HTML page
-w WIDTH, --width WIDTH
maximum line width (intended for text rendering,
default of 78 columns)
-c, --cron sleep from 10 up to 60 seconds prior to any actions
-m {TYPE}, --message {TYPE}
select type of messages
supported types:
all,
public-service-announcement,
service-recovered-up,
critical-service-down,
service-hard-down,
auxiliary-service-down,
planned-outage,
service-degraded,
important,
notice.Example of IT4IMOTD
$ it4imotd
Message of the Day (DD/MM/YYYY)
(YYYY-MM-DD hh:mm:ss)
More on https://...Changelog
0.8.14 (2023-02-01)
Other
Minor motd bugfix. [Stanislav Rosický]
0.8.13 (2022-10-24)
Other
Template updated. [Jindrich Kvita]
0.8.12 (2022-10-04)
Other
README updated. [Jindrich Kvita]
Legacy Normalised Core Hours shorten to Legacy NCH. [Jindrich Kvita]
Major changes for better readability and affected systems. [Jindrich Kvita]
0.8.11 (2022-05-26)
Other
MOTD supports new categories. [Jindrich Kvita]
Readme updated. [Jindrich Kvita]
Anselm and salomon choises removed, karolina added. [Jindrich Kvita]
0.8.10 (2022-05-04)
Other
Updated pkg info. [Jindrich Kvita]
Percentage representation improved for specific situations. [Jindrich Kvita]
0.8.9 (2022-04-28)
Other
Tests updated. [Jindrich Kvita]
Bugfix and updated readme 2. [Jindrich Kvita]
Bugfix and updated readme. [Jindrich Kvita]
0.8.8 (2022-04-27)
Other
It4ifree added -a and minor changes. [Jindrich Kvita]
0.8.7 (2022-04-19)
Other
Updated it4ifree. [Jindrich Kvita]
0.8.6 (2021-10-14)
Other
Add cluster parameter to it4icheckaccess. [Stanislav Rosický]
0.8.5 (2021-03-23)
Other
Install user and project filesystem usage tools. [Jan Krupa]
Display project filesystem usage. [Jan Krupa]
Display user filesystem usage. [Jan Krupa]
Adds readme of project and user fs usage methods. [Jan Krupa]
Remove cluster option from fs-usage. [Jan Krupa]
0.8.4 (2021-03-16)
Other
Add project storage quota to fs-usage command. [Jan Krupa]
Update PKG-INFO Version. [Roman Slíva]
Update it4ifsusage.py - use decimal units. [Roman Slíva]
0.8.3 (2020-10-29)
Other
Fix multiyear periods. [Marek Chrastina]
0.8.2 (2020-05-06)
Other
Add multiyear into it4ifree. [Marek Chrastina]
Update CI. [Marek Chrastina]
0.8.1 (2020-03-25)
Other
Add python safety to CI. [Marek Chrastina]
0.8.0 (2020-02-18)
Other
Add Barbora cluster and IT4I API url. [Marek Chrastina]
0.7.8 (2019-03-22)
Other
Add it4ifsusage command. [Marek Chrastina]
0.7.7 (2019-03-11)
Other
Add it4icheckaccess command. [Marek Chrastina]
Add it4idedicatedtime command. [Marek Chrastina]
0.7.6 (2019-03-06)
Other
Add options to select type of motd messages. [Marek Chrastina]
0.7.5 (2019-03-06)
Other
Extract json related code to separated library. [Marek Chrastina]
It4ifreetoken configuration option will be mandatory just for it4ifree command. [Marek Chrastina]
Remove functionaless options. [Marek Chrastina]
Rename motd_rss to it4imotd. [Marek Chrastina]
0.7.4 (2019-03-05)
Other
Add option to show values in percentage for it4ifree. [Marek Chrastina]
Replace argument parser library in it4ifree. [Marek Chrastina]
New api url in config. [Marek Chrastina]
0.7.3 (2019-03-04)
Other
Update documentation. [Marek Chrastina]
Fix help bug. [Marek Chrastina]
0.7.2 (2019-03-01)
Other
Update documentation. [Marek Chrastina]
Do not allow CI failure. [Marek Chrastina]
Fix pylint complaints. [Marek Chrastina]
Install required pip packages before run pylint. [Marek Chrastina]
Fix pylint complaints. [Marek Chrastina]
Fix shellcheck complaints. [Marek Chrastina]
Change automatic upload to manual. [Marek Chrastina]
0.7.1 (2019-02-28)
Other
Exclude merge commits from changelog. [Marek Chrastina]
Add CI deploy. [Marek Chrastina]
Add CI pylint. [Marek Chrastina]
Add CI shellcheck. [Marek Chrastina]
Fix mdl complaints. [Marek Chrastina]
Add CI mdcheck. [Marek Chrastina]
0.6.7 (2017-09-08)
Other
Core hour => core-hour. [David Hrbáč]
Standard CH => Normalized CH. [David Hrbáč]
0.6.6 (2017-09-08)
Other
Code lint. [David Hrbáč]
Clean-up unused imports. [David Hrbáč]
0.6.5 (2017-09-05)
Other
Core Hours to Wall-clock Core Hours; Fixes it4i-admins/it4i-portal-clients#4. [David Hrbáč]
0.6.4 (2017-09-05)
Other
Core Hours to Wall-clock Core Hours; Fixes it4i-admins/it4i-portal-clients#4. [David Hrbáč]
0.6.3 (2017-08-08)
Other
Beutify format. [Jan Krupa]
Fixed Standart -> Standard. [Jan Krupa]
Fixed labels. [kru0096]
Display normalized core hours. [kru0096]
0.6.2 (2017-07-25)
Other
Use the JSON for HTML render. [David Hrbáč]
0.6.1 (2017-07-25)
Other
Use the JSON. [David Hrbáč]
0.5.12 (2017-07-25)
Other
Require dateutil. [David Hrbáč]
0.5.11 (2017-07-25)
Other
Use 24 hours. [David Hrbáč]
0.5.10 (2017-07-25)
Other
Use the JSON. [David Hrbáč]
0.5.9 (2017-07-21)
Other
Release 0.5.9. [David Hrbáč]
Typo. [David Hrbáč]
0.5.8 (2017-07-21)
Other
Move to HTTPS channel. [David Hrbáč]
Convert it4ifree to SCS, motd deprecated. [David Hrbáč]
0.5.7 (2017-02-06)
Other
Handle long titles. [David Hrbáč]
0.5.6 (2017-02-03)
Other
Corrections to README. [David Hrbáč]
Test commit. [Jan Krupa]
0.5.5 (2017-02-02)
Other
Enable to display timerange for events. [David Hrbáč]
0.5.2 (2016-10-10)
Other
Format text. [Jan Krupa]
0.5.1 (2016-10-10)
Other
Pypandoc version pinned. [Filip Valder]
0.5 (2016-10-10)
Other
License changed. [Jan Krupa]
0.4.9 (2016-06-24)
Other
A helpful script for testing installs. [Filip Valder]
0.4.8 (2016-06-24)
Other
A more advanced solution for setup.py. [Filip Valder]
Without the dot. [Filip Valder]
A more advanced solution for setup.py. [Filip Valder]
0.4.7 (2016-06-24)
Other
Handle KeyError: ‘IT4I_FACTORY_PREBUILD’ [Filip Valder]
0.4.6 (2016-06-24)
Other
Setup_requires depends on the evironment: IT4I factory versus end-user. [Filip Valder]
0.4.5 (2016-06-24)
Other
Get python interpreter from the environment. [Filip Valder]
0.4.4 (2016-06-24)
Other
Setup deps. [Filip Valder]
0.4.3 (2016-06-24)
Other
Some ignores added. [Filip Valder]
0.4.2 (2016-06-23)
Other
The other way round. [Filip Valder]
Exclude git-related stuff from MANIFEST.in. [Filip Valder]
Additional requirements for setup. [Filip Valder]
Some gitchangelog rc file. [Filip Valder]
Mising comma. [Filip Valder]
Auto-versioning accto git tags. [Filip Valder]
See the hint in it4ifree.py. [Filip Valder]
White space. [Filip Valder]
Instructions re-ordered. [Filip Valder]
0.4.1 (2016-06-01)
Other
Keywords added. [Filip Valder]
Important functional improvements & introduced README. [Filip Valder]
0.4 (2016-06-01)
Other
Config module introduced. [Filip Valder]
Sample config file. [Filip Valder]
README.txt -> README.md due to GL (the change will also appear in setup.py) [Filip Valder]
Init & use module name ; not filename. [Filip Valder]
Get ready for 0.4 release. [Filip Valder]
Use module name ; not filename. [Filip Valder]
Bug fixes. [Filip Valder]
Support for sorting. [Filip Valder]
Support for published date/time. [Filip Valder]
CStringIO for full module usage support. [Filip Valder]
0.3.4 (2016-05-19)
Other
Support for stdin and various feed sources. [Filip Valder]
Logging goes to separate file. [Filip Valder]
Write to stderr instead of stdout. [Filip Valder]
Egg-info for 0.3.3.post2. [Filip Valder]
Repository moved, project IT4I-ized… [Filip Valder]
0.3.3.post1 released: setuptools is already dep of PIP, it may mess things up during install. [Filip Valder]
0.3.3 (2016-02-25)
Other
Egg-info files for 0.3.3. [Filip Valder]
0.3.3 released. [Filip Valder]
Support for verbose and width opts; short opt for cron changed. [Filip Valder]
Default template fixes. [Filip Valder]
Sync with MANIFEST.in. [Filip Valder]
Remove dist from repository. [Filip Valder]
0.3.2 stable with unicode encoding fixed. [Filip Valder]
Add README. [Filip Valder]
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for it4i.portal.clients-0.8.14.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 43786a55aa4e790e900887e358f758b213340324c16c57aa7e3ba49ec13a7390 |
|
| MD5 | 44356578d7007dd7829cae6e5436a65f |
|
| BLAKE2b-256 | 20627980198fd393cc5457199ac59b702ffd76385c3e3f29cd7c0c647844c829 |
