Module Index¶
Canonical navigation surface for HybridOps.Core modules.
Operator interface¶
Modules are executed via hyops:
hyops apply --module <module_ref> [--inputs <file>.yml] [--root <path>]hyops init <target>for prerequisite runtime inputs (for examplehyops init gcp)
Module identifiers use the canonical form <domain>/<provider>/<capability> (for example org/gcp/project-factory).
Normative references¶
hyops initcontract- Init target annexes
- Evidence and redaction
- Runtime root and packaging
- Naming and path conventions
Related reference¶
Core runtime¶
| Item | Purpose | Runbook | HOWTO |
|---|---|---|---|
| HybridOps.Core runtime | Install hyops, initialise local state, validate workstation readiness |
Install and initialise HybridOps.Core | Install and verify HybridOps.Core |
Modules¶
| Module | Outcome | Primary inputs | Primary outputs | Runbook | HOWTO | Maturity |
|---|---|---|---|---|---|---|
org/gcp/project-factory |
Create or converge a GCP project using Project Factory. | project_id, billing_account_id, org_id or folder_id, optional labels/APIs. |
Project id, SA email(s) (if exposed), evidence bundle. | TBD | TBD | Candidate |
core/gcp/network |
Create baseline GCP VPC/network. | Network intent inputs. | Network ids, subnets, routes, evidence bundle. | TBD | TBD | Planned |
core/gcp/cloud-router |
Create Cloud Router routing primitive. | Router intent inputs. | Router id, BGP config outputs, evidence. | TBD | TBD | Planned |
core/gcp/vpn-to-vps |
Create route-based VPN to an external VPS. | Tunnel intent inputs. | Tunnel ids, BGP status outputs, evidence. | TBD | TBD | Planned |
platform/gcp/artifact-registry |
Deliver Artifact Registry baseline. | Repo definitions and labels. | Repo ids/urls, evidence. | TBD | TBD | Planned |
platform/gcp/secret-manager |
Deliver Secret Manager baseline. | Secret set definitions. | Secret ids, evidence. | TBD | TBD | Planned |
core/azure/resource-group |
Create Azure RG baseline. | RG name/location. | RG id/name, evidence. | TBD | TBD | Planned |
core/azure/vnet |
Create Azure VNet baseline. | VNet intent inputs. | VNet ids/subnets, evidence. | TBD | TBD | Planned |
core/azure/nat-gateway |
Create NAT gateway egress primitive. | Egress intent inputs. | NAT ids, evidence. | TBD | TBD | Planned |
core/hetzner/edge-network |
Establish Hetzner edge networking baseline. | Network intent inputs. | Network ids, evidence. | TBD | TBD | Planned |
core/hetzner/edge-servers |
Provision Hetzner edge compute baseline. | Server intent inputs. | Server ids/ips, evidence. | TBD | TBD | Planned |
core/hetzner/edge-firewall |
Apply edge firewall policy. | Policy inputs. | Rule inventory, evidence. | TBD | TBD | Planned |
core/onprem/network-sdn |
Enforce on-prem network segmentation contract. | SDN contract inputs. | SDN objects, exports, evidence. | TBD | TBD | Candidate |
platform/onprem/control-node |
Provision baseline control-node capability. | Host intent inputs. | Host endpoints, evidence. | TBD | TBD | Planned |
platform/onprem/netbox |
Deploy NetBox as inventory/IPAM service. | NetBox config inputs. | URL/credentials ref, evidence. | TBD | TBD | Planned |
platform/onprem/postgresql-core |
Deploy PostgreSQL core service. | DB intent inputs. | Endpoint/connection refs, evidence. | TBD | TBD | Planned |
examples/core/hello-world |
Validate apply flow end-to-end (smoke test). | message and optional demo values. |
echo output, evidence bundle. |
TBD | TBD | Available |
Module detail sheets¶
org/gcp/project-factory¶
Details
Outcome
Create or converge a GCP project using Project Factory.
Pack
- gcp/org/00-project-factory@v1.0
Dependencies
- hyops init gcp readiness for credentials/impersonation where required.
core/gcp/network¶
Details
Outcome
Create baseline GCP VPC/network.
Pack
- TBD
Dependencies
- org/gcp/project-factory (target project must exist).
core/gcp/cloud-router¶
Details
Outcome
Create Cloud Router routing primitive.
Pack
- TBD
Dependencies
- core/gcp/network (target VPC must exist).
core/gcp/vpn-to-vps¶
Details
Outcome
Create route-based VPN to an external VPS.
Pack
- TBD
Dependencies
- core/gcp/cloud-router (Cloud Router must exist).
platform/gcp/artifact-registry¶
Details
Outcome
Deliver Artifact Registry baseline.
Pack
- TBD
Dependencies
- org/gcp/project-factory (target project must exist).
platform/gcp/secret-manager¶
Details
Outcome
Deliver Secret Manager baseline.
Pack
- TBD
Dependencies
- org/gcp/project-factory (target project must exist).
core/azure/resource-group¶
Details
Outcome
Create Azure RG baseline.
Pack
- TBD
Dependencies
- Azure subscription and credentials.
core/azure/vnet¶
Details
Outcome
Create Azure VNet baseline.
Pack
- TBD
Dependencies
- core/azure/resource-group (target RG must exist).
core/azure/nat-gateway¶
Details
Outcome
Create NAT gateway egress primitive.
Pack
- TBD
Dependencies
- core/azure/vnet (target VNet must exist).
core/hetzner/edge-network¶
Details
Outcome
Establish Hetzner edge networking baseline.
Pack
- TBD
Dependencies
- Hetzner API credentials.
core/hetzner/edge-servers¶
Details
Outcome
Provision Hetzner edge compute baseline.
Pack
- TBD
Dependencies
- core/hetzner/edge-network (network must exist).
core/hetzner/edge-firewall¶
Details
Outcome
Apply edge firewall policy.
Pack
- TBD
Dependencies
- core/hetzner/edge-servers (servers must exist).
core/onprem/network-sdn¶
Details
Outcome
Enforce on-prem network segmentation contract.
Pack
- TBD
Dependencies
- Proxmox API access and permissions.
platform/onprem/control-node¶
Details
Outcome
Provision baseline control-node capability.
Pack
- TBD
Dependencies
- core/onprem/network-sdn (network segmentation in place).
platform/onprem/netbox¶
Details
Outcome
Deploy NetBox as inventory/IPAM service.
Pack
- TBD
Dependencies
- platform/onprem/control-node (host baseline ready).
platform/onprem/postgresql-core¶
Details
Outcome
Deploy PostgreSQL core service.
Pack
- TBD
Dependencies
- platform/onprem/control-node (host baseline ready).
examples/core/hello-world¶
Details
Outcome
Validate hyops apply and driver evidence capture end-to-end.
Pack
- hello-world
Legacy¶
2026E/image-factory¶
Details
Outcome
Produce immutable, versioned images/templates for provisioning modules.
Module contract
- TBD
Primary inputs
- Packer variables and base image sources.
- Target platform credentials (as required by the selected builder).
Primary outputs
- Template IDs / image references (published via outputs.json).
- Build metadata (versions, checksums where applicable).
- Evidence bundle.
Dependencies
- None (typically the first module in a chain).
Uses
- Drivers: images/packer
- Ansible: optional; see Ansible collections
Operator procedure
- Runbook: TBD
- HOWTO: TBD
Evidence
Evidence requirements are defined by the module contract and the evidence standard.
2026E/sdn-proxmox¶
Details
Outcome
Enforce the SDN segmentation contract on Proxmox as the on-prem foundation.
Module contract
- TBD
Primary inputs
- Proxmox API credentials and target cluster identifiers.
- SDN contract inputs (zones, VNets, VLANs, DHCP pools, routing intent).
Primary outputs
- SDN object inventory (created/updated primitives).
- DHCP pool and routed segmentation evidence.
- Export artefacts where implemented.
Dependencies
- None (assumes Proxmox access and permissions are already established).
Uses
- Drivers: iac/terraform; inventory/netbox (optional)
- Ansible: optional; see Ansible collections
Operator procedure
- Runbook: TBD
- HOWTO: TBD
Evidence
Evidence requirements are defined by the module contract and the evidence standard.
2026E/ctrlplane-zerotouch¶
Details
Outcome
Provision the control plane host(s) and baseline services required to run the platform.
Module contract
- TBD
Primary inputs
- Target environment and provider credentials.
- Template IDs / image references (from image-factory).
- Network contract (from sdn-proxmox) where applicable.
Primary outputs
- Control-plane endpoints.
- Bootstrap inventory/connection metadata.
- outputs.json for downstream modules.
Dependencies
- 2026E/image-factory
- 2026E/sdn-proxmox where applicable
Uses
- Drivers: iac/terraform; inventory/netbox
- Ansible: see Ansible collections
Operator procedure
- Runbook: TBD
- HOWTO: TBD
Evidence
Evidence requirements are defined by the module contract and the evidence standard.
2026E/argocd-bootstrap¶
Details
Outcome
Establish GitOps control surface (Argo CD) for workload reconciliation.
Module contract
- TBD
Primary inputs
- Kubernetes access for the target cluster.
- Workloads repository endpoint and authentication model.
Primary outputs
- Argo CD installed and reachable.
- Repo registration and baseline sync policy.
- Bootstrap application seeded.
Dependencies
- A reachable Kubernetes cluster.
Uses
- Drivers: k8s/argocd
- Workloads: HybridOps.Workloads repository
Operator procedure
- Runbook: TBD
- HOWTO: TBD
Evidence
Evidence requirements are defined by the module contract and the evidence standard.
2026E/gitops-observability¶
Details
Outcome
Deliver the observability baseline as reconciled desired state.
Module contract
- TBD
Primary inputs
- Target environment and cluster context.
- Workloads repository and environment overlay target.
Primary outputs
- Observability workloads reconciled.
- Dashboards and alert rules applied where applicable.
- Evidence bundle.
Dependencies
- 2026E/argocd-bootstrap
- Workloads repository reachable.
Uses
- Drivers: k8s/argocd
- Workloads: observability overlays
Operator procedure
- Runbook: TBD
- HOWTO: TBD
Evidence
Evidence requirements are defined by the module contract and the evidence standard.
Maintenance¶
This index lists modules by stable module_ref and links to operator procedures where available. Update entries when modules are introduced, promoted, deprecated, or superseded.