Reference
Architecture decisions, terminology, contribution guidance, and changelog. This section is the stable reference layer — things that change slowly and that the rest of the docs link back to.
Architecture Decisions
Architecture Decision Records (ADRs) document significant choices made in Nyxever — what was chosen, what alternatives were considered, and why the chosen option was preferred. ADRs are kept in the source repository rather than in these docs, because they are tightly coupled to specific versions of the codebase and benefit from git history.
Before proposing a change that touches the platform's fundamental architecture, read the ADRs for the affected area. Understanding what has already been decided — and why — makes proposals stronger and reduces the chance of re-litigating closed decisions without new information.
- Compute platform
- Accepted — Proxmox VE (KVM/QEMU virtual machines, LXC containers, Corosync clustering).
- Container orchestration
- Accepted — Kubernetes.
- Distributed storage
- Accepted — Ceph (RBD block, CephFS file, S3-compatible object).
- Local storage
- Accepted — ZFS / OpenZFS.
- Infrastructure-as-code tooling
- Open — under evaluation.
- Network overlay and encrypted tunnels
- Open — under evaluation (802.1Q VLANs, VXLAN/EVPN, IPsec and WireGuard protocol options).
- PKI and certificate issuance
- Open — under evaluation (X.509, ACME / RFC 8555, short-lived certificates).
- Secrets management
- Open — under evaluation (requirements: encryption, audit, leasing, rotation).
- Identity provider and federation
- Open — under evaluation (OIDC / OAuth 2.0, SAML 2.0, SCIM).
- AI inference
- Open — under evaluation (local vs hosted per use case, open-weight models, MCP).
- Observability stack
- Open — under evaluation (OpenTelemetry / OTLP, OpenMetrics, syslog RFC 5424).
- Backup
- Open — under evaluation (3-2-1 strategy, RPO/RTO-driven).
adr/.Glossary
Terms used throughout Nyxever documentation. When a term appears in the docs, it uses the definition here. If a term is missing or incorrect, file an issue in the source repository.
- ADR
- Architecture Decision Record. A document capturing a significant architectural choice, its context, the alternatives considered, and the reasoning for the decision made.
- CA (Certificate Authority)
- A trusted entity that issues signed digital certificates. A CA's trustworthiness is the root of all TLS security in a system. See PKI.
- Ceph
- An open-source distributed storage system providing block (RBD), file (CephFS), and object (RGW) storage interfaces on top of the RADOS object store.
- CephFS
- Ceph File System. A POSIX-compliant distributed filesystem built on RADOS. See CephFS.
- Corosync
- Cluster communication and quorum management daemon used by Proxmox VE for high-availability clustering. See Corosync.
- CRUSH
- Controlled Replication Under Scalable Hashing. Ceph's algorithm for computing data placement across OSDs without a central lookup table.
- GPU (VRAM)
- Graphics Processing Unit and its video memory. VRAM is the binding resource for AI inference — the amount of VRAM determines what models can be loaded.
- HA (High Availability)
- A design goal where workloads continue to run (or restart automatically) when individual components fail. Requires distributed storage, cluster coordination, and fencing.
- IdP (Identity Provider)
- A service that authenticates users and issues identity tokens, typically via OIDC or SAML 2.0 for federated authentication. Nyxever's IdP choice is under evaluation.
- KV Cache
- Key-Value Cache. In AI inference, the cached intermediate attention computations for the context window. Grows with context length; VRAM-intensive.
- Kubernetes
- An open-source container orchestration system that schedules OCI containers across a cluster, with pluggable networking (CNI) and storage (CSI) interfaces. Nyxever's container orchestration layer.
- KVM
- Kernel-based Virtual Machine. A Linux kernel module that enables Type 1 hardware virtualization. The underlying engine for Proxmox VE.
- LVM
- Logical Volume Manager. Linux's local block storage management layer — physical volumes, volume groups, and logical volumes.
- LXC
- Linux Containers. A userspace interface for Linux kernel container features (namespaces, cgroups). Used for system containers in Proxmox VE.
- mTLS
- Mutual TLS. A TLS connection where both the client and server present certificates, providing mutual authentication. Used for service-to-service trust.
- OIDC
- OpenID Connect. A federated identity protocol built on OAuth2 for authenticating users and services using a trusted identity provider.
- OSD
- Object Storage Daemon (Ceph). Each OSD manages one storage device and stores a portion of the cluster's data. A Ceph cluster has many OSDs across multiple nodes.
- OpenTelemetry (OTLP)
- A vendor-neutral open standard for generating and exporting metrics, logs, and traces. OTLP is its wire protocol. One of the standards under evaluation for the observability layer.
- PKI
- Public Key Infrastructure. The system of CAs, certificates, and verification processes that establish and verify cryptographic identities.
- Proxmox VE
- Proxmox Virtual Environment. An open-source (AGPLv3) virtualization platform based on Debian, KVM/QEMU, and LXC, with Corosync-based clustering. The primary compute platform in Nyxever.
- RADOS
- Reliable Autonomic Distributed Object Store. The underlying distributed object storage system that all Ceph storage interfaces (RBD, CephFS, RGW) are built on.
- RBD
- RADOS Block Device. Ceph's distributed block storage interface. See Ceph RBD.
- RPO / RTO
- Recovery Point Objective (how much data loss is acceptable in a failure) and Recovery Time Objective (how long recovery can take). Drive backup strategy decisions.
- STONITH
- Shoot The Other Node In The Head. Cluster fencing terminology for ensuring a suspected-failed node is reliably stopped before its workloads are restarted elsewhere.
- VLAN
- Virtual Local Area Network. 802.1Q-based Layer 2 network segmentation. A tagged VLAN separates broadcast domains on shared physical infrastructure.
- VXLAN
- Virtual Extensible LAN. A Layer 2 overlay over Layer 3 networks, used to extend VLANs across multiple physical sites.
- WireGuard (protocol)
- A minimal encrypted-tunnel protocol using Curve25519, ChaCha20-Poly1305, and BLAKE2s. One of the tunnel options under evaluation, alongside IPsec.
- ZFS
- A combined filesystem and volume manager with end-to-end checksumming, copy-on-write, and built-in RAID (RAIDZ). See ZFS.
Contributing
Nyxever is an open project. Contributions to code, documentation, and ideas are welcome. Before contributing, read the Good Citizen Guide — it covers the collaboration principles that make contributions productive.
Contribution process: fork the relevant repository, create a feature branch, make changes, open a pull request. Reference any relevant issues or ADRs in the PR description. PRs are reviewed against the design principles and existing ADRs — a technically correct PR that violates a design principle will be asked to reconsider before merging.
Changelog
Significant changes to the platform are documented here. Changes that affect only a single module are documented in that module's repository. This changelog covers cross-cutting changes, design decisions, and version milestones.