Node Documentation: <node-name>
This document describes the hardware, operating system, Pterodactyl Wings configuration, and hosted services for the <node-name> Wings node.
This document should be updated when the node hardware, operating system, status, location, resource allocation, network configuration, or hosted services significantly change.
Node Identity
Node Name:
<node-name>
Role:
<Primary role>
Wings node
Current purpose:
Status:
<Status>
Location:
<Location identifier>
The location name follows the internal Pterodactyl infrastructure naming convention.
Additional notes describing the purpose, history, or special considerations of this node may be included here if relevant.
Physical Host
Hardware
CPU:
<CPU model>
CPU Architecture:
<Architecture>
RAM:
<Installed memory>
Memory Configuration:
<DIMM configuration>
Manufacturer:
<Manufacturer>
Model:
<Model>
Firmware and Management Controllers
BIOS Version:
<Version>
Management Controller:
<Vendor/model>
Management Controller Firmware:
<Version>
Storage Controller:
<Model>
Controller Cache:
<Cache amount and status>
Storage Controller Firmware:
<Version>
CPU Topology
The server contains:
<Number> CPU socket(s)
Each CPU:
<Number> physical cores
<Number> logical threads
Total:
<Number> physical cores
<Number> logical threads
CPU pinning may be configured for individual server allocations when latency-sensitive workloads require predictable CPU placement.
Document any node-specific CPU topology considerations here.
Memory
Total host memory:
<Memory>
Memory is shared between:
- Pterodactyl services.
- Wings-managed containers.
- Operating system usage.
- File caching.
- Other system services.
Document any node-specific memory considerations here.
Operating System
Operating System:
<Operating system>
Swap Configuration:
<Swap configuration>
The swap partition is configured as part of the host installation and is managed by the operating system.
Document any operating system considerations relevant to this node.
Storage
Primary Storage Volume:
<Volume or device>
Filesystem usage:
<Filesystem purpose>
Storage Configuration:
<RAID or storage layout>
Raw Capacity:
<Approximate raw capacity>
Usable Capacity:
<Approximate usable capacity>
Drive Configuration:
<Drive count and capacity>
Drive Hardware:
<Drive manufacturer>
Drive Model:
<Drive model>
Purpose:
- Container storage.
- Game server data.
- Pterodactyl application data.
- System storage.
Add additional storage devices or arrays if applicable.
Pterodactyl Configuration
Panel:
<Panel deployment or not hosted>
Wings Version:
<Version>
Document any node-specific Wings configuration that differs from the standard deployment.
Resource Allocation
Resource management for this node is handled through Pterodactyl server allocations.
CPU Limit:
<Configuration>
CPU Pinning:
<Configuration>
Memory:
<Configuration>
Disk:
<Configuration>
Hosted Services
Hosted services:
Document the primary workloads assigned to this node.
Network Configuration
Public services hosted on this node are exposed through externally managed hostnames.
Current network features:
- DNS records.
- SRV records (where applicable).
- DDNS hostname updates (where applicable).
Reverse proxy:
<Configuration>
Document additional network requirements if this node differs from the standard deployment.
Service-Specific Network Requirements
No additional service-specific network requirements are currently configured.
Additional service ports should be documented in the corresponding server environment documentation if deployed.
Backup Storage
Backup storage is maintained separately from container storage.
Pterodactyl backup storage path:
<Path>
Purpose:
- Stores Pterodactyl-generated server backups.
- Keeps backup data separate from container storage.
- Allows backup storage to be managed independently from server allocations.
Backup configuration such as retention limits, schedules, and enabled backups is managed at the individual server level and is documented in the corresponding server environment documentation.
External Mounts
The node allows container mounts from the following approved host paths:
<Approved mount path>
Example:
Host:
<Host path>
Container:
<Container path>
Purpose:
- Describe the purpose of the mount.
- Explain why external storage is used.
- Note any operational considerations.
Migration Considerations
Servers may be migrated between Wings nodes.
Before migrating servers from this node, verify:
- Required storage exists on the destination node.
- External mounts are available.
- Backup paths are accessible.
- CPU and memory allocations are supported.
- Network requirements are available.
Add any node-specific migration considerations here.
Maintenance Notes
When making changes to this node:
- Update this documentation after significant changes.
- Record operating system changes.
- Record hardware changes.
- Record firmware changes.
- Record changes to the node's role or hosted services.
- Record Wings version changes.
- Verify backups before migrations or upgrades.
- Review server documentation for consistency after infrastructure changes.
Document any additional maintenance procedures specific to this node.
Related Documentation
The following documents provide additional information about this node and the infrastructure in which it operates.
| Document | Purpose |
|---|---|
../README.md |
Documentation index and repository conventions |
../infrastructure.md |
Overall Pterodactyl deployment, storage, networking, and infrastructure |
../servers/ |
Individual server deployment documentation |
| Other node documentation | Related Wings node documentation, where applicable |
Change History
YYYY-MM-DD
Initial documentation created for the node.