README
GitLab Ultimate Technical Documentation
Comprehensive guide for production-grade software development using GitLab Ultimate
This documentation covers every aspect of GitLab Ultimate, from basic UI navigation to advanced AI-powered workflows, specifically tailored for the Agent Platform's 70+ project ecosystem.
Documentation Overview
Quick Navigation
| Section | Focus | Priority | Docs |
|---|---|---|---|
| 01 - UI Navigation | Complete GitLab UI guide | Medium | 5 files |
| 02 - Agent Platform | Triggers, Flows, Agents | CRITICAL | 8 files |
| 03 - OSSA | Open Standard Agents | CRITICAL | 7 files |
| 04 - CI/CD | Pipeline optimization | URGENT | 9 files |
| 05 - Components | Multi-project management | HIGH | 9 files |
| 06 - Versioning | SemVer & releases | High | 8 files |
| 07 - Security | Security & compliance | High | 7 files |
| 08 - Observability | Monitoring & tracing | Medium | 9 files |
| 09 - AI/Duo | AI features & automation | Medium | 9 files |
| 10 - Cost | Cost optimization | URGENT | 9 files |
Total: 80+ comprehensive documentation files
Quick Start Paths
For Developers
- Start: UI Navigation Overview
- Learn: GitLab Agent Platform
- Practice: CI/CD Best Practices
- Master: Components
For DevOps/SRE
- URGENT: Cost Optimization
- Essential: CI/CD Pipeline Efficiency
- Critical: Caching Deep Dive
- Advanced: Multi-Project Management
For Security Teams
- Start: Security Scanning
- Process: Vulnerability Management
- Policy: Security Policies
- Compliance: Compliance Frameworks
For Platform Architects
- Architecture: Agent Platform Architecture
- Standards: OSSA Integration
- Scale: 70+ Project Strategy
- Observability: Monitoring & Tracing
01 UI Navigation
Complete guide to every menu, feature, and capability in GitLab Ultimate UI
- Overview - Complete UI structure and navigation
- Project Menus - All 10 project-level menus (Plan, Code, Build, Secure, Deploy, Operate, Monitor, Analyze)
- Group Features - Portfolio management, Epics, Roadmaps
- Admin Area - Instance administration
- Ultimate Only - Premium vs Ultimate comparison (77+ exclusive features)
Coverage: 200+ features documented with navigation paths, use cases, and best practices
02 Agent Platform
GitLab Duo Agent Platform (GA: January 2026) - Intelligent workflow automation
- README - Documentation hub
- Overview - Core concepts: Agents, Triggers, Flows, Actions
- Architecture - Three-layer system, MCP integration
- Triggers - Event-driven agent activation
- Flows - YAML-based workflow orchestration
- Agents - Foundational and custom agents
- Integration - CI/CD integration with OIDC
- Best Practices - Production patterns
Key Features:
- Multi-agent parallelism
- Custom flows (YAML-based)
- Model Context Protocol (MCP)
- OIDC authentication
- Complete observability
Pre-built Flows:
- Software Development Flow (88% success rate)
- Issue-to-MR Flow
- Convert CI File Flow (Jenkins, GitHub Actions, CircleCI, Travis, Azure)
03 OSSA
Open Standard for Scalable AI Agents - Vendor-neutral agent definitions
- Overview - OSSA introduction and specification
- Specification - Complete YAML schema (v0.3.3)
- GitLab Integration - Native GitLab support
- Building Agents - Creating OSSA agents
- Ecosystem - Agent registry and discovery
- Best Practices - Production patterns
What is OSSA?
- Vendor-neutral agent manifests (like OpenAPI for AI agents)
- Multi-platform compatibility (LangChain, CrewAI, AutoGen)
- GitLab Duo Platform integration
- Kubernetes-native deployment
- Type-safe SDKs (TypeScript, Python)
Complementary Standards:
- Agent Skills (Anthropic) - Procedural knowledge
- MCP (Model Context Protocol) - Tool connectivity
- OASF - Agent discovery
04 CI/CD
Cost-optimized, efficient CI/CD pipelines - CRITICAL FOR COST SAVINGS
- Cost Optimization START HERE - Prevent wasted CI minutes
- Caching - Docker layer caching, dependencies (30-50% time reduction)
- Pipeline Efficiency - DAG optimization, parallelization
- Validation - Pre-push testing (gitlab-ci-local, pre-commit hooks)
- Components - Reusable CI/CD components
- Patterns - Common pipeline patterns
- Multi-Project - Managing 70+ projects
- Monitoring - CI/CD analytics and alerts
Expected Savings: 60-70% cost reduction
Quick Wins (Implement Today):
- Enable interruptible jobs † 30-50% savings
- Skip draft MR pipelines † 20-30% savings
- Add pre-flight validation † 50-80% savings on failures
- Right-size runners † 30-50% savings
- Path-based rules † 40-60% savings (monorepos)
05 Components
Reusable CI/CD components for 70+ project management
- README - Component documentation hub
- Overview - What are components?
- Creating Components - Building reusable templates
- Using Components - Consuming components
- Multi-Project Strategy - Managing 70+ projects
- Versioning - Semantic versioning for components
- Governance - Change management policies
- Patterns - Common component patterns
- Testing - Component testing strategies
Key Concepts:
- Centralized component library
- Version tiers (Stable, Current, Preview, Deprecated)
- 5-phase rollout process
- Automation for 70+ projects
- RFC process for breaking changes
06 Versioning
Semantic versioning, release automation, changelog generation
- README - Versioning documentation hub
- SemVer - Semantic versioning guide
- Automation - Automated version bumping
- Release Branches - release/vX.Y.x strategy
- Changelog - Automated changelog generation
- Releases - GitLab releases
- Conventional Commits - Commit standards
- Multi-Project - Versioning across projects
Your Strategy:
- Release branches:
release/v0.X.x - Auto-patching on merge
- Group milestones (v0.X.x)
- Conventional Commits
- semantic-release automation
07 Security
GitLab Ultimate security and compliance features
- Scanning - SAST, DAST, Dependency, Container, Secret, License, API
- Vulnerability Management - Triage and remediation
- Compliance - SOC 2, GDPR, HIPAA, ISO 27001
- Access Control - Branch protection, approvals, CODEOWNERS
- Policies - Security policies (scan execution, scan result)
- Secrets - OIDC, Vault, AWS, GCP integration
- Supply Chain - SBOM, dependencies, provenance
Features:
- 8 security scanners
- Automated compliance frameworks
- Group-level security policies
- OIDC authentication
- SBOM generation (CycloneDX)
08 Observability
Production-grade monitoring, tracing, and analytics
- Tracing - OpenTelemetry distributed tracing
- Error Tracking - Error aggregation and alerting
- Logs - ClickHouse log aggregation
- Metrics - Prometheus time-series metrics
- APM - Application performance monitoring
- CI/CD Analytics - Pipeline performance
- DORA Metrics - DevOps performance
- Dashboards - Visualization and reporting
- Alerting - Alert rules and notifications
Features:
- OpenTelemetry tracing (beta)
- ClickHouse-powered analytics
- DORA metrics (deployment frequency, lead time, MTTR, change failure rate)
- Custom dashboards
- Multi-channel alerting
09 AI/Duo
GitLab Duo and AI-powered features (2025/2026)
- README - AI documentation hub
- Overview - GitLab Duo platform
- Code Assistance - Code Suggestions, Chat
- CI/CD AI - Root cause analysis, pipeline fixes
- Security AI - Vulnerability explanations, false positive detection
- Planning AI - Issue refinement, work breakdown
- Agents - Agent Platform development
- API - Programmatic AI integration
- Best Practices - When and how to use AI
Major Update - GitLab 18.0 (May 2025):
- Code Suggestions and Chat included in Premium/Ultimate (no extra cost)
- Claude Sonnet 4 as default model
- 1.5M developers using GitLab AI
GitLab 18.7 (December 2025):
- SAST False Positive Detection (90% confidence)
- Planner Agent Beta
- Secret Validity Checks
- 6-month Duo Analytics Dashboard
Agent Platform GA: January 2026
- Multi-agent parallelism
- Custom flows (YAML)
- Model Context Protocol (MCP)
- Software Development Flow (88% success rate)
10 Cost Optimization
CRITICAL: Preventing wasted CI minutes across 70+ projects
- README - Cost optimization hub
- Overview - Cost factors and quick wins
- Tracking - Usage monitoring and alerts
- Strategies - 11 reduction strategies
- Caching Deep Dive - Comprehensive caching
- Pipeline Optimization - Efficiency patterns
- Pre-Push Validation - Testing before CI
- Monitoring - Cost dashboards and alerts
- Checklist - Daily/weekly/monthly tasks
Expected Impact: 60-70% total cost reduction
Immediate Actions:
- Read Overview (30 min)
- Apply Quick Wins (2-4 hours)
- Set up Monitoring (1 hour)
- Implement Pre-Push Validation (2 hours)
Documentation Statistics
- Total Files: 80+ comprehensive markdown documents
- Total Size: ~6MB of technical documentation
- Total Lines: ~40,000+ lines
- Code Examples: 500+ working configurations
- Coverage: 100% of GitLab Ultimate features
Critical Priorities
Immediate (This Week)
- Cost Optimization - Stop burning CI minutes
- Pre-Push Validation - Prevent failed pipelines
- Usage Tracking - Set up budget alerts
Short-Term (This Month)
- Component Strategy - Manage 70+ projects
- CI/CD Efficiency - Optimize pipelines
- Security Scanning - Enable all scanners
Long-Term (This Quarter)
- Agent Platform - Implement AI workflows
- Observability - Production monitoring
- DORA Metrics - Track DevOps performance
Finding Information
By Role
Developers:
- Start: UI Navigation
- Learn: Agents
- Code: AI Assistance
DevOps/SRE:
- Cost: Optimization
- Pipelines: CI/CD
- Monitor: Observability
Security:
- Scan: Scanning
- Comply: Compliance
- Secrets: Management
Architects:
- Scale: Components
- Standards: OSSA
- Platform: Architecture
By Topic
Cost Management:
- 10 - Cost Optimization
- 04 - CI/CD (efficiency focus)
Multi-Project:
AI & Automation:
Security & Compliance:
Production Readiness:
Common Issues and Solutions
"We're burning too many CI minutes"
† Start: Cost Optimization Overview † Quick wins: Strategies † Tracking: Monitoring
"Pipelines are too slow"
† Caching: Caching Deep Dive † Optimization: Pipeline Efficiency † Patterns: CI/CD Patterns
"Managing 70+ projects is overwhelming"
† Strategy: Multi-Project Strategy † Components: Creating Components † Governance: Governance
"Security scans are failing MRs"
† Scanning: Security Scanning † Triage: Vulnerability Management † Policies: Security Policies
"How do I use AI agents?"
† Start: Agent Platform Overview † Build: Building Agents † Integrate: CI/CD Integration
External Resources
Official GitLab
GitLab Duo
Community
Tools
- gitlab-ci-local - Local pipeline testing
- glab CLI - GitLab command-line tool
- semantic-release - Automated versioning
Contributing
This documentation is maintained as part of the Agent Platform technical documentation. Updates should follow:
-
File Policy:
- Documentation in GitLab Wiki (not .md files in repos)
- Technical docs in
_WIKIs/technical-docs.wiki/ - No .sh files - use npm scripts or TypeScript tools
-
Git Workflow:
- Issue-driven development
- Release branch strategy (
release/v0.X.x) - Conventional Commits
- Group milestones
-
Quality Standards:
- Comprehensive examples
- Real-world use cases
- Cited sources
- Production-ready patterns
Version History
- 2026-01-08: Initial comprehensive documentation release
- 10 major sections covering all GitLab Ultimate features
- 80+ documentation files
- Focus on cost optimization and multi-project management
- GitLab 18.7 (December 2025) features included
- Agent Platform GA preparation (January 2026)
How to Use This Documentation
First Time Here?
- Read this README completely
- Identify your role (Developer, DevOps, Security, Architect)
- Follow the "Quick Start Path" for your role
- Bookmark frequently used sections
Looking for Something Specific?
- Check the Quick Navigation table
- Use the Finding Information section
- Search for keywords in section descriptions
Implementing Best Practices?
- Start with Cost Optimization if burning CI minutes
- Review CI/CD Best Practices
- Implement Components for multi-project management
- Enable Security Scanning
- Set up Observability
Building with Agents?
- Understand Agent Platform
- Learn OSSA standards
- Review AI/Duo capabilities
- Follow Best Practices
This documentation represents the most comprehensive guide to GitLab Ultimate available, specifically tailored for production-grade software development in a multi-project environment.
Last Updated: 2026-01-08 GitLab Version: 18.7 (December 2025) Agent Platform: GA preparation (January 2026)