-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
updating docs to drop using --wipe
flag
#440
Conversation
Deploying documentation with Cloudflare Pages
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for updating the documentation @muhamadazmy. The changes look good to me.
For a bit of context for @gvdongen: We want to discourage the wipe command because it is a) dangerous, b) should hopefully no longer be needed with our backwards compatibility and c) wouldn't work in the distributed set up as it is implemented right now. Instead we ask people to delete the data directory manually if they really need to. The wipe command itself is still there but it is hidden now (not visible when running restate-server --help
).
docs/develop/local_dev.mdx
Outdated
|
||
```shell | ||
restate-server --wipe all | ||
rm -rf <BASE_DIR>/${HOST} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe replace ${HOST}
with <NODE_NAME>
. By default <NODE_NAME> == ${HOST}
but one can configure it to something else.
docs/develop/local_dev.mdx
Outdated
@@ -117,10 +117,10 @@ import clsx from "clsx"; | |||
<details> | |||
<summary> Wiping Restate </summary> | |||
|
|||
To start the Restate Server from a clean slate and wipe ongoing invocations and K/V state: | |||
To start the Restate Server from a clean slate, stop the server then wipe ongoing invocations and K/V state: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To start the Restate Server from a clean slate, stop the server then wipe ongoing invocations and K/V state: | |
To start the Restate Server from a clean slate, stop the server and then delete the data directory: |
docs/develop/local_dev.mdx
Outdated
@@ -146,7 +146,7 @@ import clsx from "clsx"; | |||
|
|||
[Cancel](/operate/invocation#cancelling-invocations) a single invocation or a batch of invocations. | |||
Use `--kill` to [kill](/operate/invocation#killing-invocations) the invocation. | |||
To remove all invocations, restart the server with `--wipe all`. | |||
To remove all invocations, stop the server then do `rm -rf <BASE_DIR>/<NODE_NAME>`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we should state that this deletes all state/data of the Restate server.
@tillrohrmann I think there is a difference in how you use Restate locally for development/learning, vs production usage. When developing locally, I still use it in quite some circumstances:
But yes, maybe doing |
@gvdongen The argument |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. +1 for merging.
Fixes #439