Enterprise Manager - Instance Manager
Centrally manage individual ColdFusion server instances in enterprise deployments
Overview
The Instance Manager in ColdFusion Enterprise Manager provides centralized control for creating, configuring, and managing individual ColdFusion server instances across your enterprise deployment. Enterprise Manager enables administrators to manage multiple server instances from a single interface, streamlining configuration, monitoring, and maintenance tasks.
This feature is available only in ColdFusion Enterprise Edition and enables organizations to efficiently manage large-scale ColdFusion deployments with consistent configurations and centralized oversight.
Instance Creation
Configure and deploy new ColdFusion server instances.
Instance Name
PurposeUnique identifier for the server instance
RequirementsMust be unique on the host server, alphanumeric characters only
RecommendationUse descriptive names indicating purpose and environment (e.g.,
prod-api-01, dev-web-02)Best Practice: Establish a consistent naming convention across your organization. Include environment, purpose, and sequence number for clarity (e.g.,
prod-app-01, staging-api-02).HTTP Port
PurposePort for HTTP connections to the instance's built-in web server
Default8500 (auto-incremented for additional instances)
RecommendationUse sequential ports for multiple instances (8500, 8501, 8502, etc.)
ProductionUse external web server (IIS, Apache, Nginx) instead of built-in web server
Security: The built-in web server is suitable for development only. Production deployments should use enterprise web servers with proper SSL/TLS configuration.
JVM Arguments
PurposeCustom Java Virtual Machine parameters for the instance
Common Args
-Xms2048m -Xmx4096m (heap size), -XX:MaxMetaspaceSize=512mRecommendationConfigure based on application memory requirements and available RAM
Memory Configuration Best Practices:
- Set initial heap (-Xms) equal to maximum heap (-Xmx) to prevent resize overhead
- Allocate 50-75% of server RAM to JVM heap (leave room for OS and other processes)
- Monitor garbage collection and adjust based on application behavior
- Use G1GC for heaps larger than 4GB:
-XX:+UseG1GC
Instance Directory
PurposeFile system location for instance configuration, logs, and runtime files
Default
{CF_HOME}/cfusion/instances/{instance_name}RecommendationUse default location unless disk space or performance requirements dictate otherwise
Storage Considerations: Ensure sufficient disk space for logs, temporary files, and cache data. Monitor disk usage regularly and implement log rotation.
Instance Lifecycle Management
Control instance states and manage running instances.
Start Instance
- Purpose
- Launch the ColdFusion instance and make it available for requests
- Startup Time
- Typically 30-90 seconds depending on applications and configurations
- Verification
- Check instance status in Enterprise Manager or access administrator URL
Monitor logs during startup to identify initialization issues or slow-loading applications.
Stop Instance
- Purpose
- Gracefully shutdown the instance
- Shutdown Time
- Allows active requests to complete (default 30-second timeout)
- Best Practice
- Remove from load balancer before stopping to avoid user disruption
Always stop instances gracefully rather than force-killing to prevent data corruption.
Restart Instance
- Purpose
- Stop and start instance to apply configuration changes
- When Required
- JVM changes, certain administrator settings, application updates
- Best Practice
- Schedule restarts during maintenance windows
Some settings take effect immediately; others require restart. Check documentation for specific settings.
Delete Instance
- Purpose
- Permanently remove instance and its configuration
- Warning
- Cannot be undone - all instance data will be deleted
- Before Deleting
- Back up configuration, logs, and any custom files
Remove instance from clusters and load balancers before deletion to prevent routing errors.
Instance Registration
Remote Instance Registration
PurposeAdd existing instances from remote servers to Enterprise Manager
RequirementsNetwork connectivity, administrator credentials for remote instance
Use CaseCentralize management of instances across multiple physical or virtual servers
Registration Process:
- Provide remote instance hostname/IP and administrator port
- Enter administrator username and password
- Verify network connectivity and firewall rules
- Test connection before finalizing registration
Instance Authentication
PurposeSecure communication between Enterprise Manager and managed instances
MethodAdministrator username and password for each instance
RecommendationUse strong passwords and consider certificate-based authentication
Security: Enterprise Manager stores instance credentials. Ensure Enterprise Manager itself is secured with strong authentication and network access controls.
Configuration Management
Centralized Configuration
PurposeApply settings across multiple instances from Enterprise Manager
CapabilitiesDatasources, mail servers, mappings, security settings
BenefitEnsures consistency and reduces configuration drift across instances
Configuration as Code: Export configurations to CAR files for version control and automated deployment across environments.
Configuration Archive (CAR) Files
PurposeExport and import instance configurations for backup and deployment
ContentsDatasources, mappings, mail settings, scheduled tasks, security settings
Use CasesEnvironment promotion, disaster recovery, instance cloning
Best Practices:
- Maintain CAR files in version control for configuration history
- Create separate CAR files for each environment (dev, staging, production)
- Test CAR imports in non-production before applying to production
- Document any manual configuration steps not captured in CAR files
- Exclude sensitive data (passwords) from version-controlled CAR files
Instance Monitoring
Instance Status
- States
- Running, Stopped, Starting, Stopping, Error
- Monitoring
- Real-time status updates in Enterprise Manager dashboard
- Alerts
- Configure notifications for instance state changes
Monitor instance status regularly to detect and respond to failures quickly.
Resource Utilization
- Metrics
- CPU usage, memory consumption, active requests, thread pool status
- Thresholds
- Set alerts for high resource usage
- Trends
- Historical data for capacity planning
Track resource trends to identify performance issues before they impact users.
Request Statistics
- Data
- Request count, average response time, slowest requests
- Analysis
- Identify performance bottlenecks and optimization opportunities
- Alerting
- Notify on slow requests or request queue buildup
Use request statistics to optimize application performance and user experience.
Log Access
- Logs
- Application logs, exception logs, mail logs, server logs
- Access
- View and download logs from Enterprise Manager interface
- Integration
- Export to centralized logging systems (ELK, Splunk)
Centralize logs for easier troubleshooting and security analysis across instances.
Common Issues & Solutions
Instance Won't Start
Symptom: Instance fails to start or shows error state in Enterprise Manager
Solutions:
- Check instance logs for error messages (
coldfusion-out.log,coldfusion-error.log) - Verify HTTP port is not already in use by another process
- Ensure sufficient disk space for temporary files and logs
- Check JVM memory settings are appropriate for available RAM
- Verify file permissions on instance directory
- Review recent configuration changes that may have caused issue
Cannot Connect to Remote Instance
Symptom: Enterprise Manager unable to register or communicate with remote instance
Solutions:
- Verify network connectivity between Enterprise Manager and remote instance
- Check firewall rules allow traffic on administrator port (default 8500)
- Confirm remote instance is running and accessible
- Test administrator credentials (username/password) are correct
- Verify remote instance administrator port in configuration
- Check for network proxy or NAT issues
Configuration Changes Not Applied
Symptom: Settings changed in Enterprise Manager not taking effect on instance
Solutions:
- Restart instance to apply changes (many settings require restart)
- Verify configuration was saved successfully (check for error messages)
- Check that instance is not using per-application settings that override administrator settings
- Review Application.cfc for settings that may override administrator configuration
- Confirm Enterprise Manager has latest instance status (refresh/sync)
- Check instance logs for configuration errors or warnings