Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id C5113200C29 for ; Tue, 14 Feb 2017 01:51:34 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id C3823160B60; Tue, 14 Feb 2017 00:51:34 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 4A255160B6C for ; Tue, 14 Feb 2017 01:51:33 +0100 (CET) Received: (qmail 7933 invoked by uid 500); 14 Feb 2017 00:51:32 -0000 Mailing-List: contact commits-help@geode.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@geode.apache.org Delivered-To: mailing list commits@geode.apache.org Received: (qmail 7921 invoked by uid 99); 14 Feb 2017 00:51:32 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 14 Feb 2017 00:51:32 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 46E68DFC31; Tue, 14 Feb 2017 00:51:32 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: dbarnes@apache.org To: commits@geode.apache.org Date: Tue, 14 Feb 2017 00:51:32 -0000 Message-Id: X-Mailer: ASF-Git Admin Mailer Subject: [1/2] geode git commit: GEODE-2052 Docs to segregate types of properties archived-at: Tue, 14 Feb 2017 00:51:35 -0000 Repository: geode Updated Branches: refs/heads/feature/GEODE-2052 b260cdb78 -> 253579a8e GEODE-2052 Docs to segregate types of properties Project: http://git-wip-us.apache.org/repos/asf/geode/repo Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/7e88f043 Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/7e88f043 Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/7e88f043 Branch: refs/heads/feature/GEODE-2052 Commit: 7e88f0432028656b9a1b5e3cf0f8e71a7a4159a5 Parents: fb14e9a Author: Dave Barnes Authored: Mon Feb 13 15:20:45 2017 -0800 Committer: Dave Barnes Committed: Mon Feb 13 16:46:39 2017 -0800 ---------------------------------------------------------------------- .../topics/gemfire_properties.html.md.erb | 100 ++++++++++++++++++- 1 file changed, 98 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/geode/blob/7e88f043/geode-docs/reference/topics/gemfire_properties.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/reference/topics/gemfire_properties.html.md.erb b/geode-docs/reference/topics/gemfire_properties.html.md.erb index 80b4ee8..914a7a5 100644 --- a/geode-docs/reference/topics/gemfire_properties.html.md.erb +++ b/geode-docs/reference/topics/gemfire_properties.html.md.erb @@ -34,12 +34,14 @@ Unless otherwise indicated, these settings only affect activities within this di - + + Setting Definition +Applies to (Server Locator, Client) Default @@ -47,6 +49,7 @@ Unless otherwise indicated, these settings only affect activities within this di ack-severe-alert-threshold Number of seconds the distributed system will wait after the ack-wait-threshold for a message to be acknowledged before it issues an alert at severe level. A value of zero disables this feature. +S, L 0 @@ -54,16 +57,19 @@ Unless otherwise indicated, these settings only affect activities within this di Number of seconds a distributed message can wait for acknowledgment before it sends an alert to signal that something might be wrong with the system member that is unresponsive.

The waiter continues to wait. The alerts are logged in the system member’s log as warnings.

Valid values are in the range 0...2147483647 +S, L 15 archive-disk-space-limit Maximum size (in megabytes) of all inactive statistic archive files combined. If this limit is exceeded, inactive archive files are deleted, oldest first, until the total size is within the limit. If set to zero, disk space use is unlimited. +S, L 0 archive-file-size-limit The maximum size (in megabytes) of a single statistic archive file. Once this limit is exceeded, a new statistic archive file is created, and the current archive file becomes inactive. If set to zero, file size is unlimited. +S, L 0 @@ -74,6 +80,7 @@ Valid values are in the range 0...2147483647 **Note:**

This setting controls only peer-to-peer communication and does not apply to client/server or multi-site communication.

+S 0 @@ -84,6 +91,7 @@ Valid values are in the range 0...2147483647 **Note:**

This setting controls only peer-to-peer communication and does not apply to client/server or multi-site communication.

+S 8 @@ -93,54 +101,64 @@ Valid values are in the range 0...2147483647 **Note:**

This setting controls only peer-to-peer communication and does not apply to client/server or multi-site communication.

+S, L 60000 bind-address Relevant only for multi-homed hosts - machines with multiple network interface cards. Specifies the adapter card the cache binds to for peer-to-peer communication. Also specifies the default location for Geode servers to listen on, which is used unless overridden by the server-bind-address. An empty string causes the member to listen on the default card for the machine. This is a machine-wide attribute used for system member and client/server communication. It has no effect on locator location, unless the locator is embedded in a member process.

Specify the IP address, not the hostname, because each network card may not have a unique hostname. An empty string (the default) causes the member to listen on the default card for the machine.

+S, L not set cache-xml-file Declarative initialization file for the member's cache. +S cache.xml cluster-configuration-dir This property specifies the directory in which the cluster configuration related disk-store and artifacts are stored. This property is only applicable to dedicated locators that have "enable-cluster-configuration" set to true. +L not set conflate-events Used only by clients in a client/server installation. This is a client-side property that is passed to the server. Affects subscription queue conflation in this client's servers. Specifies whether to conflate (true setting), not conflate (false), or to use the server's conflation setting (server). +S server conserve-sockets Specifies whether sockets are shared by the system member’s threads. If true, threads share, and a minimum number of sockets are used to connect to the distributed system. If false, every application thread has its own sockets for distribution purposes. You can override this setting for individual threads inside your application. Where possible, it is better to set conserve-sockets to true and enable the use of specific extra sockets in the application code if needed. WAN deployments increase the messaging demands on a Geode system. To avoid hangs related to WAN messaging, always set conserve-sockets=false for Geode members that participate in a WAN deployment. +S, L true delta-propagation Specifies whether to distribute the deltas for entry updates, instead of the full values, between clients and servers and between peers. +S true deploy-working-dir Working directory used when deploying JAR application files to distributed system members. This directory can be local and unique to the member or a shared resource. See Deploying Application JARs to Apache Geode Members for more information. + . (current directory) disable-auto-reconnect By default, a Geode member (both locators and servers) will attempt to reconnect and reinitialize the cache after it has been forced out of the distributed system by a network partition event or has otherwise been shunned by other members. Use this property to turn off the autoreconnect behavior. See Handling Forced Cache Disconnection Using Autoreconnect for more details. +S, L false disable-tcp Boolean indicating whether to disable the use of TCP/IP sockets for inter-cache point-to-point messaging. If disabled, the cache uses datagram (UDP) sockets. +S, L false @@ -152,97 +170,116 @@ This setting must be the same for every member of a given distributed system and
Valid values are integers in the range -1...255. -1 means no setting. +S, L -1 durable-client-id Used only for clients in a client/server installation. If set, this indicates that the client is durable and identifies the client. The ID is used by servers to reestablish any messaging that was interrupted by client downtime. +C not set durable-client-timeout Used only for clients in a client/server installation. Number of seconds this client can remain disconnected from its server and have the server continue to accumulate durable events for it. +C 300 enable-network-partition-detection Boolean instructing the system to detect and handle splits in the distributed system, typically caused by a partitioning of the network (split brain) where the distributed system is running. You must set this property to the same value across all your distributed system members. In addition, this property must be set to true if you are using persistent regions and configure your regions to use DISTRIBUTED_ACK or GLOBAL scope to avoid potential data conflicts. +S, L true enable-cluster-configuration A value of "true" causes the creation of cluster configuration on dedicated locators. The cluster configuration service on dedicated locator(s) with this property set to "true" would serve the configuration to new members joining the distributed system and also save the configuration changes caused by the gfsh commands. This property is only applicable to dedicated locators.. +L true enable-time-statistics Boolean instructing the system to track time-based statistics for the distributed system and caching. Disabled by default for performance reasons and not recommended for production environments. You must also configure statistics-sampling-enabled to true and specify a statistics-archive-file. +S, L false enforce-unique-host Whether partitioned regions will put redundant copies of the same data in different members running on the same physical machine. By default, Geode tries to put redundant copies on different machines, but it will put them on the same machine if no other machines are available. Setting this property to true prevents this and requires different machines for redundant copies. +S false groups Defines the list of groups that this member belongs to. Use commas to separate group names. Note that anything defined by the roles gemfire property will also be considered a group. See Using Member Groups for more information. +S not set http-service-bind-address If set, then the Geode member binds the embedded HTTP service to the specified address. If this property is not set but the HTTP service is enabled using http-service-port, then Geode binds the HTTP service to the member's local address. Used by the Geode Pulse Web application and the developer REST API service. +S not set http-service-port If non-zero, then Geode starts an embedded HTTP service that listens on this port. The HTTP service is used to host the Geode Pulse Web application and the development REST API service. If you are hosting the Pulse web app on your own Web server and are not using the development REST API service, then disable this embedded HTTP service by setting this property to zero. Ignored if jmx-manager and start-dev-rest-api are both set to false. +S 7070 jmx-manager If true then this member is willing to be a JMX Manager. All the other JMX Manager properties will be used when it does become a manager. If this property is false then all other jmx-manager-* properties are ignored. + false (except on locators) jmx-manager-bind-address By default the jmx-manager (when configured with a port) will listen on all the local host's addresses. You can use this property to configure what IP address or host name the JMX Manager will listen on for non-HTTP connections. Ignored if JMX Manager is false or jmx-manager-port is zero. + not set jmx-manager-hostname-for-clients Lets you control what hostname will be given to clients that ask the locator for the location of a JMX Manager. By default the IP address that the jmx-manager reports is used. But for clients on a different network this property allows you to configure a different hostname that will be given to clients. Ignored if jmx-manager is false or jmx-manager-port is zero. + not set jmx-manager-http-port Deprecated. Use http-service-port instead. + 7070 jmx-manager-port The port this JMX Manager will listen to for client connections. If this property is set to zero then Geode will not allow remote client connections but you can alternatively use the standard system properties supported by the JVM for configuring access from remote JMX clients. Ignored if jmx-manager is false. + 1099 jmx-manager-start If true then this member will start a jmx manager when it creates a cache. Management tools like gfsh can be configured to connect to the jmx-manager. In most cases you should not set this because a jmx manager will automatically be started when needed on a member that sets "jmx-manager" to true. Ignored if jmx-manager is false. + false jmx-manager-update-rate The rate, in milliseconds, at which this member will push updates to any JMX Managers. Currently this value should be greater than or equal to the statistic-sample-rate. Setting this value too high will cause stale values to be seen by gfsh and Geode Pulse. + 2000 load-cluster-configuration-from-dir Setting this property to "true" causes loading of cluster configuration from "cluster_config" directory in the locator. This property is only applicable to dedicated locators that have "enable-cluster-configuration" set to true. +L false locator-wait-time The number of seconds that a member should wait for a locator to start if a locator is not available when attempting to join the distributed system. Use this setting when you are starting locators and peers all at once. This timeout allows peers to wait for the locators to finish starting up before attempting to join the distributed system. +S 0 @@ -261,16 +298,19 @@ See Using Me **Note:**

If you specify invalid DNS hostnames in this property, any locators or servers started with gfsh will not produce log files. Make sure you provide valid DNS hostnames before starting the locator or server with gfsh.

+S, L not set lock-memory When true, locks heap and off-heap memory into RAM to prevent the operating system from paging the memory out to disk. +S, L false log-disk-space-limit Maximum size in megabytes of all inactive log files combined. If this limit is exceeded, inactive log files are deleted, oldest first, until the total size is within the limit. If set to zero, disk space use is unlimited. +S, L 0 @@ -282,22 +322,26 @@ See Using Me

locator: <locator_name>.log

server: <server_name>.log

+S, L null log-file-size-limit Maximum size in megabytes of a log file before it is closed and logging rolls on to a new (child) log file. If set to 0, log rolling is disabled. +S, L 0 log-level Level of detail of the messages written to the system member’s log. Setting log-level to one of the ordered levels causes all messages of that level and greater severity to be printed.

Valid values from lowest to highest are fine, config, info, warning, error, severe, and none.

+S, L config max-wait-time-reconnect Maximum number of milliseconds to wait for the distributed system to reconnect on each reconnect attempt. +S, L 60000 @@ -309,6 +353,7 @@ See Using Me **Note:**

This setting controls only peer-to-peer communication and does not apply to client/server or multi-site communication. If multicast is enabled, distributed regions use it for most communication. Partitioned regions only use multicast for a few purposes, and mainly use either TCP or UDP unicast.

+S, L

239.192.81.1 for IPv4 (the default IP version)

FF38::1234 for IPv6

@@ -320,6 +365,7 @@ See Using Me **Note:**

This setting controls only peer-to-peer communication, generally between distributed regions.

+S, L 1048576,0.25, 5000 @@ -335,6 +381,7 @@ See Using Me

This setting controls only peer-to-peer communication and does not apply to client/server or multi-site communication.

If you have values specified for the locators property, the mcast-port property defaults to 0.

+S, L 10334 @@ -349,6 +396,7 @@ See Using Me **Note:**

This setting controls only peer-to-peer communication and does not apply to client/server or multi-site communication.

+S, L 1048576 @@ -359,6 +407,7 @@ See Using Me **Note:**

This setting controls only peer-to-peer communication and does not apply to client/server or multi-site communication.

+S, L 65535 @@ -368,12 +417,14 @@ See Using Me **Note:**

This setting controls only peer-to-peer communication and does not apply to client/server or multi-site communication.

+S, L 32 member-timeout Geode uses the member-timeout server configuration, specified in milliseconds, to detect the abnormal termination of members. The configuration setting is used in two ways: 1) First it is used during the UDP heartbeat detection process. When a member detects that a heartbeat datagram is missing from the member that it is monitoring after the time interval of 2 * the value of member-timeout, the detecting member attempts to form a TCP/IP stream-socket connection with the monitored member as described in the next case. 2) The property is then used again during the TCP/IP stream-socket connection. If the suspected process does not respond to the are you alive datagram within the time period specified in member-timeout, the membership coordinator sends out a new membership view that notes the member's failure.

Valid values are in the range 1000..600000.

+S, L 5000 @@ -383,21 +434,25 @@ See Using Me

Therefore, the specified range must include at least three available port numbers (UDP, FD_SOCK, and TCP DirectChannel).

The system uniquely identifies the member using the combined host IP address and UDP port number.

You may want to restrict the range of ports that Geode uses so the product can run in an environment where routers only allow traffic on certain ports.

+S, L 1024-65535 memcached-port If specified and is non-zero, sets the port number for an embedded Gemcached server and starts the Gemcached server. +S 0 memcached-protocol Sets the protocol used by an embedded Gemcached server. Valid values are BINARY and ASCII. If you omit this property, the ASCII protocol is used. +S ASCII name Symbolic name used to identify this system member. +S, L not set @@ -405,12 +460,14 @@ See Using Me Specifies the size of off-heap memory in megabytes (m) or gigabytes (g). For example:

off-heap-memory-size=4096m
 off-heap-memory-size=120g

+ not set redundancy-zone Defines this member's redundancy zone. Used to separate member's into different groups for satisfying partitioned region redundancy. If this property is set, Geode will not put redundant copies of data in members with the same redundancy zone setting. See Configure High Availability for a Partitioned Region for more details. +S not set @@ -420,11 +477,13 @@ See Co

remote-locators=address1[port1],address2[port2]

remote-locators=hostName1@address1[port1],hostName2@address2[port2]

remote-locators=hostName1[port1],hostName2[port2]

+L not set remove-unresponsive-client When this property is set to true, the primary server drops unresponsive clients from all secondaries and itself. Clients are deemed unresponsive when their messaging queues become full on the server. While a client's queue is full, puts that would add to the queue block on the server. +S false @@ -432,67 +491,80 @@ See Co Any security-related (properties that begin with security-) configuration properties that are normally configured in gemfire.properties can be moved to a separate gfsecurity.properties file. Placing these configuration settings in a separate file allows you to restrict access to security configuration data. This way, you can still allow read or write access for your gemfire.properties file. + not set security-client-accessor Deprecated. Used for authorization. Static creation method returning an AccessControl object, which determines authorization of client-server cache operations. This specifies the callback that should be invoked in the pre-operation phase, which is when the request for the operation is received from the client. + not set security-client-accessor-pp Deprecated. Used for authorization. The callback that should be invoked in the post-operation phase, which is when the operation has completed on the server but before the result is sent to the client. The post-operation callback is also invoked for the updates that are sent from server to client through the notification channel. + not set security-client-auth-init Used for authentication. Static creation method returning an AuthInitialize object, which obtains credentials for peers in a distributed system. The obtained credentials should be acceptable to the Authenticator specified through the security-peer-authenticator property on the peers. + not set security-client-authenticator Deprecated. Used for authentication. Static creation method returning an Authenticator object, which is used by a peer to verify the credentials of the connecting peer. + not set security-client-dhalgo Used for authentication. For secure transmission of sensitive credentials like passwords, you can encrypt the credentials using the Diffie-Hellman key exchange algorithm. Do this by setting the security-client-dhalgo system property on the clients to the name of a valid symmetric key cipher supported by the JDK. + not set security-log-file Used with authentication. The log file for security log messages. If not specified, the member's regular log file is used. + not set security-log-level Used with authentication. Logging level detail for security log messages.

Valid values from lowest to highest are fine, config, info, warning, error, severe, and none.

+ config security-manager Specifies the implementation of the SecurityManager interface that implements the callbacks that do authentication and authorization. + not set security-peer-auth-init Deprecated. Used with authentication. Static creation method returning an AuthInitialize object, which obtains credentials for peers in a distributed system. The obtained credentials should be acceptable to the Authenticator specified through the security-peer-authenticator property on the peers. + not set security-peer-authenticator Deprecated. Used with authentication. Static creation method returning an Authenticator object, which is used by a peer to verify the credentials of the connecting peer. + not set security-peer-verifymember-timeout Used with authentication. Timeout in milliseconds used by a peer to verify membership of an unknown authenticated peer requesting a secure connection. + 1000 security-post-processor Specifies the implementation of the PostProcessor interface that implements user-defined callbacks that can change the returned results of region get operations. + not set @@ -501,35 +573,41 @@ Any security-related (properties that begin with

securit
 This is a machine-wide attribute used for communication with clients in client/server and multi-site installations. This setting has no effect on locator configuration.
 Specify the IP address, not the hostname, because each network card may not have a unique hostname.
 An empty string causes the servers to listen on the same card used for peer-to-peer communication. This is either the bind-address or, if that is not set, the machine’s default card.
+S
 not set
 
 
 socket-buffer-size
 Receive buffer sizes in bytes of the TCP/IP connections used for data transmission. To minimize the buffer size allocation needed for distributing large, serializable messages, the messages are sent in chunks. This setting determines the size of the chunks. Larger buffers can handle large messages more quickly, but take up more memory.
+S, L
 32768
 
 
 socket-lease-time
 Time, in milliseconds, a thread can have exclusive access to a socket it is not actively using. A value of zero causes socket leases to never expire. This property is ignored if conserve-sockets is true.
 Valid values are in the range 0..600000.
+S, L
 60000
 
 
 
 ssl-enabled-components
 Components for which to enable SSL. Comma-separated list of one or more of (cluster, gateway, http, jmx, locator, server) or "all".
+
 all
 
 
 
 ssl-require-authentication
 Boolean. Require two-way authentication for SSL-enabled components. Applies to all components except http.
+
 true
 
 
 
 ssl-http-require-authentication
 Boolean. Require two-way authentication for http component.
+
 false
 
 
@@ -537,23 +615,27 @@ Any security-related (properties that begin with securit
 ssl-default-alias
 String. Default certificate name. If empty, use first certificate in key store.
 
+
 
 
 
 ssl-component-alias
 String. Certificate name for specified component, which is one of: cluster, gateway, http, jmx, locator, or server.
 
+
 
 
 
 ssl-ciphers
 Comma-separated list of SSL ciphers or "any"
+
 any
 
 
 
 ssl-protocols
 Comma-separated list of SSL protocols or "any"
+
 any
 
 
@@ -561,17 +643,20 @@ Any security-related (properties that begin with securit
 ssl-keystore, ssl-keystore-password
 Strings. Path to key store, key store password.
 
+
 
 
 
 ssl-truststore, ssl-truststore-password
 Strings. Path to trust store, trust store password.
 
+
 
 
 
 start-dev-rest-api
 If set to true, then the developer REST API service will be started when cache is created. REST service can be configured using http-service-port and http-service-bind-address properties.
+S
 false
 
 
@@ -582,17 +667,20 @@ Any security-related (properties that begin with securit
 start-locator=port1
 If you only specify the port, the address assigned to the member is used for the locator.
 If not already there, this locator is automatically added to the list of locators in this set of gemfire properties.
+S
 not set
 
 
 statistic-archive-file
 The file to which the running system member writes statistic samples. For example: "StatisticsArchiveFile.gfs". An empty string disables archiving. Adding .gz suffix to the file name causes it to be compressed.
+S, L
 not set
 
 
 statistic-sample-rate
 How often to sample statistics, in milliseconds.
 Valid values are in the range 100..60000.
+S, L
 1000
 
 
@@ -603,24 +691,28 @@ If you only specify the port, the address assigned to the member is used for the
 **Note:**
 This setting does not apply to partitioned regions, where statistics are always enabled.
 
+S, L
 false
 
 
 tcp-port
 The TCP port to listen on for cache communications. If set to zero, the operating system selects an available port. Each process on a machine must have its own TCP port. Note that some operating systems restrict the range of ports usable by non-privileged users, and using restricted port numbers can cause runtime errors in Geode startup.
 Valid values are in the range 0..65535.
+S, L
 0
 
 
 tombstone-gc-threshold
 The number of tombstones that can accumulate before the Geode member triggers garbage collection for tombstones. 
 See

How Destroy and Clear Operations Are Resolved.
+S
 100000
 
 
 udp-fragment-size
 Maximum fragment size, in bytes, for transmission over UDP unicast or multicast sockets. Smaller messages are combined, if possible, for transmission up to the fragment size setting.
 Valid values are in the range 1000..60000.
+S, L
 60000
 
 
@@ -628,22 +720,26 @@ See 
 udp-send-buffer-size
 The size of the socket buffer used for outgoing UDP point-to-point transmissions.
 Valid values are in the range 2048..OS_maximum.
+S, L
 65535
 
 
 use-cluster-configuration
-This property is only applicable for data members (non-client and non -ocator). A value of "true" causes a member to request and use the configuration from cluster configuration services running on dedicated locators. Setting this property to "false" causes a member to not request the configuration from the configuration services running on the locator(s).
+This property is only applicable for data members (non-client and non-locator). A value of "true" causes a member to request and use the configuration from cluster configuration services running on dedicated locators. Setting this property to "false" causes a member to not request the configuration from the configuration services running on the locator(s).
+L
 true
 
 
 user-command-packages
 A comma separated list of Java packages that contain classes implementing the CommandMarker interface. Matching classes will be loaded when the VM starts and will be available in the GFSH command-line utility.
+
 not set