# sprint-2 - added dislaimer text.
Project: http://git-wip-us.apache.org/repos/asf/incubator-ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-ignite/commit/2b3be984 Tree: http://git-wip-us.apache.org/repos/asf/incubator-ignite/tree/2b3be984 Diff: http://git-wip-us.apache.org/repos/asf/incubator-ignite/diff/2b3be984 Branch: refs/heads/ignite-383 Commit: 2b3be98455a98243697123796d5b06a4913c3eb7 Parents: 869b3e2 Author: Dmitiry Setrakyan <dsetrak...@gridgain.com> Authored: Mon Mar 9 15:47:24 2015 -0700 Committer: Dmitiry Setrakyan <dsetrak...@gridgain.com> Committed: Mon Mar 9 15:47:34 2015 -0700 ---------------------------------------------------------------------- NOTICE.txt | 20 --------- README.txt | 25 +++++++++++ RELEASE_NOTES.txt | 39 +++++++++++++++++ docs/ignite_readme.md | 100 -------------------------------------------- docs/ignite_readme.pdf | Bin 77136 -> 0 bytes docs/release_notes.md | 16 ------- docs/release_notes.pdf | Bin 33174 -> 0 bytes 7 files changed, 64 insertions(+), 136 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/2b3be984/NOTICE.txt ---------------------------------------------------------------------- diff --git a/NOTICE.txt b/NOTICE.txt index 42e6c28..e4b9fed 100755 --- a/NOTICE.txt +++ b/NOTICE.txt @@ -19,23 +19,3 @@ http://search.maven.org/#artifactdetails%7Corg.jetbrains%7Cannotations%7C13.0%7C This software has a dependency on Persistent Collections library, licensed under MIT license. https://github.com/blackdrag/pcollections - - -DISCLAIMER ----------- - -Apache Ignite is an effort undergoing incubation at the Apache Software -Foundation (ASF), sponsored by the Apache Incubator PMC. - -Incubation is required of all newly accepted projects until a further review -indicates that the infrastructure, communications, and decision making process -have stabilized in a manner consistent with other successful ASF projects. - -While incubation status is not necessarily a reflection of the completeness -or stability of the code, it does indicate that the project has yet to be -fully endorsed by the ASF. - -For more information about the incubation status of the Apache Ignite project -you can go to the following page: - -http://ignite.incubator.apache.org/ http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/2b3be984/README.txt ---------------------------------------------------------------------- diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..f66f9ee --- /dev/null +++ b/README.txt @@ -0,0 +1,25 @@ +Apache Ignite In-Memory Data Fabric +=================================== + +Ignite In-Memory Data Fabric is designed to deliver high performance for the widest +array of in-memory computing use cases. + +The main feature set of Ignite In-Memory Data Fabric includes: +* Advanced Clustering +* Compute Grid +* Data Grid +* Service Grid +* IGFS - Ignite File System +* Distributed Data Structures +* Distributed Messaging +* Distributed Events +* Streaming & CEP + +For information on how to get started with Apache Ignite please visit: + + http://apacheignite.readme.io/v1.0/docs/getting-started + + +You can find Apache Ignite documentation here: + + http://apacheignite.readme.io/v1.0/docs/getting-started http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/2b3be984/RELEASE_NOTES.txt ---------------------------------------------------------------------- diff --git a/RELEASE_NOTES.txt b/RELEASE_NOTES.txt new file mode 100755 index 0000000..9f8a12f --- /dev/null +++ b/RELEASE_NOTES.txt @@ -0,0 +1,39 @@ + +Apache Ignite In-Memory Data Fabric 1.0 +======================================= + +This is the first release of Apache Ignite project. The source code in large part is based +on the 7 year old GridGain In-Memory Data Fabric, open source edition, v. 6.6.2, which was +donated to Apache Software Foundation in September 2014. + +The main feature set of Ignite In-Memory Data Fabric includes: +* Advanced Clustering +* Compute Grid +* Data Grid +* Service Grid +* IGFS - Ignite File System +* Distributed Data Structures +* Distributed Messaging +* Distributed Events +* Streaming & CEP + + + +DISCLAIMER +========== + +Apache Ignite is an effort undergoing incubation at the Apache Software +Foundation (ASF), sponsored by the Apache Incubator PMC. + +Incubation is required of all newly accepted projects until a further review +indicates that the infrastructure, communications, and decision making process +have stabilized in a manner consistent with other successful ASF projects. + +While incubation status is not necessarily a reflection of the completeness +or stability of the code, it does indicate that the project has yet to be +fully endorsed by the ASF. + +For more information about the incubation status of the Apache Ignite project +you can go to the following page: + +http://ignite.incubator.apache.org/ http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/2b3be984/docs/ignite_readme.md ---------------------------------------------------------------------- diff --git a/docs/ignite_readme.md b/docs/ignite_readme.md deleted file mode 100644 index 58de4fc..0000000 --- a/docs/ignite_readme.md +++ /dev/null @@ -1,100 +0,0 @@ -<center> - -</center> - -<div style="height: 5px"></div> - -## 1. Apache Ignite In-Memory Data Fabric - -Ignite In-Memory Data Fabric is designed to deliver uncompromised performance for the widest array of in-memory computing use cases. - -Following main components are included in the fabric: -* `Advanced Clustering` - support for auto-discovery of cluster nodes in any environment, including, public clouds (e.g. AWS), private clouds, or hybrid clouds. -* `Compute Grid` - includes distributed clustering, messaging, events, and computational features. -* `Data Grid` - partitioned in-memory key-value store with support for ACID transactions, off-heap memory, SQL, and more. -* `Service Grid` - support for managed user-defined services, like cluster singletons, node-singletons, and services with custom deployment topology. -* `Distributed Data Structures` - support for common distributed data structures, like maps, sets, queues, atomics, etc. -* `Streaming & CEP` - supports event workflow, rolling data windows and indexing, continuous querying, and more. -* `Distributed Filesystem` - distributed Hadoop-compliant in-memory file system. -* `Distributed Messaging` - support for topic-based and point-to-point message exchange between cluster nodes. -* `Distributed Events` - support for cluster-wide event notifications. - -## 2. Apache Ignite Installation -Ignite distribution comes in a ZIP file that simply needs to be unzipped, and `IGNITE_HOME` environment variable can optionally be set to point to it. - -There are no additional steps required for Ignite installation in such multi machine setup. - -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. Optional: point `IGNITE_HOME` environment variable to the Ignite installation folder. - -### 2.1 Check Ignite Installation - -To verify Ignite installation, you can execute the Ignite startup script. - -The following command will startup Ignite with default configuration using Multicast node discovery. - - bin/ignite.{sh|bat} - -The following command will startup Ignite with example configuration. - - bin/ignite.{sh|bat} examples/config/example-compute.xml - -If Ignite was installed successfully, the output from above commands should produce no exceptions or errors. -Note that you may see some 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} - -### 2.2 Running Ignite Examples - -Ignite comes with many well documented examples. All examples have documentation about how they should be started and what the expected outcome should be. - -> Use provided pom.xml to import examples into IDE of your choice. - -## 3. Maven -Apache Ignite hosts its Maven artifacts in Apache maven repository as well as in Maven Central. - -### 3.1 Maven Artifacts -You can use maven to add Ignite artifacts to your project. Ignite has one main artifact called `ignite-fabric`. You can also import individual maven artifacts a al carte to bring in more optional dependencies, like `ignite-aws` for AWS integration, for example. All optional maven dependencies are also available in the Ignite installation under `libs/optional` folder. - -### 3.2 Maven Example - - <dependency> - <groupId>org.apache.ignite</groupId> - <artifactId>ignite-fabric</artifactId> - <version>${ignite.version}</version> - <type>pom</type> - </dependency> - - -## 4. Starting Ignite Nodes -Ignite nodes can be started by executing `bin/ignite.{sh|bat}` script and passing a relative path to Ignite configuration file. If no file is passed, then grid nodes are started with default configuration using Multicast discovery protocol. - -Here is an example of how to start Ignite node with non-default configuration: - - `bin/ignite.sh examples/config/example-cache.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. - -## 6. Scala Integration -Ignite provides a very nice and easy to use DSL for Scala users called `Scalar`. If you like Scala, take a look at Scalar examples located under `examples/src/main/scala` folder. - -## 7. Javadoc & Scaladoc -All documentation is shipped with it and you can find it under `docs/javadoc` and `docs/scaladoc` sub-folder respectively. http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/2b3be984/docs/ignite_readme.pdf ---------------------------------------------------------------------- diff --git a/docs/ignite_readme.pdf b/docs/ignite_readme.pdf deleted file mode 100644 index 175d59b..0000000 Binary files a/docs/ignite_readme.pdf and /dev/null differ http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/2b3be984/docs/release_notes.md ---------------------------------------------------------------------- diff --git a/docs/release_notes.md b/docs/release_notes.md deleted file mode 100755 index 592c7f3..0000000 --- a/docs/release_notes.md +++ /dev/null @@ -1,16 +0,0 @@ -<center> - -</center> -##Apache Ignite In-Memory Data Fabric 1.0 -This is the first release of Apache Ignite project. The source code is based on the 7 year old GridGain In-Memory Data Fabric, open source edition, v. 6.6.2, which was donated to Apache Software Foundation in September 2014. - -The main feature set of Ignite In-Memory Data Fabric includes: -* Advanced Clustering -* Compute Grid -* Data Grid -* Service Grid -* IGFS - Ignite File System -* Distributed Data Structures -* Distributed Messaging -* Distributed Events -* Streaming & CEP \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/2b3be984/docs/release_notes.pdf ---------------------------------------------------------------------- diff --git a/docs/release_notes.pdf b/docs/release_notes.pdf deleted file mode 100644 index f08bba5..0000000 Binary files a/docs/release_notes.pdf and /dev/null differ
