Skip to content

Adjust documentation to match errors found via schema updates and new SQS parameters #29

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

Merged
merged 15 commits into from
Nov 10, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
4 changes: 2 additions & 2 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
root: ./

structure:
structure:
readme: README.md
summary: SUMMARY.md
summary: SUMMARY.md
2 changes: 1 addition & 1 deletion app-server/aws-lambda.md
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ logs:
mode: production
level: error
encoding: json
output: stderr
output: [ stderr ]

endure:
grace_period: 1s
Expand Down
2 changes: 1 addition & 1 deletion app-server/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ FROM php:8.3-alpine
# https://github.com/mlocati/docker-php-extension-installer
# https://github.com/docker-library/docs/tree/0fbef0e8b8c403f581b794030f9180a68935af9d/php#how-to-install-more-php-extensions
RUN --mount=type=bind,from=mlocati/php-extension-installer:2,source=/usr/bin/install-php-extensions,target=/usr/local/bin/install-php-extensions \
install-php-extensions @composer-2 opcache zip intl sockets profobuf
install-php-extensions @composer-2 opcache zip intl sockets protobuf

COPY --from=roadrunner /usr/bin/rr /usr/local/bin/rr

Expand Down
2 changes: 1 addition & 1 deletion kv/overview-kv.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@ To make it easy to use the KV proto API in PHP, we provide
a [GitHub repository](https://github.com/roadrunner-php/roadrunner-api-dto), that contains all the generated PHP DTO
classes proto files, making it easy to work with these files in your PHP application.

- [API](https://github.com/roadrunner-server/api/blob/master/kv/v1/kv.proto)
- [API](https://github.com/roadrunner-server/api/blob/master/proto/kv/v1/kv.proto)

### RPC API

Expand Down
4 changes: 2 additions & 2 deletions lab/logger.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ the output key.

```yaml
logs:
output: stdout
output: [ stdout ]
```

{% endcode %}
Expand Down Expand Up @@ -131,7 +131,7 @@ logs:
channels:
http:
mode: production
output: http.log
output: [ http.log ]
```

{% endcode %}
Expand Down
17 changes: 8 additions & 9 deletions plugins/tcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,11 @@ tcp:
max_jobs: 0
allocate_timeout: 60s
destroy_timeout: 60s

# The size of the read buffer in MB. Can be increased to reduce the number of read syscalls.
# Consider using a larger buffer size if you expect to receive large payloads on the TCP server.
# Optional; example.
read_buf_size: 20
```

{% endcode %}
Expand Down Expand Up @@ -110,15 +115,9 @@ tcp:
- `addr`: The server address and port, specified in the format `tcp://<IP_ADDRESS>:<PORT>`.
- `delimiter`: (Optional) The data packet delimiter. By default, it is set to `\r\n`. Each data packet should end
either with an `EOF` or the specified delimiter.
- `read_buf_size`: (Optional) The size of the read buffer in MB. To reduce the number of read syscalls, consider
using a larger buffer size if you expect to receive large payloads on the TCP server.

- `pool`: Configuration for the PHP worker pool.
- `num_workers`: The number of PHP workers to allocate.
- `max_jobs`: The maximum number of jobs each worker can handle. Set to 0 for no limit.
- `allocate_timeout`: The timeout for worker allocation, specified in the format `<VALUE>s` (e.g., `60s` for 60
seconds).
- `destroy_timeout`: The timeout for worker destruction, specified in the same format as allocate_timeout.

- `pool`: Configuration for the PHP worker pool for the TCP servers. See
https://docs.roadrunner.dev/docs/php-worker/pool for available parameters.

## PHP client

Expand Down
10 changes: 0 additions & 10 deletions queues/amqp.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,6 @@ jobs:
# If the job has priority set to 0, it will inherit the pipeline's priority. Default: 10.
priority: 1

# Consume any payload type (not only Jobs structured)
#
# Default: false
consume_all: false

# Redial timeout (in seconds). How long to try to reconnect to the AMQP server.
#
# Default: 60
Expand Down Expand Up @@ -221,11 +216,6 @@ from `pipe1` have been processed.

`queue` - required, AMQP internal (inside the driver) queue name.

### Consume all

`consume_all` - by default, RoadRunner only supports `Jobs` structures from the queue. Enable this option by setting it
to true if you wish to consume raw payloads as well.

### Exchange

`exchange` - required, rabbitMQ exchange name.
Expand Down
9 changes: 0 additions & 9 deletions queues/beanstalk.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,6 @@ jobs:
# Default: 10
priority: 10

# Consume any payload type (not only Jobs structured)
# Default: false
consume_all: false

# Optional section.
# Default: 1
tube_priority: 1
Expand Down Expand Up @@ -82,8 +78,3 @@ value should not exceed `int32` size.
### Tube

`tube` - The name of the inner "tube" specific to the Beanstalk driver.

### Consume all

`consume_all` - By default, RR supports only `Jobs` structures from the queue. Set this option to true if you want to
also consume the raw payloads.
9 changes: 0 additions & 9 deletions queues/nats.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,6 @@ jobs:
# Messages to read into the channel
prefetch: 100

# Consume any payload type (not only Jobs structured)
# Default: false
consume_all: false

# NATS subject
# Default: default
subject: default
Expand Down Expand Up @@ -91,8 +87,3 @@ jobs:
### Delete after ack

`delete_after_ack` - delete message after it successfully acknowledged.

### Consume all

`consume_all` - By default, RR supports only `Jobs` structures from the queue. Set this option to true if you want to
also consume the raw payloads.
Loading