Quick_Start.md

Quick Start

---

---

In order to experience Metal quickly, you can create a test environment through the following installation steps.

Pre-Prepared

• OpenJDK 11 and above
• npm 9.5.0 and above
• Docker
• docker-compose
• maven
• mongodb tools

Compile & Package

Under the root directory of the Metal project, execute the following command to compile and package.

mvn clean package -pl metal-dist -am -Dmaven.test.skip=true 

If an error about spotless appears, you should execute mvn spotless:apply to format code and package again.

The packaged content is saved in the ./metal-dist/target/metal-dist-${version} directory.

./metal-dist/target/metal-dist-1.0.0-SNAPSHOT-bin
├── conf
│   ├── backend
│   │   ├── log4j.properties
│   │   ├── META-INF
│   │   └── zookeeper.json
│   ├── conf
│   │   └── metal-server.json
│   ├── log4j.properties
│   ├── metal-server.openapi.json
│   └── zookeeper.json
├── doc
│   ├── Architecture_cn.md
│   ├── Architecture.md
│   ├── img
│   │   └── resources
│   ├── Quick_Start_cn.md
│   └── Quick_Start.md
├── libs
...
│   ├── metal-backend-1.0.0-SNAPSHOT.jar
│   ├── metal-backend-api-1.0.0-SNAPSHOT.jar
│   ├── metal-core-1.0.0-SNAPSHOT.jar
│   ├── metal-on-spark-1.0.0-SNAPSHOT.jar
│   ├── metal-on-spark-extensions-1.0.0-SNAPSHOT.jar
│   ├── metal-server-1.0.0-SNAPSHOT.jar
...

├── LICENSE
├── README_cn.md
├── README.md
├── sbin
│   └── db
│       ├── execs.json
│       ├── metals.json
│       ├── project.json
│       └── user.json
├── tools
│   └── metal-maven-plugin-1.0.0-SNAPSHOT.jar
└── ui
    └── webroot
        ├── asset-manifest.json
        ├── favicon.ico
        ├── images
        ├── index.html
        ├── logo192.png
        ├── logo512.png
        ├── manifest.json
        ├── robots.txt
        └── static

Running Environment

Start Service

Enter the ./metal-test/docker directory under the project root directory, and start related dependent services (including MongoDB, MongoDB Express, Zookeeper, Spark Standalone cluster and HDFS) through the following command.

docker-compose up -d

Of course, if you don't plan to perform any tasks and just want to experience the effect of Metal, you can only start MongoDB and Zookeeper. Just execute the following command.

docker-compose up -d mongo zoo0

Initialize MongoDB

First, you need to create a separate database and user in MongoDB for Metal. For example, to create a user named metal and metalDB database, you can execute the following command in mongosh,

use metalDB
db.createUser({
  user: 'metal', 
  pwd: '123456', 
  roles: [{role: 'root', db: 'admin'}]
})

The root user password of MongoDB in the quick-start environment is 123456, the address is 192.168.42.50, and the port is 27017.

Next, you need to import the db script in the build directory to the database. Just execute the following command,

ls ../../metal-dist/target/metal-dist-${version}/sbin/db | awk -F '.' '{print $1}' | xargs -I {} mongoimport -c {} --type json --file ../../metal-dist/target/metal-dist-${version}/sbin/db/{}.json mongodb://<credentials>@<host>:<port>/metalDB

Configure

After the project is compiled and packaged, the relevant configuration files will be copied to the $METAL/metal-dist/target/metal-dist-${version}/conf directory. If you use custom MongoDB and Zookeeper, you need to modify the relevant configuration files, otherwise skip this part.

• MongoDB: The following items in $METAL/metal-dist/target/metal-dist-${version}/conf/conf/metal-server.json need to be modified to the service configuration you use.

{
  ...
  "mongoConf": {
    "connection_string": "mongodb://<credentials>@<host>:<port>/<CUSTOM_DB>"
  },
  ...
}

• Zookeeper: The following items in $METAL/metal-dist/target/metal-dist-${version}/conf/zookeeper.json need to be modified to the service configuration you use.

  {
    ...
    "zookeeperHosts": "<ZOOKEEPER_HOST>",
    ...
  }

Start Metal Server

In the root directory of the project, execute the following command to complete the startup.

java -cp ./metal-dist/target/metal-dist-${version}/libs/metal-server-{VERSION}.jar:./metal-dist/target/metal-dist-${version}/ui:./metal-dist/target/metal-dist-${version}/conf org.metal.server.GatewayLauncher

Finally, open the browser and access the link http://localhost:19000.

The test username is jack, and the password is 123456.