StitcherAI Editor (VSCode)
Overview
The StitcherAI Editor is a visual editing plugin for VSCode that simplifies the
process of configuring StitcherAI pipeline configurations. This plugin provides
a user-friendly interface for editing pipeline configurations, making it easier
to manage your FinOps workflows.
Key features
The StitcherAI Editor plugin offers the following key features:
- Visual Editing Experience: A graphical interface for editing pipeline
configurations, making it easier to understand and manage complex
configurations.
- Validation Criteria: The editor enforces validation criteria to ensure that
configurations are correct and consistent.
- Ordering Configurations: Support for ordering configurations in a user-defined
order, with automatic validation and enforcement of ordering rules.
Adding new configurations
To add a new configuration, simply right-click on any pipeline phase (displayed
as folders on the left navigation) and select "Add new configuration". The
editor will display the necessary configuration UI and enforce validation
criteria based on the stage.
Ordering configurations
For Enhance and Allocation configurations, it is essential to define the order
in which configurations are applied. To support this, StitcherAI requires
configurations to be prefixed with a number that defines the order of execution.
We recommend using a numbering scheme that leaves gaps (e.g.,
1000_alloc_rule1.yaml, 1100_alloc_rule2.yaml) to allow for future additions
without renaming files and losing file history.
A high-level overview of this repository.
This is the StitcherAI Editor plugin for Visual Studio Code, which is designed
to help users configure and manage FinOps (Financial Operations) workflows. Here
are the key aspects:
- Purpose:
- It's a visual editing plugin for VSCode that simplifies the process of
configuring StitcherAI pipeline configurations
- Helps users manage and configure FinOps workflows through a user-friendly
interface
- Provides validation and ordering capabilities for configurations
- Main Features:
- Visual Editing Experience: Graphical interface for editing pipeline
configurations
- Validation Criteria: Enforces validation rules to ensure configurations are
correct
- Ordering Configurations: Supports ordering configurations in a user-defined
sequence
- Autocomplete Support: Recently added autocomplete functionality for columns
and providers
- Pipeline Stages: The plugin supports several pipeline stages:
- Extract: Configure data sources (cost and business data)
- Enhance: Improve data quality through three sub-stages:
- Prepare: Fix inconsistencies
- Normalize: Standardize data schema
- Enrich: Add business context
- Allocate: Distribute and manage costs
- Generate: Create forecasts and projections
- Govern: Manage data governance
- Integrate: Configure data destinations
- Data Source Support:
- Cost data sources (e.g., AWS Cost and Usage Report, Azure Cost Management)
- Business data sources (from Git repositories or remote sources)
- Support for various file formats (CSV, Parquet)
- Integration with cloud storage (AWS S3, GCP GCS, Azure Blob Storage)
- Database integration (BigQuery, Snowflake)
- Technical Details:
- Built as a VSCode extension
- Uses JSON schema for configuration validation
- Supports YAML, JSON, and other configuration file formats
- Includes an assistant for authoring views
- Has authentication support for StitcherAI (get an account here - )
- Development:
- Includes development tools and scripts (e.g.,
bump_version.sh
for version
management)
- Has a structured development workflow with schema updates and testing
capabilities
This plugin is part of a larger FinOps ecosystem, helping organizations manage
and optimize their cloud costs through a structured pipeline approach. It
provides a visual interface to what would otherwise be complex configuration
files, making it easier for users to manage their FinOps workflows without deep
technical knowledge.