Use multiple server instances

If you install ColdFusion with the Server configuration, you can create multiple instances and clusters, provided you have an Enterprise license or you install ColdFusion as a Trial or Developer edition. (ColdFusion Standard does not support multiple instances.)

About multiple server instances

The ColdFusion Administrator lets you create server instances and clusters. Additionally, you can connect to remote Tomcat servers and add them to clusters.

Running multiple instances of ColdFusion has the following advantages:

Application isolation You deploy an independent application to each server instance. Each server instance has separate settings and, because each server instance runs in its own Java Virtual Machine (JVM), problems that one application encounter have no effect on other applications.
Clustering (load balancing and failover) You deploy the same application to each server instance and add the instances to a cluster. The web server connector optimizes performance and stability by automatically balancing load and by switching requests to another server instance when a server instance stops running.

File location considerations

ColdFusion lets you store CFM pages either under the external web server root or under the ColdFusion web application root. The discussions here assume that you store your CFM pages under the ColdFusion web application root and specify a context root for your application.

For more information on serving CFM pages from the web server root, see Web Server Management

Defining additional server instances

You can create multiple ColdFusion instances using the ColdFusion Administrator's Enterprise Manager page, which again is available only ColdFusion Enterprise, Trial, or Developer editions.

Define a server instance

After installing ColdFusion in the Server (as opposed to JEE) configuration, create an instance of ColdFusion using the ColdFusion Administrator.

In the ColdFusion Administrator, go to Enterprise Manager > Instance Manager.
Click Add New Instance.
Enter the server name and server directory. (When you tab from the server name field, Javascript code in the Administrator will automatically append that name to the existing server directory location.)
(Optional) Check Create Windows Service.
Click Submit. Wait for the new instance to be created.
Once created, the new instance will be listed in the Instance Manager, where you can start, stop, restart, edit, delete, access the administrator, or access the web site for the instance (the latter two would be performed using the internal web server port for the instance, as selected by default by the Instance Manager).
(Optional) Click the Edit icon to edit the instance manager. Notice that you can edit the internal webserver port as well as the load balancing factor.The load balancing factor represents the load the instance takes up and is applicable only if the instance is part of the cluster.For example, the load balancing factor for the first instance is 1 and that of the second instance is 2. The second instance receives two times more requests.
Click Submit.

Note:

Deleting a cfusion instance from the Enterprise Manager page is not possible and it is not allowed. If you click the Delete icon, the message, "Running servers cannot be deleted" displays, which means you must stop the server. But if you stop the server, you anyway cannot access the Enterprise Manager page.

Enabling application isolation

You can create separate server instances, each with its own ColdFusion applications; each application then has its own ColdFusion and JEE server resources. In this configuration, you typically have a single external web server with multiple server instances on one computer, and separate virtual hosts (or sites) for each server instance.

Note: Like ColdFusion, other JEE application servers provide equivalent capabilities, and most of the concepts apply when deploying the ColdFusion JEE configuration on those JEE servers.

Running independent applications this way has several advantages, including the following:

Errors at the levels of the ColdFusion application or the Tomcat server do not affect any other ColdFusion applications.

You can support multihomed servers, where a single web server supports multiple IP addresses or domain names, such as www.mycompany.com and services.anothercompany.com, each running from a separate web root. For more information, see Multihoming.

Note: Installing and Using ColdFusion describes creating multiple server instances on a single computer. To create multiple server instances on separate computers, each computer requires a separate license of ColdFusion Enterprise Edition.

To achieve complete application isolation, you use web-server-specific functionality to create a separate website for each application. Web servers have different terminology for this concept. For example, in IIS, you define separate websites, while in Apache, you create multiple virtual hosts.

These instructions apply when running ColdFusion in the Enterprise multiple instance configuration. The principles apply also when running ColdFusion on other JEE application serversl however, not all JEE application servers integrate with external web servers. For more information, see Multihoming.

These instructions assume that you deploy each application at a named context root, which enables users to access CFM pages by specifying http://_hostname_/_context-root_/_pagename_.cfm. If other web applications are running in the server instance, each web application must use a different context root.

For example, with a context root of cf, users access CFM pages by specifying http://_hostname_/cf/_pagename_.cfm. For more information on using a context root, see Installing ColdFusion.

Note: Although {{cf }}is the context root, it does not relate to your web application directory structure.

Use multiple server instances for application isolation

Create a separate server instance by using the instructions in Defining additional server instances. If you are using the built-in web server, proceed to step 6 in the following steps.
Using your web-server-specific method, create a virtual website (or separate website) for the application. For more information, see Multihoming, or consult your web server documentation.
Test each virtual website to ensure that HTML pages are served correctly.
Store the ColdFusion files of your application the web root of the virtual website, or optionally in the ColdFusion web application root (for application portability).
Follow the instructions for your web server to configure the connection between your virtual website and the server instance. For more information, see Web server configuration for application isolation.
Test your application.
Repeat these steps for each server instance.

Web server configuration for application isolation

When you use multiple server instances for application isolation, the steps you perform to configure communication between the website and the server instance differ for each web server.

Configuring application isolation in IIS

When you use multiple virtual websites with multiple server instances under IIS, you define separate filters and mappings for each virtual website and server instance combination.

It is assumed that you already created server instances and virtual websites, as described in Enabling application isolation.

Configure multiple server instances for application isolation when using IIS

Run the Web Server Configuration Tool multiple times, once for each virtual website. In ColdFusion, you must run the Web Server Configuration tool from within each instance (the wsconfig tool in cfroot\instancename\runtime\bin), and then specify the web site to connect to. use For more information on running the Web Server Configuration Tool

Configuring application isolation in Apache

When you use multiple virtual hosts with multiple server instances under Apache, you edit the httpd.conf file manually.

It is assumed that you already created server instances and virtual websites, as described in Enabling application isolation.

Configure multiple server instances for application isolation when using Apache

Assume that you have two instances: cfusion and server1.

Configure Apache webserver for cfusion instance using the wsconfig tool. This step creates the connector-related files in the cf_root\config\wsconfig\1 folder. It also creates the mod_jk.conf in the <Apacheroot>\conf folder. The mod_jk.conf }}file is included in the {{httpd.conf.
Configure Apache virtual hosts.
1. In workers.properties of cf-root\config\wsconfig\1, add server1 to workers.list. For example, worker.list=cfusion,server1.
2. Add the following block:
  
  worker.server1.host=localhost
  worker.server1.port=8014
  
  Note: The port is the AJP port for server1 and that can be found in server1.server.xml in the cf_root\server1\runtime\conf\server.xml.
3. Copy the content of uriworkermap.properties in cf-root\config\wsconfig\1 to{{ uriworkermap1.properties}}. Replace the cfusion with server1.
4. Now add the following line in each of the virtual host: For example, VH1 is the ColdFusion instance. It should have: JkMountFile "cf_root\config\wsconfig\1\uriworkermap.properties" VH2 is the server1 instance. It should have JkMountFile "cf_root\config\wsconfig\1".

Configuring application isolation in Sun ONE Web Server

Under Sun ONE Web Server, each ColdFusion server instance is mapped to a Sub ONE Web Server instance, when you use multiple virtual hosts with multiple server instances.

Configure multiple server instances for application isolation when using Sun ONE Web Server

Run the Web Server Configuration Tool for each Sun ONE Web Server instance. Specify a different configuration directory and ColdFusion server instance each time. Ensure that you select the Configure Web Server for ColdFusion MX Applications option (GUI).

Enabling clustering for load balancing and failover

Load balancing is an enterprise-level feature in which the application server automatically alternates requests among the server instances in a cluster. Clustering also enables application servers to route requests to a running server instance when the original server instance goes down.

You can get New Admin API method to obtain instance name (getinstancename in runtime.cfc)load balancing and failover by deploying identical ColdFusion applications and configurations to multiple server instances and adding the instances to a cluster. Each instance must have the same applications deployed and the same resources configured (such as data sources, Solr collections, and mappings). The web server connector optimizes performance and stability by automatically balancing load and by switching requests to another server instance when a server instance stops running.

Note: You must be connected to a network for clustering to work.

For maximum failover protection, use multiple computers in a cluster. However, you must purchase a separate ColdFusion Enterprise Edition license for each computer.

To implement session failover for the server instances in a cluster, enable session replication for each server instance. Session replication coordinates session information in real time among the server instances in a cluster. Enabling session replication lets Tomcat automatically route a request to a running server if the current server is unavailable.

Note: When a cluster uses session replication, session data is copied to other servers in the cluster each time it is modified. This can degrade performance if you store a significant amount of information in session scope. If you plan to store a significant amount of information in session scope, consider storing this information in client variables saved in a database.

Configure a cluster of server instances for load balancing and failover

Manage clusters using the ColdFusion Administrator.

In the ColdFusion Administrator, click Enterprise Manager > Cluster Manager.
Enter a cluster name and then click Add.
Click the cluster name and move the servers to the cluster based on the requirement.
(If required) Edit the multicast port.Multicast port is used to group the cluster members together. The default value of multicast port is 45564. After you create a cluster, the port is added in the cfroot\cfusion\config\cluster. xml file. For more information on multicast port, see http://tomcat.apache.org/tomcat-8.0-doc/config/cluster-membership.html.
Specify if you need sticky session.Sticky session ensures that after a session is established on an instance, all future requests from the client are mapped to that instance. Note that if you disable sticky session, session replication will be enabled.
Click Submit.

Adding a remote instance to a cluster

To add a remote instance to a cluster, add the cluster block to the remote instance's server.xml. Then, register the remote instance and add the instance to the cluster. For more information on configuring clusters on Tomcat, see https://tomcat.apache.org/tomcat-8.0-doc/cluster-howto.html.

If you are using session replication, go to the Memory Variables page and enable J2EE sessions. Enable J2EE sessions for all server instances in the cluster. If J2EE sessions are not enabled in the ColdFusion Administrator, session replication does not function properly.

CFC serialization lets you use J2EE session replication in a cluster and have access to the CFCs in session data across all instances in the cluster. Session replication also ensures that that Session scope variables are replicated across the cluster. However, session replication does not support replication of arrays in Session scope CFCs or variables.You can also preserve and access data in a CFC in the case of session failover. ColdFusion structures stored inside the session scope are available in the session scope, even after failover.

For example, if you are running multiple ColdFusion instances to balance server load, you can store useful data, including CFCs, inside the session so that you can access the data across all the pages that are served in that session. To enable CFC serialization, set the CFC in the session, as follows:

After failover, you can then access and call methods in the CFC, as follows:

Register the remote instance to the local machine.
Create a cluster in the local machine.
Open the cfroot_instance-name_runtime\conf\server.xml file of the remote instance.

Add the following block between the entries </host> }}and {{</engine>:

Note:

1. For ColdFusion (2018 release), use the port 45564

2. For ColdFusion (2016 release), use the port 45565

In the entry, update the membership port with the multicast port of the cluster.
Using the ColdFusion Administrator of the local host, add the local instance and the remote instance to the cluster.

Note: The JVM route of the remote instance and local instance must not be the same.
Restart all the instances.

Note: When running code in multiple instances, it can be useful to run CFML code that reports which instance is currently running a requested template. For security reasons, there is no function that provides the current instance name but the ColdFusion Admin API provides a method to obtain the instance name, the getInstanceName method in the Runtime CFC.

Define remote server instances to the ColdFusion Administrator

Register a new remote instance of ColdFusion using the ColdFusion Administrator.

In the ColdFusion Administrator, click Enterprise Manager > Instance Manager > Register Remote Instance.
Specify the details such as instance name, remote host, remote port, http port, JVM route, and load balancing factor.

Instance name is a string that is used to identify the instance. Remote port and HTTP port are displayed in the Instance Manager page. These ports are provided in the server.xml file available in the runtime\conf folder of the instance. Remote port is the AJP port and the instance port is the connector port.

JVM route is the remote instance name. The JVM route is an attribute that acts as an identifier for a particular Tomcat worker. JVM route is provided in the server.xml file available in the runtime\conf folder of the instance. For more information on JVM route, see https://tomcat.apache.org/tomcat-8.0-doc/cluster-howto.html.

Note: A remote instance and a local instance cannot have the same JVM route if they are added in a cluster.
If you want remote start and stop functionality over HTTP, enter Admin Component port, Admin Component user name , and Admin Component password. The default Admin Component port is 8985.

Note: To enable this feature, install admin component on the remote host.
1. In the remote host, open the cfroot\cfusion\jetty\etc\jetty.xml.
2. Search for the string, org.mortbay.jetty.bio.SocketConnector.
3. Update the host with the IP address of the remote host.
4. Restart the jetty server.
Click Submit.