Node.js version 8 or higher is required. Either download the Node.js pre-built binary for the target platform, or install Node.js via package manager.
Once node
and npm
are installed, you can use one of the following installation options.
Execute the following command to install the Node.js Thin Client package:
npm install -g apache-ignite-client
If you want to install the Thin Client library from Ignite sources, please follow the steps:
- Download Ignite sources to
local_ignite_path
- Go to
local_ignite_path/modules/platforms/nodejs
folder - Execute
npm link
command - Execute
npm link apache-ignite-client
command (needed only for examples)
cd local_ignite_path/modules/platforms/nodejs
npm link
npm link apache-ignite-client #linking examples (optional)
For more information, see Apache Ignite Node.JS Thin Client documentation.
Tests are installed along with the client. Follow the Installation instructions.
- Run Ignite server locally or remotely with default configuration.
- Set the environment variable:
- APACHE_IGNITE_CLIENT_ENDPOINTS - comma separated list of Ignite node endpoints.
- APACHE_IGNITE_CLIENT_DEBUG - (optional) if true, tests will display additional output (default: false).
- Alternatively, instead of the environment variables setting, you can directly specify the values of the corresponding variables in nodejs-thin-client/spec/config.js file.
- Run the tests:
Call npm test
command from nodejs-thin-client
folder.
Call npm run test:examples
command from nodejs-thin-client
folder.
Active Ignite server node with non-default configuration is required (authentication and TLS switched on).
If the server runs locally:
- setup the server to accept TLS. During the setup use
keystore.jks
andtruststore.jks
certificates fromnodejs-thin-client/examples/certs/
folder. Password for the files:123456
- switch on the authentication on the server. Use the default username/password.
If the server runs remotely, and/or other certificates are required, and/or non-default username/password is required - see this instruction.
Call npm run test:auth_example
command from nodejs-thin-client
folder.
- Obtain certificates required for TLS:
-
either use pre-generated certificates provided in the examples/certs folder. Password for the files:
123456
. Note, these certificates work for an Ignite server installed locally only. -
or obtain other existing certificates applicable for a concrete Ignite server.
-
or generate new certificates applicable for a concrete Ignite server.
-
The following files are needed:
- keystore.jks, truststore.jks - for the server side
- client.key, client.crt, ca.crt - for the client side
-
Place client.key, client.crt and ca.crt files somewhere locally, eg. into the examples/certs folder.
-
If needed, modify
TLS_KEY_FILE_NAME
,TLS_CERT_FILE_NAME
andTLS_CA_FILE_NAME
constants in the example source file. The default values point to the files in the examples/certs folder. -
Setup Ignite server to accept TLS - see appropriate Ignite documentation. Provide the obtained keystore.jks and truststore.jks certificates during the setup.
-
Switch on and setup authentication in Ignite server - see appropriate Ignite documentation.
-
If needed, modify
USER_NAME
andPASSWORD
constants in the example source file. The default values are the default Ignite username/password.
-
Start three Ignite server nodes.
-
If needed, modify
ENDPOINT1
,ENDPOINT2
,ENDPOINT2
constants in an example source file - Ignite node endpoints. Default values arelocalhost:10800
,localhost:10801
,localhost:10802
respectively. -
Run an example by calling
node FailoverExample.js
. -
Shut down the node the client is connected to (you can find it out from the client logs in the console).
-
From the logs, you will see that the client automatically reconnects to another node which is available.
-
Shut down all the nodes. You will see the client being stopped after failing to connect to each of the nodes.
It should be done if a public API class/method has been changed.
- Execute
npm install -g jsdoc
to install jsdoc (https://www.npmjs.com/package/jsdoc) - Go to
nodejs-thin-client/api_spec
- Execute
jsdoc -c conf.json --readme index.md
command.
Note: nodejs-thin-client/api_spec/conf.json
is a file with jsdoc configuration.
For more information, see Ignite Node.js Thin Client documentation.