Interactive tool for generation of lithops configuration
Project description
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]
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 |
---|---|---|
|
|
|
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
Project details
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
Built Distribution
Hashes for lithopscloud-1.0.0b80-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 199fe0c9879db372dc2e3f3e2f812e87b1c1987050ccc538ace1824e01ad2002 |
|
MD5 | 590c48b489c16b7bfa8ac857bc0143e2 |
|
BLAKE2b-256 | 0fb22c68bf2dfe28c618750cee70d1e0e36c23defb53eea99a1a70a04aebd3d7 |