Skip to content

Commit

Permalink
update xap cli
Browse files Browse the repository at this point in the history
  • Loading branch information
croffler committed Feb 10, 2018
1 parent f561569 commit b26c97e
Show file tree
Hide file tree
Showing 5 changed files with 334 additions and 177 deletions.
109 changes: 109 additions & 0 deletions site/content/howto/admin-tools-container.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
---
type: post
title: Container
weight: 100
parent: admin-tools-overview.html
---

................


# Create

**Parameters**

| Parameter | Description | Required | Reference |
|:-----|:-----|:----------------------------|:---------|
| host | Host to create container on | Yes | |

**Options**

| Option | Description | Reference |
|:-----|:-----|:----------------------------|
| --help | Display help information for this command | |
| --memory=\<memory\> | Max JVM memory for the container | |
| --zone=\<zone\> | Zone where the container should be deployed | |
| --property=\<String=String\> | Additional System properties| |
| --version | Display version information | |


{{%tabs%}}
{{%tab "CLI"%}}

```bash
<XAP-HOME>/bin/xap container create myHost
```
{{%/tab%}}
{{%tab "REST"%}}
{{%/tab%}}
{{%/tabs%}}

# Kill

**Parameters**

| Parameter | Description | Required | Reference |
|:-----|:-----|:----------------------------|:---------|
| containerId | | Yes | |

{{%tabs%}}
{{%tab "CLI"%}}
```bash
<XAP-HOME>/bin/xap container kill admin~4300
```
{{%/tab%}}
{{%tab "REST"%}}
{{%/tab%}}
{{%/tabs%}}

# Restart

**Parameters**

| Parameter | Description | Required | Reference |
|:-----|:-----|:----------------------------|:---------|
| containerId | | Yes | |

{{%tabs%}}
{{%tab "CLI"%}}
```bash
<XAP-HOME>/bin/xap container restart admin~2712
```
{{%/tab%}}
{{%tab "REST"%}}
{{%/tab%}}
{{%/tabs%}}

## List

{{%tabs%}}
{{%tab "CLI"%}}
```bash
<XAP-HOME>/bin/xap container list
```
{{%/tab%}}
{{%tab "REST"%}}
{{%/tab%}}
{{%/tabs%}}



## Info

**Parameters**

| Parameter | Description | Required | Reference |
|:-----|:-----|:----------------------------|:---------|
| containerId | | Yes | |


{{%tabs%}}
{{%tab "CLI"%}}
```bash
<XAP-HOME>/bin/xap container info admin~2712
```
{{%/tab%}}
{{%tab "REST"%}}
{{%/tab%}}
{{%/tabs%}}

28 changes: 28 additions & 0 deletions site/content/howto/admin-tools-overview.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,31 @@ Breaking the functionality into two pages:
-[Administering Spaces and Processing Units](/howto/admin-tools-pu.html)

-[Administering the Service Grid](/howto/admin-tools-service-grid.html)




Viewing General Space Details<br>
Viewing Space Information<br>

Deploying a Processing Unit<br>
Viewing the Deployed Processing Units (ability to drill through to all contents, including the Space)<br>
Viewing Processing Unit Configuration Information<br>

Undeploying a Processing Unit


Querying a Space

Viewing Data Types<br>
Viewing Space Statistics<br>
Viewing Client-Side Cache Details<br>
Viewing Event Container Details<br>
Viewing Network Details<br>
Viewing Transaction Details<br>

Quiescing a Processing Unit (advanced topic)<br>
Unquiescing a Processing Unit (advanced topic)

Restarting a Processing Unit Instance (advanced)<br>
Relocating a Processing Unit (advanced)
195 changes: 19 additions & 176 deletions site/content/howto/admin-tools-pu.markdown
Original file line number Diff line number Diff line change
@@ -1,202 +1,45 @@
---
type: post
title: Space and PU
weight: 100
title: PU
weight: 300
parent: admin-tools-overview.html
---

................


# Container

## Create

**Parameters**

| Parameter | Description | Required | Reference |
|:-----|:-----|:----------------------------|:---------|
| host | Host to create container on | Yes | |

**Options**

| Option | Description | Reference |
|:-----|:-----|:----------------------------|
| --help | Display help information for this command | |
| --memory= | Max JVM memory for the container | |
| --zone= | Zone where the container should be deployed | |
| --property= | Additional System properties| |


{{%tabs%}}
{{%tab "CLI"%}}

```bash
<XAP-HOME>/bin/xap container create myHost
```
{{%/tab%}}

{{%tab "REST"%}}


[REST Manager localhost](http://localhost:8090/v1/index.html#!/Containers/post_containers)

{{%/tab%}}


{{%tab "Web Console"%}}
[Web Management Center](/xap/12.3/admin/web-management-common-view.html)
{{%/tab%}}

{{%tab "Admin Console"%}}

```bash

```
{{%/tab%}}

{{%/tabs%}}

## Kill
# Deploy

**Parameters**

| Parameter | Description | Required | Reference |
|:-----|:-----|:----------------------------|:---------|
| containerId | | Yes | |

{{%tabs%}}
{{%tab "CLI"%}}
```bash
<XAP-HOME>/bin/xap container kill containerId
```
{{%/tab%}}
{{%tab "REST"%}}
[REST Manager localhost](http://localhost:8090/v1/index.html#!/Containers/post_containers)
{{%/tab%}}
{{%tab "Web Console"%}}
[Web Management Center](/xap/12.3/admin/web-management-common-view.html)
{{%/tab%}}
{{%tab "Admin Console"%}}

```bash
```
{{%/tab%}}
{{%/tabs%}}
| name | Name of the processing unit to deploy | Yes | |
| \[file\] | Path to processing unit file (.jar or .zip) |Yes | |

## Restart

**Parameters**

| Parameter | Description | Required | Reference |
|:-----|:-----|:----------------------------|:---------|
| containerId | | Yes | |
**Options**

{{%tabs%}}
{{%tab "CLI"%}}
```bash
<XAP-HOME>/bin/xap container restart containerId
```
{{%/tab%}}
{{%tab "REST"%}}
[REST Manager localhost](http://localhost:8090/v1/index.html#!/Containers/post_containers)
{{%/tab%}}
{{%tab "Web Console"%}}
[Web Management Center](/xap/12.3/admin/web-management-common-view.html)
{{%/tab%}}
{{%tab "Admin Console"%}}

```bash
```
{{%/tab%}}
{{%/tabs%}}

## List


## Info

**Parameters**

| Parameter | Description | Required | Reference |
|:-----|:-----|:----------------------------|:---------|
| containerId | | Yes | |


# Space

## Deploying a Space
(automatically deploys a PU that contains only a Space)

## Parameters

| Parameter | Description | Required | Reference |
|:-----|:-----|:----------------------------|:---------|
| name | The name of the Space | Yes | |

## Options

| Option | Description | Reference |
|:-----|:-----|:----------------------------|
| --ha | Should backups be used for high availability | |
| --help | Display help information for deploy | |
| --partitions=partitions | Number of partitions | |
| --requires-isolation | if each instance should be provisioned in an isolated container| |

| --backups=\<backups\> | Number of backups per partition | |
| --instances=\<instances\> | Number of instances| |
| --max-instances-per-machine=\<maxInstancesPerMachine\>| Determines maximum number of instances in same machine | |
| --max-instances-per-vm=\<maxInstancesPerVM\> |Determines maximum number of instances in same VM | |
| --partitions=\<partitions\> | Number of partitions| |
| --property=\<String,String>\> | Context properties| |
| --schema=\<schema\> | Cluster schema ||
| --version |Display version information | |
| --zones=\<zones\> |Which zones can host this processing unit| |


{{%tabs%}}
{{%tab "CLI"%}}

```bash
<XAP-HOME>/bin/xap space deploy
<XAP-HOME>/bin/xap pu deploy --partitions=2 myPu mypu.jar
```
{{%/tab%}}

{{%tab "REST"%}}

```bash

```
{{%/tab%}}


{{%tab "Web Console"%}}
[Deploying a Space](/xap/12.3/admin/web-management-deploy-space.html)
{{%/tab%}}

{{%tab "Admin Console"%}}

```bash

```
{{%/tab%}}

{{%/tabs%}}




Viewing General Space Details<br>
Viewing Space Information<br>

Deploying a Processing Unit<br>
Viewing the Deployed Processing Units (ability to drill through to all contents, including the Space)<br>
Viewing Processing Unit Configuration Information<br>

Undeploying a Processing Unit


Querying a Space

Viewing Data Types<br>
Viewing Space Statistics<br>
Viewing Client-Side Cache Details<br>
Viewing Event Container Details<br>
Viewing Network Details<br>
Viewing Transaction Details<br>

Quiescing a Processing Unit (advanced topic)<br>
Unquiescing a Processing Unit (advanced topic)

Restarting a Processing Unit Instance (advanced)<br>
Relocating a Processing Unit (advanced)


2 changes: 1 addition & 1 deletion site/content/howto/admin-tools-service-grid.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
type: post
title: Service Grid
weight: 200
weight: 400
parent: admin-tools-overview.html
---

Expand Down
Loading

0 comments on commit b26c97e

Please sign in to comment.