You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by dp...@apache.org on 2018/09/24 13:52:40 UTC

ignite git commit: IGNITE-8022 Need to add README.txt for ignite-direct-io

Repository: ignite
Updated Branches:
  refs/heads/ignite-8022 [created] ab55b32d9


IGNITE-8022 Need to add README.txt for ignite-direct-io


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

Branch: refs/heads/ignite-8022
Commit: ab55b32d96a8a5f8913852c43112478022e44e17
Parents: b769f25
Author: Dmitriy Pavlov <dp...@apache.org>
Authored: Mon Sep 24 16:52:03 2018 +0300
Committer: Dmitriy Pavlov <dp...@apache.org>
Committed: Mon Sep 24 16:52:03 2018 +0300

----------------------------------------------------------------------
 modules/direct-io/README.txt | 48 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/ignite/blob/ab55b32d/modules/direct-io/README.txt
----------------------------------------------------------------------
diff --git a/modules/direct-io/README.txt b/modules/direct-io/README.txt
new file mode 100644
index 0000000..90e0944
--- /dev/null
+++ b/modules/direct-io/README.txt
@@ -0,0 +1,48 @@
+Apache Ignite Direct IO Module
+------------------------
+
+Apache Ignite Direct IO is plugin, which provides page store with ability to write and read cache partitions
+in O_DIRECT mode.
+
+OS gets the data and stores it in a file buffer cache. Similarly, for every write operation,
+the OS first writes the data in a cache and then transfers to the disk. To eliminate this process you can enable
+Direct I/O in which case the data is read and written directly from/to the disk bypassing the file buffer cache.
+
+Direct I/O plugin in Ignite is used for the checkpointing process where the dirty pages in RAM are written to the disk.
+
+Importing Cloud Module In Maven Project
+-------------------------------------
+
+If you are using Maven to manage dependencies of your project, you can add Direct IO Module
+dependency like this (replace '${ignite.version}' with actual Ignite version you are
+interested in):
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
+                        http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    ...
+    <dependencies>
+        ...
+        <dependency>
+            <groupId>org.apache.ignite</groupId>
+            <artifactId>ignite-direct-io</artifactId>
+            <version>${ignite.version}</version>
+        </dependency>
+        ...
+    </dependencies>
+    ...
+</project>
+
+For gradle you can add compile dependency, where igniteVersion is actual Ignite version:
+
+compile group: 'org.apache.ignite', name: 'ignite-direct-io', version: igniteVersion
+
+Additional setup is not required. Once plugin is available in classpath, it will be used for Durable Memory IO.
+
+-------------------------------------
+See more information in Apache Ignite documentation:
+https://apacheignite.readme.io/docs/durable-memory-tuning#section-enabling-direct-i-o
+
+and description of internal desing can be found in Wiki:
+https://cwiki.apache.org/confluence/display/IGNITE/Ignite+Persistent+Store+-+under+the+hood#IgnitePersistentStore-underthehood-DirectI/O
\ No newline at end of file