Docker Deployment Overview
NCache provides official Docker images that allow you to run NCache inside containerized environments without installing it directly on the host operating system. Docker deployments can be used for development, testing, and distributed cache environments depending on configuration and licensing.
Important
NCache Docker images are only supported on Linux-based environments.
Similar to traditional NCache installations, Docker supports two deployment modes:
- Cache Server
- Dev/QA
The selected mode determines whether the container can be configured to join a distributed cache cluster or runs as a standalone instance with development-oriented limitations.
Note
Regardless of deployment mode, all NCache containers must be registered using an evaluation key or a purchased license key before NCache can be used. Registration is performed after the container is started. For details, refer to the Docker installation guide.
Choosing a Docker Deployment Model
| Deployment Model | Mode | Recommended For |
|---|---|---|
| Single Container per Host | Cache Server | Production deployments requiring distributed caching. Each container runs as one cache server node. Typically deployed with one container per host. |
| Multiple Containers per Host (Docker Compose) | Cache Server | Evaluation and controlled testing of distributed caching on a single machine. Uses Docker Compose to deploy and manage multiple cache server nodes on one host. |
| Custom Docker Image | Cache Server | Scenarios where the official NCache Docker image needs to be extended with additional dependencies, configuration, or scripts to meet specific requirements. |
| Single Container | Dev/QA | Local development and testing. Runs a standalone cache instance with licensing restrictions. Intended for application development and integration testing. |
Cache Server
Cache Server deployment runs NCache as a cache server node inside a Docker container. Each container runs an NCache Server instance and can be configured to join a distributed cache cluster. Containers registered in Cache Server can host caches, join clusters, and communicate with other server nodes. Production deployments require appropriate licensing based on your environment and usage model.
Regardless of the deployment model used, Cache Server containers must be configured with the correct networking and exposed ports to support cluster formation and inter-node communication. Required ports are documented in Firewalls and Ports. Host network mode is strongly recommended for NCache deployments. Bridge networking is not recommended. For full networking guidance, refer to the Docker installation guide.
Cache Server Deployment Models
Cache Server containers can be deployed using different infrastructure models depending on how nodes are distributed across hosts.
Single Container per Host
In this model, each virtual machine or physical host runs one NCache container. When forming a distributed cluster, multiple machines each run their own container instance. This model mirrors traditional multi-server NCache deployments where each node runs on a separate machine. It is the recommended model for production-grade distributed caching environments because if a machine goes down, only the container hosted on that machine is affected. Containers running on other machines remain available, preserving cache cluster operation.
Multiple Containers per Host (Docker Compose)
Docker Compose enables multiple NCache server containers to run on a single machine using a compose configuration file. Each container operates as an independent cache server node within the same host. This model is used for evaluation and controlled testing of distributed caching behavior on a single machine.
Custom Image Deployment
A custom Docker image can be created by extending the official NCache Docker image. This allows you to include additional dependencies, configuration files, or scripts required for your specific environment. Regardless of image customization, containers must still be registered in the correct mode and configured to support the required networking and cluster communication. For details, refer to Customize Dockerfile.
Dev/QA
Dev/QA deployment is intended for development, testing, and other non-production scenarios. In this mode, the container runs as a standalone cache instance and does not participate in multi-node clustering. Containers registered in Dev/QA mode are restricted to single-node operation and are subject to the following limitations:
- Only 2 remote clients can connect to the local cache on the Dev/QA machine. Local clients can connect without restriction.
- Only 3 caches can run on the Dev/QA machine with a maximum combined size of 2 GB.
- The total number of requests per second per local cache is limited to 25.
- A Dev/QA licensed client can send a maximum of 200,000 requests to the remote cache over its lifetime. Once this limit is reached, a licensing exception is thrown. Restarting the application resets the counter.
- Adding a client requires manually updating client.ncconf. No command-line or web-based tooling support is available for this operation.
Note
Dev/QA Server is free to use.
Dev/QA Deployment Model
Dev/QA Docker deployments use a single container configuration. The container runs independently and does not require cluster setup or inter-node communication. This model is appropriate for testing application integration with NCache and developing caching logic locally. Because it operates as a standalone instance, Dev/QA mode is optimized for simplicity and lightweight operation rather than scalability.
In This Section
Docker
Step-by-step instructions for pulling NCache images and deploying standalone containers. Ideal for local development and testing NCache features in an isolated environment.
Docker Compose
Explains how to deploy multiple NCache containers for evaluation using Docker Compose. This is the preferred method for simulating distributed cluster behavior and evaluation in a containerized stack.
