{"_id":"5a553bbc05cd370012bae61b","project":"5633ebff7e9e880d00af1a53","version":{"_id":"5633ec007e9e880d00af1a56","project":"5633ebff7e9e880d00af1a53","__v":16,"createdAt":"2015-10-30T22:15:28.105Z","releaseDate":"2015-10-30T22:15:28.105Z","categories":["5633ec007e9e880d00af1a57","5633f072737ea01700ea329d","5637a37d0704070d00f06cf4","5637cf4e7ca5de0d00286aeb","564503082c74cf1900da48b4","564503cb7f1fff210078e70a","567af26cb56bac0d0019d87d","567afeb8802b2b17005ddea0","567aff47802b2b17005ddea1","567b0005802b2b17005ddea3","568adfffcbd4ca0d00aebf7e","56ba80078cf7c9210009673e","574d127f6f075519007da3d0","574fde60aef76a0e00840927","57a22ba6cd51b22d00f623a0","5a062c15a66ae1001a3f5b09"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"567af26cb56bac0d0019d87d","pages":["567af282b56bac0d0019d87e","567af41fc952030d0038c782","567af469b56bac0d0019d887","567af4a493919f0d00c97a72","567af4c7c952030d0038c788","568371947af9120d007ac34d","568411af3b87430d00483c14","5684127c65976e0d00001bf1","568414c77916270d00eee2e1","5684152b7af9120d007ac3e9","5684162b3b87430d00483c21","5684164f65976e0d00001bfe","568440dcc11c7e0d00aaff47","56eadf15eed93a0e00dd501b","56eadffb0ce1452200bd5db1","56eae136d25d831700006abc"],"project":"5633ebff7e9e880d00af1a53","__v":16,"version":"5633ec007e9e880d00af1a56","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-12-23T19:13:48.702Z","from_sync":false,"order":6,"slug":"quickstart-guides","title":"Heroku Plan Management"},"user":"5633ec9b35355017003ca3f2","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-01-09T22:01:32.651Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"Bonsai supports a command line flag for specifying which version of Elasticsearch you want to use. Note that we only support specific versions of Elasticsearch, so you can’t provision an arbitrary one. We have a list of available versions documented here:\n\n- [Supported Elasticsearch Versions](https://docs.bonsai.io/v1.0/docs/supported-elasticsearch-versions) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"heroku addons:create bonsai:[plan] [-a APP_NAME] [--version=X.Y]\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"The version you can provision through our Heroku addon is a function of two variables:\\n1. The region\\n2. The supported versions in that region (see full list here:  [Supported Elasticsearch Versions](https://docs.bonsai.io/v1.0/docs/supported-elasticsearch-versions))\\n\\nYour Elasticsearch cluster addon will be provisioned in the same AWS region that your Heroku app is located in. We do not allow a region flag to be supplied to the CLI. To determine which versions you have available to you, first check your Heroku app's region, then reconcile this with the list linked above.\\n\\nIf you provide a version number that is not supported, then the CLI will provision a cluster with the default highest version available in your region.\",\n  \"title\": \"Which Elasticsearch versions are available to your app?\"\n}\n[/block]\nThe `version` parameter also works in your app.json, if you use PR apps and Heroku pipelines:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"name\\\": \\\"Small Sharp Tool\\\",\\n  \\\"description\\\": \\\"This app does one little thing, and does it well.\\\",\\n  \\\"keywords\\\": [\\n    \\\"productivity\\\",\\n    \\\"HTML5\\\",\\n    \\\"scalpel\\\"\\n  ],\\n  \\\"addons\\\" : [\\n    {\\n    \\t\\\"plan\\\": \\\"bonsai\\\",\\n      \\\"version\\\": \\\"2.4.0\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nFor further help with your app.json and addons, see Heroku's documentation here:\n\n- [Heroku App JSON Schema](https://devcenter.heroku.com/articles/app-json-schema#addons) \n[block:api-header]\n{\n  \"title\": \"Minor Version Support\"\n}\n[/block]\nThe less specific you are about the version you need for your Elasticsearch addon, the more likely you will get a match. For example, if you want any version of 5, you should just put `5`. If, however, you specify 5.1.1 and we only have 5.3.2 available, it will default to highest available, which as of writing is 6.\n\nAgain, it's a good idea to reconcile which version you need with our list of [supported ES versions per region](https://docs.bonsai.io/v1.0/docs/supported-elasticsearch-versions).","excerpt":"","slug":"elasticsearch-version-management","type":"basic","title":"Elasticsearch Version Management"}

Elasticsearch Version Management


Bonsai supports a command line flag for specifying which version of Elasticsearch you want to use. Note that we only support specific versions of Elasticsearch, so you can’t provision an arbitrary one. We have a list of available versions documented here: - [Supported Elasticsearch Versions](https://docs.bonsai.io/v1.0/docs/supported-elasticsearch-versions) [block:code] { "codes": [ { "code": "heroku addons:create bonsai:[plan] [-a APP_NAME] [--version=X.Y]", "language": "text" } ] } [/block] [block:callout] { "type": "warning", "body": "The version you can provision through our Heroku addon is a function of two variables:\n1. The region\n2. The supported versions in that region (see full list here: [Supported Elasticsearch Versions](https://docs.bonsai.io/v1.0/docs/supported-elasticsearch-versions))\n\nYour Elasticsearch cluster addon will be provisioned in the same AWS region that your Heroku app is located in. We do not allow a region flag to be supplied to the CLI. To determine which versions you have available to you, first check your Heroku app's region, then reconcile this with the list linked above.\n\nIf you provide a version number that is not supported, then the CLI will provision a cluster with the default highest version available in your region.", "title": "Which Elasticsearch versions are available to your app?" } [/block] The `version` parameter also works in your app.json, if you use PR apps and Heroku pipelines: [block:code] { "codes": [ { "code": "{\n \"name\": \"Small Sharp Tool\",\n \"description\": \"This app does one little thing, and does it well.\",\n \"keywords\": [\n \"productivity\",\n \"HTML5\",\n \"scalpel\"\n ],\n \"addons\" : [\n {\n \t\"plan\": \"bonsai\",\n \"version\": \"2.4.0\"\n }\n ]\n}", "language": "json" } ] } [/block] For further help with your app.json and addons, see Heroku's documentation here: - [Heroku App JSON Schema](https://devcenter.heroku.com/articles/app-json-schema#addons) [block:api-header] { "title": "Minor Version Support" } [/block] The less specific you are about the version you need for your Elasticsearch addon, the more likely you will get a match. For example, if you want any version of 5, you should just put `5`. If, however, you specify 5.1.1 and we only have 5.3.2 available, it will default to highest available, which as of writing is 6. Again, it's a good idea to reconcile which version you need with our list of [supported ES versions per region](https://docs.bonsai.io/v1.0/docs/supported-elasticsearch-versions).