Skip to content

Commit 4e9493b

Browse files
author
Hong
authored
[ML-166] Backport to 1.3 to update documentation and Changelog (#169)
* [ML-166] Update Changelog and OAP Documentation * [ML-166] Update Changelog and OAP Documentation * [ML-166] Update Changelog
1 parent 471718c commit 4e9493b

6 files changed

+254
-313
lines changed

CHANGELOG.md

+202-1
Large diffs are not rendered by default.

docs/OAP-Developer-Guide.md

+7-17
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,9 @@
33
This document contains the instructions & scripts on installing necessary dependencies and building OAP modules.
44
You can get more detailed information from OAP each module below.
55

6-
* [SQL Index and Data Source Cache](https://github.com/oap-project/sql-ds-cache/blob/v1.2.0/docs/Developer-Guide.md)
7-
* [PMem Common](https://github.com/oap-project/pmem-common/tree/v1.2.0)
8-
* [PMem Spill](https://github.com/oap-project/pmem-spill/tree/v1.2.0)
9-
* [PMem Shuffle](https://github.com/oap-project/pmem-shuffle/tree/v1.2.0#5-install-dependencies-for-pmem-shuffle)
10-
* [Remote Shuffle](https://github.com/oap-project/remote-shuffle/tree/v1.2.0)
11-
* [OAP MLlib](https://github.com/oap-project/oap-mllib/tree/v1.2.0)
12-
* [Gazelle Plugin](https://github.com/oap-project/gazelle_plugin/tree/v1.2.0)
6+
7+
* [OAP MLlib](https://github.com/oap-project/oap-mllib/tree/v1.3.0)
8+
* [Gazelle Plugin](https://github.com/oap-project/gazelle_plugin/tree/v1.3.0)
139

1410
## Building OAP
1511

@@ -22,22 +18,16 @@ We provide scripts to help automatically install dependencies required, please c
2218
# cd oap-tools
2319
# sh dev/install-compile-time-dependencies.sh
2420
```
25-
*Note*: oap-tools tag version `v1.2.0` corresponds to all OAP modules' tag version `v1.2.0`.
21+
*Note*: oap-tools tag version `v1.3.0` corresponds to all OAP modules' tag version `v1.3.0`.
2622

2723
Then the dependencies below will be installed:
2824

2925
* [Cmake](https://cmake.org/install/)
3026
* [GCC > 7](https://gcc.gnu.org/wiki/InstallingGCC)
31-
* [Memkind](https://github.com/memkind/memkind/tree/v1.10.1)
32-
* [Vmemcache](https://github.com/pmem/vmemcache)
33-
* [HPNL](https://github.com/Intel-bigdata/HPNL)
34-
* [PMDK](https://github.com/pmem/pmdk)
3527
* [OneAPI](https://software.intel.com/content/www/us/en/develop/tools/oneapi.html)
36-
* [Arrow](https://github.com/oap-project/arrow/tree/v4.0.0-oap-1.2.0)
28+
* [Arrow](https://github.com/oap-project/arrow/tree/v4.0.0-oap-1.3.0)
3729
* [LLVM](https://llvm.org/)
3830

39-
- **Requirements for Shuffle Remote PMem Extension**
40-
If enable Shuffle Remote PMem extension with RDMA, you can refer to [PMem Shuffle](https://github.com/oap-project/pmem-shuffle) to configure and validate RDMA in advance.
4131

4232
### Building
4333

@@ -55,9 +45,9 @@ Change to `root` user, run
5545

5646
#### Building OAP specific module
5747

58-
If you just want to build a specific OAP Module, such as `sql-ds-cache`, change to `root` user, then run:
48+
If you just want to build a specific OAP Module, such as `gazelle_plugin`, change to `root` user, then run:
5949

6050
```
6151
# cd oap-tools
62-
# sh dev/compile-oap.sh --component=sql-ds-cache
52+
# sh dev/compile-oap.sh --component=gazelle_plugin
6353
```

docs/OAP-Installation-Guide.md

+2-15
Original file line numberDiff line numberDiff line change
@@ -28,25 +28,11 @@ To test your installation, run the command `conda list` in your terminal window
2828
Create a Conda environment and install OAP Conda package.
2929

3030
```bash
31-
$ conda create -n oapenv -c conda-forge -c intel -y oap=1.2.0
31+
$ conda create -n oapenv -c conda-forge -c intel -y oap=1.3.0
3232
```
3333

3434
Once finished steps above, you have completed OAP dependencies installation and OAP building, and will find built OAP jars under `$HOME/miniconda2/envs/oapenv/oap_jars`
3535

36-
Dependencies below are required by OAP and all of them are included in OAP Conda package, they will be automatically installed in your cluster when you Conda install OAP. Ensure you have activated environment which you created in the previous steps.
37-
38-
- [Arrow](https://github.com/oap-project/arrow/tree/v4.0.0-oap-1.2.0)
39-
- [Plasma](http://arrow.apache.org/blog/2017/08/08/plasma-in-memory-object-store/)
40-
- [Memkind](https://github.com/memkind/memkind/tree/v1.10.1)
41-
- [Vmemcache](https://github.com/pmem/vmemcache.git)
42-
- [HPNL](https://anaconda.org/intel/hpnl)
43-
- [PMDK](https://github.com/pmem/pmdk)
44-
- [OneAPI](https://software.intel.com/content/www/us/en/develop/tools/oneapi.html)
45-
46-
47-
#### Extra Steps for Shuffle Remote PMem Extension
48-
49-
If you use one of OAP features -- [PMem Shuffle](https://github.com/oap-project/pmem-shuffle) with **RDMA**, you need to configure and validate RDMA, please refer to [PMem Shuffle](https://github.com/oap-project/pmem-shuffle#4-configure-and-validate-rdma) for the details.
5036

5137

5238
### Configuration
@@ -57,6 +43,7 @@ Once finished steps above, make sure libraries installed by Conda can be linked
5743
spark.executorEnv.LD_LIBRARY_PATH $HOME/miniconda2/envs/oapenv/lib
5844
spark.executor.extraLibraryPath $HOME/miniconda2/envs/oapenv/lib
5945
spark.driver.extraLibraryPath $HOME/miniconda2/envs/oapenv/lib
46+
spark.executorEnv.CC $HOME/miniconda2/envs/oapenv/bin/gcc
6047
spark.executor.extraClassPath $HOME/miniconda2/envs/oapenv/oap_jars/$OAP_FEATURE.jar
6148
spark.driver.extraClassPath $HOME/miniconda2/envs/oapenv/oap_jars/$OAP_FEATURE.jar
6249
```

docs/User-Guide.md

-220
This file was deleted.

0 commit comments

Comments
 (0)