Skip to content
This repository has been archived by the owner on Feb 7, 2024. It is now read-only.

[v2023.3]: update Queues docs - add ping for kafka #146

Merged
3 changes: 3 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# These are supported funding model platforms

github: roadrunner-server
14 changes: 7 additions & 7 deletions docs/en/app-server/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ This command allows you to specify one or more pipelines to `pause`. For example
`pipeline2`, you can use the following command:

```terminal
./rr jobs pause pipeline1,pipeline2
./rr jobs --pause pipeline1,pipeline2
```

:::
Expand All @@ -234,18 +234,18 @@ This command allows you to specify one or more pipelines to `resume`. For exampl
`pipeline2`, you can use the following command:

```terminal
./rr jobs resume pipeline1,pipeline2
./rr jobs --resume pipeline1,pipeline2
```

:::

::: tab Stop
::: tab Destroy

This command allows you to specify one or more pipelines to `stop`. For example, to stop pipelines `pipeline1` and
This command allows you to specify one or more pipelines to `destroy`. For example, to destroy pipelines `pipeline1` and
`pipeline2`, you can use the following command:

```terminal
./rr jobs stop pipeline1,pipeline2
./rr jobs --destroy pipeline1,pipeline2
```

:::
Expand All @@ -255,7 +255,7 @@ This command allows you to specify one or more pipelines to `stop`. For example,
To list all running pipelines, you can use the following command:

```terminal
./rr jobs list
./rr jobs --list
```

### Available options
Expand All @@ -279,4 +279,4 @@ For example:
```yaml .rr.yaml
rpc:
listen: "127.0.0.1:6001"
```
```
4 changes: 2 additions & 2 deletions docs/en/kv/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ communication with cache drivers such as:

- [Redis Server](https://redis.io/),
- [Memcached](https://memcached.org/),
- [BoltDB](https://github.com/etcd-io/bbolt) - not require a separate server,
- [BoltDB](https://github.com/etcd-io/bbolt) - does not require a separate server,
- In-memory storage - temporary stores data in RAM.

It is able to handle cache operations more efficiently than the same operations in PHP, leading to faster response times
Expand Down Expand Up @@ -343,4 +343,4 @@ $response = RPC::create('tcp://127.0.0.1:6001')
->withServicePrefix('kv')
->withCodec(new ProtobufCodec())
->call('MGet', new Request([ ... ]), Response::class);
```
```
2 changes: 2 additions & 0 deletions docs/en/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,8 @@
"title": "Releases",
"icon": "<svg width=\"30\" height=\"30\" viewBox=\"0 0 30 30\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path fill-rule=\"evenodd\" clip-rule=\"evenodd\" d=\"M23.4375 25H6.5625C4.39621 25 2.62594 23.3044 2.50643 21.168L2.5 20.9375V7.8125C2.5 6.32392 3.65645 5.10544 5.11994 5.00649L5.3125 5H20.9375C22.4261 5 23.6446 6.15645 23.7435 7.61994L23.75 7.8125V8.75H24.6875C26.1761 8.75 27.3946 9.90645 27.4935 11.3699L27.5 11.5625V20.9375C27.5 23.1038 25.8044 24.8741 23.668 24.9936L23.4375 25H6.5625H23.4375ZM6.5625 23.125H23.4375C24.5852 23.125 25.5265 22.2411 25.6177 21.1169L25.625 20.9375V11.5625C25.625 11.0879 25.2723 10.6956 24.8147 10.6336L24.6875 10.625H23.75V20.3125C23.75 20.7871 23.3973 21.1794 22.9397 21.2414L22.8125 21.25C22.3379 21.25 21.9456 20.8973 21.8836 20.4397L21.875 20.3125V7.8125C21.875 7.33788 21.5223 6.94564 21.0647 6.88356L20.9375 6.875H5.3125C4.83788 6.875 4.44564 7.22769 4.38356 7.68529L4.375 7.8125V20.9375C4.375 22.0852 5.25889 23.0265 6.38309 23.1177L6.5625 23.125H23.4375H6.5625ZM15.3075 18.125H19.0653C19.5831 18.125 20.0028 18.5447 20.0028 19.0625C20.0028 19.5371 19.6501 19.9294 19.1925 19.9914L19.0653 20H15.3075C14.7897 20 14.37 19.5803 14.37 19.0625C14.37 18.5879 14.7227 18.1956 15.1803 18.1336L15.3075 18.125H19.0653H15.3075ZM11.5541 13.7556C12.0719 13.7556 12.4916 14.1753 12.4916 14.6931V19.0625C12.4916 19.5803 12.0719 20 11.5541 20H7.1847C6.66693 20 6.2472 19.5803 6.2472 19.0625V14.6931C6.2472 14.1753 6.66693 13.7556 7.1847 13.7556H11.5541ZM10.6166 15.6306H8.1222V18.125H10.6166V15.6306ZM15.3075 13.7556H19.0653C19.5831 13.7556 20.0028 14.1753 20.0028 14.6931C20.0028 15.1677 19.6501 15.56 19.1925 15.622L19.0653 15.6306H15.3075C14.7897 15.6306 14.37 15.2109 14.37 14.6931C14.37 14.2185 14.7227 13.8262 15.1803 13.7642L15.3075 13.7556H19.0653H15.3075ZM7.1847 9.37809H19.0653C19.5831 9.37809 20.0028 9.79782 20.0028 10.3156C20.0028 10.7902 19.6501 11.1825 19.1925 11.2445L19.0653 11.2531H7.1847C6.66693 11.2531 6.2472 10.8334 6.2472 10.3156C6.2472 9.84097 6.59989 9.44873 7.05749 9.38665L7.1847 9.37809H19.0653H7.1847Z\" /></svg>",
"links": {
"releases/v2023-2-2": "v2023.2.2",
"releases/v2023-2-1": "v2023.2.1",
"releases/v2023-2-0": "v2023.2.0",
"releases/v2023-1-5": "v2023.1.5",
"releases/v2023-1-4": "v2023.1.4",
Expand Down
5 changes: 4 additions & 1 deletion docs/en/php/worker.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ $psr7 = new PSR7Worker($worker, $factory, $factory, $factory);
while (true) {
try {
$request = $psr7->waitRequest();
if ($request === null) {
break;
}
} catch (\Throwable $e) {
// Although the PSR-17 specification clearly states that there can be
// no exceptions when creating a request, however, some implementations
Expand Down Expand Up @@ -232,4 +235,4 @@ interacting with RoadRunner.

## What's Next?

1. [Plugins — Server](../plugins/server.md) - Read more about RoadRunner server plugin.
1. [Plugins — Server](../plugins/server.md) - Read more about RoadRunner server plugin.
2 changes: 1 addition & 1 deletion docs/en/plugins/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ The `after_init` section is used to execute some script/binary when the pool of
The `server.command` option is required and is used to start the worker pool for each configured section in the config.

> **Note**
> This option can be overridden by plugins with a pool section, such as the http.pool.command.
> This option can be overridden by plugins with a pool section, such as the `http.pool.command`, or in general `<plugin>.pool.command`.

The `user` and `group` options allow you to set the user and group that will start and own the worker process. This
feature provides an additional layer of security and control over the application's execution environment.
Expand Down
7 changes: 7 additions & 0 deletions docs/en/queues/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ kafka:
# Required to use Kafka driver
brokers: [ "127.0.0.1:9092", "127.0.0.1:9002" ]

# Ping to test connection to Kafka
#
# Examples: "2s", "5m"
# Optional, default: "10s"
ping:
timeout: "10s"

# SASL authentication options to use for all connections. Depending on the auth type, plain or aws_msk_plain sections might be removed.
#
# Optional, default: empty
Expand Down
13 changes: 13 additions & 0 deletions docs/en/releases/v2023-2-1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Description of Changes

# <center> 🚀 v2023.2.1 🚀 </center>

## 🩹 Fixes

- 🐛 **NATS driver**: Segfault when sending job via third-party sender without `consume_all` option set to `true`: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1650), (thanks @KernelMrex).
- 🐛 **Metrics plugin**: Irregular panic when declaring metrics via `on_init` option: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1648), (thanks @Kaspiman).
- 🐛 **Headers middleware**: Inconsistent usage of CORS options, failed to apply `allowed_*` options with spaces: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1655), (thanks @gam6itko).

### <center>🧹 Chore:</center>

- 🧑‍🏭 **Dependencies**: update project dependencies.
14 changes: 14 additions & 0 deletions docs/en/releases/v2023-2-2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Description of Changes

# <center> 🚀 v2023.2.2 🚀 </center>

## 🩹 Fixes

- 🐛 **JOBS plugin**: Fix typo in the `RPC` span name: [PR](https://github.com/roadrunner-server/jobs/pull/92), (thanks @Kaspiman).
- 🐛 **SDK**: Fix incorrect workers state when worker reached `idleTTL` state: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1669), (thanks @Aleksa1996).

### <center>🧹 Chore:</center>

- 🧑‍🏭 **HTTP plugin**: faster PostForm/MultipartForm processing [PR](https://github.com/roadrunner-server/http/pull/145).
- 🧑‍🏭 **Golang**: Update Golang version to v1.21.
- 🧑‍🏭 **Dependencies**: update project dependencies.