1. Docs

Deploying Cloaked Search

Cloaked Search is provided as a Docker container that can be run within your infrastructure. The container is stateless and can be scaled horizontally as needed.


The Cloaked Search Docker container is hosted publicly on the IronCore Labs Docker registry. Find the latest tag available and pull down the image by running this command:

docker pull gcr.io/ironcore-images/cloaked-search:{tag}

You can see the changes in each version of Cloaked Search in its changelog entry.

After you have successfully pulled Cloaked Search, you should be able to see the image listed in your docker images list.

Starting Locally for Development

If you want to run Cloaked Search in Docker running on your local machine, see our Try Cloaked Search repository.

Deployment and Tuning

Running Cloaked Search in a production deployment is usually more involved than just starting it up. Many decisions will be specific to your infrastructure, but we have an example Kubernetes deployment that you can use as a starting point.


There are several endpoints available that may be useful for monitoring a Cloaked Search deployment:

  • _cloaked_search/health: probe that reports combined live and ready information
  • _cloaked_search/live: probe that reports if the service is running
  • _cloaked_search/version: reports the currently running version of CS

Was this page helpful?