fotoobo Architecture Documentation

This documentation describes the architecture of fotoobo which means

• The goals, constraints and scope of fotoobo

• The structure of fotoobo

• Common patterns

This part of the documentation is based on the Arc42 template.

Together with the Collective Code Construction Contract and the fotoobo Module Documentation it builds the developer documentation of fotoobo.

• 1. Introduction and Goals
  • Goals
  • Supported Fortinet products
  • Core use cases
  • fotoobo vs. Fortinet REST API
  • fotoobo vs. Fortinet ansible module
• 2. Constraints
  • The Fortinet-APIs
• 3. Context & Scope
  • Context
  • Scope
• 4. Solution Strategy
  • Design Goals
  • Core building blocks
  • Decoupling of the building blocks
  • Getting data from the respective devices
  • Used Frameworks
    • Runtime Requirements
    • For Development
• 5. Building Block View
  • The layers of fotoobo
    • The Interface Layer
    • The Business Logic Layer
    • The Infrastructure Layer
  • Package structure
  • Class view
• 6. Runtime & Deployment View
• 7. Crosscutting concepts
  • Separation of Input, Output and Processing
  • Common Result class
  • Parallelization
• 8. Quality Assurance
  • Quality Goals
  • How quality assurance is done
    • Testing, Types & Linting
    • Four eyes principle
    • Extensive Documentation
• 9. Risks & Technical Depths
  • Use of undocumented API parts
    • Description
    • Risk
    • Mitigation
  • Use of unencrypted inventory including credentials
    • Description
    • Risk
    • Mitigation