Blueberry IDP Reference Documentation

This directory contains technical reference documentation for the Blueberry Internal Developer Platform.

Directory Structure

🔧 Configuration

Complete configuration reference
- Kubernetes configuration options
- Secret management configuration
- Configuration loading mechanisms
- Override system reference
- Validation rules and schemas

🌐 API

API endpoint documentation
- REST API reference
- Authentication methods
- Request/response schemas
- Error codes and handling
- Rate limiting details

💻 CLI

Command-line interface reference
- Available commands
- Command options and flags
- Environment variables
- Configuration files

📦 Helm Values

Helm chart configuration reference
- Available values for each chart
- Default configurations
- Override examples
- Dependencies

📖 Glossary

Terms and definitions
- Platform-specific terminology
- Kubernetes concepts
- Architecture terms
- Acronyms and abbreviations

Purpose

Reference documentation provides:
- Complete technical specifications
- All available options and parameters
- Default values and constraints
- API contracts and schemas
- Detailed configuration examples

How to Use Reference Docs

1. Looking up specific options? Use the search function
2. Configuring a component? Check the relevant configuration section
3. Integrating via API? Start with the API reference
4. Using the CLI? Refer to command documentation
5. Confused by a term? Check the glossary

Documentation Standards

Reference documentation should:
- Be comprehensive and accurate
- Include all parameters with descriptions
- Show default values
- Provide valid examples
- Note version-specific changes
- Link to related guides and workflows

Contributing

When updating reference documentation:
1. Ensure completeness - document all options
2. Maintain accuracy - test all examples
3. Use consistent formatting
4. Include type information
5. Note required vs optional parameters
6. Add cross-references where helpful

Related Documentation

• Workflows - How to perform tasks
• Guides - Conceptual understanding
• Architecture - System design
• Setup - Installation procedures