Traceable Platform On-Prem Documentation¶
This documentation provides comprehensive guidelines for deploying and managing Traceable Platform in on-premises and cloud environments.
Architecture¶
Note: For OpenShift environments, use OpenShift Routers instead of Ingress-Nginx for ingress traffic management.
Documentation Structure¶
Prerequisites¶
Essential requirements before installing Traceable Platform:
Installation¶
Step-by-step installation guides:
- Single Node Installation - Dev/Test environments
- Multi-Node Installation - Production environments
- Post-Installation Checks
- RKE2 Installation
- VM Requirements
- System Configuration
- Validate Images in Registry
- Overriding Helm Chart Values
Networking & Connectivity¶
How to expose the platform and route external traffic:
- Connecting to the Traceable Platform - Cloud LoadBalancer, NGINX, Traefik, OpenShift Routes
Operations¶
Day-to-day operations and maintenance:
- Restart and Patching Guide
- Password Reset
- Update DNS
- Update Certificates
- Backup Guide
- Restore Guide
- Disaster Recovery Runbook
- Docker Registry Setup
- Sync Images to Registry
- Custom Logo
- Alerts Runbook
Advanced Configuration¶
Advanced configuration tasks:
Upgrade¶
Comprehensive upgrade procedures:
- Pre-Upgrade Checks
- Download Workflow File
- Upgrading the Platform
- Rollback Procedures
- Upgrading the Operator
Integrations¶
Configure external service integrations:
Platform-Specific Guides¶
Platform-specific configurations:
Quick Start¶
New Installation¶
- Review the Prerequisites to ensure your environment meets all requirements
- Follow the Installation Guide for your deployment type:
- Single Node for dev/test
- Multi-Node for production
- Run Post-Installation Checks
- Configure Integrations such as SMTP and SAML
Existing Installation¶
- For upgrades, refer to the Upgrade Guide
- For operations, refer to the Operations Guide
- For troubleshooting alerts, see the Alerts Runbook
Support¶
For assistance, contact: support@harness.io