lithopscloud 1.0.0b63

Interactive tool for generation of lithops configuration

Tool to generate Lithops configuration file

Lithopscloud is a CLI tool that greatly simplifies user experience by generating Lithops and Ray configuration files.

Setup

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

[//]: <> ( is used in the following table to create spacing)

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, by using it to execute a test function. Akin to running lithops test -c CONFIG_FILE_PATH
version		no	Returns lithopscloud's package version

Supported backends:

Standalone Compute Backends	Serverless Compute Backends	Storage Backends
Gen2/Lithops Gen2/Ray Local Host	IBM Cloud Functions IBM Code Engine	IBM Cloud Object Storage

##For Contributors

Add new unsupported sections to config file

If the new configuration is provider specific

1. implement config_builder.py interface
2. add your implementation under provider package
3. add reference to your implementation in the list of exported modules, e.g. lithops modules

If the new configuration is common for multiple providers

1. implement config_builder.py interface to hold common logic
2. add your implementation to modules package
3. extend your common implementation under each provider package, e.g. lithops image.py and ray image.py to have config file specific logic