You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by kl...@apache.org on 2016/11/15 20:49:09 UTC
[22/50] [abbrv] incubator-geode git commit: GEODE-2094 Update
admin/dev REST API documentation
GEODE-2094 Update admin/dev REST API documentation
- Add 3 missing gfsh start server options:
--http-service-port
--http-service-bind-address
--start-rest-api
- Update examples to use these options, instead of using
the older --J=-gemfire. property specification.
Project: http://git-wip-us.apache.org/repos/asf/incubator-geode/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-geode/commit/3db9b309
Tree: http://git-wip-us.apache.org/repos/asf/incubator-geode/tree/3db9b309
Diff: http://git-wip-us.apache.org/repos/asf/incubator-geode/diff/3db9b309
Branch: refs/heads/feature/GEODE-1930
Commit: 3db9b309740ff10a7bc0bc6c4ad9bcea3124f29a
Parents: 5731300
Author: Karen Miller <km...@pivotal.io>
Authored: Thu Nov 10 14:28:40 2016 -0800
Committer: Karen Miller <km...@pivotal.io>
Committed: Fri Nov 11 14:56:12 2016 -0800
----------------------------------------------------------------------
.../cluster_config/gfsh_remote.html.md.erb | 6 +++---
geode-docs/rest_apps/setup_config.html.md.erb | 12 ++++++------
.../gfsh/command-pages/start.html.md.erb | 20 ++++++++++++++++++--
3 files changed, 27 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/3db9b309/geode-docs/configuring/cluster_config/gfsh_remote.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/configuring/cluster_config/gfsh_remote.html.md.erb b/geode-docs/configuring/cluster_config/gfsh_remote.html.md.erb
index c8ea240..a1fab41 100644
--- a/geode-docs/configuring/cluster_config/gfsh_remote.html.md.erb
+++ b/geode-docs/configuring/cluster_config/gfsh_remote.html.md.erb
@@ -28,13 +28,13 @@ To connect `gfsh` using the HTTP protocol to a remote GemFire cluster:
``` pre
gfsh>start server --name=server1 --J=-Dgemfire.jmx-manager=true \
- --J=-Dgemfire.jmx-manager-start=true --J=-Dgemfire.http-service-port=8080 \
- --J=-Dgemfire.http-service-bind-address=myremotecluster.example.com
+ --J=-Dgemfire.jmx-manager-start=true --http-service-port=8080 \
+ --http-service-bind-address=myremotecluster.example.com
```
This command must be executed directly on the host machine that will ultimately act as the remote GemFire server that hosts the HTTP service for remote administration. (You cannot launch a GemFire server remotely.)
-3. On your local system, run the `gfsh` `connect` command to connect to the remote system. Include the `--use-http` and `--url` parameters. For example:
+3. On your local system, run the `gfsh connect` command to connect to the remote system. Include the `--use-http` and `--url` parameters. For example:
``` pre
gfsh>connect --use-http=true --url="http://myremotecluster.example.com:8080/gemfire/v1"
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/3db9b309/geode-docs/rest_apps/setup_config.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/rest_apps/setup_config.html.md.erb b/geode-docs/rest_apps/setup_config.html.md.erb
index 604dd05..71c50f5 100644
--- a/geode-docs/rest_apps/setup_config.html.md.erb
+++ b/geode-docs/rest_apps/setup_config.html.md.erb
@@ -78,8 +78,8 @@ The following procedure starts up a REST API service-enabled Geode deployment:
2. Start a server node with the Geode property `start-dev-rest-api` set to `true`. For example:
``` pre
- gfsh>start server --name=server1 --J=-Dgemfire.start-dev-rest-api=true \
- --J=-Dgemfire.http-service-port=8080 --J=-Dgemfire.http-service-bind-address=localhost
+ gfsh>start server --name=server1 --start-rest-api=true \
+ --http-service-port=8080 --http-service-bind-address=localhost
```
Optionally, you can also configure a `http-service-bind-address` and `http-service-port` to identify the cache server and specific port that will host REST services. If you do not specify the `http-service-port`, the default port is 7070. If you do not specify `http-service-bind-address`, the HTTP service will bind to all local addresses by default.
@@ -87,8 +87,8 @@ The following procedure starts up a REST API service-enabled Geode deployment:
Any server that hosts data, even a server acting as a JMX manager, can start the developer REST API service. For example, to start the service on a server that is also a JMX manager, you would run:
``` pre
- gfsh>start server --name=server1 --J=-Dgemfire.start-dev-rest-api=true \
- --J=-Dgemfire.http-service-port=8080 --J=-Dgemfire.http-service-bind-address=localhost \
+ gfsh>start server --name=server1 --start-rest-api=true \
+ --http-service-port=8080 --http-service-bind-address=localhost \
--J=-Dgemfire.jmx-manager=true --J=-Dgemfire.jmx-manager-start=true
```
@@ -97,8 +97,8 @@ The following procedure starts up a REST API service-enabled Geode deployment:
3. You may also need to specify a CLASSPATH to load any functions that need to be made available to your REST services. For example:
``` pre
- gfsh>start server --name=server1 --J=-Dgemfire.start-dev-rest-api=true \
- --J=-Dgemfire.http-service-port=8080 --J=-Dgemfire.http-service-bind-address=localhost \
+ gfsh>start server --name=server1 --start-rest-api=true \
+ --http-service-port=8080 --http-service-bind-address=localhost \
--classpath=/myapps/testfunctions.jar
```
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/3db9b309/geode-docs/tools_modules/gfsh/command-pages/start.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/tools_modules/gfsh/command-pages/start.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/start.html.md.erb
index ff703cb..06dfce4 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/start.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/start.html.md.erb
@@ -499,6 +499,8 @@ start server --name=value [--assign-buckets(=value)] [--bind-address=value]
[--hostname-for-clients=value] [--max-connections=value]
[--message-time-to-live=value] [--max-message-count=value] [--max-threads=value]
[--socket-buffer-size=value] [--lock-memory=value] [--off-heap-memory-size=value]
+ [--start-rest-api=value]
+ [--http-service-port=value] [--http-service-bind-address=value]
```
<a id="topic_3764EE2DB18B4AE4A625E0354471738A__table_at5_bwg_2w"></a>
@@ -745,11 +747,25 @@ See <a href="../../../configuring/cluster_config/gfsh_persist.html">Overview of
<td>The integer quantity of off-heap memory to be used for storing region values. Specified in Gigabytes with a 'g' suffix, or Megabytes with an 'm' suffix. For example, allocate a 2 Gigabyte off-heap space with <code class="ph codeph">--off-heap-memory-size=2g</code>. The default value of 0 does not use any off-heap memory.</td>
<td>0</td>
</tr>
+<tr class="even">
+<td><span class="keyword parmname">\-\-start-rest-api</span></td>
+<td>When true, starts the REST API service.</td>
+<td>false</td>
+</tr>
+<tr class="even">
+<td><span class="keyword parmname">\-\-http-service-port</span></td>
+<td>Specifies the port on which the HTTP service will listen.</td>
+<td></td>
+</tr>
+<tr class="even">
+<td><span class="keyword parmname">\-\-http-service-bind-address</span></td>
+<td>Specifies the IP address to which the HTTP service will be bound.
+</td>
+<td>all local addresses</td>
+</tr>
</tbody>
</table>
-<span class="tablecap">Table 7. Start Server Parameters</span>
-
### <a id="topic_3764EE2DB18B4AE4A625E0354471738A__section_A50120613D3C4A848463236C4EFF18C7" class="no-quick-link"></a>Examples
``` pre