Install & Update
Install Service
info BaseInfo
Brief Description
- None
Request URL
- /lpnode/lpnode_admin_panel/ctrl/installDeployment
Request Method
- post
Request Parameter Example
json
{
"setupConfig": {
"imageRepository": "magicpigdocker/lp-market:v0.2",
"installType": "market",
"name": "market-01",
"install": true,
"customEnv": [
{
"key": "key2",
"value": "value2"
},
{
"key": "key3",
"value": "value3"
}
]
}
}Description of the request json field
| Parameter Name | Mandatory | Type | Explain |
|---|---|---|---|
| setupConfig | Y | Object | none |
| setupConfig.imageRepository | Y | string | The address of the image. |
| setupConfig.installType | Y | string | amm market |
| setupConfig.install | Y | boolean | Whether to install immediately or just view the return template. |
| setupConfig.customEnv | N | array | Custom environment variables. |
| setupConfig.customEnv.key | N | string | none |
| setupConfig.customEnv.value | N | string | none |
Successful return example
json
{
"code": 0,
"result": {
"CmdStdout": "deployment.apps/obridge-amm unchanged\n",
"CmdStderr": "",
"Template": "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: \"obridge-amm\"\n labels:\n app: \"obridge-amm\"\nspec:\n replicas: 1\n selector:\n matchLabels:\n app: \"obridge-amm\"\n template:\n metadata:\n labels:\n app: \"obridge-amm\"\n spec:\n containers:\n - name: \"obridge-amm\"\n image: \"magicpigdocker/amm:v0.11\"\n ports:\n - containerPort: 18081 \n env:\n \n - name: \"key1\"\n value: \"value1\"\n \n - name: \"key2\"\n value: \"value3\"\n \n - name: MONGODBPASS\n valueFrom:\n secretKeyRef:\n name: obridge-lpnode-db-mongodb\n key: mongodb-root-password\n - name: REDIS_PASS\n valueFrom:\n secretKeyRef:\n name: obridge-lpnode-db-redis\n key: redis-password\n"
},
"message": ""
}Parameter description of the successful return example
| Parameter Name | Type | Explain |
|---|---|---|
| code | string | 0 when successful |
| result | Object | There is a result when successful. |
| CmdStdout | string | none |
| CmdStderr | string | none |
| Template | string | Template |
| message | string | none |
Install LpClient
info BaseInfo
Brief Description
- None
Request URL
- /lpnode/lpnode_admin_panel/ctrl/installLpClient
Request Method
- post
Request Parameter Example
json
{
"setupConfig": {
"type": "near",
"imageRepository": "kldtks/edge:obridge-chain-client-evm-latest",
"install": true,
"customEnv": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value3"
}
],
"rpcUrl": "https://data-seed-prebsc-2-s1.binance.org:8545",
"startBlock": "20000000"
}
}Uninstall LpClient
info BaseInfo Brief Description
- None
Request URL
- /lpnode/lpnode_admin_panel/ctrl/uninstallLpClient
Request Method
- post
Request Parameter Example
json
{
"setupConfig": {
"type": "bsc",
"uninstall": true
}
}Uninstall market
info BaseInfo
Brief Description
- None
Request URL
- /lpnode/lpnode_admin_panel/ctrl/uninstallDeployment
Request Method
- post
Request Parameter Example
json
{
"setupConfig": {
"installType": "market",
"name": "market-01",
"uninstall": true
}
}Install Service-Amm
info BaseInfo
Brief Description
- None
Request URL
- /lpnode/lpnode_admin_panel/ctrl/installDeployment
Request Method
- post
Request Parameter Example
json
{
"setupConfig": {
"imageRepository": "kldtks/edge:otmoic-lpnode-amm-edd840f7",
"installType": "amm",
"name": "amm01",
"install": true,
"customEnv": [
{
"key": "keyA",
"value": "value2"
},
{
"key": "keyb",
"value": "value3"
}
]
}
}Description of the request json field
| Parameter Name | Mandatory | Type | Explain |
|---|---|---|---|
| setupConfig | Y | Object | none |
| setupConfig.imageRepository | Y | string | image address |
| setupConfig.installType | Y | string | amm market |
| setupConfig.install | Y | boolean | Whether to install immediately or just view the returned template |
| setupConfig.customEnv | N | array | Env |
| setupConfig.customEnv.key | N | string | none |
| setupConfig.customEnv.value | N | string | none |
Successful return example
json
{
"code": 0,
"result": {
"CmdStdout": "deployment.apps/obridge-amm unchanged\n",
"CmdStderr": "",
"Template": "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: \"obridge-amm\"\n labels:\n app: \"obridge-amm\"\nspec:\n replicas: 1\n selector:\n matchLabels:\n app: \"obridge-amm\"\n template:\n metadata:\n labels:\n app: \"obridge-amm\"\n spec:\n containers:\n - name: \"obridge-amm\"\n image: \"magicpigdocker/amm:v0.11\"\n ports:\n - containerPort: 18081 \n env:\n \n - name: \"key1\"\n value: \"value1\"\n \n - name: \"key2\"\n value: \"value3\"\n \n - name: MONGODBPASS\n valueFrom:\n secretKeyRef:\n name: obridge-lpnode-db-mongodb\n key: mongodb-root-password\n - name: REDIS_PASS\n valueFrom:\n secretKeyRef:\n name: obridge-lpnode-db-redis\n key: redis-password\n"
},
"message": ""
}Parameter description of the successful return example
| Parameter Name | Type | Explain |
|---|---|---|
| code | string | It is "0" when the operation is successful. |
| result | Object | There will be a "result" when the operation is successful. |
| CmdStdout | string | none |
| CmdStderr | string | none |
| Template | string | The deployment template rendered during installation. |
| message | string | none |
update service Amm
info BaseInfo
Brief Description
- None
Request URL
- /lpnode/lpnode_admin_panel/ctrl/updateDeployment
Request Method
- post
Request Parameter Example
json
{
"setupConfig": {
"installType": "userApp",
"name": "user01",
"installContext": "{\"deployment\":{\"customEnv\":[{\"key\":\"key005\",\"value\":\"value1\"},{\"key\":\"key008\",\"value\":\"value2\"}]}}",
"image": "magicpigdocker/amm:v0.18",
"update": true
}
}Description of the request json field
| Parameter Name | Mandatory | Type | Explain |
|---|---|---|---|
| setupConfig | Y | Object | none |
| setupConfig.imageRepository | Y | string | The address of the image. |
| setupConfig.installType | Y | string | amm market |
| setupConfig.install | Y | boolean | Whether to install immediately or just view the return template. |
| setupConfig.customEnv | N | array | Custom environment variables. |
| setupConfig.customEnv.key | N | string | none |
| setupConfig.customEnv.value | N | string | none |
Successful return example
json
{
"code": 0,
"result": {
"CmdStdout": "deployment.apps/obridge-amm unchanged\n",
"CmdStderr": "",
"Template": "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: \"obridge-amm\"\n labels:\n app: \"obridge-amm\"\nspec:\n replicas: 1\n selector:\n matchLabels:\n app: \"obridge-amm\"\n template:\n metadata:\n labels:\n app: \"obridge-amm\"\n spec:\n containers:\n - name: \"obridge-amm\"\n image: \"magicpigdocker/amm:v0.11\"\n ports:\n - containerPort: 18081 \n env:\n \n - name: \"key1\"\n value: \"value1\"\n \n - name: \"key2\"\n value: \"value3\"\n \n - name: MONGODBPASS\n valueFrom:\n secretKeyRef:\n name: obridge-lpnode-db-mongodb\n key: mongodb-root-password\n - name: REDIS_PASS\n valueFrom:\n secretKeyRef:\n name: obridge-lpnode-db-redis\n key: redis-password\n"
},
"message": ""
}Parameter description of the successful return example
| Parameter Name | Type | Explain |
|---|---|---|
| code | string | It is 0 when successful. |
| result | Object | There is a result when successful. |
| CmdStdout | string | none |
| CmdStderr | string | none |
| Template | string | The deployment template rendered during installation. |
| message | string | none |
list all service
info BaseInfo
Brief Description
- None
Request URL
- /lpnode/lpnode_admin_panel/ctrl/listInstall
Request Method
- post
Request Parameter Example
json
{
"installType": "amm"
}Description of the request json field
| Parameter Name | Mandatory | Type | Explain |
|---|---|---|---|
| installType | Y | string | amm ammClient market |
uninstall service
info BaseInfo
Brief Description
- None
Request URL
- /lpnode/lpnode_admin_panel/ctrl/uninstallDeployment
Request Method
- post
Request Parameter Example
json
{
"setupConfig": {
"installType": "amm",
"name": "amm01",
"uninstall": true
}
}Description of the request json field
| Parameter Name | Mandatory | Type | Explain |
|---|---|---|---|
| setupConfig | Y | Object | none |
| setupConfig.installType | Y | string | amm market |
| setupConfig.name | Y | string | name for install |
| setupConfig.uninstall | Y | boolean | none |
update service
info BaseInfo
Brief Description
- None
Request URL
- /lpnode/lpnode_admin_panel/ctrl/updateDeployment
Request Method
- post
Request Parameter Example
json
{
"setupConfig": {
"installType": "ammClient",
"name": "bsc",
"image": "kldtks/edge:obridge-chain-client-near-37b587b2",
"installContext": "{\"deployment\":{\"startBlock\":\"800\",\"rpcUrl\":\"bscupdate url\",\"image\":\"kldtks/edge:otmoic-chainclient-evm-95f97f3d\",\"customEnv\":[{\"key\":\"key5\",\"value\":\"value1\"},{\"key\":\"key4\",\"value\":\"value2\"}]}}",
"update": true
}
}