# vmware/vcf-upgrade-planner architecture

> Architecture diagram of the GitHub repository vmware/vcf-upgrade-planner, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vmware/vcf-upgrade-planner
- Repository: https://github.com/vmware/vcf-upgrade-planner

## Overview

This is a browser-based VCF upgrade-planning tool. Users choose an upgrade scenario, follow phased guidance, review networking and resource requirements, and can export the deliverables as a PDF. The tree shows scenario-specific HTML and JSON under `docs/`, plus a generated `site/` with client-side search. The README documents the planning workflow and PDF export, but the scenario-page wiring and export implementation were not excerpted; those links are therefore dashed and unverified.

Main entry points: [`docs`](https://github.com/vmware/vcf-upgrade-planner/tree/main/docs) (Scenario guidance), [`site/search/worker.js`](https://github.com/vmware/vcf-upgrade-planner/blob/main/site/search/worker.js) (Search worker), [`docs/index.html`](https://github.com/vmware/vcf-upgrade-planner/blob/main/docs/index.html) (Planner entry), [`site/js/base.js`](https://github.com/vmware/vcf-upgrade-planner/blob/main/site/js/base.js) (Site interface)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_planning["Upgrade planning"]
  node_planner["Planner entry<br/>[index.html]"]
  node_pdf["PDF deliverables"]
end

subgraph group_content["Scenario content"]
  node_scenario["Scenario guidance"]
  node_scenario_data["Scenario data"]
  node_compat["Compatibility data<br/>[compat-data.json]"]
  node_diagrams["Upgrade diagrams<br/>[diagram.js]"]
  node_inline["Interactive guidance<br/>[docs_inline.js]"]
end

subgraph group_experience["Browser experience"]
  node_site_ui["Site interface<br/>[base.js]"]
  node_theme["Theme controls<br/>[darkmode.js]"]
end

subgraph group_search["Site search"]
  node_search_ui["Search interface<br/>[main.js]"]
  node_search_worker["Search worker<br/>[worker.js]"]
  node_lunr["Lunr engine<br/>[lunr.js]"]
  node_search_index["Search index<br/>[search_index.json]"]
end

node_visitor(("Planner user"))

node_visitor -.->|"opens"| node_planner
node_planner -.->|"selects scenario"| node_scenario
node_scenario -.->|"uses scenario data"| node_scenario_data
node_scenario -.->|"renders guidance"| node_diagrams
node_scenario -.->|"enables interactions"| node_inline
node_scenario -.->|"consults compatibility"| node_compat
node_planner -.->|"exports PDF"| node_pdf
node_visitor -.->|"uses"| node_site_ui
node_site_ui -.->|"provides theme controls"| node_theme
node_search_ui -->|"posts queries"| node_search_worker
node_search_worker -->|"returns results"| node_search_ui
node_search_worker -->|"loads index"| node_search_index
node_search_worker -->|"builds or loads index"| node_lunr

click node_planner "https://github.com/vmware/vcf-upgrade-planner/blob/main/docs/index.html"
click node_scenario "https://github.com/vmware/vcf-upgrade-planner/tree/main/docs"
click node_scenario_data "https://github.com/vmware/vcf-upgrade-planner/tree/main/docs"
click node_compat "https://github.com/vmware/vcf-upgrade-planner/blob/main/docs/compat-data.json"
click node_diagrams "https://github.com/vmware/vcf-upgrade-planner/blob/main/docs/diagram.js"
click node_inline "https://github.com/vmware/vcf-upgrade-planner/blob/main/docs/docs_inline.js"
click node_site_ui "https://github.com/vmware/vcf-upgrade-planner/blob/main/site/js/base.js"
click node_search_ui "https://github.com/vmware/vcf-upgrade-planner/blob/main/site/search/main.js"
click node_search_worker "https://github.com/vmware/vcf-upgrade-planner/blob/main/site/search/worker.js"
click node_lunr "https://github.com/vmware/vcf-upgrade-planner/blob/main/site/search/lunr.js"
click node_search_index "https://github.com/vmware/vcf-upgrade-planner/blob/main/site/search/search_index.json"
click node_theme "https://github.com/vmware/vcf-upgrade-planner/blob/main/site/js/darkmode.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_planner,node_pdf,node_visitor toneBlue
class node_scenario,node_scenario_data,node_compat,node_diagrams,node_inline toneAmber
class node_site_ui,node_theme toneMint
class node_search_ui,node_search_worker,node_lunr,node_search_index toneRose
```

## Components

### Upgrade planning

- [Planner entry](https://github.com/vmware/vcf-upgrade-planner/blob/main/docs/index.html): `docs/index.html`
- **PDF deliverables**

### Scenario content

- [Scenario guidance](https://github.com/vmware/vcf-upgrade-planner/tree/main/docs): `docs`
- [Scenario data](https://github.com/vmware/vcf-upgrade-planner/tree/main/docs): `docs`
- [Compatibility data](https://github.com/vmware/vcf-upgrade-planner/blob/main/docs/compat-data.json): `docs/compat-data.json`
- [Upgrade diagrams](https://github.com/vmware/vcf-upgrade-planner/blob/main/docs/diagram.js): `docs/diagram.js`
- [Interactive guidance](https://github.com/vmware/vcf-upgrade-planner/blob/main/docs/docs_inline.js): `docs/docs_inline.js`

### Browser experience

- [Site interface](https://github.com/vmware/vcf-upgrade-planner/blob/main/site/js/base.js): `site/js/base.js`
- [Theme controls](https://github.com/vmware/vcf-upgrade-planner/blob/main/site/js/darkmode.js): `site/js/darkmode.js`

### Site search

- [Search interface](https://github.com/vmware/vcf-upgrade-planner/blob/main/site/search/main.js): `site/search/main.js`
- [Search worker](https://github.com/vmware/vcf-upgrade-planner/blob/main/site/search/worker.js): `site/search/worker.js`
- [Lunr engine](https://github.com/vmware/vcf-upgrade-planner/blob/main/site/search/lunr.js): `site/search/lunr.js`
- [Search index](https://github.com/vmware/vcf-upgrade-planner/blob/main/site/search/search_index.json): `site/search/search_index.json`

### Other components

- **Planner user**

## Connections

- Planner user → Planner entry: opens (evidence: `README.md`)
- Planner entry → Scenario guidance: selects scenario (evidence: `README.md`)
- Scenario guidance → Scenario data: uses scenario data
- Scenario guidance → Upgrade diagrams: renders guidance
- Scenario guidance → Interactive guidance: enables interactions
- Scenario guidance → Compatibility data: consults compatibility
- Planner entry → PDF deliverables: exports PDF (evidence: `README.md`)
- Planner user → Site interface: uses
- Site interface → Theme controls: provides theme controls
- Search interface → Search worker: posts queries (evidence: `site/search/main.js`)
- Search worker → Search interface: returns results (evidence: `site/search/main.js`)
- Search worker → Search index: loads index (evidence: `site/search/worker.js`)
- Search worker → Lunr engine: builds or loads index (evidence: `site/search/worker.js`)
