Skip to content

how-to-run-rabbitmq-on-hypernode.md

Latest commit

 

History

History
97 lines (67 loc) · 4.27 KB

how-to-run-rabbitmq-on-hypernode.md

File metadata and controls

97 lines (67 loc) · 4.27 KB
Raw
myst
html_meta
description title
Use RabbitMQ to run resource-intensive tasks in the background on Hypernode. Learn how to enable and access RabbitMQ on Hypernode.
How to Run RabbitMQ | Hypernode
redirect_from
/en/best-practices/database/how-to-run-rabbitmq-on-hypernode/

How to Run RabbitMQ on Hypernode

RabbitMQ is available on all Hypernode plans. Check the changelog here.

What is RabbitMQ?

Because Magento is a heavy and slow application, tasks are preferably executed in the background. To run tasks in the background you need queues. RabbitMQ is message-queueing software where queues can be defined. Applications can connect to the queue and transfer a message onto it. This way you can (for example) import many products into Magento without having to wait a substantial time until the process is finished. The import takes place in the background.

The main idea behind queues is to avoid doing a resource-intensive task immediately and having to wait for it to complete. Instead you can schedule the task to be done later. The task is wrapped-up as a message and sent to a queue. A worker process running in the background will pop the tasks and eventually execute the job.

Details RabbitMQ on Hypernode

  • Hypernode installs and runs RabbitMQ if the hosting plan supports it AND if you have explicitly enabled it
  • RabbitMQ can be enabled / disabled via the hypernode-api or hypernode-systemctl commandline tool
  • RabbitMQ will be disabled automatically when you downgrade your hosting plan that does not support it
  • When upgrading or downgrading your hosting plan, any exchanges, queues, users and persistent messages (non-transient) will be transferred to your new Hypernode. Even if your new hosting plan does not support RabbitMQ, the data will be kept.
  • The data is also kept if RabbitMQ disabled. After re-enabling it again, you still have your queues, users, etc.

Enabling RabbitMQ

Enabling RabbitMQ can be done via de commandline tool or the Hypernode API.

As an app user you enable RabbitMQ this way:

hypernode-systemctl settings rabbitmq_enabled True

Use False to turn it off.

If your hosting plan does not support RabbitMQ, you will receive the following message:

app@uaijq6-test-magweb-do:~$ hypernode-systemctl settings rabbitmq_enabled --value True
Looks like something went wrong: b'{"rabbitmq_enabled":["RabbitMQ cannot be enabled for this app. Please upgrade to a plan that supports RabbitMQ if you want to make use of this feature."]}'

Restarting RabbitMQ

You can run this command to restart RabbitMQ:

hypernode-servicectl restart rabbitmq-server

Accessing the RabbitMQ admin interface

  • RabbitMQ only binds on localhost
  • The default admin account is username guest and password guest. You can change and add users via the admin interface.
  • You can access the admin interface e.g. by forwarding the tcp port via SSH:
ssh app@appname.hypernode.io -L 55672:localhost:15672

Use your browser to go to localhost:55672 and logon using guest/guest.

Another way to access the admin interface is via hypernode-vpn

Creating RabbitMQ users

You can also create your own RabbitMQ users. This can be done by in the RabbitMQ admin interface, as follows:

  1. Go to the RabbitMQ admin interface
  2. Click on the Admin tab
  3. Click on Add a user
  4. Fill in the username and password
  5. Click on Add user
  6. Click on the user you just created
  7. Click on Set permission

RabbitMQ and Magento 2

To configure RabbitMQ in Magento 2, you can run the following command:

bin/magento setup:config:set \
    --amqp-host="rabbitmq" \
    --amqp-port="5672" \
    --amqp-user="guest" \
    --amqp-password="guest" \
    --amqp-virtualhost="/"

Note: Hypernode provisions a non-default user called hypernode-admin but you are free to create new users.