blob: dd4322df37614d320e8a9fc2a6e7ee5f13946b38 [file] [log] [blame]
"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[804],{15680:(e,n,t)=>{t.d(n,{xA:()=>g,yg:()=>m});var r=t(96540);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function l(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{};n%2?i(Object(t),!0).forEach((function(n){a(e,n,t[n])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):i(Object(t)).forEach((function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(t,n))}))}return e}function o(e,n){if(null==e)return{};var t,r,a=function(e,n){if(null==e)return{};var t,r,a={},i=Object.keys(e);for(r=0;r<i.length;r++)t=i[r],n.indexOf(t)>=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)t=i[r],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=r.createContext({}),d=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},g=function(e){var n=d(e.components);return r.createElement(s.Provider,{value:n},e.children)},p="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},c=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,g=o(e,["components","mdxType","originalType","parentName"]),p=d(t),c=a,m=p["".concat(s,".").concat(c)]||p[c]||u[c]||i;return t?r.createElement(m,l(l({ref:n},g),{},{components:t})):r.createElement(m,l({ref:n},g))}));function m(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,l=new Array(i);l[0]=c;var o={};for(var s in n)hasOwnProperty.call(n,s)&&(o[s]=n[s]);o.originalType=e,o[p]="string"==typeof e?e:a,l[1]=o;for(var d=2;d<i;d++)l[d]=t[d];return r.createElement.apply(null,l)}return r.createElement.apply(null,t)}c.displayName="MDXCreateElement"},52791:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>s,default:()=>m,frontMatter:()=>o,metadata:()=>d,toc:()=>p});var r=t(58168),a=t(98587),i=(t(96540),t(15680)),l=["components"],o={id:"single-server",title:"Single server deployment"},s=void 0,d={unversionedId:"operations/single-server",id:"operations/single-server",title:"Single server deployment",description:"\x3c!--",source:"@site/docs/latest/operations/single-server.md",sourceDirName:"operations",slug:"/operations/single-server",permalink:"/docs/latest/operations/single-server",draft:!1,tags:[],version:"current",frontMatter:{id:"single-server",title:"Single server deployment"},sidebar:"docs",previous:{title:"Quickstart (local)",permalink:"/docs/latest/tutorials/"},next:{title:"Clustered deployment",permalink:"/docs/latest/tutorials/cluster"}},g={},p=[{value:"Single server reference configurations (deprecated)",id:"single-server-reference-configurations-deprecated",level:2}],u={toc:p},c="wrapper";function m(e){var n=e.components,t=(0,a.A)(e,l);return(0,i.yg)(c,(0,r.A)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,i.yg)("p",null,"Druid includes a launch script, ",(0,i.yg)("inlineCode",{parentName:"p"},"bin/start-druid")," that automatically sets various memory-related parameters based on available processors and memory.\nIt accepts optional arguments such as list of services, total memory, and a config directory to override default JVM arguments and service-specific runtime properties."),(0,i.yg)("p",null,"By default, the services started by ",(0,i.yg)("inlineCode",{parentName:"p"},"bin/start-druid"),":"),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},"use all processors"),(0,i.yg)("li",{parentName:"ul"},"can use up to 80% memory on the system"),(0,i.yg)("li",{parentName:"ul"},"apply the configuration files in ",(0,i.yg)("inlineCode",{parentName:"li"},"conf/druid/auto")," for all other settings.")),(0,i.yg)("p",null,"For details about possible arguments, run ",(0,i.yg)("inlineCode",{parentName:"p"},"bin/start-druid --help"),"."),(0,i.yg)("h2",{id:"single-server-reference-configurations-deprecated"},"Single server reference configurations (deprecated)"),(0,i.yg)("p",null,"Druid includes a set of reference configurations and launch scripts for single-machine deployments.\nThese start scripts are deprecated in favor of the ",(0,i.yg)("inlineCode",{parentName:"p"},"bin/start-druid")," script documented above.\nThese configuration bundles are located in ",(0,i.yg)("inlineCode",{parentName:"p"},"conf/druid/single-server/"),"."),(0,i.yg)("table",null,(0,i.yg)("thead",{parentName:"table"},(0,i.yg)("tr",{parentName:"thead"},(0,i.yg)("th",{parentName:"tr",align:null},"Configuration"),(0,i.yg)("th",{parentName:"tr",align:null},"Sizing"),(0,i.yg)("th",{parentName:"tr",align:null},"Launch command"),(0,i.yg)("th",{parentName:"tr",align:null},"Configuration directory"))),(0,i.yg)("tbody",{parentName:"table"},(0,i.yg)("tr",{parentName:"tbody"},(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"nano-quickstart")),(0,i.yg)("td",{parentName:"tr",align:null},"1 CPU, 4GiB RAM"),(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"bin/start-nano-quickstart")),(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"conf/druid/single-server/nano-quickstart"))),(0,i.yg)("tr",{parentName:"tbody"},(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"micro-quickstart")),(0,i.yg)("td",{parentName:"tr",align:null},"4 CPU, 16GiB RAM"),(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"bin/start-micro-quickstart")),(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"conf/druid/single-server/micro-quickstart"))),(0,i.yg)("tr",{parentName:"tbody"},(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"small")),(0,i.yg)("td",{parentName:"tr",align:null},"8 CPU, 64GiB RAM (~i3.2xlarge)"),(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"bin/start-small")),(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"conf/druid/single-server/small"))),(0,i.yg)("tr",{parentName:"tbody"},(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"medium")),(0,i.yg)("td",{parentName:"tr",align:null},"16 CPU, 128GiB RAM (~i3.4xlarge)"),(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"bin/start-medium")),(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"conf/druid/single-server/medium"))),(0,i.yg)("tr",{parentName:"tbody"},(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"large")),(0,i.yg)("td",{parentName:"tr",align:null},"32 CPU, 256GiB RAM (~i3.8xlarge)"),(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"bin/start-large")),(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"conf/druid/single-server/large"))),(0,i.yg)("tr",{parentName:"tbody"},(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"xlarge")),(0,i.yg)("td",{parentName:"tr",align:null},"64 CPU, 512GiB RAM (~i3.16xlarge)"),(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"bin/start-xlarge")),(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("inlineCode",{parentName:"td"},"conf/druid/single-server/xlarge"))))),(0,i.yg)("p",null,"The ",(0,i.yg)("inlineCode",{parentName:"p"},"micro-quickstart")," is sized for small machines like laptops and is intended for quick evaluation use-cases."),(0,i.yg)("p",null,"The ",(0,i.yg)("inlineCode",{parentName:"p"},"nano-quickstart")," is an even smaller configuration, targeting a machine with 1 CPU and 4GiB memory. It is meant for limited evaluations in resource constrained environments, such as small Docker containers."),(0,i.yg)("p",null,"The other configurations are intended for general use single-machine deployments. They are sized for hardware roughly based on Amazon's i3 series of EC2 instances."),(0,i.yg)("p",null,"The startup scripts for these example configurations run a single ZK instance along with the Druid services. You can choose to deploy ZK separately as well."))}m.isMDXComponent=!0}}]);