Reference
This section collects system-level configuration, port documentation, version compatibility matrices, API entry points and a glossary for readers who need to verify details or tune behavior on demand, rather than reading it through as a workflow.
Quick Navigation
| Section | Content | When to Read |
|---|---|---|
| Environment Variables | Environment variables and default values | Deployment, tuning, troubleshooting startup issues |
| Logs & Troubleshooting | Viewing logs, locating issues by request ID | Locate failures from logs when issues occur |
| Ports | Purpose of each port and how to change it | Not sure which port to access in the browser, or want to change ports |
| System Configuration | System configuration items and default values | Adjust default behavior |
| Menu Disable | Hide unnecessary menu items per user | Simplify the end-user view |
| Resource Availability | Auto-detect whether a resource type is installed in the cluster | Block creation entry points of unavailable resources early |
| K8s Capability Detection | Probe available capabilities by cluster version | Assess affected features before a cluster upgrade |
| Version Matrix | Compatibility with each Kubernetes version | Confirm feasibility before an upgrade |
| RBAC Scopes | The three permission scopes | Design role authorization rules |
| API Documentation | Swagger UI API entry | Secondary development and automation integration |
| Glossary | Quick reference of 10 core terms | New users understand documentation wording |
Recommended Reading Order
- Deployment / startup — start with Environment Variables; on startup issues, follow Troubleshooting to view logs; which port to access in the browser is covered in Ports
- Runtime tuning — adjust default behavior through System Configuration, and simplify the end-user view with Menu Disable
- Cluster compatibility — before upgrading Kubernetes, assess the impact against the Version Matrix and Capability Detection
- Permission design — read RBAC Scopes before designing roles
- Secondary development / automation — start from API Documentation, and look up unfamiliar terms in the Glossary
Relationship to other sections
The Reference is cross-cutting capability documentation that does not depend on any particular business flow. Consult it on demand during usage rather than reading it end to end.