EGI SKU Standard
Standardized SKU (Stock Keeping Unit) format for versioning systems and releases across all platforms and system types.
Overview
The EGI SKU standard provides a consistent way to identify, version, and track released systems across different platforms and system types. Every released component should have a unique SKU that captures its version, purpose, platform, and build date.
Format
X.Y.Z.TYPE.PLATFORM.YYYYMMDD
Components
- X.Y.Z - Semantic version (major.minor.patch)
- TYPE - System type code (API, BOT, RAG, etc.)
- PLATFORM - Deployment platform code (EKS, GKE, LM, etc.)
- YYYYMMDD - Build/release date
Quick Examples
1.0.0.API.EKS.20250127 # API on AWS EKS, version 1.0.0
2.5.1.BOT.GKE.20250115 # Bot worker on Google GKE, version 2.5.1
1.2.0.RAG.LM.20250201 # RAG service on AWS Lambda, version 1.2.0
3.0.0.WA.VE.20250110 # Web app on Vercel, version 3.0.0
Philosophy
The SKU standard is designed to:
- Provide traceability - Know exactly what version is running where
- Enable automation - Machines can parse and validate SKUs
- Support multi-platform - Same code, different platforms, different SKUs
- Track deployments - Build date helps correlate with CI/CD runs
- Enforce semantic versioning - Clear version progression
Why Use SKUs?
- Deployment tracking - Quickly identify what's running in each environment
- Rollback safety - Know exactly which version to revert to
- Change management - Tie deployments to specific builds and dates
- Audit compliance - Track what was deployed when and where
- CI/CD integration - Automate version management and validation
Documentation Structure
This section covers:
- Naming Conventions - Detailed SKU format and rules
- Platform Identifiers - All supported platform codes
- System Types - All supported system type codes
- Release Conventions - How SKUs evolve with releases
- Examples - Real-world SKU examples
- Tooling - Tools for generating and validating SKUs
- Update Process - How to update SKU standards
Getting Started
- Review the naming conventions to understand the format
- Find your platform code and system type
- Check out examples for similar deployments
- Use the tooling to generate and validate SKUs
- Follow release conventions as you evolve your service
Quick Reference
Common Platform Codes
| Code | Platform | Use For |
|---|---|---|
| EKS | AWS Elastic Kubernetes Service | Production containerized workloads on AWS |
| GKE | Google Kubernetes Engine | Production containerized workloads on GCP |
| LM | AWS Lambda | Serverless functions |
| VE | Vercel | Next.js and frontend deployments |
| CF | Cloudflare Workers/Pages | Edge compute and static sites |
Common System Types
| Code | Description | Use For |
|---|---|---|
| API | REST/GraphQL API service | Backend APIs and microservices |
| BOT | Background worker/bot | Queue workers, cron jobs, automation |
| RAG | RAG system | Retrieval-augmented generation systems |
| WA | Web application | Frontend web apps (SPAs, SSR) |
| SDK | Client SDK | Python/JavaScript packages for developers |
See the full lists in Platform Identifiers and System Types.
Support
For questions or to propose new platform codes or system types:
- submit a PR to this repo
- contact the platform team
- see Update Process for contribution guidelines