Skip to content

Commit f01c8a2

Browse files
authored
Merge pull request magento#7010 from magento/db_consumers
magento#7008 Clarify Configure Consumers page
2 parents 2c95e2f + 56044f8 commit f01c8a2

File tree

3 files changed

+11
-15
lines changed

3 files changed

+11
-15
lines changed

src/_data/toc/installation-guide.yml

+3
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,9 @@ pages:
210210
- label: Enable or disable maintenance mode
211211
url: /install-gde/install/cli/install-cli-subcommands-maint.html
212212

213+
- label: Configure consumer behavior
214+
url: /install-gde/install/cli/install-cli-subcommands-consumers.html
215+
213216
- label: Create the Magento database schema
214217
url: /install-gde/install/cli/install-cli-subcommands-db.html
215218

src/_includes/config/consumers.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
Name|Value|Required?|
2-
|`--consumers-wait-for-messages`|Should consumers wait for a message from the queue? 1 - Yes, 0 - No|No|
3-
{:style="table-layout:auto;"}
1+
| Name | Description | Value | Required |
2+
| `--consumers-wait-for-messages` | Determines if consumers will wait for a message from the queue. | 1 - Yes, 0 - No | No |
43

5-
`0`Consumers process available messages in the queue, close the TCP connection, and terminate. Consumers do not wait for additional messages to enter the queue, even if the number of processed messages is less than the `--max_messages` value specified during starting consumers.
4+
* `0`: Consumers process available messages in the queue, close the TCP connection, and terminate. Consumers do not wait for additional messages to enter the queue, even if the number of processed messages is less than the `--max_messages` value specified during starting consumers.
65

7-
`1`Consumers continue to process messages from the message queue until reaching the maximum number of messages (the value specified for `--max_messages` on the `queue:consumers:start` command) before closing the TCP connection and terminating the consumer process. If the queue empties before reaching `--max_messages` the consumer waits for more messages to arrive. If you use workers to run consumers instead of using a cron job, set this variable to `1`.
6+
* `1`: Consumers continue to process messages from the message queue until reaching the maximum number of messages (the value specified for `--max_messages` on the `queue:consumers:start` command) before closing the TCP connection and terminating the consumer process. If the queue empties before reaching `--max_messages` the consumer waits for more messages to arrive. If you use workers to run consumers instead of using a cron job, set this variable to `1`.
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,25 @@
11
---
22
group: installation-guide
3-
title: Configure the lock provider
3+
title: Configure consumer behavior
44
functional_areas:
55
- Install
66
- System
77
- Setup
88
---
99

10-
## First steps {#instgde-cli-before}
11-
{% include install/first-steps-cli.md %}
12-
In addition to the command arguments discussed here, see [Common arguments]({{ page.baseurl }}/install-gde/install/cli/install-cli-subcommands.html#instgde-cli-subcommands-common).
13-
14-
## Prerequisites {#instgde-cli-subcommands-store-prereq}
15-
1610
Before you run this command, you must do all of the following *or* you must [install the Magento software]({{ page.baseurl }}/install-gde/install/cli/install-cli-install.html):
1711

1812
* [Create or update the deployment configuration]({{ page.baseurl }}/install-gde/install/cli/install-cli-subcommands-deployment.html)
1913
* [Create the Magento database schema]({{ page.baseurl }}/install-gde/install/cli/install-cli-subcommands-db.html)
2014

21-
## Configure the consumers behaviour {#instgde-cli-consumersconfig}
15+
## Configure the consumers behavior {#instgde-cli-consumersconfig}
2216

23-
> Command usage
17+
Configuring consumer behavior is done by sending key/value pairs within the setup function:
2418

2519
```bash
2620
magento setup:config:set [--<parameter_name>=<value>, ...]
2721
```
2822

29-
> Parameter descriptions
23+
### Parameter descriptions
3024

3125
{% include config/consumers.md %}

0 commit comments

Comments
 (0)