Skip to content

Add Valkey information to Docs #36

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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: 4 additions & 0 deletions configuration/magento2-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@ All the necessary files are located in `dev/tests/integration/`:

2. You need to create `etc/install-config-mysql.php` based on `etc/install-config-mysql.php.dist` as a template. The arguments are exactly the same to those you use for `bin/magento setup:install`:

:::{note}
Please note the below values for cache and session may be different if using Valkey instead of Redis
:::

```php
return [
'db-host' => 'tmp-mysql',
Expand Down
2 changes: 2 additions & 0 deletions environments/customizing.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The versions of MariaDB, Elasticsearch, Varnish, Redis, NodeJS and Composer may
* `MARIADB_VERSION`
* `ELASTICSEARCH_VERSION`
* `REDIS_VERSION`
* `VALKEY_VERSION`
* `VARNISH_VERSION`
* `RABBITMQ_VERSION`
* `NODE_VERSION`
Expand All @@ -20,6 +21,7 @@ Start of some environments could be skipped by using variables in `.env` file:

* `WARDEN_DB=0`
* `WARDEN_REDIS=0`
* `WARDEN_VALKEY=0`

## Docker Specific Customizations
To override default docker settings, add a custom configuration file in your project root
Expand Down
13 changes: 13 additions & 0 deletions environments/magento2.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,15 @@ In addition to the below manual process, there is a `Github Template available f
BLACKFIRE_SERVER_ID=
BLACKFIRE_SERVER_TOKEN=

:::{note}
Starting with Magento 2.4.8, set:

WARDEN_REDIS=0
WARDEN_VALKEY=1
VALKEY_VERSION=8.1

:::

3. Sign an SSL certificate for use with the project (the input here should match the value of `TRAEFIK_DOMAIN` in the above `.env` example file):

warden sign-certificate exampleproject.test
Expand Down Expand Up @@ -102,6 +111,10 @@ In addition to the below manual process, there is a `Github Template available f

8. Install the application and you should be all set:

:::{note}
Please note that if using Valkey instead of Redis, the value of the session and cache flags will be different
:::

## Install Application
bin/magento setup:install \
--backend-frontname=backend \
Expand Down
8 changes: 5 additions & 3 deletions usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,17 @@ Flush varnish:

warden env exec -T varnish varnishadm 'ban req.url ~ .'

Connect to redis:
Connect to redis/valkey:

warden redis
warden valkey

Flush redis completely:
Flush redis/valkey completely:

warden redis flushall
warden valkey flushall

Run redis continous stat mode
Run redis continuous stat mode
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Run redis continuous stat mode
Run redis/valkey continuous stat mode


warden redis --stat
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
warden redis --stat
warden redis --stat
warden valkey --stat


Expand Down