Skip to content

Commit

Permalink
docker doco #387
Browse files Browse the repository at this point in the history
  • Loading branch information
JerryShea committed Jan 19, 2022
1 parent 31181ef commit 8ab828b
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
8 changes: 7 additions & 1 deletion docs/CM_FAQs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,13 @@ The same code is run on both Windows and Linux. However, we encourage all our cl
Will Chronicle Map work in *Docker* environments “out-of-the-box”. For example, two java programs running on dockers?

=== Answer
While Chronicle Map has not been tested with *Docker*, we are not aware of any reason why it would not if you use Chronicle Map for IPC (https://en.wikipedia.org/wiki/Inter-process_communication). In other words, if you distribute data between two or more instances of the same map, then the same memory mapped file which holds your map data would have to be available to all the instances of Chronicle Map. We assume this would have to be in the same docker. Alternatively, you could replicate the data between your maps using Chronicle Map Enterprise.
Yes, Chronicle Map works in Docker containers. If you wish to share maps between docker containers and/or the host,
you should ensure that:

* containers share IPC namespace (run with `--ipc="host"`)
* queues are mounted on bind-mounted folders from the host (i.e. `-v /host/dir/1/:/container/dir`)

Alternatively, you could replicate the data between containers using https://chronicle.software/products/map[Chronicle Map Enterprise].

== What are the performance benefits of Disk vs RAM?

Expand Down
2 changes: 1 addition & 1 deletion docs/CM_Features.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ queries*.
- **Durability** - no; Chronicle Map can be persisted to disk, but with no guarantee as to how frequently this
happens. This is under the control of the OS. All data is guaranteed to be written to disk when the Map is closed.
- **Clustering** and **replication** for Chronicle
Map is provided by https://github.com/ChronicleEnterprise/Chronicle-Map-Enterprise[Chronicle Map Enterprise].
Map is provided by https://chronicle.software/products/map[Chronicle Map Enterprise].

== What is the data structure of Chronicle Map?
Simply put, a Chronicle Map data store is a big chunk of shared memory (optionally mapped to disk).
Expand Down
2 changes: 1 addition & 1 deletion docs/CM_Replication.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ try (ReplicatedMap clusterOnHost1 = createCluster(CLUSTER_YAML, 1);
}
....

This example is available in the repository https://github.com/ChronicleEnterprise/Chronicle-Map-Enterprise-Demo/blob/master/Example1/src/main/java/software/chronicle/enterprise/map/demo/example1/ThreeWayMapReplicationExampleMain.java[here]
This example is available in the Chronicle Map Enterprise Demo - for access contact info@chronicle.software

== Replication event logging

Expand Down

0 comments on commit 8ab828b

Please sign in to comment.