Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update description of Postgres port #171

Merged
merged 1 commit into from
Oct 24, 2023
Merged

Update description of Postgres port #171

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/restate/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
Restate is currently a single binary that contains everything you need.
It exposes three services by default, each on different ports:

| Name | Port | Description | Protocol |
|---------|------|-----------------------------------------------------------------------------|---------------------------------------------------|
| Ingress | 8080 | Acts as an API gateway for all services registered with Restate | gRPC + [Connect Protocol](https://connect.build/) |
| Storage | 9071 | Exposes raw RocksDB read-only storage operations, used by the CLI | gRPC |
| Meta | 9070 | Allows for CRUD operations on service metadata, eg for service registration | REST |
| Name | Port | Description | Protocol |
|----------|------|--------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|
| Ingress | 8080 | Acts as an API gateway for all services registered with Restate | gRPC + [Connect Protocol](https://connect.build/) |
| Admin | 9070 | Allows for CRUD operations on service/endpoint metadata, eg for service registration | REST |

Check notice on line 14 in docs/restate/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/restate/deployment.md#L14 

[Google.Acronyms] Spell out 'CRUD', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'CRUD', if it's unfamiliar to the audience.", "location": {"path": "docs/restate/deployment.md", "range": {"start": {"line": 14, "column": 32}}}, "severity": "INFO"}

Check failure on line 14 in docs/restate/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/restate/deployment.md#L14 

[Vale.Spelling] Did you really mean 'eg'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'eg'?", "location": {"path": "docs/restate/deployment.md", "range": {"start": {"line": 14, "column": 78}}}, "severity": "ERROR"}

Check failure on line 14 in docs/restate/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/restate/deployment.md#L14 

[Google.Latin] Use 'for example' instead of 'eg'.
Raw output 
{"message": "[Google.Latin] Use 'for example' instead of 'eg'.", "location": {"path": "docs/restate/deployment.md", "range": {"start": {"line": 14, "column": 78}}}, "severity": "ERROR"}

Check notice on line 14 in docs/restate/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/restate/deployment.md#L14 

[Google.Acronyms] Spell out 'REST', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'REST', if it's unfamiliar to the audience.", "location": {"path": "docs/restate/deployment.md", "range": {"start": {"line": 14, "column": 150}}}, "severity": "INFO"}
| Postgres | 9071 | Exposes Restate RocksDB read-only storage operations using the Postgres protocol. See [Introspection](/services/introspection) | Postgres |

Check failure on line 15 in docs/restate/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/restate/deployment.md#L15 

[Vale.Spelling] Did you really mean 'Postgres'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'Postgres'?", "location": {"path": "docs/restate/deployment.md", "range": {"start": {"line": 15, "column": 3}}}, "severity": "ERROR"}

Check warning on line 15 in docs/restate/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/restate/deployment.md#L15 

[write-good.Weasel] 'only' is a weasel word!
Raw output 
{"message": "[write-good.Weasel] 'only' is a weasel word!", "location": {"path": "docs/restate/deployment.md", "range": {"start": {"line": 15, "column": 50}}}, "severity": "WARNING"}

Check failure on line 15 in docs/restate/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/restate/deployment.md#L15 

[Vale.Spelling] Did you really mean 'Postgres'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'Postgres'?", "location": {"path": "docs/restate/deployment.md", "range": {"start": {"line": 15, "column": 84}}}, "severity": "ERROR"}

Check failure on line 15 in docs/restate/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/restate/deployment.md#L15 

[Vale.Spelling] Did you really mean 'Postgres'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'Postgres'?", "location": {"path": "docs/restate/deployment.md", "range": {"start": {"line": 15, "column": 150}}}, "severity": "ERROR"}

It will store metadata and RocksDB data in the relative directory of /target under the current working directory of the process.

Expand Down Expand Up @@ -56,7 +56,7 @@
value: Json
ports:
- containerPort: 9070
name: meta
name: admin
- containerPort: 8080
name: ingress
- containerPort: 9071
Expand Down Expand Up @@ -91,7 +91,7 @@
app: restate
ports:
- port: 9070
name: meta
name: admin
- port: 8080
name: ingress
- port: 9071
Expand Down