ignite-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sboi...@apache.org
Subject [23/27] incubator-ignite git commit: # refactor ignite README files
Date Fri, 24 Jul 2015 11:57:44 GMT
# refactor ignite README files


Project: http://git-wip-us.apache.org/repos/asf/incubator-ignite/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-ignite/commit/fcf5ecb6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-ignite/tree/fcf5ecb6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-ignite/diff/fcf5ecb6

Branch: refs/heads/ignite-752
Commit: fcf5ecb62ac03b9adfa2be8e91e494c1cedb2b30
Parents: 0055b40
Author: ashutak <ashutak@gridgain.com>
Authored: Fri Jul 24 12:38:20 2015 +0300
Committer: ashutak <ashutak@gridgain.com>
Committed: Fri Jul 24 12:38:20 2015 +0300

----------------------------------------------------------------------
 modules/clients/README.txt            |  16 ++++
 modules/clients/readme.md             |  32 -------
 modules/clients/readme.pdf            | Bin 47887 -> 0 bytes
 modules/hadoop/docs/HADOOP_README.txt | 122 ++++++++++++++++++++++++++
 modules/hadoop/docs/hadoop_readme.md  | 135 -----------------------------
 modules/hadoop/docs/hadoop_readme.pdf | Bin 82219 -> 0 bytes
 modules/yardstick/README.md           |  85 ------------------
 modules/yardstick/README.txt          |  93 ++++++++++++++++++++
 parent/pom.xml                        |   2 +
 9 files changed, 233 insertions(+), 252 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/fcf5ecb6/modules/clients/README.txt
----------------------------------------------------------------------
diff --git a/modules/clients/README.txt b/modules/clients/README.txt
new file mode 100644
index 0000000..8299c33
--- /dev/null
+++ b/modules/clients/README.txt
@@ -0,0 +1,16 @@
+Java Client README
+==================
+Java Client is a lightweight gateway to Ignite nodes.
+
+Client communicates with grid nodes via REST interface and provides reduced but powerful
subset of Ignite API.
+Java Client allows to use Ignite features from devices and environments where fully-functional
Ignite node
+could not (or should not) be started.
+
+Client vs Grid Node
+===================
+Note that for performance and ease-of-use reasons, you should always prefer to start grid
node in your cluster
+instead of remote client. Grid node will generally perform a lot faster and can easily exhibit
client-only
+functionality by excluding it from task/job execution and from caching data.
+
+For example, you can prevent a grid node from participating in caching by setting
+`CacheConfiguration.setDistributionMode(...)` value to either `CLIENT_ONLY` or `NEAR_ONLY`.

http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/fcf5ecb6/modules/clients/readme.md
----------------------------------------------------------------------
diff --git a/modules/clients/readme.md b/modules/clients/readme.md
deleted file mode 100644
index 007daf4..0000000
--- a/modules/clients/readme.md
+++ /dev/null
@@ -1,32 +0,0 @@
-<!--
-  Licensed to the Apache Software Foundation (ASF) under one or more
-  contributor license agreements.  See the NOTICE file distributed with
-  this work for additional information regarding copyright ownership.
-  The ASF licenses this file to You under the Apache License, Version 2.0
-  (the "License"); you may not use this file except in compliance with
-  the License.  You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
--->
-
-<center>
-![Ignite Logo](https://ignite.incubator.apache.org/images/logo3.png "Ignite Logo")
-</center>
-
-## Java Client README
-
-Java Client is a **lightweight gateway** to Ignite nodes.
-
-Client communicates with grid nodes via REST interface and provides reduced but powerful
subset of Ignite API.
-Java Client allows to use Ignite features from devices and environments where fully-functional
Ignite node
-could not (*or should not*) be started.
-
-## Client vs Grid Node
-Note that for performance and ease-of-use reasons, you should always prefer to start grid
node in your cluster instead of remote client. Grid node will generally perform a lot faster
and can easily exhibit client-only functionality by excluding it from task/job execution and
from caching data. 
-

http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/fcf5ecb6/modules/clients/readme.pdf
----------------------------------------------------------------------
diff --git a/modules/clients/readme.pdf b/modules/clients/readme.pdf
deleted file mode 100644
index 5ecb8d8..0000000
Binary files a/modules/clients/readme.pdf and /dev/null differ

http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/fcf5ecb6/modules/hadoop/docs/HADOOP_README.txt
----------------------------------------------------------------------
diff --git a/modules/hadoop/docs/HADOOP_README.txt b/modules/hadoop/docs/HADOOP_README.txt
new file mode 100644
index 0000000..8915554
--- /dev/null
+++ b/modules/hadoop/docs/HADOOP_README.txt
@@ -0,0 +1,122 @@
+1. Apache Ignite In-Memory Accelerator For Apache Hadoop
+========================================================
+
+Ignite In-Memory Accelerator For Apache Hadoop is designed to deliver uncompromised performance
for existing Apache
+Hadoop 2.2 or above applications with zero code change as well as simplicity of installation
and configuration across all the
+supported platforms.
+
+2. Installation
+===============
+
+Ignite distribution comes in a ZIP file that simply needs to be unzipped. The Accelerator
requires Apache Hadoop of
+version 2.2 or above to be already installed on the system either using Apache Bigtop packages
or manually (manual installation
+just means that Apache Hadoop binary distribution must be unpacked somewhere on the system).
In case of manual
+installation `HADOOP_HOME` environment variable must point to the installation directory
of Apache Hadoop.
+
+> NOTE: You do not need any Apache Hadoop processes to be started, you only need to deploy
the Apache Hadoop
+> distribution on your system. Nevertheless you can run Apache Hadoop jobs with Ignite
Accelerator over HDFS,
+> in this case up and running HDFS infrastructure will be needed.
+
+The Accelerator comes with command line setup tool `bin/setup-hadoop.sh` (`bin/setup-hadoop.bat`
on Windows) which
+will guide you through all the needed setup steps (note that the setup tool will require
write permissions to the
+Apache Hadoop installation directory).
+
+Installation requirements:
+
+1. Windows, Linux, or MacOS environment.
+2. Java 7 or 8 (latest update is advisable).
+3. Point `JAVA_HOME` environment variable to your JDK or JRE installation.
+4. Apache Hadoop 2.2 or above installed.
+5. Point `HADOOP_HOME` environment variable to the installation directory of Apache Hadoop.
+6. Run `bin/setup-hadoop.{sh|bat}` setup script and follow instructions.
+
+> NOTE: On Windows platform Apache Hadoop client requires `JAVA_HOME` path to not contain
space characters.
+> Java installed to `C:\\Program Files\` will not work, install JRE to correct location
and point `JAVA_HOME` there.
+
+2.1 Check Apache Ignite Installation
+====================================
+
+After setup script successfully completed, you can execute the Ignite startup script.
+The following command will startup Ignite node with default configuration using multicast
node discovery.
+
+    bin/ignite.{sh|bat}
+
+If Ignite was installed successfully, the output from above commands should produce no exceptions
or errors.
+Note that you may see some other warnings during startup, but this is OK as they are meant
to inform that certain
+functionality is turned on or off by default.
+
+You can execute the above commands multiple times on the same machine and make sure that
nodes discover each other.
+Here is an example of log printout when 2 nodes join topology:
+
+    ... Topology snapshot [nodes=2, CPUs=8, hash=0xD551B245]
+
+You can also start Ignite Management Console, called Visor, and observe started nodes. To
startup Visor, you should execute the following script:
+
+    /bin/ignitevisorcmd.{sh|bat}
+
+3. Configuration
+================
+
+To configure Ignite nodes you can change configuration files at `config` directory of Ignite
installation. Those are conventional Spring files. Please refer to shipped configuration files
and Ignite javadocs for more details.
+
+3.1 Distributed File System Configuration
+=========================================
+
+Ignite has it's own distributed in-memory file system called IgniteFS. Hadoop jobs can use
it instead of HDFS to achieve maximum performance and scalability. Setting up IGFS is much
simpler than HDFS, it requires just few tweaks of Ignite node configuration and does not require
starting any additional processes. Default configuration shipped with the Accelerator contains
one configured instance named "ignitefs" which can be used as reference.
+
+Generally URI for IgniteFS which will be used by Apache Hadoop looks like:
+
+    igfs://igfs_name@host_name
+
+Where `igfs_name` is IgniteFS instance name, `host_name` is any host running Ignite node
with that IgniteFS instance configured.
+For more details please refer to IgniteFS documentation.
+
+3.2 Apache Hadoop Client Configuration
+======================================
+
+To run Apache Hadoop jobs with Ignite cluster you need to configure `core-site.xml` and `mapred-site.xml`
at
+`$HADOOP_HOME/etc/hadoop` directory the same way as it is done in templates shipped with
the Accelerator.
+The setup tool `bin/setup-hadoop.{sh|bat}` will ask you to replace those files with Ignite
templates or
+you can find these templates at `config/hadoop/core-site.ignite.xml` and `config/hadoop/mapred-site.ignite.xml`
+respectively and perform the needed configuration manually.
+
+Apache Hadoop client will need to have Ignite jar files in classpath, the setup tool will
care of that as well.
+
+4. Running Apache Hadoop Job With Ignite In-Memory Accelerator
+==============================================================
+
+To run Apache Hadoop job with Ignite cluster you have to start one or multiple Ignite nodes
and make sure they successfully discovered each other.
+
+When all the configuration is complete and Ignite nodes are started, running Apache Hadoop
job will be the same as with conventional Apache Hadoop distribution except that all Ignite
nodes are equal and any of them can be treated as Job Tracker and DFS Name Node.
+
+To run "Word Count" example you can load some text files to IGFS using standard Apache Hadoop
tools:
+
+    cd $HADOOP_HOME/bin
+
+    ./hadoop fs -mkdir /input
+
+    ./hadoop fs -copyFromLocal $HADOOP_HOME/README.txt /input/WORD_COUNT_ME.txt
+
+Run the job:
+
+    ./hadoop jar $HADOOP_HOME/share/hadoop/mapreduce/*-mapreduce-examples-*.jar wordcount
/input /output
+
+Check results:
+
+    ./hadoop fs -ls /output
+
+    ./hadoop fs -cat /output/part-r-00000
+
+A job can be ran on multiple nodes on localhost or in cluster environment the same way. The
only changes needed to
+switch Apache Hadoop client to a cluster are to fix host in default DFS URI in `core-site.xml`
and host in job tracker
+address in `mapred-site.xml`.
+
+5. Management & Monitoring with Visor
+=====================================
+Ignite comes with CLI (command) based DevOps Managements Console, called Visor, delivering
advance set of management and monitoring capabilities.
+
+To start Visor in console mode you should execute the following command:
+
+    `bin/ignitevisorcmd.sh`
+
+On Windows, run the same commands with `.bat` extension.

http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/fcf5ecb6/modules/hadoop/docs/hadoop_readme.md
----------------------------------------------------------------------
diff --git a/modules/hadoop/docs/hadoop_readme.md b/modules/hadoop/docs/hadoop_readme.md
deleted file mode 100644
index 8f73ede..0000000
--- a/modules/hadoop/docs/hadoop_readme.md
+++ /dev/null
@@ -1,135 +0,0 @@
-<!--
-  Licensed to the Apache Software Foundation (ASF) under one or more
-  contributor license agreements.  See the NOTICE file distributed with
-  this work for additional information regarding copyright ownership.
-  The ASF licenses this file to You under the Apache License, Version 2.0
-  (the "License"); you may not use this file except in compliance with
-  the License.  You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
--->
-
-<center>
-![Ignite Logo](https://ignite.incubator.apache.org/images/logo3.png "Ignite Logo")
-</center>
-
-## 1. Apache Ignite In-Memory Accelerator For Apache Hadoop
-
-Ignite In-Memory Accelerator For Apache Hadoop is designed to deliver uncompromised performance
for existing Apache 
-Hadoop 2.2 or above applications with zero code change as well as simplicity of installation
and configuration across all the 
-supported platforms. 
-
-## 2. Installation
-
-Ignite distribution comes in a ZIP file that simply needs to be unzipped. The Accelerator
requires Apache Hadoop of 
-version 2.2 or above to be already installed on the system either using Apache Bigtop packages
or manually (manual installation
-just means that Apache Hadoop binary distribution must be unpacked somewhere on the system).
In case of manual 
-installation `HADOOP_HOME` environment variable must point to the installation directory
of Apache Hadoop. 
-
-> **NOTE:** You do not need any Apache Hadoop processes to be started, you only need to
deploy the Apache Hadoop 
-> distribution on your system. Nevertheless you can run Apache Hadoop jobs with Ignite
Accelerator over HDFS,
-> in this case up and running HDFS infrastructure will be needed.
-
-The Accelerator comes with command line setup tool `bin/setup-hadoop.sh` (`bin/setup-hadoop.bat`
on Windows) which 
-will guide you through all the needed setup steps (note that the setup tool will require
write permissions to the 
-Apache Hadoop installation directory). 
-
-Installation requirements:
-
-1. Windows, Linux, or MacOS environment.
-2. Java 7 or 8 (latest update is advisable).
-3. Point `JAVA_HOME` environment variable to your JDK or JRE installation.
-4. Apache Hadoop 2.2 or above installed.
-5. Point `HADOOP_HOME` environment variable to the installation directory of Apache Hadoop.
-6. Run `bin/setup-hadoop.{sh|bat}` setup script and follow instructions.
-
-> **NOTE:** On Windows platform Apache Hadoop client requires `JAVA_HOME` path to not
contain space characters.
-> Java installed to `C:\\Program Files\` will not work, install JRE to correct location
and point `JAVA_HOME` there.
-
-### 2.1 Check Apache Ignite Installation
-
-After setup script successfully completed, you can execute the Ignite startup script.
-The following command will startup Ignite node with default configuration using multicast
node discovery.
-
-    bin/ignite.{sh|bat}
-
-If Ignite was installed successfully, the output from above commands should produce no exceptions
or errors.
-Note that you may see some other warnings during startup, but this is OK as they are meant
to inform that certain
-functionality is turned on or off by default.
-
-You can execute the above commands multiple times on the same machine and make sure that
nodes discover each other.
-Here is an example of log printout when 2 nodes join topology:
-
-    ... Topology snapshot [nodes=2, CPUs=8, hash=0xD551B245]
-
-You can also start Ignite Management Console, called Visor, and observe started nodes. To
startup Visor, you should execute the following script:
-
-    /bin/ignitevisorcmd.{sh|bat}
-
-## 3. Configuration
-
-To configure Ignite nodes you can change configuration files at `config` directory of Ignite
installation. Those are conventional Spring files. Please refer to shipped configuration files
and Ignite javadocs for more details.
-
-### 3.1 Distributed File System Configuration
-
-Ignite has it's own distributed in-memory file system called IgniteFS. Hadoop jobs can use
it instead of HDFS to achieve maximum performance and scalability. Setting up IGFS is much
simpler than HDFS, it requires just few tweaks of Ignite node configuration and does not require
starting any additional processes. Default configuration shipped with the Accelerator contains
one configured instance named "ignitefs" which can be used as reference.
-
-Generally URI for IgniteFS which will be used by Apache Hadoop looks like:
-
-    igfs://igfs_name@host_name
-
-Where `igfs_name` is IgniteFS instance name, `host_name` is any host running Ignite node
with that IgniteFS instance configured.
-For more details please refer to IgniteFS documentation.
-
-### 3.2 Apache Hadoop Client Configuration
-
-To run Apache Hadoop jobs with Ignite cluster you need to configure `core-site.xml` and `mapred-site.xml`
at 
-`$HADOOP_HOME/etc/hadoop` directory the same way as it is done in templates shipped with
the Accelerator. 
-The setup tool `bin/setup-hadoop.{sh|bat}` will ask you to replace those files with Ignite
templates or 
-you can find these templates at `config/hadoop/core-site.ignite.xml` and `config/hadoop/mapred-site.ignite.xml`
-respectively and perform the needed configuration manually.
-
-Apache Hadoop client will need to have Ignite jar files in classpath, the setup tool will
care of that as well.
-
-## 4. Running Apache Hadoop Job With Ignite In-Memory Accelerator
-
-To run Apache Hadoop job with Ignite cluster you have to start one or multiple Ignite nodes
and make sure they successfully discovered each other.
-
-When all the configuration is complete and Ignite nodes are started, running Apache Hadoop
job will be the same as with conventional Apache Hadoop distribution except that all Ignite
nodes are equal and any of them can be treated as Job Tracker and DFS Name Node.
-
-To run "Word Count" example you can load some text files to IGFS using standard Apache Hadoop
tools:
- 
-    cd $HADOOP_HOME/bin
- 
-    ./hadoop fs -mkdir /input
-    
-    ./hadoop fs -copyFromLocal $HADOOP_HOME/README.txt /input/WORD_COUNT_ME.txt
-     
-Run the job:
-
-    ./hadoop jar $HADOOP_HOME/share/hadoop/mapreduce/*-mapreduce-examples-*.jar wordcount
/input /output
-
-Check results:
-
-    ./hadoop fs -ls /output
-    
-    ./hadoop fs -cat /output/part-r-00000
-
-A job can be ran on multiple nodes on localhost or in cluster environment the same way. The
only changes needed to 
-switch Apache Hadoop client to a cluster are to fix host in default DFS URI in `core-site.xml`
and host in job tracker 
-address in `mapred-site.xml`.
-
-## 5. Management & Monitoring with Visor
-Ignite comes with CLI (command) based DevOps Managements Console, called Visor, delivering
advance set of management and monitoring capabilities. 
-
-To start Visor in console mode you should execute the following command:
-
-    `bin/ignitevisorcmd.sh`
-
-On Windows, run the same commands with `.bat` extension.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/fcf5ecb6/modules/hadoop/docs/hadoop_readme.pdf
----------------------------------------------------------------------
diff --git a/modules/hadoop/docs/hadoop_readme.pdf b/modules/hadoop/docs/hadoop_readme.pdf
deleted file mode 100644
index ffd8d13..0000000
Binary files a/modules/hadoop/docs/hadoop_readme.pdf and /dev/null differ

http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/fcf5ecb6/modules/yardstick/README.md
----------------------------------------------------------------------
diff --git a/modules/yardstick/README.md b/modules/yardstick/README.md
deleted file mode 100644
index 36f4314..0000000
--- a/modules/yardstick/README.md
+++ /dev/null
@@ -1,85 +0,0 @@
-<!--
-  Licensed to the Apache Software Foundation (ASF) under one or more
-  contributor license agreements.  See the NOTICE file distributed with
-  this work for additional information regarding copyright ownership.
-  The ASF licenses this file to You under the Apache License, Version 2.0
-  (the "License"); you may not use this file except in compliance with
-  the License.  You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
--->
-
-# Yardstick Ignite Benchmarks
-Yardstick Ignite is a set of <a href="http://ignite.incubator.apache.org/">Ignite Grid</a>
benchmarks written on top of Yardstick framework.
-
-## Yardstick Framework
-Visit <a href="https://github.com/gridgain/yardstick" target="_blank">Yardstick Repository</a>
for detailed information on how to run Yardstick benchmarks and how to generate graphs.
-
-The documentation below describes configuration parameters in addition to standard Yardstick
parameters.
-
-## Installation
-1. Create a local clone of Ignite repository
-2. Run `mvn package` command for Yardstick Ignite POM
-
-## Provided Benchmarks
-The following benchmarks are provided:
-
-1. `GetBenchmark` - benchmarks atomic distributed cache get operation
-2. `PutBenchmark` - benchmarks atomic distributed cache put operation
-3. `PutGetBenchmark` - benchmarks atomic distributed cache put and get operations together
-4. `PutTxBenchmark` - benchmarks transactional distributed cache put operation
-5. `PutGetTxBenchmark` - benchmarks transactional distributed cache put and get operations
together
-6. `SqlQueryBenchmark` - benchmarks distributed SQL query over cached data
-7. `SqlQueryJoinBenchmark` - benchmarks distributed SQL query with a Join over cached data
-8. `SqlQueryPutBenchmark` - benchmarks distributed SQL query with simultaneous cache updates
-
-## Writing Ignite Benchmarks
-All benchmarks extend `AbstractBenchmark` class. A new benchmark should also extend this
abstract class and implement `test` method. This is the method that is actually benchmarked.
-
-## Running Ignite Benchmarks
-Before running Ignite benchmarks, run `mvn package` command. This command will compile the
project and also will unpack scripts from `yardstick-resources.zip` file to `bin` directory.
-
-### Properties And Command Line Arguments
-> Note that this section only describes configuration parameters specific to Ignite benchmarks,
and not for Yardstick framework. To run Ignite benchmarks and generate graphs, you will need
to run them using Yardstick framework scripts in `bin` folder.
-
-> Refer to [Yardstick Documentation](https://github.com/gridgain/yardstick) for common
Yardstick properties and command line arguments for running Yardstick scripts.
-
-The following Ignite benchmark properties can be defined in the benchmark configuration:
-
-* `-nn <num>` or `--nodeNumber <num>` - Number of nodes (automatically set in
`benchmark.properties`), used to wait for the specified number of nodes to start
-* `-b <num>` or `--backups <num>` - Number of backups for every key
-* `-cfg <path>` or `--Config <path>` - Path to Ignite configuration file
-* `-sm <mode>` or `-syncMode <mode>` - Synchronization mode (defined in `CacheWriteSynchronizationMode`)
-* `-cl` or `--client` - Client flag
-* `-nc` or `--nearCache` - Near cache flag
-* `-wom <mode>` or `--writeOrderMode <mode>` - Write order mode for ATOMIC caches
(defined in `CacheAtomicWriteOrderMode`)
-* `-txc <value>` or `--txConcurrency <value>` - Cache transaction concurrency
control, either `OPTIMISTIC` or `PESSIMISTIC` (defined in `CacheTxConcurrency`)
-* `-txi <value>` or `--txIsolation <value>` - Cache transaction isolation (defined
in `CacheTxIsolation`)
-* `-ot` or `--offheapTiered` - Flag indicating whether tiered off-heap mode is on
-* `-ov` or `--offheapValuesOnly` - Flag indicating whether off-heap mode is on and only cache
values are stored off-heap
-* `-rtp <num>`  or `--restPort <num>` - REST TCP port, indicates that a Ignite
node is ready to process Ignite Clients
-* `-rth <host>` or `--restHost <host>` - REST TCP host
-* `-ss` or `--syncSend` - Flag indicating whether synchronous send is used in `TcpCommunicationSpi`
-* `-r <num>` or `--range` - Range of keys that are randomly generated for cache operations
-
-For example if we need to run 2 `IgniteNode` servers on localhost with `PutBenchmark` benchmark
on localhost, with number of backups set to 1, synchronization mode set to `PRIMARY_SYNC`,
then the following configuration should be specified in `benchmark.properties` file:
-
-```
-SERVER_HOSTS=localhost,localhost
-    
-# Note that -dn and -sn, which stand for data node and server node, are 
-# native Yardstick parameters and are documented in Yardstick framework.
-CONFIGS="-b 1 -sm PRIMARY_SYNC -dn PutBenchmark -sn IgniteNode"
-```
-
-## Issues
-Use Ignite Apache JIRA (https://issues.apache.org/jira/browse/IGNITE) to file bugs.
-
-## License
-Yardstick Ignite is available under [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
Open Source license.

http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/fcf5ecb6/modules/yardstick/README.txt
----------------------------------------------------------------------
diff --git a/modules/yardstick/README.txt b/modules/yardstick/README.txt
new file mode 100644
index 0000000..c52838d
--- /dev/null
+++ b/modules/yardstick/README.txt
@@ -0,0 +1,93 @@
+Yardstick Ignite Benchmarks
+===========================
+Yardstick Ignite is a set of Ignite Grid (http://ignite.incubator.apache.org/) benchmarks
written on top of Yardstick framework.
+
+Yardstick Framework
+===================
+Visit Yardstick Repository (https://github.com/gridgain/yardstick) for detailed information
on how to run Yardstick benchmarks and how to generate graphs.
+
+The documentation below describes configuration parameters in addition to standard Yardstick
parameters.
+
+Installation
+============
+1. Create a local clone of Ignite repository
+2. Run
+
+mvn package
+
+command for Yardstick Ignite POM
+
+Provided Benchmarks
+===================
+The following benchmarks are provided:
+
+1. `GetBenchmark` - benchmarks atomic distributed cache get operation
+2. `PutBenchmark` - benchmarks atomic distributed cache put operation
+3. `PutGetBenchmark` - benchmarks atomic distributed cache put and get operations together
+4. `PutTxBenchmark` - benchmarks transactional distributed cache put operation
+5. `PutGetTxBenchmark` - benchmarks transactional distributed cache put and get operations
together
+6. `SqlQueryBenchmark` - benchmarks distributed SQL query over cached data
+7. `SqlQueryJoinBenchmark` - benchmarks distributed SQL query with a Join over cached data
+8. `SqlQueryPutBenchmark` - benchmarks distributed SQL query with simultaneous cache updates
+
+Writing Ignite Benchmarks
+=========================
+All benchmarks extend `AbstractBenchmark` class. A new benchmark should also extend this
abstract class
+and implement `test` method. This is the method that is actually benchmarked.
+
+Running Ignite Benchmarks
+=========================
+Before running Ignite benchmarks, run:
+
+mvn package
+
+command. This command will compile the project and also will unpack scripts from `yardstick-resources.zip`
file to `bin` directory.
+
+Properties And Command Line Arguments
+=====================================
+Note that this section only describes configuration parameters specific to Ignite benchmarks,
+and not for Yardstick framework. To run Ignite benchmarks and generate graphs, you will need
to run them using
+Yardstick framework scripts in `bin` folder.
+
+Refer to Yardstick Documentation (https://github.com/gridgain/yardstick) for common Yardstick
properties
+and command line arguments for running Yardstick scripts.
+
+The following Ignite benchmark properties can be defined in the benchmark configuration:
+
+* `-nn <num>` or `--nodeNumber <num>` - Number of nodes (automatically set in
`benchmark.properties`), used to wait for the specified number of nodes to start
+* `-b <num>` or `--backups <num>` - Number of backups for every key
+* `-cfg <path>` or `--Config <path>` - Path to Ignite configuration file
+* `-sm <mode>` or `-syncMode <mode>` - Synchronization mode (defined in `CacheWriteSynchronizationMode`)
+* `-cl` or `--client` - Client flag
+* `-nc` or `--nearCache` - Near cache flag
+* `-wom <mode>` or `--writeOrderMode <mode>` - Write order mode for ATOMIC caches
(defined in `CacheAtomicWriteOrderMode`)
+* `-txc <value>` or `--txConcurrency <value>` - Cache transaction concurrency
control, either `OPTIMISTIC` or `PESSIMISTIC` (defined in `CacheTxConcurrency`)
+* `-txi <value>` or `--txIsolation <value>` - Cache transaction isolation (defined
in `CacheTxIsolation`)
+* `-ot` or `--offheapTiered` - Flag indicating whether tiered off-heap mode is on
+* `-ov` or `--offheapValuesOnly` - Flag indicating whether off-heap mode is on and only cache
values are stored off-heap
+* `-rtp <num>`  or `--restPort <num>` - REST TCP port, indicates that a Ignite
node is ready to process Ignite Clients
+* `-rth <host>` or `--restHost <host>` - REST TCP host
+* `-ss` or `--syncSend` - Flag indicating whether synchronous send is used in `TcpCommunicationSpi`
+* `-r <num>` or `--range` - Range of keys that are randomly generated for cache operations
+
+For example if we need to run 2 `IgniteNode` servers on localhost with `PutBenchmark` benchmark
on localhost,
+with number of backups set to 1, synchronization mode set to `PRIMARY_SYNC`, then the following
configuration
+should be specified in `benchmark.properties` file:
+
+```
+SERVER_HOSTS=localhost,localhost
+...
+
+Note that -dn and -sn, which stand for data node and server node, are native Yardstick parameters
and are documented in Yardstick framework.
+===========================================================================================================================================
+
+CONFIGS="-b 1 -sm PRIMARY_SYNC -dn PutBenchmark -sn IgniteNode"
+```
+
+Issues
+======
+Use Ignite Apache JIRA (https://issues.apache.org/jira/browse/IGNITE) to file bugs.
+
+License
+=======
+Yardstick Ignite is available under Apache 2.0 (http://www.apache.org/licenses/LICENSE-2.0.html)
Open Source license.

http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/fcf5ecb6/parent/pom.xml
----------------------------------------------------------------------
diff --git a/parent/pom.xml b/parent/pom.xml
index 1dbd511..4ca023a 100644
--- a/parent/pom.xml
+++ b/parent/pom.xml
@@ -673,6 +673,8 @@
                                         <exclude>**/*.dylib</exclude><!--bin-files-->
                                         <exclude>**/*.gar</exclude><!--bin-files-->
                                         <exclude>**/licenses/*.txt</exclude><!--files
of licenses-->
+                                        <exclude>**/*readme*.txt</exclude><!--readme
files-->
+                                        <exclude>**/*README*.txt</exclude><!--readme
files-->
                                         <exclude>**/*.timestamp</exclude><!--tmp-files-->
                                         <exclude>**/*.iml</exclude><!--IDEA
files-->
                                         <exclude>**/pom-installed.xml</exclude><!--tmp-files-->


Mime
View raw message