{"_id":"5abb2255d4b7b600129c63a6","project":"5633ebff7e9e880d00af1a53","version":{"_id":"5a8fae0268264c001f20cc00","project":"5633ebff7e9e880d00af1a53","__v":4,"createdAt":"2018-02-23T06:00:34.961Z","releaseDate":"2018-02-23T06:00:34.961Z","categories":["5a8fae0268264c001f20cc01","5a8fae0268264c001f20cc02","5a8fae0368264c001f20cc03","5a8fae0368264c001f20cc04","5a8fae0368264c001f20cc05","5a8fae0368264c001f20cc06","5a8fae0368264c001f20cc07","5a8fae0368264c001f20cc08","5a8fae0368264c001f20cc09","5abaa7eb72d6dc0028a07bf3","5b8ee7842790f8000333f9ba","5b8ee8f244a21a00034b5cd9"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"category":{"_id":"5abaa7eb72d6dc0028a07bf3","project":"5633ebff7e9e880d00af1a53","version":"5a8fae0268264c001f20cc00","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-03-27T20:22:03.555Z","from_sync":false,"order":3,"slug":"bonsai-manifold-basics","title":"Bonsai Manifold Basics"},"user":"5637d336aa96490d00a64f81","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-28T05:04:21.559Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"If you have an account with [Manifold.co](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.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Bonsai clusters can be provisioned in a couple of 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:\\n\\n* [Getting Started With Bonsai.io](doc:getting-started-with-bonsaiio) \\n* [Getting Started With Heroku](doc:getting-started-with-heroku)\"\n}\n[/block]\nManifold makes it quick and easy to integrate Bonsai Elasticsearch into your project. We recommend using one of the [official clients](https://www.elastic.co/guide/en/elasticsearch/client/index.html), based on your application stack.\n[block:api-header]\n{\n  \"title\": \"Creating a Bonsai Elasticsearch Cluster\"\n}\n[/block]\nTo get started, sign up or sign in to your [Manifold.co](https://manifold.co) account. In your main dashboard, click on \"Add new resource\" to add a search resource to your account:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/c10304f-manifold-bonsai-getting-started-1.png\",\n        \"manifold-bonsai-getting-started-1.png\",\n        2534,\n        1234,\n        \"#0d0d0e\"\n      ],\n      \"caption\": \"In this example, no project has yet been created. Search resources can be added and managed regardless.\"\n    }\n  ]\n}\n[/block]\nFrom the Resources menu, click on the \"All Services\" link to show all available filters. Click on \"Search\" to see the available search resources:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ea4ed0e-manifold-bonsai-getting-started-2.png\",\n        \"manifold-bonsai-getting-started-2.png\",\n        1862,\n        780,\n        \"#181721\"\n      ],\n      \"caption\": \"Resources can be filtered by type.\"\n    }\n  ]\n}\n[/block]\nThis should narrow down the list to a set of search engine products, including Bonsai.io. Click on the \"Try Free\" button to provision a new Bonsai Elasticsearch cluster.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/dcd91cb-manifold-bonsai-getting-started-3.png\",\n        \"manifold-bonsai-getting-started-3.png\",\n        1830,\n        666,\n        \"#f1f1f9\"\n      ],\n      \"caption\": \"Search engines like Bonsai and Websolr can be added for free to your Manifold account, and used by your Manifold projects.\"\n    }\n  ]\n}\n[/block]\nThis will take you to a list of available plans for your new cluster:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ecbdcff-manifold-bonsai-getting-started-4.png\",\n        \"manifold-bonsai-getting-started-4.png\",\n        920,\n        1632,\n        \"#f2f2f9\"\n      ],\n      \"caption\": \"A list of all available plans. Email support:::at:::bonsai.io if you have questions or concerns.\"\n    }\n  ]\n}\n[/block]\nEach 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](mailto:support@bonsai.io) with any questions you may have.\n\nOnce 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.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/6c490ca-manifold-bonsai-getting-started-5.png\",\n        \"manifold-bonsai-getting-started-5.png\",\n        1534,\n        694,\n        \"#f3f3f9\"\n      ],\n      \"caption\": \"Configuration options for your new cluster.\"\n    }\n  ]\n}\n[/block]\nFinally, 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.\n\nClick on \"Create One More Cloud Resource\" to spin up your new Bonsai Elasticsearch cluster.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"\\\"One More Cloud Resource\\\"?\",\n  \"body\": \"Bonsai.io is a product designed and developed by [One More Cloud, LLC](https://omc.io).\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Accessing Your Cluster\"\n}\n[/block]\nOnce the new resource has been provisioned, you should see a page like this:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/a4284fb-manifold-bonsai-getting-started-6.png\",\n        \"manifold-bonsai-getting-started-6.png\",\n        1280,\n        1614,\n        \"#f2f2f9\"\n      ],\n      \"caption\": \"The Manifold resource dashboard.\"\n    }\n  ]\n}\n[/block]\nFrom 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:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/826916b-manifold-bonsai-getting-started-8.png\",\n        \"manifold-bonsai-getting-started-8.png\",\n        1720,\n        496,\n        \"#f3f3fb\"\n      ],\n      \"caption\": \"The Credentials section will show your cluster URL.\"\n    }\n  ]\n}\n[/block]\nClick on the \"Show credentials\" button to see the secret URL to your cluster. It will look something like this:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/6ff3b85-manifold-bonsai-getting-started-9.png\",\n        \"manifold-bonsai-getting-started-9.png\",\n        1728,\n        638,\n        \"#0c0c0c\"\n      ],\n      \"caption\": \"The secret URL to your cluster.\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"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:\\n\\nBad: \\\"My cluster is https://username:password@somehost-1234567.us-east-1.bonsaisearch.net\\\"\\n\\nGood: \\\"My cluster is somehost-1234567\\\"\\n\\nIf your URL is leaked somehow, you can regenerate the credentials. See [The Dashboard](doc:bonsai-elasticsearch-dashboard) for more information.\",\n  \"title\": \"Keep Your URL Secret\"\n}\n[/block]\nYou can use a tool like `curl` to verify that your cluster is up and running like so:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ curl https://randomuser:randompass@somehost1234567.us-east-1.bonsai.io\\n{\\n  \\\"name\\\" : \\\"PvRcoFq\\\",\\n  \\\"cluster_name\\\" : \\\"elasticsearch\\\",\\n  \\\"cluster_uuid\\\" : \\\"DNlbVYS0TIGYwbQ6CUNwTw\\\",\\n  \\\"version\\\" : {\\n    \\\"number\\\" : \\\"5.4.3\\\",\\n    \\\"build_hash\\\" : \\\"eed30a8\\\",\\n    \\\"build_date\\\" : \\\"2017-06-22T00:34:03.743Z\\\",\\n    \\\"build_snapshot\\\" : false,\\n    \\\"lucene_version\\\" : \\\"6.5.1\\\"\\n  },\\n  \\\"tagline\\\" : \\\"You Know, for Search\\\"\\n}\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nYou can also copy and paste the URL into a browser to see if it's working:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/b6ee19b-manifold-bonsai-getting-started-10.png\",\n        \"manifold-bonsai-getting-started-10.png\",\n        604,\n        328,\n        \"#0b74e4\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Next Steps\"\n}\n[/block]\nCongratulations! Your new Bonsai Elasticsearch cluster is up and running! You can now work to integrate it into your Manifold project. We have plenty of documentation about [Managing Your Cluster](doc:managing-your-cluster-1) and [Connecting to Elasticsearch](doc:connecting-to-elasticsearch), so read on to learn more. And if you have any questions or run into any issues, please don't hesitate to [let us know](mailto:support@bonsai.io)!","excerpt":"How to add the Bonsai addon through a Manifold account.","slug":"getting-started-with-manifold","type":"basic","title":"Getting Started With Manifold"}

Getting Started With Manifold

How to add the Bonsai addon through a Manifold account.

If you have an account with [Manifold.co](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. [block:callout] { "type": "warning", "body": "Bonsai clusters can be provisioned in a couple of 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:\n\n* [Getting Started With Bonsai.io](doc:getting-started-with-bonsaiio) \n* [Getting Started With Heroku](doc:getting-started-with-heroku)" } [/block] Manifold makes it quick and easy to integrate Bonsai Elasticsearch into your project. We recommend using one of the [official clients](https://www.elastic.co/guide/en/elasticsearch/client/index.html), based on your application stack. [block:api-header] { "title": "Creating a Bonsai Elasticsearch Cluster" } [/block] To get started, sign up or sign in to your [Manifold.co](https://manifold.co) account. In your main dashboard, click on "Add new resource" to add a search resource to your account: [block:image] { "images": [ { "image": [ "https://files.readme.io/c10304f-manifold-bonsai-getting-started-1.png", "manifold-bonsai-getting-started-1.png", 2534, 1234, "#0d0d0e" ], "caption": "In this example, no project has yet been created. Search resources can be added and managed regardless." } ] } [/block] From the Resources menu, click on the "All Services" link to show all available filters. Click on "Search" to see the available search resources: [block:image] { "images": [ { "image": [ "https://files.readme.io/ea4ed0e-manifold-bonsai-getting-started-2.png", "manifold-bonsai-getting-started-2.png", 1862, 780, "#181721" ], "caption": "Resources can be filtered by type." } ] } [/block] This should narrow down the list to a set of search engine products, including Bonsai.io. Click on the "Try Free" button to provision a new Bonsai Elasticsearch cluster. [block:image] { "images": [ { "image": [ "https://files.readme.io/dcd91cb-manifold-bonsai-getting-started-3.png", "manifold-bonsai-getting-started-3.png", 1830, 666, "#f1f1f9" ], "caption": "Search engines like Bonsai and Websolr can be added for free to your Manifold account, and used by your Manifold projects." } ] } [/block] This will take you to a list of available plans for your new cluster: [block:image] { "images": [ { "image": [ "https://files.readme.io/ecbdcff-manifold-bonsai-getting-started-4.png", "manifold-bonsai-getting-started-4.png", 920, 1632, "#f2f2f9" ], "caption": "A list of all available plans. Email support@bonsai.io if you have questions or concerns." } ] } [/block] 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](mailto:support@bonsai.io) 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. [block:image] { "images": [ { "image": [ "https://files.readme.io/6c490ca-manifold-bonsai-getting-started-5.png", "manifold-bonsai-getting-started-5.png", 1534, 694, "#f3f3f9" ], "caption": "Configuration options for your new cluster." } ] } [/block] 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 One More Cloud Resource" to spin up your new Bonsai Elasticsearch cluster. [block:callout] { "type": "info", "title": "\"One More Cloud Resource\"?", "body": "Bonsai.io is a product designed and developed by [One More Cloud, LLC](https://omc.io)." } [/block] [block:api-header] { "title": "Accessing Your Cluster" } [/block] Once the new resource has been provisioned, you should see a page like this: [block:image] { "images": [ { "image": [ "https://files.readme.io/a4284fb-manifold-bonsai-getting-started-6.png", "manifold-bonsai-getting-started-6.png", 1280, 1614, "#f2f2f9" ], "caption": "The Manifold resource dashboard." } ] } [/block] 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: [block:image] { "images": [ { "image": [ "https://files.readme.io/826916b-manifold-bonsai-getting-started-8.png", "manifold-bonsai-getting-started-8.png", 1720, 496, "#f3f3fb" ], "caption": "The Credentials section will show your cluster URL." } ] } [/block] Click on the "Show credentials" button to see the secret URL to your cluster. It will look something like this: [block:image] { "images": [ { "image": [ "https://files.readme.io/6ff3b85-manifold-bonsai-getting-started-9.png", "manifold-bonsai-getting-started-9.png", 1728, 638, "#0c0c0c" ], "caption": "The secret URL to your cluster." } ] } [/block] [block:callout] { "type": "danger", "body": "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:\n\nBad: \"My cluster is https://username:password@somehost-1234567.us-east-1.bonsaisearch.net\"\n\nGood: \"My cluster is somehost-1234567\"\n\nIf your URL is leaked somehow, you can regenerate the credentials. See [The Dashboard](doc:bonsai-elasticsearch-dashboard) for more information.", "title": "Keep Your URL Secret" } [/block] You can use a tool like `curl` to verify that your cluster is up and running like so: [block:code] { "codes": [ { "code": "$ curl https://randomuser:randompass@somehost1234567.us-east-1.bonsai.io\n{\n \"name\" : \"PvRcoFq\",\n \"cluster_name\" : \"elasticsearch\",\n \"cluster_uuid\" : \"DNlbVYS0TIGYwbQ6CUNwTw\",\n \"version\" : {\n \"number\" : \"5.4.3\",\n \"build_hash\" : \"eed30a8\",\n \"build_date\" : \"2017-06-22T00:34:03.743Z\",\n \"build_snapshot\" : false,\n \"lucene_version\" : \"6.5.1\"\n },\n \"tagline\" : \"You Know, for Search\"\n}", "language": "shell" } ] } [/block] You can also copy and paste the URL into a browser to see if it's working: [block:image] { "images": [ { "image": [ "https://files.readme.io/b6ee19b-manifold-bonsai-getting-started-10.png", "manifold-bonsai-getting-started-10.png", 604, 328, "#0b74e4" ] } ] } [/block] [block:api-header] { "title": "Next Steps" } [/block] Congratulations! Your new Bonsai Elasticsearch cluster is up and running! You can now work to integrate it into your Manifold project. We have plenty of documentation about [Managing Your Cluster](doc:managing-your-cluster-1) and [Connecting to Elasticsearch](doc:connecting-to-elasticsearch), so read on to learn more. And if you have any questions or run into any issues, please don't hesitate to [let us know](mailto:support@bonsai.io)!