Skip to content

Commit 19f19f9

Browse files
committed
final updates to RN upgrade topic, updates to Web UI topics in Admin guide, wrote CLI intro
1 parent 96757fb commit 19f19f9

8 files changed

+74
-24
lines changed

site/content/xap/12.3/admin/admin-interactive-cli.markdown

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,24 @@ weight: 100
66
parent: admin-tools.html
77
---
88

9-
10-
9+
GigaSpaces provides a Command Line Interface (CLI) tool for administering both XAP and InsightEdge. The CLI is based on the REST Manager API, enabling users to administer local, remote, and cloud-based application environments. In addition to the REST Manager API operations, the CLI supports certain administration tasks in the open source application editions.
1110

11+
Users that are administering a XAP environment should use the `xap` script. For example:
1212

13-
# Interactive Command Line
14-
15-
![image](/attachment_files/admin/xap-cli.png)
13+
`xap space deploy`
1614

15+
Users that are administering InsightEdge should use the `insightedge` CLI script, which contains all of the actions available with the `xap` script, plus additional options where relevant for administering InsightEdge components.
1716

17+
Use the `--help` command to see the syntax of a specified CLI command, or a list of all available commands. The list of commands may vary depending on whether you are running the XAP or the InsightEdge script. For example,
18+
the list of commands for `insightedge host run-agent --help` contains all the actions available under `xap host run-agent --help`, plus additional options for administering the Spark master and worker components.
1819

20+
{{%info "Info"%}}
21+
If you have recently upgraded to version 12.3, note that this is a new version of the CLI tool and uses a different syntax and command set. We encourage using this new version, but if you need information about the old CLI commands, refer to the [GigaSpaces CLI](command-line-interface.html) pages in the [Legacy Tools](admin-legacy-tools.html) section.
22+
{{%/info%}}
1923

20-
# Open source version
2124

25+
# Command Line Interface
2226

27+
![image](/attachment_files/admin/xap-cli.png)
2328

24-
![image](/attachment_files/admin/xap-cli-os.png)
2529

site/content/xap/12.3/admin/admin-quiesce-pu.markdown

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -436,6 +436,8 @@ curl -X POST --header 'Content-Type: application/json' --header 'Accept: text/pl
436436

437437

438438
{{%tab "Web Management Console"%}}
439+
440+
N/A
439441

440442
{{%/tab%}}
441443

@@ -511,6 +513,8 @@ curl -X DELETE --header 'Accept: text/plain' 'http://localhost:8090/v2/pus/myPu/
511513

512514

513515
{{%tab "Web Management Console"%}}
516+
517+
N/A
514518

515519
{{%/tab%}}
516520

site/content/xap/12.3/admin/admin-service-grid-agent.markdown

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ parent: admin-service-grid.html
99

1010

1111

12-
**To start a Service Grid Agent:**
12+
**To start a Grid Service Agent:**
1313
<br>
1414

1515

@@ -48,6 +48,43 @@ N/A
4848
{{%/tab%}}
4949

5050

51+
{{%tab "Web Management Console"%}}
52+
53+
N/A
54+
55+
{{%/tab%}}
56+
57+
58+
{{%tab "GigaSpaces Management Center"%}}
59+
60+
Refer to the [GigaSpaces Management Center](./gigaspaces-management-center.html) topics in the Administration section.
61+
62+
{{%/tab%}}
63+
64+
65+
{{%tab "Administration API"%}}
66+
Refer to the [Admin API](../dev-java/administration-and-monitoring-overview.html) topics in the Developer Guide.
67+
{{%/tab%}}
68+
69+
{{% /tabs %}}
70+
71+
72+
**To stop a Grid Service Agent:**
73+
74+
{{%tabs%}}
75+
{{%tab "Command Line Interface"%}}
76+
77+
TBD
78+
79+
{{%/tab%}}
80+
81+
{{%tab "REST Manager API"%}}
82+
83+
N/A
84+
85+
{{%/tab%}}
86+
87+
5188
{{%tab "Web Management Console"%}}
5289

5390
You can stop a Grid Service Agent via the Web Management Console.
@@ -70,4 +107,4 @@ Refer to the [GigaSpaces Management Center](./gigaspaces-management-center.html)
70107
Refer to the [Admin API](../dev-java/administration-and-monitoring-overview.html) topics in the Developer Guide.
71108
{{%/tab%}}
72109

73-
{{% /tabs %}}
110+
{{% /tabs %}}

site/content/xap/12.3/admin/admin-service-grid-security.markdown

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
type: post123
3-
title: Securing the Service Grid
3+
title: Accessing a Secured Service Grid
44
categories: XAP123ADM,PRM
55
weight: 900
66
parent: admin-service-grid.html
77
---
88

99

10-
**Accessing a secured Service Grid:**
10+
**To access a secured service grid:**
1111

1212

1313
<br>
@@ -44,7 +44,9 @@ See securing the Service Grid property `-Dcom.gs.security.enabled=true`
4444

4545

4646
{{%tab "Web Management Console"%}}
47-
TBD
47+
48+
See the [Security](./tools-web-ui.html#security) paragraph of the [Web Management Console](./tools-web-ui.html) topic for information on how to configure the tool to access a secured service grid.
49+
4850
{{%/tab%}}
4951

5052

site/content/xap/12.3/admin/admin-view-event-container-detail.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,11 +143,11 @@ N/A
143143
</tr>
144144
<tr>
145145
<td>Comm. Type</td>
146-
<td></td>
146+
<td>N/A</td>
147147
</tr>
148148
<tr>
149149
<td>Take On Notify</td>
150-
<td></td>
150+
<td>N/A</td>
151151
</tr>
152152
<tr>
153153
<td>FIFO</td>

site/content/xap/12.3/admin/admin-view-gen-space-details.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -273,11 +273,11 @@ You can see the following high-level Space details in the main Spaces view:
273273
</tr>
274274
<tr>
275275
<td>Connections</td>
276-
<td></td>
276+
<td>Number of currently connected clients.</td>
277277
</tr>
278278
<tr>
279279
<td>Active Transactions</td>
280-
<td></td>
280+
<td>Number of transactions that are now active.</td>
281281
</tr>
282282
</table>
283283

@@ -319,11 +319,11 @@ Click the arrow in the right-hand column of the space entry to drill through to
319319
</tr>
320320
<tr>
321321
<td>Connections</td>
322-
<td></td>
322+
<td>Number of currently connected clients.</td>
323323
</tr>
324324
<tr>
325325
<td>Active Transactions</td>
326-
<td></td>
326+
<td>Number of transactions that are now active.</td>
327327
</tr>
328328
</table>
329329

site/content/xap/12.3/admin/admin-view-transaction-details.markdown

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Transaction information is only available for Space instances that are in primar
6161
</tr>
6262
<tr>
6363
<td>Timeout</td>
64-
<td></td>
64+
<td>Length of time after which the transaction expires.</td>
6565
</tr>
6666
<tr>
6767
<td>Locked Objects</td>
@@ -70,7 +70,7 @@ Transaction information is only available for Space instances that are in primar
7070
</table>
7171

7272

73-
* Per individual transaction (when drilling down):
73+
* Per individual transaction (when drilling down), when a transaction is blocked:
7474

7575
<table>
7676
<tr>
@@ -79,19 +79,19 @@ Transaction information is only available for Space instances that are in primar
7979
</tr>
8080
<tr>
8181
<td>UID</td>
82-
<td></td>
82+
<td>ID of the data entry in the Space that is blocked.</td>
8383
</tr>
8484
<tr>
8585
<td>Class Name</td>
86-
<td></td>
86+
<td>Type of data entry.</td>
8787
</tr>
8888
<tr>
8989
<td>Operation Code</td>
90-
<td></td>
90+
<td>Data operation that was being peformed when the transaction became blocked.</td>
9191
</tr>
9292
<tr>
9393
<td>Lock Type</td>
94-
<td></td>
94+
<td>Type of lock on the transaction.</td>
9595
</tr>
9696
</table>
9797

site/content/xap/12.3/rn/upgrading.markdown

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,6 @@ For information about product changes that may affect your upgrade process, refe
2020

2121
V2 of the REST Manager API was released in this version. As a result, V1 has been deprecated. While V1 is still supported, we encourage upgrading to the latest version of the InsightEdge platform in order to benefit from the the changes and improvements available with V2, and to ensure forward compatibility in client applications.
2222

23+
# New Command Line Interface
24+
25+
A new Command Line Interface (CLI) was introduced in this version that supports both XAP and InsightEdge environments. While the old version is still supported, it will be deprecated in the future and we encourage working with the new version.

0 commit comments

Comments
 (0)