Using the a9s Elasticsearch for PCF

This topic describes how developers use a9s Elasticsearch for PCF after it has been successfully installed. For information about installation, see the Installing and Configuring Elasticsearch for PCF topic.

Use a9s Elasticsearch for PCF with an Application

To use a9s Elasticsearch for PCF with an application, create a service instance and bind the service instance to your application. For more information on managing service instances, see Managing Service Instances with the cf CLI.

View the a9s Elasticsearch for PCF Service

After the tile is installed, you can see the a9s-elasticsearch5 and its service plans appear in your PCF marketplace. Run cf marketplace to see the service listing:

$ cf marketplace
Getting services from marketplace in org test / space test as admin...
service               plans                                                     description
a9s-elasticsearch5    elasticsearch-single-small, elasticsearch-cluster-small,  This is the anynines Elasticsearch 5 service.
                      elasticsearch-single-big, elasticsearch-cluster-big

For more information on available service plans, see the Configure Service Plans topic.

Create a Service Instance and Bind It to an App

To provision a Elasticsearch database, run cf create-service. For example:

$ cf create-service a9s-elasticsearch5 elasticsearch-single-small my-elasticsearch-service

Depending on your infrastructure and service broker utilization, it may take several minutes to create the service instance.

Run the cf services command to view the creation status. This command displays a list of all your service instances. To view the status of a specific service instance, run cf service NAME-OF-YOUR-SERVICE.

Bind an Application to a Service Instance

After your database is created, run cf bind-service to bind the service to your application:

$ cf bind-service a9s-elasticsearch-app my-elasticsearch5-service

Restage or Restart Your Application

To enable your application to access the service instance, run cf restage or cf restart to restage or restart your application.

Obtain Service Instance Access Credentials

After a service instance is bound to an application, the credentials of your Elasticsearch database are stored in the environment variables of the application. Run cf env APP-NAME to display the environment variables.

You can find the credentials in the VCAP_SERVICES key.

$ cf env a9s-elasticsearch-app
Getting env variables for app a9s-elasticsearch-app in org test / space test as admin...

   "a9s-elasticsearch": [
      "credentials": {
       "host": [
       "password": "EXAMPLE_USER",
       "username": "EXAMPLE_PASSWORD"
     "label": "a9s-elasticsearch",
     "name": "my-elasticsearch-service",
     "plan": "elasticsearch-cluster-small",
     "tags": [

You can use the host, username, and password values to connect to your database with a Elasticsearch client.

Delete an a9s Elasticsearch for PCF Service Instance

WARNING: Before deleting a service instance, you must backup data stored in your database. This operation cannot be undone and all the data is lost when the service is deleted.

Before you can delete a service instance, you must unbind it from all apps.

List Available Services

Run cf services to list your available services.

$ cf services

Getting services in org test / space test as admin...

name                       service              plan                         bound apps              last operation
my-elasticsearch-service   a9s-elasticsearch5   elasticsearch-single-small   a9s-elasticsearch-app   create succeeded

This example shows that my-elasticsearch-service is bound to the a9s-elasticsearch-app application.

Unbind a Service Instance

Run cf unbind-service to unbind the service from your application.

$ cf unbind-service a9s-elasticsearch-app my-elasticsearch-service

Delete a Service Instance

After unbinding the service, it is no longer bound to an application. Run cf delete-service to delete the service:

$ cf delete-service my-elasticsearch-service

It may take several minutes to delete the service. Deleting a service deprovisions the corresponding infrastructure resources. Run the cf services command to view the deletion status.

Upgrade the Service Instance to another Service Plan

Once created, you can upgrade your service instance to another, larger service plan. A larger service plan provides more CPU, RAM and storage. For more information, see the Update a Service Instance of the Managing Service Instances with the cf CLI topic.

$ cf update-service my-elasticsearch-service -p a-bigger-plan

Here are the plans you can upgrade to depending on the one you are currently using:

  • If you are currently using the elasticsearch-single-small plan, you can upgrade to the monelasticsearchgodb-single-big plan.

  • If you are currently using the elasticsearch-cluster-small plan, you can upgrade to the elasticsearch-cluster-big plan.

Add a Graphite Endpoint

If you want to monitor your service with Graphite, you can set an endpoint to where to information will be sent with the cf update-service command. This command expects the -c flag and a JSON string containing the graphite and metrics_prefix keys.

$ cf update-service my-elasticsearch-service -c '{ "graphite": [""], "metrics_prefix": "" }'

Add a Syslog Endpoint

The cf update-service command used with the -c flag can let you stream your syslog to a third-party service. In this case, the command expects a JSON string containing the syslog key.

$ cf update-service my-elasticsearch-service -c '{ "syslog": [""] }'
Create a pull request or raise an issue on the source for this page in GitHub