Apache
/
druid
mirror of https://github.com/apache/druid.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove unnecessary python topic. Style changes to quickstart. (#13647) 

Co-authored-by: Victoria Lim <vtlim@users.noreply.github.com>
This commit is contained in:
Charles Smith 2023-04-07 09:55:52 -07:00 committed by GitHub
parent a769f14652
commit 166cb6203b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 17 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
docs/operations/python.md
View File

@ -1,49 +0,0 @@
---
id: python
title: "Python Installation"
---
<!--
~ Licensed to the Apache Software Foundation (ASF) under one
~ or more contributor license agreements. See the NOTICE file
~ distributed with this work for additional information
~ regarding copyright ownership. The ASF licenses this file
~ to you under the Apache License, Version 2.0 (the
~ "License"); you may not use this file except in compliance
~ with the License. You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing,
~ software distributed under the License is distributed on an
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~ KIND, either express or implied. See the License for the
~ specific language governing permissions and limitations
~ under the License.
-->
Apache Druid startup script requires Python2 or Python3 interpreter.
Since Python2 is deprecated, this document has instructions to install Python3 interpreter.
## Python3 interpreter installation instructions
### Linux
#### Debian or Ubuntu
- `sudo apt update`
- `sudo apt install -y python3-pip`
#### RHEL
- `sudo yum install -y epel-release`
- `sudo yum install -y python3-pip`
### MacOS
#### Install with Homebrew
Refer [Installing Python 3 on Mac OS X](https://docs.python-guide.org/starting/install3/osx/)
#### Install the official Python release
* Browse to the [Python Downloads Page](https://www.python.org/downloads/) and download the latest version (3.x.x)
Verify if Python3 is installed by issuing `python3 --version` command.

2
docs/tutorials/cluster.md
View File

@ -133,7 +133,7 @@ The [basic cluster tuning guide](../operations/basic-cluster-tuning.md) has info
We recommend running your favorite Linux distribution. You will also need
* [Java 8 or 11](../operations/java.md).
* [Python2 or Python3](../operations/python.md)
* Python 2 or Python 3
> If needed, you can specify where to find Java using the environment variables
> `DRUID_JAVA_HOME` or `JAVA_HOME`. For more details run the `bin/verify-java` script.

29
docs/tutorials/index.md
View File

@ -22,9 +22,9 @@ title: "Quickstart (local)"
~ under the License.
-->
This quickstart gets you started with Apache Druid and introduces you to Druid ingestion and query features. For this tutorial, we recommend a machine with at least 6 GB of RAM.
This quickstart helps you install Apache Druid and introduces you to Druid ingestion and query features. For this tutorial, you need a machine with at least 6 GiB of RAM.
In this quickstart, you'll do the following:
In this quickstart, you'll:
- install Druid
- start up Druid services
- use SQL to ingest and query data
@ -32,20 +32,19 @@ In this quickstart, you'll do the following:
Druid supports a variety of ingestion options. Once you're done with this tutorial, refer to the
[Ingestion](../ingestion/index.md) page to determine which ingestion method is right for you.
## Requirements
## Prerequisites
You can follow these steps on a relatively modest machine, such as a workstation or virtual server with 16 GiB of RAM.
You can follow these steps on a relatively modest machine, such as a workstation or virtual server with 6 GiB of RAM.
The software requirements for the installation machine are:
* Linux, Mac OS X, or other Unix-like OS. (Windows is not supported)
* [Java 8u92+ or Java 11](../operations/java.md)
* [Python2 or Python3](../operations/python.md)
* Python 3 (preferred) or Python 2
* Perl 5
> Druid relies on the environment variables `JAVA_HOME` or `DRUID_JAVA_HOME` to find Java on the machine. You can set
`DRUID_JAVA_HOME` if there is more than one instance of Java. To verify Java requirements for your environment, run the
`bin/verify-java` script.
Java must be available. Either it is on your path, or set one of the `JAVA_HOME` or `DRUID_JAVA_HOME` environment variables.
You can run `apache-druid-{{DRUIDVERSION}}/bin/verify-java` to verify Java requirements for your environment.
Before installing a production Druid instance, be sure to review the [security
overview](../operations/security-overview.md). In general, avoid running Druid as root user. Consider creating a
@ -69,7 +68,7 @@ The distribution directory contains `LICENSE` and `NOTICE` files and subdirector
Start up Druid services using the automatic single-machine configuration.
This configuration includes default settings that are appropriate for this tutorial, such as loading the `druid-multi-stage-query` extension by default so that you can use the MSQ task engine.
You can view that setting and others in the configuration files in the `conf/druid/auto`.
You can view the default settings in the configuration files located in `conf/druid/auto`.
From the apache-druid-{{DRUIDVERSION}} package root, run the following command:
@ -77,7 +76,8 @@ From the apache-druid-{{DRUIDVERSION}} package root, run the following command:
./bin/start-druid
```
This brings up instances of ZooKeeper and the Druid services and may use up to 80% of the total available system memory. To explicitly set the total memory available to Druid, pass a value for the memory parameter, e.g. `./bin/start-druid -m 16g` or `./bin/start-druid --memory 16g`.
This launches instances of ZooKeeper and the Druid services.
For example:
```bash
$ ./bin/start-druid
@ -93,8 +93,11 @@ $ ./bin/start-druid
[Tue Nov 29 16:31:06 2022] Running command[middleManager]: bin/run-druid middleManager /apache-druid-{{DRUIDVERSION}}/conf/druid/single-server/quickstart '-Xms64m -Xmx64m' '-Ddruid.worker.capacity=2 -Ddruid.indexer.runner.javaOptsArray=["-server","-Duser.timezone=UTC","-Dfile.encoding=UTF-8","-XX:+ExitOnOutOfMemoryError","-Djava.util.logging.manager=org.apache.logging.log4j.jul.LogManager","-Xms256m","-Xmx256m","-XX:MaxDirectMemorySize=256m"]'
```
All persistent state, such as the cluster metadata store and segments for the services, are kept in the `var` directory under
the Druid root directory, apache-druid-{{DRUIDVERSION}}. Each service writes to a log file under `var/sv`.
Druid may use up to 80% of the total available system memory.
To explicitly set the total memory available to Druid, pass a value for the memory parameter. For example, `./bin/start-druid -m 16g`.
Druid stores all persistent state data, such as the cluster metadata store and data segments, in `apache-druid-{{DRUIDVERSION}}/var`.
Each service writes to a log file under `apache-druid-{{DRUIDVERSION}}/log`.
At any time, you can revert Druid to its original, post-installation state by deleting the entire `var` directory. You may want to do this, for example, between Druid tutorials or after experimentation, to start with a fresh instance.
@ -102,7 +105,7 @@ To stop Druid at any time, use CTRL+C in the terminal. This exits the `bin/start
## Open the web console
After the Druid services finish startup, open the [web console](../operations/web-console.md) at [http://localhost:8888](http://localhost:8888).
After starting the Druid services, open the [web console](../operations/web-console.md) at [http://localhost:8888](http://localhost:8888).
![web console](../assets/tutorial-quickstart-01.png "web console")