Provides a CLI to run all sorts of sequences like demo prep.
Project description
CAST AI SE CLI (cast-ai-se-cli package | se-cli tool)
Introduction / Overview
This project aims to serve as swiss knife intended to serve CAST AI SEs. Assisting with demo environment prep, providing snapshot analysis and many others in the future. The CLI tool is based on a modular architecture and leverages API orchestration tools package -> cast-ai-se-tools
Table of Contents
Installation
To install, run:
pip install cast-ai-se-cli --force-reinstall
Usage
For some of the functions(commands) the tool offers a configuration file is required (config.json).
First time running the tool if file is not found, the tool would create an empty template file.
The user is required to fill fields required to automate sequences related to the chosen command.
The template comes with additional default parameters that can found here
High-Level:
Cli command/s:
se-cli demo <on|off|refresh> [--cluster_id <cluster_id>] [-h|--help] [-d|--debug]
Options:
-h, --help Show this help message and exit.
-d, --debug Enable debug logging.
-c, --cluster_id <cluster_id> (Optional) Specify the cluster ID for the demo environment.
Command->Outcome:
se-cli demo on
:
se-cli demo off
:
se-cli demo refresh
:
Hitting a timeout:
se-cli audit analyze
:
Contributing
Contributions are welcome! To contribute, follow these steps:
git clone project as first step create features/fixes by applying a simple <TYPE(fix/feature...)>/<INITIATING_USER>-<FEATURE/FIX-NAME> branch do not forget to update version and open a PR Please make sure CI process that enforces light flake8 lint passes (flak8 and other helper script can be found in helper_script folder)
License
This project is licensed under the APACHE License.
Roadmap
- Version 0.1.0: First semi-major release end of 2023 Q4 - tested and vetted demo functionality
- Version 0.2.0: Second semi-major release to support snapshots analysis
- Version 0.3.0: Third semi-major to integrate with solution-engineering tool
- Version 1.0.0: First Major release tested and vetter all other previous releases (end of 2024 Q1)
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.