README.md

Suggested Development Environments

• Latest version of Git for your OS: http://git-scm.com/downloads

• JDK 1.7 or above: http://www.oracle.com/technetwork/java/javase/downloads/index.html

• Eclipse IDE For Java Developers. Version 4.2 (Juno) or later: http://www.eclipse.org/downloads/

• Maven 3.0.3 or later: http://maven.apache.org/download.cgi

• Protocol buffer 2.5 [https://code.google.com/p/protobuf/downloads/list] (https://code.google.com/p/protobuf/downloads/list) (Optional requirement. Required only if desired to change the kinetic.proto file. See build.setup.readme for details.)

• For Windows 7 system, install the system patch package for jni: 32 bit: http://www.microsoft.com/en-us/download/details.aspx?id=5555 64 bit: http://www.microsoft.com/en-us/download/details.aspx?id=14632

Project components

The kinetic-java project contains:

• kinetic-client (kinetic java client API and implementation)

• kinetic-simulator (kinetic simulator API and implementation)

• kinetic-common (common library for kinetic-client and kinetic-simulator)

• kinetic-test (test suite for the kinetic-java and kinetic drive implementation)

kinetic-java provides the Java API and Simulator for the Kinetic Open Storage Platform: [https://developers.seagate.com/display/KV/Kinetic+Open+Storage+Documentation+Wiki] (https://developers.seagate.com/display/KV/Kinetic+Open+Storage+Documentation+Wiki)

Client bootstrap class: [https://github.com/Seagate/kinetic-java/blob/master/kinetic-client/src/main/java/kinetic/client/KineticClientFactory.java] (https://github.com/Seagate/kinetic-java/blob/master/kinetic-client/src/main/java/kinetic/client/KineticClientFactory.java)

Simulator bootstrap class: https://github.com/Seagate/kinetic-java/blob/master/kinetic-simulator/src/main/java/kinetic/simulator/KineticSimulator.java

Getting Started With Kinetic drives

• The 4-bay developer kit: [http://youtu.be/2UOepUmAJ3o] (http://youtu.be/2UOepUmAJ3o) https://developers.seagate.com/display/KV/Kinetic+Developer+Kit+Connection+Guide https://developers.seagate.com/display/KV/Development+Chassis

Getting Started With Development

1. Clone the code: git clone https://github.com/Seagate/kinetic-java.git
2. Build the runtime jar files as stated in Getting Started with Simulator below
3. Run the integration tests against the Java Simulator: mvn test -DargLine="-Xmx500M"
4. Run the integration tests but exclude specific files: `mvn test -Dmaven.test.excludes="/File.java,/OtherFile.java"
5. Run the integration tests against the remote instance at a particular path: mvn test -DRUN_AGAINST_EXTERNAL=true -DKINETIC_PATH=/path/to/kinetic_home
6. Run the integration tests against the remote instance at a particular host: mvn test -DRUN_AGAINST_EXTERNAL=true -DKINETIC_HOST=1.2.3.4
7. Run the integration tests against the remote instance at a particular host using SSH to reset state before runs: mvn test -DRUN_AGAINST_EXTERNAL=true -DKINETIC_HOST=1.2.3.4 -DFAST_CLEAN_UP=true

Getting Started With Simulator

1. Run "mvn clean package" in "Kinetic-Folder"

2. Start with java CLI: java -jar in "Kinetic-Folder"/kinetic-simulator/target/kinetic-simulator-"Version"-SNAPSHOT-jar-with-dependencies.jar where "Version" above is the build version number. Such as 0.8.0.1 .

   or Start with script (If configuration tcp_port, tls_port and Kinetic_home, use script -help):

Windows:

  cd "Kinetic-Folder"\bin
  startSimulator.bat

Linux & Mac:

  cd "Kinetic-Folder"/bin
  sh startSimulator.sh

Admin command line Usage

1, make sure "Kinetic-Folder"/kinetic-simulator/target/kinetic-simulator-'Version"-SNAPSHOT-jar-with-dependencies.jar "Kinetic-Folder"/kinetic-client/target/kinetic-client-"Version"-SNAPSHOT-jar-with-dependencies.jar exist

2, start simulator as described in the above section.

3, run admin cli

Windows:

   cd "Kinetic-Folder"/bin
   kineticadmin -help

Linux:

   cd "Kinetic-Folder"/bin
   ./kineticadmin.sh -help

Erasing all data in the Simulator

• The simulator should be running, default port for TCP is 8123, SSL/TLS port is 8443
• You'll need to have recently built .jar (i.e. run mvn package)

1. ./bin/kineticadmin.sh -setup -erase true

Simulator and Java API usage examples

Examples are located at the following directory.

"Kinetic-Folder"/kinetic-test/src/test/java/com/seagate/kinetic/example

Kinetic Javadoc location

To browse Javadoc: [http://seagate.github.io/kinetic-java/] (http://seagate.github.io/kinetic-java/)

To generate Javadoc:

1. Run "mvn clean package" in "Kinetic-Folder".

2. Or run "mvn clean package" in "Kinetic-Folder"/kinetic-client, "Kinetic-Folder"/kinetic-simulator and "Kinetic-Folder"/kinetic-test.

3. Javadoc will be generated for modules in directory of "Kinetic-Folder"/kinetic-client/doc, "Kinetic-Folder"/kinetic-simulator/doc and "Kinetic-Folder"/kinetic-test/doc.

Latest Kinetic release, protocol dependency, and runtime dependencies on maven central

• kinetic-releases: [https://github.com/Seagate/kinetic-java/releases] (https://github.com/Seagate/kinetic-java/releases)

Run smoke test against simulator or kinetic drive

Make sure one instance of simulator or kinetic drive is running.

1. Run "mvn clean package" in "Kinetic-Folder" or "Kinetic-Folder"/kinetic-test, verify that "Kinetic-Folder"/kinetic-test/target/kinetic-test-0.8.0.1-SNAPSHOT-jar-with-dependencies.jar "Kinetic-Folder"/kinetic-test/target/smoke-tests.jar exist.

2. cd "Kinetic-Folder"/bin

3. sh runSmokeTests.sh [-host host_ip] [-port port] [-tlsport tlsport] [-home kinetic_home] or python runSmokeTests.py [-host host_ip] [-port port] [-tlsport tlsport] [-home kinetic_home]