🗺 Introduce a Production Landscape Diagram

[janhalen]

🎯 Goals

• Support expansion of member base: Clear documentation can help potential interested new members understand the infrastructure, making it easier for them to evaluate the project.
• Attract Collaborators: A well-documented production environment can attract more developers and contributors by providing a clear understanding of the setup.
• Improved Understanding: Helps new members of our community quickly grasp the setup and facilitates better communication among team members and stakeholders.
• Documentation and Compliance: Aids in compliance with industry standards, governance and regulations.
• Optimization and Planning: Assists in identifying areas for optimization and planning future roadmaps.

After a talk with @sobuos we agreed it would be valuable to add a production landscape diagram to the project's documentation.

The diagram should visually represent the following aspects of the production instance:

1. Hosting Provider:

   • Name and (country)location of the current hosting company.
   • Simple specifications of the current hosting environment. (Baremetal, Openshift or K8s? What OS choices are made for nodes and infrastructure etc.)

2. Deployment Technologies:

   • Technologies and tools used for deploying the project. (GitOps with ArgoCD or flux?, Terraform/OpenTofu for IaC? etc.)
   • Any services, repositories etc. involved in the deployment process. (e.g. : "private deployment-repo owned by XXX", located @xxx? )

3. Operational Technologies:

   • Technologies used to operate and maintain the production instance.

This diagram will provide a clear and comprehensive overview of the production setup, making it easier for team members to understand and manage the deployment and hosting processes.

It would be preferred in Markdown / Mermaid format for version controllability…

[janhalen]

To inspire i mocked this diagram up representing my limited knowledge og the projects production landscape:

flowchart TD
 subgraph subGraph0["Deployment Pipeline @ Company?"]
        J{{"Infrastructure as Code"}}
  end
    M["os2fleetoptimizer<br>GitHub<br>Repository"] -. Contains .- N["Source Code"]
    M --> H{{"GitHub Actions<br>CI Pipeline"}}
    H -- Builds --> n1["Container Images <br>"]
    subGraph0 -- Webhook --> H
    subGraph0 --> K["Operations Hosting @ <br>Provider X in <br>🇩🇰 Denmark"] & n2["Test Instance @<br>Provider Y in<br>??"]
    subGraph0 -- Pulls --> n1
    K ~~~ M

    M@{ shape: cyl}
    N@{ shape: card}
    n1@{ shape: h-cyl}
    K@{ shape: display}
    n2@{ shape: display}
     N:::Peach
     n1:::Aqua
    classDef Aqua stroke-width:1px, stroke-dasharray:none, stroke:#46EDC8, fill:#DEFFF8, color:#378E7A
    classDef Peach stroke-width:1px, stroke-dasharray:none, stroke:#FBB35A, fill:#FFEFDB, color:#8F632D
    style J fill:#D5E8D4,stroke:#B7D7A8,stroke-width:2px, color:#2E4A2E
    style M fill:#FFF2CC,stroke:#F9E79F,stroke-width:2px, color:#5C5C3D
    style H fill:#D5E8D4,stroke:#B7D7A8,stroke-width:2px, color:#2E4A2E
    style subGraph0 stroke:none,fill:#C8E6C9, color:#2E4A2E
    style K fill:#A9DFBF,stroke:#D5E8D4,stroke-width:2px, color:#2E4A2E
    style n2 fill:#D5E8D4,stroke:#B7D7A8,stroke-width:2px, color:#2E4A2E

Loading

Feel free to take inspiration from this diagram...

[janhalen]

We are aware of the more technology heavy and general descrption here:

https://os2fleetoptimiser.github.io/OS2fleetoptimiser-docs/production.html

But an understanding of the current platforms, hosting centres and suppliers and the deployment pipeline would be a valuable addition to the docs