Added a page describing the "jobs" plugin #70
Conversation
|
The documentation has been completed. No more major changes or additions on my part are planned. |
beep-beep/jobs.md
Outdated
| - `pool.num_workers` - How many worker processes will be started. Zero | ||
| (or nothing) means the number of logical CPUs. | ||
|
|
||
| - `pool.max_jobs` - Maximal count of worker executions. Zero (or nothing) means | ||
| no limit. | ||
|
|
||
| - `pool.allocate_timeout` - Timeout for worker allocation. Zero means no limit. | ||
|
|
||
| - `pool.destroy_timeout` - Timeout for worker destroying before process killing. | ||
| Zero means no limit. |
There was a problem hiding this comment.
Pool inherits all general pool options, such as supervisor, TTL, etc, not only 4 described above.
There was a problem hiding this comment.
@rustatian Maybe then just remove this description altogether leaving a link to https://roadrunner.dev/docs/intro-config ?
There was a problem hiding this comment.
@rustatian Maybe then just remove this description altogether leaving a link to https://roadrunner.dev/docs/intro-config ?
Yep, ok.
beep-beep/jobs.md
Outdated
| [documentation page](https://www.rabbitmq.com/download.html). After that, you | ||
| should configure the connection to the server in the "`amqp`" section. This | ||
| configuration section contains exactly one `addr` key with a connection DSN | ||
| in the format: `amqp://[USER]:[PASSWORD]@[HOST]:[PORT]`. |
There was a problem hiding this comment.
Put the doc about AMQP URI format here: https://www.rabbitmq.com/uri-spec.html
| window size in octets. See also ["prefetch-size"](https://www.rabbitmq.com/amqp-0-9-1-reference.html) | ||
| in AMQP QoS documentation reference. | ||
|
|
||
| - `queue` - AMQP internal (inside the driver) queue name. |
There was a problem hiding this comment.
When I revisit this section, I guess, that we can delete internal (inside the driver) from the description, because this is the actual AMQP queue name.
There was a problem hiding this comment.
This note is needed in order to understand that this queue name is not public, available for work from the plugin's API.
beep-beep/jobs.md
Outdated
| ```sh | ||
| wget https://s3-eu-west-1.amazonaws.com/softwaremill-public/elasticmq-server-1.2.0.jar | ||
|
|
||
| // Where "custom.conf" is your own config file |
There was a problem hiding this comment.
I guess that will be better to point the user to the existing Dockerfile with all configuration needed. Or, provide both, local and dockered setup with the sample of the custom.conf : https://github.com/spiral/roadrunner/blob/master/tests/env/custom.conf
There was a problem hiding this comment.
I don’t think it makes sense to write down the complete installation instructions. This example is only needed to show that the SQS is available for local installation too, in addition to being used in AWS.
So yeah, I think a Dockerfile link will suffice.
However, I am confused by the fact that it is located in the tests directory, which may confuse users and they may think that this use case is only possible for development.
There was a problem hiding this comment.
P.S. yaml is not a valid Dockerfile extension
There was a problem hiding this comment.
kk. I corrected this description by simply providing a link to the repository with the project.
beep-beep/jobs.md
Outdated
| > Please note that this functionality is rarely used and slows down the work of | ||
| > queues. |
There was a problem hiding this comment.
https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html (at the bottom). Put a link or reference to the SQS docs section (Note part at the bottom)
Related PR: roadrunner-server/roadrunner#726
It is worth noting that all places marked with the
TODOlabel contain an unfinished description containing information about the internal device of the RoadRunner:num_pollerspipeline_sizepool.num_workerspool.max_jobspool.allocate_timeoutpool.destroy_timeoutjobs.Pushjobs.PushBatchjobs.Pausejobs.Resumejobs.Listjobs.DeclareP.S. Additionally
jobs.Stat