Skip to content

Commit 43c76cd

Browse files
chore(oasis-deployment): adds deployment config and docs
adds a new oasis-deployment setup to simplify building and deploying the service on oasis. provides an example environment variable file, a docker-compose-style service definition for the mcp server, and a readme with step-by-step instructions and troubleshooting tips. these additions make it easier to bootstrap, deploy, and maintain testnet deployments.
1 parent 286e5a9 commit 43c76cd

3 files changed

Lines changed: 65 additions & 0 deletions

File tree

oasis-deployment/.env.example

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
PLURALITY_DOMAIN=dev.plurality.network

oasis-deployment/README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Steps for making a new deployment
2+
3+
## Create Oasis project (optional)
4+
Create a new Oasis project (if there isn't any)
5+
```
6+
oasis rofl init
7+
oasis rofl create --network testnet
8+
```
9+
10+
## Build and the image
11+
Run the following command
12+
```
13+
oasis rofl build
14+
```
15+
16+
## Import environment variables
17+
```
18+
oasis rofl secret import .env.example
19+
oasis rofl update
20+
```
21+
(Hint: if you changed sth manually in rofl.yaml, you can use ```oasis rofl update``` to make your change work)
22+
23+
## Deploy the image
24+
```
25+
oasis rofl deploy
26+
```
27+
28+
## Show the deployment
29+
After deployment you can check the status of deployment by using
30+
```
31+
oasis rofl machine show
32+
```
33+
34+
It may take some time after the deployment because the applciation needs to start
35+
36+
## Top up the machine
37+
After successfully testing, you can top up the machine so that it keeps your application longer (the default expiration time is very short), here is an example of top up the machine for 2 more hours
38+
```
39+
oasis rofl machine top-up --term hour --term-count 2
40+
```
41+
42+
## Show the account (optional)
43+
In case you may need to top up your oasis account by getting some TEST token from the faucet https://faucet.testnet.oasis.io/, do the following command to see your account address
44+
```
45+
oasis account show
46+
```
47+
48+
## Common Errors:
49+
1. Oasis update failed with error msg ```insufficient gas```, try to do ```oasis rofl update --gas-limit XXXXXX```
50+
2. Deployment failed with error msg ```no space left```, manually change in ```rofl.yml``` the disk to sth like ```17000``` instead of using ```20000```
51+
3. Deployment failed with error msg ```can not find the node```, manually delete the ```machines``` section in ```rofl.yml``` and redo ```oasis rofl update``` then ```oasis rofl deploy```
52+
4. The deployment mahcine goes down after sometime, you need to top it up after the deployment ```oasis rofl machine top-up --term hour --term-count <hours>```

oasis-deployment/compose.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
services:
2+
#######
3+
# MCP Server
4+
#######
5+
plurality-mcp-server-dev:
6+
container_name: plurality-mcp-server-dev
7+
image: ghcr.io/web3-plurality/plurality-mcp-server-pre:latest
8+
environment:
9+
HYDRA_ISSUER: https://${PLURALITY_DOMAIN}
10+
MCP_RESOURCE_URL: https://${PLURALITY_DOMAIN}
11+
BACKEND_API_URL: https://${PLURALITY_DOMAIN}/api
12+
restart: always

0 commit comments

Comments
 (0)