findingrish opened a new pull request, #13365: URL: https://github.com/apache/druid/pull/13365
<!-- Thanks for trying to help us make Apache Druid be the best it can be! Please fill out as much of the following information as is possible (where relevant, and remove it when irrelevant) to help make the intention and scope of this PR clear in order to ease review. --> <!-- Please read the doc for contribution (https://github.com/apache/druid/blob/master/CONTRIBUTING.md) before making this PR. Also, once you open a PR, please _avoid using force pushes and rebasing_ since these make it difficult for reviewers to see what you've changed in response to their reviews. See [the 'If your pull request shows conflicts with master' section](https://github.com/apache/druid/blob/master/CONTRIBUTING.md#if-your-pull-request-shows-conflicts-with-master) for more details. --> <!-- Replace XXXX with the id of the issue fixed in this PR. Remove this section if there is no corresponding issue. Don't reference the issue in the title of this pull-request. --> <!-- If you are a committer, follow the PR action item checklist for committers: https://github.com/apache/druid/blob/master/dev/committer-instructions.md#pr-and-issue-action-item-checklist-for-committers. --> ### Description This change adds a new script `start-druid` to start druid services, the script accepts optional parameters like `totalMemory`, `baseConfigPath`, services to start etc. This script invokes a python script `druid-automated-quickstart.py`, which has the logic to compute memory distribution for the services, create supervise config for the services specified and start up the druid services It relies on base configs from `examples/conf/druid/single-server/quickstart`. > ./start-druid help ``` Usage: start-druid [options] where options include: totalMemory=<> memory for druid cluster, if totalMemory is not specified 80% of system memory is used, baseConfigPath=<> relative path to base directory containing common and service specific properties to be overridden, this directory must contain `_common` directory with `common.jvm.config` & `common.runtime.properties` if this config is not specified, config from conf/druid/single-server/quickstart is used computeOnly command dry-run, displays the memory distribution for services runZk specification to run zookeeper, zk config is picked up from conf/zk <service_identifier>=[subdirectory] service_identifier is the service to be started, multiple services can be specified, `service_identifier` should be one of [broker, router, middleManager, historical, coordinator-overlord] `subdirectory` is optional directory within `baseConfigPath` containing runtime properties or/and jvm properties Note, if jvm.config file is present for one service, it must be present for all other services If no service is specified, all services and zookeeper are started sample usage: start-druid start up all the services using the default system memory start-druid totalMemory=100g start up all the services using the given memory start-druid totalMemory=100g computeOnly compute memory distribution for all the services start-druid totalMemory=100g broker router historical starts broker, router and historical services, using 100g of memory start-druid totalMemory=100g baseConfigPath=/conf/druid/single-server/large broker router historical starts broker, router and historical services, using 100g of memory, use common configs from specified `baseConfigPath` start-druid totalMemory=100g baseConfigPath=/conf/druid/single-server/large broker=broker router=router historical=historical starts broker, router and historical services, using 100g of memory, use common configs from specified `baseConfigPath`, use service specific config from specified directories if jvm.config is specified for all the services, memory distribution is not computed start-druid totalMemory=100g baseConfigPath=/conf/druid/single-server/large broker=broker1 broker=broker2 starts 2 instances of broker config is read from respective directories, depending on whether jvm.config is specified, memory distribution is computed ``` <!-- Describe the goal of this PR, what problem are you fixing. If there is a corresponding issue (referenced above), it's not necessary to repeat the description here, however, you may choose to keep one summary sentence. --> <!-- Describe your patch: what did you change in code? How did you fix the problem? --> <!-- If there are several relatively logically separate changes in this PR, create a mini-section for each of them. For example: --> <!-- In each section, please describe design decisions made, including: - Choice of algorithms - Behavioral aspects. What configuration values are acceptable? How are corner cases and error conditions handled, such as when there are insufficient resources? - Class organization and design (how the logic is split between classes, inheritance, composition, design patterns) - Method organization and design (how the logic is split between methods, parameters and return types) - Naming (class, method, API, configuration, HTTP endpoint, names of emitted metrics) --> <!-- It's good to describe an alternative design (or mention an alternative name) for every design (or naming) decision point and compare the alternatives with the designs that you've implemented (or the names you've chosen) to highlight the advantages of the chosen designs and names. --> <!-- If there was a discussion of the design of the feature implemented in this PR elsewhere (e. g. a "Proposal" issue, any other issue, or a thread in the development mailing list), link to that discussion from this PR description and explain what have changed in your final design compared to your original proposal or the consensus version in the end of the discussion. If something hasn't changed since the original discussion, you can omit a detailed discussion of those aspects of the design here, perhaps apart from brief mentioning for the sake of readability of this PR description. --> <!-- Some of the aspects mentioned above may be omitted for simple and small changes. --> #### Release note <!-- Give your best effort to summarize your changes in a couple of sentences aimed toward Druid users. If your change doesn't have end user impact, you can skip this section. --> For tips about how to write a good release note, see [Release notes](https://github.com/apache/druid/blob/master/CONTRIBUTING.md#release-notes). <hr> ##### Key changed/added classes in this PR * `examples/bin/start-druid` * `examples/bin/druid-automated-quickstart.py` * `examples/bin/run-druid` * `examples/conf/druid/single-server/quickstart` <hr> <!-- Check the items by putting "x" in the brackets for the done things. Not all of these items apply to every PR. Remove the items which are not done or not relevant to the PR. None of the items from the checklist below are strictly necessary, but it would be very helpful if you at least self-review the PR. --> This PR has: - [ ] been self-reviewed. - [ ] using the [concurrency checklist](https://github.com/apache/druid/blob/master/dev/code-review/concurrency.md) (Remove this item if the PR doesn't have any relation to concurrency.) - [ ] added documentation for new or modified features or behaviors. - [ ] a release note entry in the PR description. - [ ] added Javadocs for most classes and all non-trivial methods. Linked related entities via Javadoc links. - [ ] added or updated version, license, or notice information in [licenses.yaml](https://github.com/apache/druid/blob/master/dev/license.md) - [ ] added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader. - [ ] added unit tests or modified existing tests to cover new code paths, ensuring the threshold for [code coverage](https://github.com/apache/druid/blob/master/dev/code-review/code-coverage.md) is met. - [ ] added integration tests. - [ ] been tested in a test Druid cluster. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
