Skip to content

Latest commit

 

History

History
176 lines (133 loc) · 9.23 KB

README.md

File metadata and controls

176 lines (133 loc) · 9.23 KB

Cost Management On-Premise Helm Chart Documentation

Welcome to the Resource Optimization Service (ROS) for OpenShift Container Platform documentation. This directory contains comprehensive guides for installing, configuring, and operating the Cost Management On-Premise Helm chart.

📂 Documentation Structure

Documentation is now organized into four categories for easier navigation:

docs/
├── architecture/     # System design, components, data flows
├── operations/       # Installation, configuration, troubleshooting
├── api/             # Authentication, authorization, API guides
├── development/     # Testing, validation, development resources
└── README.md        # This file - documentation index and navigation

📚 Documentation Index

Browse documentation by category:

🏗️ Architecture

System design, component interactions, and technical architecture.

Document Purpose
Platform Guide Overview of the ROS platform architecture and components
Helm Templates Reference Documentation of all Helm chart templates and resources
Sources API Production Flow Provider creation flow using Sources API and Kafka
External Keycloak Scenario Analysis and architecture for using external Keycloak

🚀 Operations

Deployment, configuration, maintenance, and troubleshooting.

Installation & Setup

Document Purpose
Quickstart Fast-track guide to get Cost Management On-Premise running quickly
Installation Guide Comprehensive installation instructions for Cost Management On-Premise
Cost Management Installation Detailed Cost Management component installation

Cost Management

Document Purpose
Cost Management Concepts Core concepts, cost models, and cost calculation methods
Data Sources and Providers Configuring and managing OpenShift providers and data collection

Configuration

Document Purpose
Configuration Reference Complete reference of all Helm values and configuration options
Resource Requirements Hardware and resource sizing guidance
Worker Deployment Scenarios Different worker deployment configurations
TLS Certificate Options Guide to different TLS certificate configuration scenarios
Cost Management Operator TLS Config TLS configuration for the Cost Management Metrics Operator
Force Operator Upload Guide for manually triggering metrics upload for testing
Upload Verification Checklist Step-by-step checklist to verify operator metrics upload
Troubleshooting Guide Common issues and their solutions

🔐 API & Authentication

Authentication, authorization, and API integration guides.

Document Purpose
Keycloak JWT Authentication Setup Complete guide for setting up JWT authentication with Keycloak
Native JWT Authentication Detailed explanation of JWT authentication architecture
UI OAuth Authentication Complete guide for UI OAuth authentication with Keycloak OAuth proxy

🧪 Development & Testing

Testing guides, validation procedures, and development resources.

Document Purpose
OCP Dev Setup with S4 Set up a dev environment on OCP using S4 instead of ODF
UI OAuth Testing Guide for testing UI OAuth flow with Keycloak

🚀 Quick Navigation by Use Case

"I'm new to Cost Management On-Premise"

  1. Start with Quickstart for a rapid deployment
  2. Read Platform Guide to understand the architecture
  3. Learn Cost Management Concepts to understand cost models and attribution
  4. Review Configuration Reference for customization options

"I'm deploying to production"

  1. Follow Installation Guide for detailed setup
  2. Configure authentication using Keycloak JWT Authentication Setup
  3. Set up TLS using TLS Certificate Options
  4. Configure providers via Data Sources and Providers
  5. Understand the provider creation flow via Sources API Production Flow
  6. Review Configuration Reference for production settings

"I'm setting up authentication"

  1. Read Native JWT Authentication to understand the architecture
  2. Follow Keycloak JWT Authentication Setup for step-by-step instructions
  3. For UI authentication, see UI OAuth Authentication (OpenShift only)
  4. Use TLS Certificate Options for TLS configuration
  5. Reference External Keycloak Scenario if using external Keycloak

"I'm setting up the Cost Management Operator"

  1. Follow Cost Management Operator TLS Config Setup
  2. Use Force Operator Upload to test the upload pipeline
  3. Verify with Upload Verification Checklist

"Something isn't working"

  1. Check Troubleshooting Guide for common issues
  2. Use Upload Verification Checklist to verify operator uploads
  3. Review logs and debugging steps in relevant setup guides

"I'm setting up a development environment"

  1. Follow OCP Dev Setup with S4 to deploy with S4 (no ODF required)
  2. Read Installation Guide for the full install options
  3. Set up authentication using Keycloak JWT Authentication Setup

"I need to understand the codebase"

  1. Read Helm Templates Reference for resource definitions
  2. Review Platform Guide for architecture overview
  3. Check Configuration Reference for available options

📖 Detailed Document Descriptions

For detailed information about each document's purpose, use cases, and key topics, refer to the categorized sections below or explore the documentation directories directly:

  • architecture/ - System architecture, design decisions, and technical deep-dives
  • operations/ - Installation, configuration, deployment, and operational guides
  • api/ - Authentication, authorization, and API integration documentation
  • development/ - Testing, validation, and development resources

🔧 Developer Resources

Contributing

When contributing to the project, please ensure documentation is updated:

  • Update relevant guides when adding features
  • Add new guides for significant new functionality
  • Keep configuration references up-to-date
  • Update this README when adding new documentation

Documentation Standards

  • Use clear, concise language
  • Include practical examples
  • Provide both "how" and "why" explanations
  • Keep troubleshooting sections updated with new issues
  • Cross-reference related documents

📞 Getting Help

If you can't find what you're looking for in these guides:

  1. Check the troubleshooting guide - Many common issues are documented
  2. Review related guides - Information may be in a related document
  3. Check the repository - README.md and inline code comments may help
  4. Open an issue - If something is unclear or missing, let us know

📝 Document Status

All documents are maintained and updated regularly. If you find outdated information, please:

  1. Check if a newer version exists
  2. Open an issue or pull request
  3. Contact the maintainers

Last Updated: 2026-01-29 Helm Chart Version: 0.1.5+ Documentation Structure: Reorganized into architecture/, operations/, api/, and development/ categories (TASK-014)