a9s Elasticsearch for PCF

This documentation describes the a9s Elasticsearch for Pivotal Cloud Foundry (PCF) tile. a9s Elasticsearch for PCF enables on-demand provisioning of VM-based, dedicated Elasticsearch servers and clusters. Developers can create instances of a Elasticsearch server or cluster using Apps Manager or the Cloud Foundry Command Line interface (cf CLI) and bind these instances to an application. Depending on your service plan, a service instance may be associated with a single, dedicated VM or a set of VMs consisting of multiple VMs containing a Elasticsearch replica set cluster.

A9s elasticsearch


When you run the cf CLI create-service a9s-elasticsearch command, PCF creates dedicated VMs for this service instance. This allows the best possible bad neighborhood protection.

Elasticsearch service instance provisioning, including VM orchestration, is entirely automated. This enables service instances to be highly isolated and shielded by infrastructure virtualization mechanisms.

Due to the on-demand provisioning on VMs, only existing service instances allocate infrastructure resources. These resources are released when service instances are destroyed. Using on-demand provisioning the number of service instances is not limited by design.

Distributed across multiple infrastructure availability zones, clustered data service plans enable short failover times and are resilient against failures of individual infrastructure hosts or entire availability zones.

Current Features

The current version of a9s Elasticsearch for PCF includes the following key features:

Feature Benefit
OnĀ­-Demand Service Instance Provisioning a9s Elasticsearch for PCF deploys Elasticsearch instances automatically. Developers can provision a single VM Elasticsearch server or a multi VM Elasticsearch Replica Set using a single command.
Service Instance Isolation Each Elasticsearch server runs on a dedicated VM to ensure bad neighborhood protection in order to be aligned with enterprise security requirements.

a9s Elasticsearch for PCF uses Cloud Foundry security groups to prevent network connections being established by unauthorized applications.
High Availability a9s Elasticsearch for PCF ensures high-availability.

The Consul-based internal DNS system provided by a9s Consul DNS for PCF ensures that the connected application always connects to a working node.
Smoke Tests a9s Elasticsearch for PCF contains a post-deploy smoke tests errand that runs a series of basic test against your installation to ensure that it is configured properly.
Service Instance Capacity Upgrade Cloud Foundry Service Plan updates allow upgrades to the RAM, CPU and storage capacity for your Elasticsearch instances.
Logging and Monitoring Each Elasticsearch service instance provides log messages and Elasticsearch-specific metrics to one or more syslog/graphite endpoints. You can configure the syslog/graphite endpoint to receive logging and monitoring information.
Deployment Updater This errand automatically updates the stemcell and all provisioned a9s Elasticsearch for PCF service instances to their lastest version.
Backup Manager The Backup Manager does regular backup of your instances and offers endpoints to backup instantly and restore backups.
Service Guard The Service Guard creates Cloud Foundry security groups for your service instance VMs.

When the IP address of a service instance changes, the guard updates the security group.
Service Dashboard The Service Dashboard provides single sign on and lets the user easily trigger backups.
New Elasticsearch Versions Added a9s Elasticsearch v5 and v6
Default Syslog Endpoints for Instances In the tile, a default endpoint for syslog and Graphite can be configured for each service instance created by the user.
Consul Domain Configurable The consul domain can now be configured.
BOSH DNS Handler a9s BOSH DNS handler added to make a9s service instances accessible from Diego cells.
a9s-pg Backup Added backup option for a9s-pg.
Instance Sharing a9s MySQL no supports instance sharing between orgs an spaces, see documentation.
Update to Xenial Upgrades the stemcell to Ubuntu Xenial

Video Overview of a9s Elasticsearch for PCF

The following video provides an overview of how a9s Elasticsearch for PCF works.

Product Snapshot

The following table provides version and version-support information about a9s Elasticsearch for PCF:

Element Details
Version v2.1.1
Release date March 19, 2019
Compatible Ops Manager version(s) v2.1.x, v2.2.x, v2.3.x, and v2.4.x
Compatible Pivotal Application Service version(s): v2.1.x, v2.2.x, v2.3.x, and v2.4.x
BOSH stemcell version Ubuntu Xenial
IaaS support AWS, Azure, GCP, OpenStack, and vSphere

WARNING: a9s Elasticsearch for PCF v2.0.2 and earlier require a Ubuntu Trusty stemcell. The end-of-life date for Ubuntu Trusty is April 2019. If a security vulnerability is found on this stemcell after April, it will not be fixed.

Note: Upgrades from a9s Elasticsearch for PCF v1.x are not supported. If you previously installed a9s Elasticsearch for PCF v1.x, uninstall it and install the latest version.


To install and use a9s Elasticsearch for PCF, you must install the following products and tiles:

  • Pivotal Application Service (formerly Elastic Runtime) v2.1.x or later

For more information, see Installing and Configuring a9s Elasticsearch for PCF.

Feedback and Support

a9s Elasticsearch for PCF is an automation toolset for Open Source Elasticsearch. The entire anynines team can help your team get started and be successful. Technical support, including a service level agreement, is available with a commercial license.

If your company has specific Elasticsearch administration policies or configuration best practices, the anynines team is happy to incorporate them, if applicable. Third-party Elasticsearch support organizations are also welcome to assist.

The anynines team welcomes all contributions. Send any bugs, feature requests, or questions to dssupport@anynines.com.


Contact our sales team to learn more about commercial licenses and support.

Create a pull request or raise an issue on the source for this page in GitHub