Skip to content

Commit c27762e

Browse files
author
Niv Ingberg
committed
Merge branch 'master' of https://github.com/Gigaspaces/xap-docs 
2 parents 06d917c + 19f19f9 commit c27762e

15 files changed

+197
-42
lines changed

‎site/content/xap/12.3/admin/admin-cli-open-source.markdown‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,7 @@ Deploys a Processing Unit onto the Service Grid.
8282

8383
| Item | Name | Description |
8484
|:-----|:-----|:------------|
85-
| Parameter | path |
86-
Relative/absolute path of a Processing Unit directory or archive file.|
85+
| Parameter | path | Relative/absolute path of a Processing Unit directory or archive file.|
8786
| Option | ---ha | High availability adding a backup per partition. |
8887
| Option | ---instances=\<instances\> | Number of instances to run.|
8988
| Option | ---lus| Start a lookup service. |

‎site/content/xap/12.3/admin/admin-ie-delete-spark-app.markdown‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ parent: admin-insightedge.html
77
---
88

99

10-
11-
{{% bgcolor yellow %}}write intro for this topic{{% /bgcolor %}}
10+
**To delete a Spark Application:**
11+
1212

1313
<br>
1414

@@ -19,7 +19,28 @@ N/A
1919
{{%/tab%}}
2020

2121
{{%tab "REST Manager API"%}}
22-
N/A
22+
23+
*Path*
24+
25+
`DELETE /spark/applications/{id}`
26+
27+
*Description:*
28+
29+
Deletes the spark application resource by name.
30+
31+
*Example Request:*
32+
33+
```bash
34+
curl -X DELETE --header 'Accept: text/plain' 'http://localhost:8090/v2/spark/applications/resources/app1'
35+
```
36+
37+
*Options:*
38+
39+
| Option | Description | Required |
40+
|------|-------------------|----------------|
41+
| id | Spark driver id | Yes |
42+
43+
2344
{{%/tab%}}
2445

2546
{{% /tabs %}}

‎site/content/xap/12.3/admin/admin-ie-terminate-spark-job.markdown‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@ weight: 700
66
parent: admin-insightedge.html
77
---
88

9-
109

11-
{{% bgcolor yellow %}}write intro for this topic{{% /bgcolor %}}
10+
**To terminate a Spark Job:**
1211

1312
<br>
1413

@@ -19,7 +18,29 @@ N/A
1918
{{%/tab%}}
2019

2120
{{%tab "REST Manager API"%}}
22-
N/A
21+
22+
*Path*
23+
24+
`DELETE /spark/applications/{id}`
25+
26+
*Description:*
27+
28+
Terminating a Spark Job.
29+
30+
*Example Request:*
31+
32+
```bash
33+
curl -X DELETE --header 'Accept: text/plain' 'http://localhost:8090/v2/spark/applications/application1'
34+
```
35+
36+
*Options:*
37+
38+
| Option | Description | Required |
39+
|------|-------------------|----------------|
40+
| id | Spark driver id | Yes |
41+
42+
43+
2344
{{%/tab%}}
2445

2546
{{% /tabs %}}

‎site/content/xap/12.3/admin/admin-ie-upload-spark-app-file.markdown‎

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ parent: admin-insightedge.html
88

99

1010

11-
{{% bgcolor yellow %}}write intro for this topic{{% /bgcolor %}}
11+
**To upload a Spark Application:**
1212

1313
<br>
1414

@@ -19,7 +19,45 @@ N/A
1919
{{%/tab%}}
2020

2121
{{%tab "REST Manager API"%}}
22-
N/A
22+
23+
*Path*
24+
25+
`POST /spark/applications`
26+
27+
*Description:*
28+
29+
Submitting a Spark Application
30+
31+
*Example Request:*
32+
33+
```bash
34+
curl -X POST --header 'Content-Type: application/json' --header 'Accept: text/plain' -d '{ \
35+
"mainClass": "string", \
36+
"applicationJar": "string", \
37+
"applicationArguments": [ \
38+
"string" \
39+
], \
40+
"name": "string", \
41+
"sparkProperties": {} \
42+
}' 'http://localhost:8090/v2/spark/applications'
43+
```
44+
45+
*Example Response:*
46+
47+
```bash
48+
```
49+
50+
*Options:*
51+
52+
| Option | Description | Required |
53+
|------|-------------------|----------------|
54+
| mainClass | | |
55+
| applicationJar | | Yes |
56+
| applicationArguments | | |
57+
| name | | |
58+
| sparkProperties | | |
59+
60+
2361
{{%/tab%}}
2462

2563
{{% /tabs %}}

‎site/content/xap/12.3/admin/admin-ie-view-spark-apps.markdown‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ parent: admin-insightedge.html
88

99

1010

11-
{{% bgcolor yellow %}}write intro for this topic{{% /bgcolor %}}
11+
1212

1313
<br>
1414

‎site/content/xap/12.3/admin/admin-ie-view-spark-job.markdown‎

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ parent: admin-insightedge.html
77
---
88

99

10-
11-
{{% bgcolor yellow %}}write intro for this topic{{% /bgcolor %}}
12-
10+
**To view the Spark Job Status:**
1311
<br>
1412

1513
{{%tabs%}}
@@ -19,7 +17,33 @@ N/A
1917
{{%/tab%}}
2018

2119
{{%tab "REST Manager API"%}}
22-
N/A
20+
21+
22+
*Path*
23+
24+
`GET /spark/applications/{id}`
25+
26+
*Description:*
27+
28+
29+
*Example Request:*
30+
31+
```bash
32+
curl -X GET --header 'Accept: text/plain' 'http://localhost:8090/v2/spark/applications/application1'
33+
```
34+
35+
*Example Response:*
36+
37+
```bash
38+
```
39+
40+
*Options:*
41+
42+
| Option | Description | Required |
43+
|------|-------------------|----------------|
44+
| id | The id of the Spark driver.| Yes |
45+
46+
2347
{{%/tab%}}
2448

2549
{{% /tabs %}}

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

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

9-
10-
{{% bgcolor yellow %}}This is an intro topic for the 5 admin tools that will be described. Need to write some introductory text (might be best to copy from existing content from original administration section(s), and maybe provide links to the sub-topics.{{% /bgcolor %}}
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+
`xap space deploy`
1314

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.
1416

15-
# CLI
16-
17-
![image](/attachment_files/admin/xap-cli.png)
18-
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.
1919

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%}}
2023

2124

22-
## Open source version
23-
25+
# Command Line Interface
2426

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

26-
![image](/attachment_files/admin/xap-cli-os.png)
2729

‎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

0 commit comments

Comments
 (0)