This is an automated email from the ASF dual-hosted git repository.
jinsongzhou pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/amoro.git
The following commit(s) were added to refs/heads/master by this push:
new f269f6fdd [AMORO-3614][Improvement]: Add a document about deploying
Amoro in IDE (#3615)
f269f6fdd is described below
commit f269f6fdd7e31c6fd4a2b30f5453cf3facd033fd
Author: cxxiii <[email protected]>
AuthorDate: Tue Jun 17 19:20:25 2025 +0800
[AMORO-3614][Improvement]: Add a document about deploying Amoro in IDE
(#3615)
* Change the url of quickstart
* Change the url of quickstart
* Add the document of deploying Amoro on IDE
* Add the document of deploying Amoro on IDE
* revise some formulation in doc and move the doc to CONTRIBUTING
* revise CONTRIBUTING.md
* restore some of the deleted content
---------
Co-authored-by: Xu Bai <[email protected]>
---
CONTRIBUTING.md | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 86 insertions(+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 41339ef57..24a12ce01 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -85,6 +85,92 @@ for reference.
[Build Guide](https://github.com/apache/amoro?tab=readme-ov-file#building) can
be found in GitHub readme.
+## Importing the Amoro project into IntelliJ IDEA
+
+The following guide describes how to import the Amoro project into IntelliJ
IDEA and deploy it.
+
+### Requirements
++ Java Version: Java 8 or Java 11 is required.
+
+#### Required plugins
+1. Go to `Settings` → `Plugins` in IntelliJ IDEA.
+2. Select the “Marketplace” tab.
+3. Search for and install the following plugins:
+ - Scala
+4. Restart IntelliJ IDEA if prompted.
+
+### Import Amoro into IntelliJ IDEA
+This guide is based on IntelliJ IDEA 2024. Some details might differ in other
versions.
+
+1. Clone the repository and create the test configuration file:
+
+```shell
+$ git clone https://github.com/apache/amoro.git
+$ cd amoro
+$ base_dir=$(pwd)
+$ mkdir -p conf
+$ cp dist/src/main/amoro-bin/conf/config.yaml conf/config.yaml
+$ sed -i '' "s|/tmp/amoro/derby|${base_dir}/conf/derby|g" conf/config.yaml
+```
+The above text replacement command is applicable to macOS. In the Linux
system, `-i ''` should be replaced with `-i`.
+
+2. Import the project:
+ 1. Open IntelliJ IDEA and select `File`->`Open`.
+ 2. Choose the root folder of the cloned Amoro repository.
+3. Configure Java version:
+ 1. Open the `Maven` tab on the right side of the IDE.
+ 2. Expand `Profiles` and ensure the selected Java version matches your
IDE's Java version.
+ 3. To check or change the project SDK, go to `File`->`Project
Structure...`->`Project`->`SDK`.
+
+4. Load dependencies
+
+ In the `Maven` tab, click the `Reload All Maven Projects` botton, or
right-click the imported Amoro project in the Project view and select
`Maven`->`Reload project`.
+
+### Start AMS
+1. Open the following file:
+
+`
+{base_dir}/amoro-ams/src/main/java/org/apache/amoro/server/AmoroServiceContainer.java
+`
+
+2. In the top right corner of IntelliJ IDEA, click the `Run
AmoroServiceContainer` button to start the AMS service.
+3. Once the service has started, open your web browser and navigate to:
[http://localhost:1630](http://localhost:1630/)
+4. If you see the login page, the startup was successful. The default username
and password for login are both `admin`.
+
+### Start the optimizer
+#### Add an optimizer group
+1. Open http://localhost:1630 in your browser and log in with admin/admin.
+2. Click on `Optimizing` in the sidebar, select `Optimizer Groups`, and click
the `Add Group` button to create a new group.
+3. Configure the newly added Optimizer group:
+ 
+
+ The following configuration needs to be filled in:
+
+ - Name: the name of the optimizer group, which can be seen in the list of
optimizer groups on the front-end page.
+ - Container: the name of a container configured in containers.
+ - Properties: the default configuration under this group, is used as a
configuration parameter for tasks when the optimize page is scaled out.
+
+
+#### Start an optimizer in IntelliJ IDEA
+1. Open the following file in IntelliJ IDEA:
+
+`
+{base_dir}/amoro-optimizer/amoro-optimizer-standalone/src/main/java/org/apache/amoro/optimizer/standalone/StandaloneOptimizer.java
+`
+
+2. Click the `Run/Debug Configurations` botton in the top right corner of
IntelliJ IDEA and select `Current File`.
+3. Click `More Actions` on the right side and select `Run with Parameters...`.
+4. In `Build and run`, enter the following parameters in the `Program
arguments:`:`-a thrift://127.0.0.1:1261 -p 1 -g local`
+
+ The detailed description of the relevant parameters can be found in
[Managing
Optimizers](https://amoro.apache.org/docs/latest/managing-optimizers/).
+
+5. Click `Apply` and `Run` to start an optimizer.
+6. In the Amoro dashboard, click on `Optimizing` in the sidebar and choose
`Optimizers`. If you see a newly created optimzier, the startup was successful.
+
+### Quickstart
+To quickly explore Amoro's core features, such as self-optimizing, visit
[Quickstart](https://amoro.apache.org/quick-start/).
+
+
## Code suggestions
### Code formatting
