You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by sf...@apache.org on 2015/06/24 18:00:42 UTC

[3/6] incubator-usergrid git commit: Additional property updates to the re-organized usergrid-default.properties. Also fixed some spelling errors.

Additional property updates to the re-organized usergrid-default.properties.  Also fixed some spelling errors.


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

Branch: refs/heads/two-dot-o-dev
Commit: 0b8545145155021fcf0e1dd6d8fed75d64d2d783
Parents: 5eb332c
Author: Michael Russo <mr...@apigee.com>
Authored: Wed Jun 17 16:48:31 2015 -0700
Committer: Michael Russo <mr...@apigee.com>
Committed: Wed Jun 17 16:48:31 2015 -0700

----------------------------------------------------------------------
 .../main/resources/usergrid-default.properties  | 220 ++++++++++---------
 1 file changed, 119 insertions(+), 101 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/0b854514/stack/config/src/main/resources/usergrid-default.properties
----------------------------------------------------------------------
diff --git a/stack/config/src/main/resources/usergrid-default.properties b/stack/config/src/main/resources/usergrid-default.properties
index 016bf15..af92fa8 100644
--- a/stack/config/src/main/resources/usergrid-default.properties
+++ b/stack/config/src/main/resources/usergrid-default.properties
@@ -27,7 +27,11 @@
 # All properties below will follow the below format:
 #
 #     # Property Description
-#     #property=defaultValue
+#     #
+#     property=value
+#
+# NOTE: If a property is commented out, its value is defaulted elsewhere in the
+#       codebase and put here as a reference that the property can be overridden.
 #
 # DO NOT PUT INSTALLATION SPECIFIC OR CONFIDENTIAL SETTINGS HERE IF YOU PLAN
 # TO COMMIT/PUSH THIS TO GIT.
@@ -47,70 +51,101 @@ usergrid.persistence=CP
 
 
 
-###########################  Datastore (Cassandra)  ###########################
+###########################  Cassandra (Datastore)  ###########################
 #
-# These settings will configure how Usergrid interacts with with Cassandra.
+# These settings will configure how Usergrid interacts with with Cassandra and
+# include properties used in Core Persistence and Classic Entity Manager.
 #
 
-# Tell Usergrid which version of cassandra is being used.
+# Set a property to tell Usergrid which version of cassandra is being used.
+#
 #cassandra.version=1.2
 
-# Set the hosts and port used for connecting to Cassandra.
+
+# Set the Cassandra cluster name that this instance of Usergrid should use.
 #
-#cassandra.hosts=localhost
-#cassandra.port=9160
+cassandra.cluster=Test Cluster
+
+# Set a comma-separated list of one or more Cassandra hosts (host:port) that Usergrid will connect to.
+# If no port is provided, the default Cassandra port of 9160 will be used.
+#
+cassandra.url=localhost:9160
+
+
+# Set the system level keyspace to be used by Usergrid (for management type functions.
+#
+#cassandra.system.keyspace=Usergrid
+
+
+# Set the Cassandra keyspaces to be used by Usergrid for storing data.
+#
+#collections.keyspace=Usergrid_Applications
+cassandra.keyspace.application=Usergrid_Applications
+
+# Set the keyspace strategy to be used.
+#
+cassandra.keyspace.strategy=SimpleStrategy
+
+# Set the replication factor to be used for cassandra.keyspace.application.
+#
+cassandra.keyspace.replication=replication_factor:1
+
+# Tell Usergrid that Cassandra is not embedded.
+#
+cassandra.embedded=false
 
 # Set the maximum number of connections to Cassandra
 #
 #cassandra.connections=100
-cassandra.connections=600
 
 # Read timeout for an individual request (in millseconds)
 #
 #cassandra.timeout=5000
 
-# The name of the cassandra cluster to use.  Helpful is running Usergrid in a
-# multi-tenant environment and sharing clusters.
-#
-#cassandra.cluster=Usergrid
 
 # Set the credentials used for Cassandra, if any.
 #
 cassandra.username=
 cassandra.password=
 
-# Configure specific keyspace that Usergrid will use.  If deploying multiple
-# instances of Usergrid in a single deployment, ensure that that the keyspace
-# name used is the same so data is not segmented.
+# Set the Cassandra consistency levels for use in the cluster. With large
+# clusters, > 3 nodes, these settings could impact read and write performance.
+# For balanced data consistency and performance, choose LOCAL_QUORUM.
 #
-#cassandra.system.keyspace=Usergrid
-#cassandra.keyspace.application=Usergrid_Applications
-#cassandra.keyspace.strategy=org.apache.cassandra.locator.SimpleStrategy
-#cassandra.keyspace.replication=replication_factor:1
-
-
-# Cassandra Consistency levels for use in the cluster.  With large clusters, > 3
-# nodes, these settings could impact read and write performance.  For balanced
-# data consistency and performance, choose LOCAL_QUORUM.  For more info on data
-# consistency, check the Cassandra docs at:
-# <http://docs.datastax.com/en/cassandra/2.0/cassandra/dml/dml_config_consistency_c.html>
+# Usergrid currently uses two different Cassandra drivers (hector and astyanax).
+#
+# For hector:
+#     cassandra.readcl
+#     cassandra.writecl
 #
+# For astyanax:
+#     usergrid.read.cl
+#     usergrid.write.cl
+#
+# You should configure these to use the same consistency levels.  For possible
+# values, see the following docs for each client:
+#
+#  hector: <http://hector-client.github.io/hector/build/html/content/consistency_level.html>
+#  astyanax : <http://netflix.github.io/astyanax/javadoc/com/netflix/astyanax/model/ConsistencyLevel.html>
 
-# Read consistency level.  This is the default Usergrid read consistency.
+# Set the read consistency level.  This is the default Usergrid read consistency.
 #
-#usergrid.read.cl=CL_LOCAL_ONE
+cassandra.readcl=QUORUM
+usergrid.read.cl=CL_QUORUM
 
-# When choosing to perform a consistent read from Usergrid, this is the
-# consistency level used when reading from Cassandra.
+# Set the write consistency level.  This is the default Usergrid write consistency.
 #
-#usergrid.consistent.read.cl=CL_LOCAL_QUORUM
+cassandra.writecl=QUORUM
+usergrid.write.cl=CL_QUORUM
 
-# Write consistency level
+# Set an additional strict read consistency level.  When choosing to perform a
+# consistent read from Usergrid, this is the consistency level used when reading
+# from Cassandra.  Used only with astyanax client.
 #
-#usergrid.write.cl=CL_QUORUM
+#usergrid.consistent.read.cl=CL_LOCAL_QUORUM
 
 
-# Timeout used when writing unique values and logs to the datastore. (in seconds).
+# Set the timeout used when writing unique values and logs to the datastore. (in seconds).
 # If the datastore becomes unavailable before the timeout, the column will expire and
 # not be left around in the application.
 #
@@ -123,8 +158,38 @@ cassandra.password=
 
 # Set the cache size and timeout for entities
 #
-#usergrid.entity_cache_size=200
-#usergrid.entity_cache_timeout_ms=500
+usergrid.entity_cache_size=200
+usergrid.entity_cache_timeout_ms=500
+
+
+# The maximum number of pending mutations allowed in RAM before it is flushed to cassandra
+#
+#cassandra.mutation.flushsize=2000
+
+# Set the Cassandra keyspace to use for locking.
+#
+# NOTE: If this instance is deployed in a production cluster, the replication factor (RF)
+#       on this keyspace MUST be updated to use an odd number. Even numbers for RF can
+#       potentially cause the locks to fail, via "split brain" when read at QUORUM
+#       on lock verification.
+#
+#
+cassandra.lock.keyspace=Locks
+
+# Set read and write consistency level for locking.
+#
+# NOTE: Used by hector client only.
+#
+cassandra.lock.readcl=LOCAL_QUORUM
+cassandra.lock.writecl=LOCAL_QUORUM
+
+# Set a timeout (in milliseconds) before Hector considers a thrift socket dead.
+#
+#cassandra.thriftSocketTimeout=0
+
+# Set a flag that tells Hector whether or not to use the host's TCP keep alive settings.
+#
+#cassandra.useSocketKeepalive=false
 
 
 
@@ -148,19 +213,18 @@ cassandra.password=
 #
 elasticsearch.cluster_name=elasticsearch
 
-# Set the Elasticsearch client node name
-#
-elasticsearch.node_name=default
-
 # Set the Elasticsearch index prefix
 #
 elasticsearch.index_prefix=elasticsearch
 
+# Set the Elasticsearch client node name
+#
+#elasticsearch.node_name=default
+
 # Set how Elasticsearch should be started.  Valid values: embedded, forked or remote
 #
 #elasticsearch.startup=remote
 
-
 # Set the number of shards and replicas to use for the Elasticsearch index.
 # Depending on the use case for Usergrid, these numbers may vary.  A single running
 # instance of Usergrid will always use only 1 index, and you can choose how it's
@@ -169,7 +233,7 @@ elasticsearch.index_prefix=elasticsearch
 #  <https://www.elastic.co/guide/en/elasticsearch/guide/current/routing-value.html>
 #
 #elasticsearch.number_shards=1
-#elasticsearch.number_replicas=1
+#elasticsearch.number_replicas=0
 
 
 # Set an alias used for this running instance of Usergrid.  This allows you to
@@ -286,6 +350,10 @@ usergrid.twodoto.appinfo.migration=true
 #
 #elasticsearch.queue_visibility_timeout=12000000
 
+# Set the timeout in locks from reading messages transitionally from a queue. (in seconds)
+#
+usergrid.queue.lock.timeout=5
+
 
 
 
@@ -365,61 +433,6 @@ usergrid.scheduler.job.queueName=/jobs
 
 
 
-###################  Usergrid Classic Entity Manager Settings  ################
-#
-# Usergrid tests still include pre Core Persistence confgiurations.  The settings below are
-# used for the classic Entity Manager implementation -> usergrid.persistence=EM
-#
-
-# URL for local testing Cassandra cluster
-cassandra.url=localhost:9160
-
-# Name of Cassandra cluster
-cassandra.cluster=Test Cluster
-
-# Keyspace names to be used (see also the locks keyspace below)
-#cassandra.system.keyspace=Usergrid
-#cassandra.application.keyspace=Usergrid_Applications
-
-#cassandra.keyspace.strategy=org.apache.cassandra.locator.SimpleStrategy
-#cassandra.keyspace.strategy=org.apache.cassandra.locator.NetworkTopologyStrategy
-
-#cassandra.keyspace.replication=replication_factor:1
-#cassandra.keyspace.replication=us-east:3
-
-# Read consistency level for the cassandra cluster
-cassandra.readcl=QUORUM
-
-# Write consistency level for the cassandra cluster
-cassandra.writecl=QUORUM
-
-# The maximum number of pending mutations allowed in ram before it is flushed to cassandra
-#cassandra.mutation.flushsize=2000
-
-# Keyspace to use for locking
-# Note that if this is deployed in a production cluster, the RF on the keyspace
-# MUST be updated to use an odd number for it's replication Factor. Even numbers
-# for RF can potentially case the locks to fail, via "split brain" when read at
-# QUORUM on lock verification
-#
-cassandra.lock.keyspace=Locks
-
-# locking read & write policies
-cassandra.lock.readcl=LOCAL_QUORUM
-cassandra.lock.writecl=LOCAL_QUORUM
-
-# Timeout in ms before hector considers a thrift socket dead
-#cassandra.thriftSocketTimeout=0
-# If hector should use host TCP keep alive settings
-#cassandra.useSocketKeepalive=false
-
-# Set the timeout in locks from reading messages transitionally from a queue. (in seconds)
-#
-usergrid.queue.lock.timeout=5
-
-
-
-
 ###############################  Usergrid Central SSO  #############################
 #
 # Usergrid has a feature to provide a distributing SSO system.  The below configurations
@@ -428,8 +441,9 @@ usergrid.queue.lock.timeout=5
 
 # Set the base URL of the central Usergrid SSO server.  This will enable
 # External Token Validation for Admin Users and will configure this Usergrid
-# instance to delegate all Admin User authentication to the central Usegrid SSO
+# instance to delegate all Admin User authentication to the central Usergrid SSO
 # server. See also: https://issues.apache.org/jira/browse/USERGRID-567
+#
 usergrid.central.url=
 
 # Set the HTTP Client connection pool for connections to the SSO central server.
@@ -461,7 +475,7 @@ usergrid.binary.bucketname=usergrid-test
 
 # Set the location for storing and temporary files.
 #
-#usergrid.temp.files=/tmp/usergrid
+usergrid.temp.files=/tmp/usergrid
 
 
 
@@ -540,7 +554,7 @@ usergrid.websocket.disable=true
 
 # Set batch size for when to submit counter batches.
 #
-#usergrid.counter.batch.size=1000
+usergrid.counter.batch.size=1000
 
 # Set the time interval for when to submit counter batches.
 #
@@ -551,6 +565,10 @@ usergrid.websocket.disable=true
 #
 usergrid.version.build=${version}
 
+# Set a unique cluster name that this Usergrid instance is a member of.
+#
+#usergrid.cluster_name=ug
+
 
 
 
@@ -585,7 +603,7 @@ usergrid.test=false
 #########################  Usergrid Activation/Confirmation  ##################
 #
 # Usergrid will send emails for activation and provide links for users to visit
-# for activiation.  In the event that Usergrid is behind a proxy or public endpoint,
+# for activation.  In the event that Usergrid is behind a proxy or public endpoint,
 # the below properties allow the system to use a different URL and control the
 # activation behavior.
 #