From b26c97eae0a7b2d4e16bb0d237d4c451544c7b2c Mon Sep 17 00:00:00 2001 From: croffler Date: Sat, 10 Feb 2018 14:02:15 +0200 Subject: [PATCH] update xap cli --- .../howto/admin-tools-container.markdown | 109 ++++++++++ .../howto/admin-tools-overview.markdown | 28 +++ site/content/howto/admin-tools-pu.markdown | 195 ++---------------- .../howto/admin-tools-service-grid.markdown | 2 +- site/content/howto/admin-tools-space.markdown | 177 ++++++++++++++++ 5 files changed, 334 insertions(+), 177 deletions(-) create mode 100644 site/content/howto/admin-tools-container.markdown create mode 100644 site/content/howto/admin-tools-space.markdown diff --git a/site/content/howto/admin-tools-container.markdown b/site/content/howto/admin-tools-container.markdown new file mode 100644 index 000000000..e7c216a80 --- /dev/null +++ b/site/content/howto/admin-tools-container.markdown @@ -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=\ | Max JVM memory for the container | | +| --zone=\ | Zone where the container should be deployed | | +| --property=\ | Additional System properties| | +| --version | Display version information | | + + +{{%tabs%}} +{{%tab "CLI"%}} + +```bash +/bin/xap container create myHost +``` +{{%/tab%}} +{{%tab "REST"%}} +{{%/tab%}} +{{%/tabs%}} + +# Kill + +**Parameters** + +| Parameter | Description | Required | Reference | +|:-----|:-----|:----------------------------|:---------| +| containerId | | Yes | | + +{{%tabs%}} +{{%tab "CLI"%}} +```bash +/bin/xap container kill admin~4300 +``` +{{%/tab%}} +{{%tab "REST"%}} +{{%/tab%}} +{{%/tabs%}} + +# Restart + +**Parameters** + +| Parameter | Description | Required | Reference | +|:-----|:-----|:----------------------------|:---------| +| containerId | | Yes | | + +{{%tabs%}} +{{%tab "CLI"%}} +```bash +/bin/xap container restart admin~2712 +``` +{{%/tab%}} +{{%tab "REST"%}} +{{%/tab%}} +{{%/tabs%}} + +## List + +{{%tabs%}} +{{%tab "CLI"%}} +```bash +/bin/xap container list +``` +{{%/tab%}} +{{%tab "REST"%}} +{{%/tab%}} +{{%/tabs%}} + + + +## Info + +**Parameters** + +| Parameter | Description | Required | Reference | +|:-----|:-----|:----------------------------|:---------| +| containerId | | Yes | | + + +{{%tabs%}} +{{%tab "CLI"%}} +```bash +/bin/xap container info admin~2712 +``` +{{%/tab%}} +{{%tab "REST"%}} +{{%/tab%}} +{{%/tabs%}} + \ No newline at end of file diff --git a/site/content/howto/admin-tools-overview.markdown b/site/content/howto/admin-tools-overview.markdown index afe521541..7f3ebb4b2 100644 --- a/site/content/howto/admin-tools-overview.markdown +++ b/site/content/howto/admin-tools-overview.markdown @@ -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
+ Viewing Space Information
+ + Deploying a Processing Unit
+ Viewing the Deployed Processing Units (ability to drill through to all contents, including the Space)
+ Viewing Processing Unit Configuration Information
+ + Undeploying a Processing Unit + + + Querying a Space + + Viewing Data Types
+ Viewing Space Statistics
+ Viewing Client-Side Cache Details
+ Viewing Event Container Details
+ Viewing Network Details
+ Viewing Transaction Details
+ + Quiescing a Processing Unit (advanced topic)
+ Unquiescing a Processing Unit (advanced topic) + + Restarting a Processing Unit Instance (advanced)
+ Relocating a Processing Unit (advanced) diff --git a/site/content/howto/admin-tools-pu.markdown b/site/content/howto/admin-tools-pu.markdown index 9c94b0147..056c7136d 100644 --- a/site/content/howto/admin-tools-pu.markdown +++ b/site/content/howto/admin-tools-pu.markdown @@ -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 -/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 -/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 -/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=\ | Number of backups per partition | | +| --instances=\ | Number of instances| | +| --max-instances-per-machine=\| Determines maximum number of instances in same machine | | +| --max-instances-per-vm=\ |Determines maximum number of instances in same VM | | +| --partitions=\ | Number of partitions| | +| --property=\\> | Context properties| | +| --schema=\ | Cluster schema || +| --version |Display version information | | +| --zones=\ |Which zones can host this processing unit| | + {{%tabs%}} {{%tab "CLI"%}} - ```bash -/bin/xap space deploy +/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
-Viewing Space Information
- -Deploying a Processing Unit
-Viewing the Deployed Processing Units (ability to drill through to all contents, including the Space)
-Viewing Processing Unit Configuration Information
- -Undeploying a Processing Unit - - -Querying a Space - -Viewing Data Types
-Viewing Space Statistics
-Viewing Client-Side Cache Details
-Viewing Event Container Details
-Viewing Network Details
-Viewing Transaction Details
- -Quiescing a Processing Unit (advanced topic)
-Unquiescing a Processing Unit (advanced topic) - -Restarting a Processing Unit Instance (advanced)
-Relocating a Processing Unit (advanced) \ No newline at end of file + + \ No newline at end of file diff --git a/site/content/howto/admin-tools-service-grid.markdown b/site/content/howto/admin-tools-service-grid.markdown index 4d5729275..213dd512e 100644 --- a/site/content/howto/admin-tools-service-grid.markdown +++ b/site/content/howto/admin-tools-service-grid.markdown @@ -1,7 +1,7 @@ --- type: post title: Service Grid -weight: 200 +weight: 400 parent: admin-tools-overview.html --- diff --git a/site/content/howto/admin-tools-space.markdown b/site/content/howto/admin-tools-space.markdown new file mode 100644 index 000000000..b281fd4b3 --- /dev/null +++ b/site/content/howto/admin-tools-space.markdown @@ -0,0 +1,177 @@ +--- +type: post +title: Space +weight: 200 +parent: admin-tools-overview.html +--- + +................ + + + +# 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=\ | Number of partitions | | +| --requires-isolation | if each instance should be provisioned in an isolated container| | + + +{{%tabs%}} +{{%tab "CLI"%}} +```bash +/bin/xap space deploy mySpace +``` +{{%/tab%}} + +{{%tab "REST"%}} +```bash +``` +{{%/tab%}} +{{%/tabs%}} + +# List + +Lists all spaces + +{{%tabs%}} +{{%tab "CLI"%}} +```bash +/bin/xap space list +``` +{{%/tab%}} + +{{%tab "REST"%}} +```bash +``` +{{%/tab%}} +{{%/tabs%}} + +# List Instances + +| Parameter | Description | Required | Reference | +|:-----|:-----|:----------------------------|:---------| +| name | The name of the Space | Yes | | + +## Options + +| Option | Description | Reference | +|:-----|:-----|:----------------------------| +| --help | Display help information for deploy | | + + +{{%tabs%}} +{{%tab "CLI"%}} +```bash +/bin/xap space list-instances mySpace +``` +{{%/tab%}} + +{{%tab "REST"%}} +```bash +``` +{{%/tab%}} +{{%/tabs%}} + +# Space Info + +| Parameter | Description | Required | Reference | +|:-----|:-----|:----------------------------|:---------| +| name | The name of the Space | Yes | | + +## Options + +| Option | Description | Reference | +|:-----|:-----|:----------------------------| +| --help | Display help information for deploy | | +|--operation-stats | Get space operation statistics | | +|--type-stats | Get space types statistics | | + + +{{%tabs%}} +{{%tab "CLI"%}} +```bash +/bin/xap space info --operation-stats mySpace +``` +{{%/tab%}} + +{{%tab "REST"%}} +```bash +``` +{{%/tab%}} +{{%/tabs%}} + + +# Space Instance Info + +| Parameter | Description | Required | Reference | +|:-----|:-----|:----------------------------|:---------| +| instanceId | Space instance Id | Yes | | + +## Options + +| Option | Description | Reference | +|:-----|:-----|:----------------------------| +| --help | Display help information for deploy | | +|--operation-stats | Get space operation statistics | | +|--type-stats | Get space types statistics | | +|--replication-stats | Get replication statistics | | + + +{{%tabs%}} +{{%tab "CLI"%}} +```bash +/bin/xap space info-instance --operation-stats mySpace~1 +``` +{{%/tab%}} + +{{%tab "REST"%}} +```bash +``` +{{%/tab%}} +{{%/tabs%}} + + +# Run + +Under construction + +| Parameter | Description | Required | Reference | +|:-----|:-----|:----------------------------|:---------| +| name | The name of the Space | Yes | | + +## Options + +| Option | Description | Reference | +|:-----|:-----|:----------------------------| +| --help | Display help information for deploy | | +|--ha | Should the space include backups for high availability | | +|--instances=\ | Which instances should be run (default is all) | | +|--partitions=\ | Number of partitions in space | | +|--version | DIsplay version information | | + + +{{%tabs%}} +{{%tab "CLI"%}} +```bash +/bin/xap space run --partitions=2 mySpace +``` +{{%/tab%}} + +{{%tab "REST"%}} +```bash +``` +{{%/tab%}} +{{%/tabs%}} +