Skip to content

Commit 7d7525a

Browse files
jwomearajwomeara
committed
Merge pull request #409 from ngageoint/doc-updates-0.8.7
Final tweaks to documentation before release
2 parents 8918fbf + a99a51c commit 7d7525a

4 files changed

Lines changed: 82 additions & 12 deletions

File tree

‎docs/content/085-accumulo-config.adoc‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44

55
=== Overview
66

7+
The two high level tasks to configure Accumulo for use with GeoWave are to ensure the memory allocations for the master
8+
and tablet server processes are adequate and to add the GeoWave Accumulo iterator to a classloader. The iterator is a rather
9+
large file so ensure the Accumulo Master process has at least 512m of heap space and the Tablet Server processes have at least
10+
1g of heap space.
11+
712
The recommended Accumulo configuration for GeoWave requires several manual configuration steps but isolates the GeoWave
813
libraries in application specific classpath(s) reducing the possibility of dependency conflict issues. A single user for
914
all of geowave data or a user per data type are two of the many local configuration options just ensure each namespace
@@ -15,25 +20,24 @@ containing GeoWave tables is configured to pick up the geowave-accumulo.jar.
1520
. Grant the user ownership permissions on all tables created within the application namespace
1621
. Create an application or data set specific classpath
1722
. Configure all tables within the namespace to use the application classpath
18-
. Configure GeoWave transaction support
1923

2024
[source, bash]
2125
----
2226
accumulo shell -u root
2327
createuser geowave // <1>
2428
createnamespace geowave
25-
grant NameSpace.CREATE_TABLE -ns geowave -u geowave
26-
config -s general.vfs.context.classpath.geowave=hdfs://NAME_NODE_FQDN:8020/accumulo/classpath/geowave/[^.].*.jar
27-
config -ns geowave -s table.classpath.context=geowave
28-
exit // <2>
29-
# From the node with the GeoWave application server installed
30-
java -cp "/usr/local/geowave/geoserver/webapps/geoserver/WEB-INF/lib/*" mil.nga.giat.geowave.vector.plugin.GeoWaveGTDataStore -z ZOOKEEPER_NODE:2181 -i accumulo -u root -p ROOT_PASSWORD -n geowave -m 20 -r geowave
29+
grant NameSpace.CREATE_TABLE -ns geowave -u geowave <2>
30+
config -s general.vfs.context.classpath.geowave=hdfs://NAME_NODE_FQDN:8020/ACCUMULO_ROOT/classpath/geowave/VERSION_AND_VENDOR_VERSION/[^.].*.jar <3>
31+
config -ns geowave -s table.classpath.context=geowave <4>
32+
exit
3133
----
3234
<1> You'll be prompted for a password
33-
<2> Done with Accumulo specific configs
35+
<2> Ensure the user has ownership of all tables created within the namespace
36+
<3> The Accumulo root path in HDFS varies between hadoop vendors. Cloudera is /accumulo and Hortonworks is /apps/accumulo
37+
<4> Link the namespace with the application classpath, adjust the labels as needed if you've used different user or appilcation names
3438

35-
These manual configuration steps have to be performed once after the first install of GeoWave. After the initial install you
36-
may elect to do further user and namespace creation and configuring to provide isolation between groups and data sets
39+
These manual configuration steps have to be performed before attempting to create GeoWave index tables. After the initial configuration
40+
you may elect to do further user and namespace creation and configuring to provide isolation between groups and data sets.
3741

3842
=== Versioning
3943

@@ -78,7 +82,7 @@ sudo find /tmp -name "*geowave-accumulo.jar" -exec unzip -p {} build.properties
7882
.Example
7983
[source, bash]
8084
----
81-
[spohnae@c1-node-03 ~]$ sudo -u hdfs hadoop fs -cat /accumulo/classpath/geowave/geowave-accumulo-build.properties | grep scm.revision | sed s/project.scm.revision=//
85+
[spohnae@c1-node-03 ~]$ sudo -u hdfs hadoop fs -cat /ACCUMULO_ROOT/classpath/geowave/VERSION_AND_VENDOR_VERSION/geowave-accumulo-build.properties | grep scm.revision | sed s/project.scm.revision=//
8286
294ffb267e6691de3b9edc80e312bf5af7b2d23f <1>
8387
[spohnae@c1-node-03 ~]$ sudo find /tmp -name "*geowave-accumulo.jar" -exec unzip -p {} build.properties \; | grep scm.revision | sed s/project.scm.revision=//
8488
294ffb267e6691de3b9edc80e312bf5af7b2d23f <2>

‎docs/content/105-puppet.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ class { 'geowave::repo':
6060
repo_refresh_md => 0,
6161
} ->
6262
class { 'geowave':
63+
geowave_version => '0.8.7',
6364
hadoop_vendor_version => 'cdh5',
6465
install_accumulo => true,
6566
install_app => true,
@@ -79,6 +80,7 @@ node 'c1-master' {
7980
repo_enabled => 1,
8081
} ->
8182
class { 'geowave':
83+
geowave_version => '0.8.7',
8284
hadoop_vendor_version => 'cdh5',
8385
install_accumulo => true,
8486
install_app => true,
@@ -92,6 +94,7 @@ node 'c1-app-01' {
9294
repo_enabled => 1,
9395
} ->
9496
class { 'geowave':
97+
geowave_version => '0.8.7',
9598
hadoop_vendor_version => 'cdh5',
9699
install_app_server => true,
97100
http_port => '8888',

‎docs/content/manpages/geowave-zktx.txt‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
//:geowave-zktx(1)
2+
//:===============
3+
//::doctype: manpage
4+
5+
NAME
6+
//:----
7+
8+
geowave-zktx - Reserve transaction IDs for long running WFS-T transactions
9+
10+
SYNOPSIS
11+
//:--------
12+
13+
*geowave -zkTx* <options>
14+
15+
DESCRIPTION
16+
//:-----------
17+
18+
The geowave-zkTx(1) operator will create the specified number of transaction IDs for use with long running WFS-T transactions with auto-commit turned off.
19+
These transaction IDs are used as visibility labels in Accumulo to hide ongoing changes until a commit point when the label is removed.
20+
21+
OPTIONS
22+
//:-------
23+
24+
-h,--help::
25+
Display help
26+
27+
-i, --instance-id <arg>::
28+
The Accumulo instance ID
29+
30+
-m,--maximum <arg>::
31+
Maximum number of simultaneous transactions
32+
33+
-n, --namespace <arg>::
34+
The table namespace (optional; default is no namespace)
35+
36+
-p, --password <arg>::
37+
The password for the user
38+
39+
-r,--recipient <arg>::
40+
Recipient application user account for the set of transactions
41+
42+
-u, --user <arg>::
43+
A valid Accumulo user ID
44+
45+
-z, --zookeepers <arg>::
46+
A comma-separated list of zookeeper servers that an Accumulo instance is using
47+
48+
EXAMPLES
49+
//:--------
50+
51+
geowave -zkTx \
52+
-i hdp-accumulo-instance \
53+
-m NUM_SIMULTANEOUS_TRANSACTIONS \
54+
-n NAMESPACE \
55+
-r NAMESPACE_USER \
56+
-u root \
57+
-p ROOT_PWD \
58+
-z ZK_SERVER:2181
59+
60+
This command should output a logging message stating if it added transaction IDs ex: "Added 20 useable transaction IDs". If transactions
61+
have already been allocated it may return a message like "Added 0 useable transactions IDs" which absent any error messages is OK. You
62+
can verify the transactions have been created using a zookeeper client with a command like, "zookeeper-client -server c3-master:2181 ls /geowave/tx"
63+
which should return a list of transaction IDs (guids)

‎extensions/adapters/vector/src/main/java/mil/nga/giat/geowave/adapter/vector/transaction/TransactionAllocationCLIOperation.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public static void main(
5454
"m",
5555
"maximum",
5656
true,
57-
"Maximum number of simulataneous transactions"));
57+
"Maximum number of simultaneous transactions"));
5858
options.addOption(new Option(
5959
"r",
6060
"recipient",

0 commit comments

Comments
 (0)