This release is a pre-release and may not be stable for production use.
Tool to generate Lithops configuration file
Lithopscloud is a CLI tool that greatly simplifies user experience by generating Lithops and Ray configuration files.
Setup
The tool been mostly tested with Ubuntu 18.04/20.04, but should work with most Linux systems
Requirements: ssh-keygen utility installed:
sudo apt install openssh-client
Install lithopscloud from pip repository
pip install lithopscloud
Usage
Use the configuration tool as follows
lithopscloud [--iam-api-key IAM_API_KEY] [-i INPUT_FILE] [-o OUTPUT_PATH] [--verify_config CONFIG_FILE_PATH] [--version] [--backend backend] [--defaults]
Get a short description of the available flags via lithopscloud --help
Flags Detailed Description
| Key | Default | Mandatory | Additional info |
|---|---|---|---|
| iam-api-key | yes | IBM Cloud API key. To generate a new API Key, adhere to the following guide | |
| input-file | <compute_backend>/defaults.py | no | Existing config file to be used as a template in the configuration process |
| output-path | A randomly generated path to a randomly named yaml file | no | A custom location the config file will be written to |
| verify-config |
no | Verifies the integrity of an existing config file and outputs a usable config file based on it. Currently doesn't support gen2 backends. | |
| version | no | Returns lithopscloud's package version |
Verify Additional ways of configuration
Using the verify-config option enables verification of additional valid ways of configuration, that otherwise
left unchecked. This mode scans for any possible subset of valid parameters and extract them to output a new
lithops config file (e.g., verify cos configured by HMAC credentials).
To utilize simply run lithopscloud --verify-config CONFIG_FILE_PATH -o OUTPUT_FILE_PATH
Please note that this feature doesn't currently support the verification of gen2 backends.
Supported backends:
|
Standalone Compute Backends |
Serverless Compute Backends |
Storage Backends |
|---|---|---|
|
|
|
Using lithopscloud to generate config file without user interaction
In order to let lithopscloud generate config file based on some defaults and create vpc and all its peripherial assets automatically, please run:
lithopscloud -a <API_KEY> -b <BACKEND> --defaults
- currently, lithops
gen2is the only supported backend
Using lithopscloud config tool programmatically
Notice, not all fields are mandatory. Unspecified resources will be created automatically on the backend.
E.g. If existing vpc id not provided - vpc will be created automatically with all required peripherial resources like security groups, gateway.. etc following minimal default requierments If ssh key details not provided - new ssh key pair will be generated and registered in ibm cloud
Lithops Gen2
from lithopscloud import generate_config
from lithopscloud import LITHOPS_GEN2, LITHOPS_CF, LITHOPS_CE, RAY_GEN2, LOCAL_HOST
api_key = '<IAM_API_KEY>'
region = 'eu-de'
generate_config(LITHOPS_GEN2, api_key, region, cos_bucket_name='kpavel-bucket', image_id='r010-5a674db7-95aa-45c5-a2f1-a6aa9d7e93ad', key_id='r010-fe6cb103-60e6-46bc-9cb5-14e415990849', ssh_key_filename='/home/kpavel/.ssh/id_rsa', profile_name='bx2-2x8', vpc_id='r010-af1adda4-e4e5-4060-9aa2-7a0c981aff8e')
Mandatory fields are: backend_type (LITHOPS_GEN2), api_key, region and cos_bucket. Minimal example:
from lithopscloud import generate_config
from lithopscloud import LITHOPS_GEN2, RAY_GEN2
api_key = <IAM_API_KEY>
region = 'ca-tor'
cos_bucket_name='kpavel-bucket'
config_file = generate_config(LITHOPS_GEN2, api_key, region, cos_bucket_name=cos_bucket_name)
Ray Gen2
from lithopscloud import generate_config
from lithopscloud import RAY_GEN2
api_key = '<IAM_API_KEY>'
region = 'eu-de'
generate_config(RAY_GEN2, api_key, region, image_id='r010-5a674db7-95aa-45c5-a2f1-a6aa9d7e93ad', key_id='r010-fe6cb103-60e6-46bc-9cb5-14e415990849', ssh_key_filename='/home/kpavel/.ssh/id_rsa', profile_name='bx2-2x8', vpc_id='r010-af1adda4-e4e5-4060-9aa2-7a0c981aff8e', min_workers=1, max_workers=1)
Mandatory fields are: backend_type (LITHOPS_GEN2), api_key, region and cos_bucket. Minimal example:
from lithopscloud import generate_config
from lithopscloud import RAY_GEN2
api_key = <IAM_API_KEY>
region = 'eu-de'
config_file = generate_config(RAY_GEN2, api_key, region)
For Contributors
Add new unsupported sections to config file
If the new configuration is provider specific
- implement config_builder.py interface
- add your implementation under provider package
- add reference to your implementation in the list of exported modules, e.g. lithops modules
If the new configuration is common for multiple providers
- implement config_builder.py interface to hold common logic
- add your implementation to modules package
- extend your common implementation under each provider package, e.g. lithops image.py and ray image.py to have config file specific logic
3 maintainers
Release files for lithopscloud 1.0.0b98
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| lithopscloud-1.0.0b98.tar.gz | 48.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| lithopscloud-1.0.0b98-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 118.9 kB
Release files / lithopscloud-1.0.0b98.tar.gz
| Download URL | lithopscloud-1.0.0b98.tar.gz |
|---|---|
| Size | 48.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
080adb72192aad685bdcd57876c16901eeef2f8732edcba6d9b77359300ca800
|
|
BLAKE2b-256 checksum How to use checksums |
a863bdbc3bf1bb2285a8e0c5978e0682b4d276f34ec9b85af547590aa09dc91c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.2.0 pkginfo/1.7.0 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.7.3
|
Release files / lithopscloud-1.0.0b98-py3-none-any.whl
| Download URL | lithopscloud-1.0.0b98-py3-none-any.whl |
|---|---|
| Size | 70.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cd36228435ba727e70ddbb0a5bdd04ac59e5b2b68d51c1321d9eb49f0735f233
|
|
BLAKE2b-256 checksum How to use checksums |
f41d372ff3f14273620ac40551b0b2982b4e1e916ba8fa5a0991332917ecb0e3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.2.0 pkginfo/1.7.0 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.7.3
|
