Documentation about question OOIs

[Donnype]

Issue links with info and schematics:

• Question OOIs with json-schema #288

PRs

• Add Question ooi model and create the first bit that generates a question #1407
• Add Question OOI form rendering on the object detail page #1408
• Add answer normalizer to create Config OOI #1409

Diagrams and technical explanation

Config flow and cardinality:

classDiagram

direction RL
    class Question
    class Config
    class JsonAnswer
    class JsonAnswer2["JsonAnswer"]

    Question : ooi[OOI]
    Question : schema[str]

    Config : ooi[OOI]
    Config : config[str]
    Config : bit_id[str]

    OOI <|-- Question
    Question <|-- JsonAnswer
    Question <|-- JsonAnswer2
    JsonAnswer <|-- Config
    JsonAnswer2 <|-- Config

Loading

Resulting ERD:

classDiagram

direction RL
    class Question
    class Config
    class OOI

    Question : ooi[OOI]
    Question : schema[str]

    Config : ooi[OOI]
    Config : config[str]
    Config : bit_id[str]

    OOI <|-- Question
    OOI <|-- Config

Loading

The Flow of creating Configs through Questions

sequenceDiagram
    participant User
    participant Rocky
    participant Normalizer
    participant Octopoes
    participant Bits
    participant Bytes

    Normalizer->>Octopoes: Add Network
    Bits->>Octopoes: Add Question["What ports may be open for this Network?"]
    Rocky->>Octopoes: Get Question
    Rocky->>User: Prompt Question to user
    User->>Rocky: Give answer (form)
    Rocky->>Bytes: Add answer (json) to Bytes
    Bytes->>Normalizer: Read answer
    Normalizer->>Octopoes: Create Config
    Bits->>Octopoes: Read Config

Loading

---

To create a question OOI in Rocky:

• Rebuild Rocky and the boefjes/normalizers (Or: make kat)
• Add a Network object
• Increase its clearance level to at least L2
• Wait a few seconds and refresh the objects page (perhaps filter on Question objects)
• Open the Question detail page and see the json form rendered.