Sync READMEs: add missing guides and example configs
README.md: add networking, shared-storage, production-lab guides; reorder notes in learning sequence. CLAUDE.md: add production-lab, version-compat, iso-download to structure. incusos/README.md: add 5 missing example configs, organize by category. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
2f04a4838c
commit
ccd8e87be6
|
|
@ -28,9 +28,12 @@ incu-contrib/
|
||||||
└── notes/ # Research notes and reference material
|
└── notes/ # Research notes and reference material
|
||||||
├── clustering-guide.md # Detailed Incus clustering walkthrough
|
├── clustering-guide.md # Detailed Incus clustering walkthrough
|
||||||
├── operations-center-guide.md # Operations Center provisioning & management
|
├── operations-center-guide.md # Operations Center provisioning & management
|
||||||
├── networking-guide.md # OVN overlay networking tutorial (bridge + OVN + LAN)
|
├── networking-guide.md # OVN overlay networking tutorial (bridge + OVN + LAN)
|
||||||
├── shared-storage-guide.md # iSCSI + lvmcluster shared storage (tested)
|
├── shared-storage-guide.md # iSCSI + lvmcluster shared storage (tested)
|
||||||
|
├── production-lab-guide.md # Manual cluster + OVN + HA (validated end-to-end)
|
||||||
├── migration-guide.md # Migration paths into Incus from other hypervisors
|
├── migration-guide.md # Migration paths into Incus from other hypervisors
|
||||||
|
├── incus-version-compatibility.md # Incus versions across platforms
|
||||||
|
├── iso-download-methods.md # ISO download/customization research
|
||||||
└── utm-support.md # UTM support design document (future)
|
└── utm-support.md # UTM support design document (future)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
15
README.md
15
README.md
|
|
@ -27,19 +27,22 @@ See [`incusos/README.md`](incusos/README.md) for full documentation.
|
||||||
|
|
||||||
### [`notes/`](notes/)
|
### [`notes/`](notes/)
|
||||||
|
|
||||||
Research notes and reference material:
|
Guides and reference material (roughly in learning order):
|
||||||
|
|
||||||
- [`incus-version-compatibility.md`](notes/incus-version-compatibility.md) --
|
|
||||||
Incus package versions across platforms (macOS, Debian/Ubuntu, Arch),
|
|
||||||
install instructions, and certificate management notes.
|
|
||||||
- [`iso-download-methods.md`](notes/iso-download-methods.md) --
|
|
||||||
Original research on ISO download/customization approaches.
|
|
||||||
- [`clustering-guide.md`](notes/clustering-guide.md) --
|
- [`clustering-guide.md`](notes/clustering-guide.md) --
|
||||||
Detailed Incus clustering walkthrough (manual cluster formation via remotes).
|
Detailed Incus clustering walkthrough (manual cluster formation via remotes).
|
||||||
- [`operations-center-guide.md`](notes/operations-center-guide.md) --
|
- [`operations-center-guide.md`](notes/operations-center-guide.md) --
|
||||||
Operations Center provisioning, cluster management, and tested limitations.
|
Operations Center provisioning, cluster management, and tested limitations.
|
||||||
|
- [`networking-guide.md`](notes/networking-guide.md) --
|
||||||
|
OVN overlay networking tutorial (bridge + OVN + LAN access).
|
||||||
|
- [`shared-storage-guide.md`](notes/shared-storage-guide.md) --
|
||||||
|
iSCSI + lvmcluster shared storage for instant migration.
|
||||||
|
- [`production-lab-guide.md`](notes/production-lab-guide.md) --
|
||||||
|
Manual cluster + OVN + HA workloads (validated end-to-end).
|
||||||
- [`migration-guide.md`](notes/migration-guide.md) --
|
- [`migration-guide.md`](notes/migration-guide.md) --
|
||||||
Migration paths into Incus from Proxmox, UTM, VMware Fusion, and Docker.
|
Migration paths into Incus from Proxmox, UTM, VMware Fusion, and Docker.
|
||||||
|
- [`incus-version-compatibility.md`](notes/incus-version-compatibility.md) --
|
||||||
|
Incus package versions across platforms and install instructions.
|
||||||
- [`utm-support.md`](notes/utm-support.md) --
|
- [`utm-support.md`](notes/utm-support.md) --
|
||||||
Design document for future UTM support on macOS.
|
Design document for future UTM support on macOS.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -656,19 +656,31 @@ openssl pkcs12 -export \
|
||||||
|
|
||||||
See the [`examples/`](examples/) directory for sample seed configurations:
|
See the [`examples/`](examples/) directory for sample seed configurations:
|
||||||
|
|
||||||
|
**Seed templates:**
|
||||||
|
|
||||||
- [`incus-standalone.yaml`](examples/incus-standalone.yaml) -- Single Incus server with defaults
|
- [`incus-standalone.yaml`](examples/incus-standalone.yaml) -- Single Incus server with defaults
|
||||||
- [`incus-cluster-node.yaml`](examples/incus-cluster-node.yaml) -- Cluster node (no defaults)
|
- [`incus-cluster-node.yaml`](examples/incus-cluster-node.yaml) -- Cluster node (no defaults)
|
||||||
- [`ops-center.yaml`](examples/ops-center.yaml) -- Operations Center
|
- [`ops-center.yaml`](examples/ops-center.yaml) -- Operations Center
|
||||||
- [`network-static.yaml`](examples/network-static.yaml) -- Static network configuration
|
- [`network-static.yaml`](examples/network-static.yaml) -- Static network configuration
|
||||||
|
|
||||||
|
**Proxmox connection:**
|
||||||
|
|
||||||
- [`proxmox.yaml.example`](examples/proxmox.yaml.example) -- Proxmox connection config template
|
- [`proxmox.yaml.example`](examples/proxmox.yaml.example) -- Proxmox connection config template
|
||||||
- [`proxmox-lab.yaml`](examples/proxmox-lab.yaml) -- Proxmox: 4-VM lab (self-contained, includes proxmox: section)
|
|
||||||
- [`proxmox-minimal.yaml`](examples/proxmox-minimal.yaml) -- Proxmox: single standalone VM (self-contained)
|
**Lab configs (Proxmox deployment):**
|
||||||
- [`lab-cluster.yaml`](examples/lab-cluster.yaml) -- Proxmox: 3-node cluster (uses proxmox.yaml)
|
|
||||||
- [`lab-single.yaml`](examples/lab-single.yaml) -- Proxmox: single standalone node (uses proxmox.yaml)
|
- [`proxmox-lab.yaml`](examples/proxmox-lab.yaml) -- 4-VM lab (self-contained, includes proxmox: section)
|
||||||
- [`lab-advanced.yaml`](examples/lab-advanced.yaml) -- Proxmox: 3-node heterogeneous migration cluster
|
- [`proxmox-minimal.yaml`](examples/proxmox-minimal.yaml) -- Single standalone VM (self-contained)
|
||||||
- [`lab-oc.yaml`](examples/lab-oc.yaml) -- Proxmox: Operations Center + 3 nodes (uses proxmox.yaml)
|
- [`lab-single.yaml`](examples/lab-single.yaml) -- Single standalone node (uses proxmox.yaml)
|
||||||
- [`lab-oc-deploy.yaml`](examples/lab-oc-deploy.yaml) -- Proxmox: OC server only (for hybrid OC workflow)
|
- [`lab-cluster.yaml`](examples/lab-cluster.yaml) -- 3-node cluster (uses proxmox.yaml)
|
||||||
- [`lab-oc-nodes.yaml`](examples/lab-oc-nodes.yaml) -- Proxmox: 3 OC-managed nodes (requires `--iso`)
|
- [`lab-advanced.yaml`](examples/lab-advanced.yaml) -- 3-node heterogeneous migration cluster
|
||||||
|
- [`lab-production.yaml`](examples/lab-production.yaml) -- Production-like cluster (OVN + HA)
|
||||||
|
- [`lab-replace.yaml`](examples/lab-replace.yaml) -- Node replacement testing
|
||||||
|
- [`lab-networking.yaml`](examples/lab-networking.yaml) -- OVN networking lab
|
||||||
|
- [`lab-oc.yaml`](examples/lab-oc.yaml) -- Operations Center + 3 nodes (uses proxmox.yaml)
|
||||||
|
- [`lab-oc-deploy.yaml`](examples/lab-oc-deploy.yaml) -- OC server only (for hybrid OC workflow)
|
||||||
|
- [`lab-oc-nodes.yaml`](examples/lab-oc-nodes.yaml) -- 3 OC-managed nodes (requires `--iso`)
|
||||||
|
- [`lab-iscsi-target.yaml`](examples/lab-iscsi-target.yaml) -- iSCSI target reference config
|
||||||
|
|
||||||
## Platform Support
|
## Platform Support
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue