Skip to content

Commit 2775903

Browse files
docs: add rofl machine info
docs: improve rofl proxy cli docs docs: update rofl machine show section for clarity fix: pr review suggestions
1 parent b1cbbb8 commit 2775903

File tree

4 files changed

+89
-2
lines changed

4 files changed

+89
-2
lines changed

docs/rofl.md

Lines changed: 61 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -227,10 +227,34 @@ offer:
227227

228228
[ROFL marketplace]: https://github.com/oasisprotocol/oasis-sdk/blob/main/docs/rofl/features/marketplace.mdx
229229

230-
## Top-up payment for the machine {#top-up}
230+
## Manage a deployed ROFL machine {#machine}
231+
232+
Once a ROFL app is deployed, you can manage the machine it's running on using
233+
the `oasis rofl machine` subcommands.
234+
235+
### Show machine information {#machine-show}
236+
237+
To view details about a deployed machine, including its status, expiration,
238+
and any proxy URLs, run `oasis rofl machine show`:
239+
240+
![code shell](../examples/rofl/machine-show.in.static)
241+
242+
![code](../examples/rofl/machine-show.out.static)
243+
244+
If you have published ports in your `compose.yaml`, the output will include
245+
a `Proxy` section with public URLs to access your services. For more details on
246+
how to configure the proxy and for troubleshooting, see the [ROFL Proxy]
247+
feature page.
248+
249+
[ROFL Proxy]: https://github.com/oasisprotocol/oasis-sdk/blob/main/docs/rofl/features/proxy.mdx
250+
251+
### Top-up payment for the machine {#machine-top-up}
231252

232253
Run `rofl machine top-up` to extend the rental of the machine obtained from
233-
the [ROFL marketplace]. The rental is extended under the terms of the original
254+
the [ROFL marketplace]. You can check the current expiration date of your
255+
machine in the `Paid until` field from
256+
the [`oasis rofl machine show` output](#machine-show).
257+
The rental is extended under the terms of the original
234258
offer. Specify the extension period with [`--term`][term-flags] and
235259
[`--term-count`][term-flags] parameters.
236260

@@ -240,6 +264,41 @@ offer. Specify the extension period with [`--term`][term-flags] and
240264

241265
[term-flags]: #deploy
242266

267+
### Show machine logs {#machine-logs}
268+
269+
You can fetch logs from your running ROFL app using `oasis rofl machine logs`.
270+
271+
![code shell](../examples/rofl/machine-logs.in.static)
272+
273+
:::danger Logs are not encrypted!
274+
275+
While only the app admin can access the logs, they are stored
276+
**unencrypted on the ROFL node**. In production, make sure
277+
you never print any confidential data to the standard or error outputs!
278+
279+
:::
280+
281+
### Restart a machine {#machine-restart}
282+
283+
To restart a running machine, use `oasis rofl machine restart`.
284+
285+
If you wish to clear the machine's persistent storage,
286+
pass the [`--wipe-storage`] flag.
287+
288+
[`--wipe-storage`]: #machine-deploy
289+
290+
### Stop a machine {#machine-stop}
291+
292+
To stop a machine, use `oasis rofl machine stop`.
293+
To start it back again, use [`oasis rofl machine restart`].
294+
295+
[`oasis rofl machine restart`]: #machine-restart
296+
297+
### Remove a machine {#machine-remove}
298+
299+
To cancel the rental and permanently remove a machine,
300+
including its persistent storage, use `oasis rofl machine remove`.
301+
243302
## Advanced
244303

245304
### Upgrade ROFL app dependencies {#upgrade}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
oasis rofl machine logs
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
oasis rofl machine show
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Name: default
2+
Provider: oasis1qp2ens0hsp7gh23wajxa4hpetkdek3swyyulyrmz
3+
ID: 000000000000025a
4+
Offer: 0000000000000001
5+
Status: accepted
6+
Creator: oasis1qzvxd8vjgp2y0tjx229420tva822mdk2wxpx0vws
7+
Admin: oasis1qzvxd8vjgp2y0tjx229420tva822mdk2wxpx0vws
8+
Node ID: DbeoxcRwDO4Wh8bwq5rAR7wzhiB+LeYn+y7lFSGAZ7I=
9+
Created at: 2025-08-25 10:00:00 +0000 UTC
10+
Updated at: 2025-08-25 10:00:10 +0000 UTC
11+
Paid until: 2025-08-26 10:00:00 +0000 UTC
12+
Proxy:
13+
Domain: m602.test-proxy-b.rofl.app
14+
Ports from compose file:
15+
8080 (http-echo): https://p8080.m602.test-proxy-b.rofl.app
16+
Resources:
17+
TEE: Intel TDX
18+
Memory: 4096 MiB
19+
vCPUs: 2
20+
Storage: 20000 MiB
21+
Deployment:
22+
App ID: rofl1qrqw99h0f7az3hwt2cl7yeew3wtz0fxunu7luyfg
23+
Metadata:
24+
net.oasis.deployment.orc.ref: rofl.sh/0ba0712d-114c-4e39-ac8e-b28edffcada8:1747909776@sha256:77ff0dc76adf957a4a089cf7cb584aa7788fef027c7180ceb73a662ede87a217
25+
Commands:
26+
<no queued commands>

0 commit comments

Comments
 (0)