DolphinDB ARM Standalone Deployment
This tutorial is a quick start guide describing how to deploy the DolphinDB ARM standalone, and update the server and license file. You can also find solutions to common issues in the FAQ section.
System Requirements
These are basic requirements for installing DolphinDB:
Operating system: Linux (kernel 3.10 or above)
RAM: 2 GB or above
Flash memory: 8 GB or above
Supported ARM CPU:
- CORTEXA15
- CORTEXA9
- ARMV7
- ARMV8
- CORTEXA53
- CORTEXA57
- CORTEXA72
- CORTEXA73
- FALKOR
- THUNDERX
- THUNDERX2T99
- TSV110
Cross compiler for 32-bit systems: arm-linux-gnueabihf4.9
Cross compiler for 64-bit systems: aarch64-linux-gnu_4.9.3
If you encounter any problems, contact us (support@dolphindb.com) for technical support.
Deploy DolphinDB ARM Standalone
Step 1: Download
- Official website: DolphinDB
- Or you can download DolphinDB for ARM with a shell command:
wget https://www.dolphindb.com/downloads/DolphinDB_ARM64_V${release}.zip -O dolphindb.zip
${release}
refers to the version of DolphinDB server. For example, you can download ARM64 server 2.00.11.3 with the following command:
wget https://www.dolphindb.com/downloads/DolphinDB_ARM64_V2.00.11.3.zip -O dolphindb.zip
- Then extract the installation package to the specified directory (
/path/to/directory
):
unzip dolphindb.zip -d </path/to/directory>
Note: The directory name cannot contain any space characters, otherwise the startup of the data node will fail.
Step 2: Update License File
If you have obtained the Enterprise Edition license, use it to replace the following file:
/DolphinDB/server/dolphindb.lic
Otherwise, you can continue to use the community version of DolphinDB, which allows up to 8GB RAM use for 20 years.
Step 3: Run DolphinDB Server
Navigate to the folder /DolphinDB/server . The file permissions need to be modified for the first startup. Execute the following shell command:
chmod +x dolphindb
Due to the limited memory of the system, you need to modify the memory-related configuration parameters according to your device for the first startup. Execute the following shell command:
vim dolphindb.cfg
The default port number of the system is 8848. You can change it (e.g., to 8900) with the parameter localSite:
localSite=localhost:8900:local8900
Specify the maximum amount of memory (in GB) allocated to DolphinDB with parameter maxMemSize, e.g., to set it to 0.8 GB:
maxMemSize=0.8
Specify the maximum amount of memory (in MB) allocated to an array with parameter regularArrayMemoryLimit. It must be the exponential power of 2 with the default value of 512. To set it to 64 MB:
regularArrayMemoryLimit=64
Set the parameter maxLogSize. When the log file reaches the specified size it will be archived. The default value is 1024 MB and the minimum value is 100 MB. To set it to 100MB:
maxLogSize=100
Linux console mode:
./dolphindb
Linux background mode:
sh startSingle.sh
To check whether the node was started, execute the following shell command:
ps aux|grep dolphindb
The following information indicates a successful startup:
Step 4: Check the Node Status on DolphinDB Web
Enter the deployment server IP address and port number (8848 by default) in the browser to navigate to the DolphinDB Web. The server address (ip:port) used in this tutorial is 10.0.0.82:8848. Below is the web interface.
Note: If the browser and DolphinDB are not deployed on the same server, you should turn off the firewall or open the corresponding port beforehand.
Update DolphinDB Server
Step 1: Close the Server
Navigate to the folder /DolphinDB/server/clusterDemo to execute the following command:
./stopAllNode.sh
Step 2: Back up the Metadata
The default directory to save the metadata for a standalone mode is:
/DolphinDB/server/local8848/dfsMeta/
/DolphinDB/server/local8848/storage/CHUNK_METADATA/
Back up the metadata with the following command:
mkdir backup
cp -r local8848/dfsMeta/ backup/dfsMeta
cp -r local8848/storage/CHUNK_METADATA/ backup/CHUNK_METADATA
Note: If the backup files are not in the above default directories, check the directories specified by the configuration parameters dfsMetaDir and chunkMetaDir. If the configuration parameters are not modified but the configuration parameter volumes is specified, then you can find the CHUNK_METADATA under the volumes directory.
Step 3: Upgrade
Note: When the server is upgraded to a certain version, the plugin should also be upgraded to the corresponding version.
Download a new version of server package from DolphinDB website.
Replace the existing server with all files (except dolphindb.cfg and dolphindb.lic) in the current \DolphinDB\server folder.
Step 4: Restart the Server
Navigate to the folder /DolphinDB/server to start the server with the following command:
sh startSingle.sh
Open the web interface and execute the following script to check the current version of DolphinDB.
version()
Update License File
Step 1: Replace the License File
Replace an existing license file with a new one.
License file path:
/DolphinDB/server/dolphindb.lic
Step 2: Update License File
Online Update
Execute the following script in web interface:
updateLicense()
Note:
- The client name of the license cannot be changed.
- The number of nodes, memory size, and the number of CPU cores cannot be smaller than the original license.
- The update takes effect only on the node where the function is executed. Therefore, in a cluster mode, the function needs to be run on all controllers, agents, data nodes, and compute nodes.
- The license type must be either commercial (paid) of free.
Offline Update
Restart DolphinDB server to complete the updates.
FAQ
Q1: Failed to start the server for the port is occupied by other programs
The default port number of the system is 8848. If you cannot start the server, you can first check the log file dolphindb.log under /DolphinDB/server.
If the following error occurs, it indicates that the specified port is occupied by other programs.
<ERROR> :Failed to bind the socket on port 8848 with error code 98
In such case, you can change to another free port in the config file.
Q2: Failed to access the web interface
Despite the server running and the server address being correct, the web interface remains inaccessible.
The common reason for the above problem is that the browser and DolphinDB are not deployed on the same server, and the server where DolphinDB is deployed has a firewall on. You can solve this issue by turning off the firewall or by opening the corresponding port.
Q3: Roll back a failed upgrade on Linux
If you cannot start DolphinDB server after upgrade, you can follow steps below to roll back to the previous version.
Step 1: Restore Metadata Files
Navigate to the folder /DolphinDB/server to restore metadata files from backup with the following commands:
cp -r backup/dfsMeta/ local8848/dfsMeta cp -r backup/CHUNK_METADATA/ local8848/storage/CHUNK_METADATA
Step 2: Restore Program Files
Download the previous version of server package from the official website. Replace the server that failed to update with all files (except dolphindb.cfg and dolphindb.lic) just downloaded.
Q4: Failed to update the license file
Updating the license file online has to meet the requirements listed in Step 2, Chapter 4.
If not, you can choose to update offline or apply for an Enterprise Edition License.
Q5: Change configuration
For more details on configuration parameters, refer to Configuration.
If you encounter performance problems, you can contact our team on Slack for technical support.