Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
105 lines (71 sloc) 6.65 KB
title: a9s Elasticsearch for PCF
owner: Partners
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.
<%= image_tag("a9s-elasticsearch.png") %>
## <a id='overview'></a> Overview
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.
### <a id='currentfeatures'></a> 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.<br/><br/>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.<br/><br/>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.<br /><br /> When the IP address of a service instance changes, the guard updates the security group. The Service Guard also restarts the application instances bound to the affected service instance. **The instances of one application are restarted one by one to avoid downtime.**|
| **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 instances which is greated by the end user. |
### <a id='video'></a> Video Overview of a9s Elasticsearch for PCF
The following video provides an overview of how a9s Elasticsearch for PCF works.
<iframe src=""
width="656" height="372" frameborder="0" allowfullscreen></iframe>
## <a id="snapshot"></a> Product Snapshot
<p class='note'><strong>Note:</strong> As of PCF v2.0, Elastic Runtime is renamed Pivotal Application Service (PAS).</p>
The following table provides version and version-support information about a9s Elasticsearch for PCF:
<table class="nice">
<td>Release date</td>
<td>September 4, 2018</td>
<td>Compatible Ops Manager version(s)</td>
<td>v1.12.x, v2.0.x, v2.1.x, and v2.2.x</td>
<td>Compatible Pivotal Application Service version(s):</td>
<td>v1.12.x, v2.0.x, v2.1.x, and v2.2.x</td>
<td>IaaS support</td>
<td>AWS, Azure, GCP, OpenStack, and Vsphere</td>
<p class='note'><strong>Note:</strong> This is a major release. 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.</p>
## <a id="reqs"></a> Requirements
To install and use a9s Elasticsearch for PCF, you must install the following products and tiles:
* Pivotal Application Service (formerly Elastic Runtime) v1.12 or later
For more information, see [Installing and Configuring a9s Elasticsearch for PCF](./installing.html).
## <a id="feedback"></a> 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 [](
## <a id='license'></a> License
Contact our [sales team]( to learn more about commercial licenses and support.