Architecture & Workflows Documentation Inventory¶
This directory contains documentation about the architecture, components, workflows, diagrams, deployment options, and integrations for the Secure CINC Auditor Kubernetes Container Scanning solution.
Contents¶
Components¶
- Components Overview - Core architectural components
- Components Inventory - Components documentation inventory
- Core Components - Details of main system components
- Security Components - Security-focused components
- Communication Patterns - Component communication patterns
Workflows¶
- Workflows Overview - End-to-end workflow processes
- Workflows Inventory - Workflows documentation inventory
- Standard Container Workflow - Workflow for standard containers
- Distroless Container Workflow - Workflow for distroless containers
- Sidecar Container Workflow - Workflow using sidecar approach
- Security Workflows - Security-focused workflows
Diagrams¶
- Diagrams Overview - WCAG-compliant architecture diagrams
- Diagrams Inventory - Diagrams documentation inventory
- Component Diagrams - Component visualization diagrams
- Workflow Diagrams - Workflow visualization diagrams
- Deployment Diagrams - Deployment visualization diagrams
Deployment¶
- Deployment Overview - Deployment architecture options
- Deployment Inventory - Deployment documentation inventory
- Script Deployment - Script-based deployment architecture
- Helm Deployment - Helm chart deployment architecture
- CI/CD Deployment - CI/CD integration deployment architecture
Integrations¶
- Integrations Overview - CI/CD integration architecture
- Integrations Inventory - Integrations documentation inventory
- GitHub Actions Integration - GitHub Actions integration architecture
- GitLab CI Integration - GitLab CI integration architecture
- GitLab Services Integration - GitLab Services integration architecture
- Custom Integrations - Custom integration architecture
Overview¶
The architecture documentation provides a comprehensive understanding of how the scanning system is designed, how the components interact, and the various workflows supported by the system. This information is valuable for both users seeking to understand how the system operates and for developers looking to extend or modify the system.
The documentation uses Mermaid diagrams extensively to visualize complex architectures, workflows, and system interactions, making it easier to understand the relationships between different components.