Manifold

Hold Up!

Bonsai clusters can be provisioned in a few different ways. These instructions are for Manifold users. If you have an account on Bonsai.io or via Heroku, then you will not need these instructions. Instead, check out:

If you have an account with Manifold.co you can provision an Elasticsearch cluster with Bonsai through their marketplace. Read on to learn how to get started with Bonsai on Manifold.

Manifold makes it quick and easy to integrate Bonsai Elasticsearch into your project. We recommend using one of the official clients, based on your application stack.

Creating a Bonsai Elasticsearch Cluster

To get started, sign up or sign in to your Manifold.co account. In your main dashboard, click on “+ NEW” next to "Other Resources" to add a search resource to your account:

From the Resources menu, search for "Bonsai Elasticsearch", or click on the “Search” category in the left side bar to see the available search resources:

This should narrow down the list to a set of search engine products, including Bonsai.io. Click on the “Bonsai Elasticsearch”  to provision a new Bonsai Elasticsearch cluster.

This will take you to a list of available plans for your new cluster:

Each plan has a different set of available options, so read carefully and pick the plan that’s right for you. You can also email us with any questions you may have.

Once you have selected a plan, scroll down to see a dropdown list of available regions. This will offer a list of geographic regions in which your cluster can be provisioned. You’ll want to pick a region that is as close to your project as possible to minimize latency.

Finally, you can add the resource to a project (if you have one), and give it a name. These last steps are optional. If you don’t provide a name for the cluster, Manifold will create one for you.

Click on “Create Bonsai Elasticsearch Resource” to spin up your new Bonsai Elasticsearch cluster.

Accessing Your Cluster

Once the new resource has been provisioned, you should see a page like this:

From here, you are able to update your cluster’s plan, access the cluster dashboard, and destroy the resource altogether. To verify that your cluster is up and running, scroll down to the Credentials section:

Click on the “Show credentials” button to see the secret URL to your cluster. It will look something like this:

Keep Your URL Secret

Because the URL includes authentication information, anyone with the fully-qualified URL can access your cluster. Treat the URL like a password: don’t hard-code it into applications, don’t check it into source control, and for Pete’s sake, never ever paste it into a StackOverflow question. If you need to share your cluster URL with us for support purposes, the auth-less host name is all you need:

Bad: “My cluster is https://username:password@somehost-1234567.us-east-1.bonsaisearch.net”

Good: “My cluster is somehost-1234567”

If your URL is leaked somehow, you can regenerate the credentials. See Credentials for more information.

You can use a tool like curl to verify that your cluster is up and running like so:

$ curl https://randomuser:randompass@somehost1234567.us-east-1.bonsai.io
{
  "name" : "PvRcoFq",
  "cluster_name" : "elasticsearch",
  "cluster_uuid" : "DNlbVYS0TIGYwbQ6CUNwTw",
  "version" : {
    "number" : "5.4.3",
    "build_hash" : "eed30a8",
    "build_date" : "2017-06-22T00:34:03.743Z",
    "build_snapshot" : false,
    "lucene_version" : "6.5.1"
  },
  "tagline" : "You Know, for Search"
}

You can also copy and paste the URL into a browser to see if it’s working:

How to Update Your Cluster Plan

Start by logging in to your Manifold dashboard. Click on the resource you’d like to update:

This will bring up the resource dashboard. Click on the button marked “Update Plan”:

This will bring up a menu of all available plans. Click on the new plan you would like. Changes are saved immediately.

If you haven’t already added a credit card to Manifold, and are trying to update to a paid plan, you will see a form for entering payment information like this:

Successful changes to your Bonsai plan take effect immediately.

Removing the Resource

Danger!

This will destroy all associated data and cannot be undone!

To remove the resource from your Manifold account, first you will need to log in to your Manifold dashboard, and click on the resource you’d like to remove.

This will bring up the resource dashboard. Click on the "More" drop-down menu, and you will see “Delete resource” marked in red:

Clicking on this link will bring up a modal asking for confirmation:

Click on “Delete” to confirm. The resource will be removed, and your cluster will be destroyed.