-
Notifications
You must be signed in to change notification settings - Fork 7
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
Use CLI in quickstart #250
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,6 +15,7 @@ | |
- TypeScript: Latest stable version of [NodeJS](https://nodejs.org/en/) >= v18.17.1 and [npm CLI](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) >= 9.6.7 | ||
- Java: [JDK](https://whichjdk.com/) >= 17 | ||
- [Docker](https://docs.docker.com/engine/install/) to run Restate | ||
- (Optional): Restate CLI: [Installation guide](/restate/cli#installation) | ||
Check notice on line 18 in docs/quickstart.mdx GitHub Actions / vale[vale] docs/quickstart.mdx#L18
Raw output
Check warning on line 18 in docs/quickstart.mdx GitHub Actions / vale[vale] docs/quickstart.mdx#L18
Raw output
|
||
|
||
## Step 1: Scaffold the project | ||
|
||
|
@@ -39,8 +40,13 @@ | |
</TabItem> | ||
<TabItem value="jvm" label="Java" default> | ||
|
||
Grab the Java Hello world example: | ||
Grab the Java Hello world example via the Restate CLI: | ||
Check warning on line 43 in docs/quickstart.mdx GitHub Actions / vale[vale] docs/quickstart.mdx#L43
Raw output
|
||
|
||
```shell | ||
restate example java-hello-world-http && cd java-hello-world-http | ||
``` | ||
|
||
Or via `wget`: | ||
```shell | ||
wget https://github.com/restatedev/examples/releases/latest/download/java-hello-world-http.zip && unzip java-hello-world-http.zip -d java-hello-world-http && rm java-hello-world-http.zip | ||
``` | ||
|
@@ -104,54 +110,69 @@ | |
docker run --name restate_dev --rm -d --network=host docker.io/restatedev/restate:VAR::RESTATE_VERSION | ||
``` | ||
|
||
:::tip | ||
Restate is a single self-contained binary and Docker just one of the ways to run it. You can also obtain the binary from the | ||
Check notice on line 114 in docs/quickstart.mdx GitHub Actions / vale[vale] docs/quickstart.mdx#L114
Raw output
Check warning on line 114 in docs/quickstart.mdx GitHub Actions / vale[vale] docs/quickstart.mdx#L114
Raw output
|
||
[releases page](https://github.com/restatedev/restate/releases), from our [Homebrew tap](https://github.com/restatedev/homebrew-tap) | ||
Check warning on line 115 in docs/quickstart.mdx GitHub Actions / vale[vale] docs/quickstart.mdx#L115
Raw output
|
||
with `brew install restatedev/tap/restate`, or from [npm](https://www.npmjs.com/package/@restatedev/restate-server) | ||
with `npm install @restatedev/restate-server`. | ||
::: | ||
|
||
Register the service: | ||
|
||
Now, we need to tell Restate where the service is running. | ||
We do this by sending a request to the endpoint of the runtime at `http://localhost:9070/deployments` | ||
|
||
We can do this via the CLI: | ||
Check warning on line 124 in docs/quickstart.mdx GitHub Actions / vale[vale] docs/quickstart.mdx#L124
Raw output
Check warning on line 124 in docs/quickstart.mdx GitHub Actions / vale[vale] docs/quickstart.mdx#L124
Raw output
|
||
|
||
```shell | ||
restate dep register http://localhost:9080 | ||
``` | ||
|
||
Or via `curl`, by sending a request to the endpoint of the runtime at `http://localhost:9070/deployments` | ||
and providing it with the deployment endpoint of the service `http://localhost:9080`. | ||
```shell | ||
curl -X POST http://localhost:9070/deployments -H 'content-type: application/json' -d '{"uri": "http://localhost:9080"}' | ||
``` | ||
|
||
Restate then sends a request to the service deployment to ask which services and methods | ||
are running behind this deployment and will keep track of these (including of the method signatures). | ||
After executing this curl request, you should see the discovered services and methods printed to your terminal. | ||
|
||
</TabItem> | ||
<TabItem value="mac" label="macOS"> | ||
|
||
Run the Restate Docker container: | ||
|
||
```shell | ||
docker run --name restate_dev --rm -d -p 8080:8080 -p 9070:9070 -p 9071:9071 docker.io/restatedev/restate:VAR::RESTATE_VERSION | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think you can drop the docker.io part, no? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this didn't work for some setups. I am not sure anymore which one though. Let me check... There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. agreed re dropping it There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's required for podman apparently |
||
``` | ||
|
||
:::tip | ||
Restate is a single self-contained binary and Docker just one of the ways to run it. You can also obtain the binary from the | ||
[releases page](https://github.com/restatedev/restate/releases), from our [Homebrew tap](https://github.com/restatedev/homebrew-tap) | ||
with `brew install restatedev/tap/restate`, or from [npm](https://www.npmjs.com/package/@restatedev/restate-server) | ||
with `npm install @restatedev/restate-server`. | ||
::: | ||
|
||
Register the services: | ||
|
||
</TabItem> | ||
<TabItem value="mac" label="macOS"> | ||
Now, you need to tell Restate where the service is running. | ||
Check notice on line 158 in docs/quickstart.mdx GitHub Actions / vale[vale] docs/quickstart.mdx#L158
Raw output
|
||
|
||
Run the Restate Docker container: | ||
We can do this via the CLI: | ||
Check warning on line 160 in docs/quickstart.mdx GitHub Actions / vale[vale] docs/quickstart.mdx#L160
Raw output
Check warning on line 160 in docs/quickstart.mdx GitHub Actions / vale[vale] docs/quickstart.mdx#L160
Raw output
|
||
|
||
```shell | ||
docker run --name restate_dev --rm -d -p 8080:8080 -p 9070:9070 -p 9071:9071 docker.io/restatedev/restate:VAR::RESTATE_VERSION | ||
restate dep register http://host.docker.internal:9080 | ||
``` | ||
|
||
Register the services: | ||
|
||
Now, we need to tell Restate where the service is running. | ||
We do this by sending a request to the endpoint of the runtime at `http://localhost:9070/deployments` | ||
Or via `curl`, by sending a request to the endpoint of the runtime at `http://localhost:9070/deployments` | ||
and providing it with the deployment endpoint of the service `http://host.docker.internal:9080`. | ||
```shell | ||
curl -X POST http://localhost:9070/deployments -H 'content-type: application/json' -d '{"uri": "http://host.docker.internal:9080"}' | ||
``` | ||
|
||
Restate then sends a request to the service deployment to ask which services and methods | ||
are running behind this deployment and will keep track of these (including of the method signatures). | ||
After executing this curl request, you should see the discovered services and methods printed to your terminal. | ||
|
||
:::tip | ||
Restate is a single self-contained binary and Docker just one of the ways to run it. You can also obtain the binary from the | ||
[releases page](https://github.com/restatedev/restate/releases), from our [Homebrew tap](https://github.com/restatedev/homebrew-tap) | ||
with `brew install restatedev/tap/restate`, or from [npm](https://www.npmjs.com/package/@restatedev/restate-server) | ||
with `npm install @restatedev/restate-server`. | ||
::: | ||
|
||
</TabItem> | ||
</Tabs> | ||
|
||
|
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.
Suggested:
Now, we need to tell Restate where the service is running. To do this, we register a new "deployment" on restate server.
We can do this via the CLI: