Skip to content

User-oriented Architecture Guide #3578

Open
@mpstefan

Description

@mpstefan

As a user or potential user of NGF
I want an architecture document that gives me a high level overview of NGF's architecture
So that I can understand how to operate and deploy NGF in my environment.

Acceptance

  • The current architecture documentation page is reworked to focus solely on the usage and operation of NGF for users.
  • All information that is only relevant for contributors is relegated to another developer-oriented architecture guide.
  • A clear and visible description of what NGF's control and data planes are present.
  • Diagrams should be limited to demonstrate one relationship between components at maximum.
    • Traffic flow and configuration flow should not be present in the same diagram.
  • A link to the developer architecture documentation is present at the top of the page when possible.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    Status

    🆕 New

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions