Useful tools to interact with Resource Locker Project
Project description
Useful tools to work with Rlocker project API
Quick Start
Normal installation
pip install rlockertools
Setup
git clone https://github.com/jimdevops19/rlockertools.git
cd rlockertools
python -m venv venv
source venv/bin/activate
python setup.py install
rlock --help
usage: rlock [-h] --server-url SERVER_URL --token TOKEN [--release] [--lock] [--resume-on-connection-error] [--signoff SIGNOFF]
[--priority PRIORITY] [--search-string SEARCH_STRING] [--link LINK] [--interval INTERVAL] [--attempts ATTEMPTS]
optional arguments:
-h, --help show this help message and exit
--server-url SERVER_URL
The URL of the Resource Locker Server
--token TOKEN Token of the user that creates API calls
--release Use this argument to release a resource
--lock Use this argument to lock a resource
--resume-on-connection-error
Use this argument in case you don't want to break queue execution in the middle of waiting for queue status
being FINISHED
--signoff SIGNOFF Use this when lock=True, locking a resource requires signoff
--priority PRIORITY Use this when lock=True, specify the level of priority the resource should be locked
--search-string SEARCH_STRING
Use this when lock=True, specify the lable or the name of the lockable resource
--link LINK Use this when lock=True, specify the link of the CI/CD pipeline that locks the resource
--interval INTERVAL Use this when lock=True, how many seconds to wait between each call while checking for a free resource
--attempts ATTEMPTS Use this when lock=True, how many times to create an API call that will check for a free resource
Usage Examples
To add a queue for locking a resource
rlock --lock --server-url=your.rlocker.instance.com --token=YOURTOKEN --search-string=nameorlabel --signoff=YOURUNIQUESIGNOFF --priority=3 --interval=15 --attempts=15
To release a locked resource (filtration by signoff only)
rlock --release --server-url=your.rlocker.instance.com --token=YOURTOKEN --signoff=YOURUNIQUESIGNOFF
Change log
[0.0.1] - 2021-03-15
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
rlockertools-0.3.8.tar.gz
(9.1 kB
view details)
Built Distribution
File details
Details for the file rlockertools-0.3.8.tar.gz.
File metadata
- Download URL: rlockertools-0.3.8.tar.gz
- Upload date:
- Size: 9.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.0 importlib_metadata/3.7.3 packaging/20.8 pkginfo/1.7.0 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0ee2e48535bf9c28bcdb9ec3a6682f456fe2c0aea9633c24df08fd4cfb14ca0c |
|
| MD5 | fcfe5b3eb129a653439070819d150bae |
|
| BLAKE2b-256 | b272c748b22979626218ef90f0a00d0cca08db294dc69dfe2d2419be65b916cf |
File details
Details for the file rlockertools-0.3.8-py3-none-any.whl.
File metadata
- Download URL: rlockertools-0.3.8-py3-none-any.whl
- Upload date:
- Size: 9.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.0 importlib_metadata/3.7.3 packaging/20.8 pkginfo/1.7.0 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2e7852f46126be12d11c93415cc180ecf0db87d09cb11be2ba3114303fdea65b |
|
| MD5 | 3255055e8a90b0cca1ef15d6df2fe83c |
|
| BLAKE2b-256 | 3bda503b64411a6da2011b8291b4944efa2fcca0f9a332a81c82d07d4ba4042f |
