Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pykettk/module-indexer-deploy-config
A Magento 2 module that allows developers to lock indexer modes via deployment config.
https://github.com/pykettk/module-indexer-deploy-config
Last synced: 18 days ago
JSON representation
A Magento 2 module that allows developers to lock indexer modes via deployment config.
- Host: GitHub
- URL: https://github.com/pykettk/module-indexer-deploy-config
- Owner: pykettk
- License: osl-3.0
- Created: 2022-11-04T12:06:47.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-17T21:13:37.000Z (over 1 year ago)
- Last Synced: 2024-10-20T17:00:13.748Z (24 days ago)
- Language: PHP
- Homepage:
- Size: 44.9 KB
- Stars: 31
- Watchers: 0
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
element119 | Indexer Deploy Config
A Magento 2 module that allows developers to lock indexer modes via deployment config.
## 📝 Features
✔️ Allows you to selectively lock indexer modes via the `app/etc/config.php` file
✔️ Indexer configuration validated and imported as part of `app:config:import`
✔️ Supports custom indexers
✔️ Provides messaging for admins to see which indexers are locked via deploy config
✔️ Informs admins when they try to change indexer modes that are locked via deploy config
✔️ Supports Magento Open Source and Adobe Commerce
✔️ Supports Hyvä and Luma based themes
✔️ Seamless integration with Magento
✔️ Built with developers and extensibility in mind to make customisations as easy as possible
✔️ Installable via Composer
## 🔌 Installation
Run the following command to *install* this module:
```bash
composer require element119/module-indexer-deploy-config
php bin/magento setup:upgrade
```
## ⏫ Updating
Run the following command to *update* this module:
```bash
composer update element119/module-indexer-deploy-config
php bin/magento setup:upgrade
```
## ❌ Uninstallation
Run the following command to *uninstall* this module:
```bash
composer remove element119/module-indexer-deploy-config
php bin/magento setup:upgrade
```
## 📚 User Guide
### Locking Indexer Modes
1. Add a new `indexers` array to the `app/etc/config.php` file
2. Add the `realtime` or `schedule` arrays to the `indexers` array as required
3. Specify the indexer IDs you want to lock to a specific mode within the respective mode array
### Example
```php
'indexers' => [
'realtime' => [
'catalogrule_rule',
'design_config_grid',
],
'schedule' => [
'catalog_category_product',
'catalog_product_category',
'catalog_product_attribute',
'catalog_product_price',
],
],
```
> **Note**
>
> Empty indexer mode arrays may be omitted in the cases where you don't want to lock any indexers to that mode.
### Indexer Mode Locking Cron Fallback
A new system configuration option allows you to enable a cron job that will ensure indexers are in the mode they are
supposed to be in, according to deployment config. This option can be found in `Stores -> Configuration -> Advanced ->
System -> Indexer Mode Locking`.
### `indexer:lock-all` Command
The module adds a new `indexer:lock-all` command that you can use to lock the indexer modes via the command line.
```
Description:
Lock all indexers
Usage:
indexer:lock-all [options]
Options:
-m, --mode=MODE Passing one of two modes (schedule, realtime) will lock all indexers to that mode.
-h, --help Display this help message
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
```
> **Note**
>
> You will need to run `app:config:import` after indexer modes have been set, unset, or changed in the deploy config.
>
> Due to the fact that this new command writes to the deploy config files and this module makes
[additions to the deploy config pool](https://github.com/pykettk/module-indexer-deploy-config/blob/master/etc/di.xml#L26-L39),
any automated deployment pipelines will need to run `app:config:import` in non-interactive mode by passing either
`-n` or `--no-interaction` as command options to avoid [the usual prompt](https://github.com/pykettk/module-indexer-deploy-config/blob/master/Model/Config/Importer.php#L72-L144).
*No arguments locks the indexer modes to their current state.*
*Passing `-m realtime` as the argument sets all indexers to `Update on Save`.*
*Passing `-m schedule` as the argument sets all indexers to `Update by Schedule`.*
### Restricted Admin Controls
