Akeneo Onboarder
#Synchronization
#Push catalog structure to the middleware
To work, the middleware needs some data from the PIM and you will have to push them once your installation will be done.
Data synchronized are: attribute groups, attributes, attribute option, and families.
$ php bin/console akeneo:synchronization:push-catalog-to-onboarder --env=prod
Please not that the synchronization can take time.
You will have to run this command only once. Once the extension is correctly installed, all data mentioned above will be synchronized automatically when they will be saved.
#Launch the message worker
worker
.#You want a supervised worker
This process is only for “On premise” PIMs. If you are using the Flexibility mode of Akeneo Cloud Edition, please follow the systemd part below.
You can use supervisor to run the worker
as a daemonized process, supervisor will monitor this process and according to the configuration you’ll define it will be autostarted and autorestarted.
[program:pim-onboarder-worker]
command=bin/console akeneo:synchronization:message:consumer --env=prod
directory=/path/to/your/pim
user=www-data
autostart=true
autorestart=true
By default the environment variable of the shell that is running the supervisord process will not propagate the environment variables to the process it monitor.
You have to configure the mandatory environment variables that the akeneo/pim-onboarder bundle requires in the /etc/supervisor.conf
file.
[supervisord]
environment=ONBOARDER_GOOGLE_APPLICATION_CREDENTIALS="/srv/pim/onboarderServiceAccount.json",ONBOARDER_TOPIC_NAME_FOR_PUBLICATION_TO_MIDDLEWARE="middleware-topic-name",...
Supervisor documentation: https://github.com/Supervisor/supervisor#documentation
#You want a systemd worker
This process is only for the Flexibility mode of Akeneo Cloud Edition. If you are using an “On premise” PIM, please follow the supervised worker part above.
While Onboarder requires consumers to run at all times, those are disabled by default since some customers do not use Onboarder.
Similarly to PIM job consumers, here is how you can manipulate Onboarder daemons:
# Start the daemon
partners_systemctl pim_onboarder_worker@1 start
# Enable daemon #1 to be started at instance boot
partners_systemctl pim_onboarder_worker@1 enable
# Check the status of the daemon #1
partners_systemctl pim_onboarder_worker@1 status
# Stop daemon #1
partners_systemctl pim_onboarder_worker@1 stop
#You want an infinite worker
Launch the following command line:
bin/console akeneo:synchronization:message:consumer --ttl=-1 --env=prod
This command does not ensure that the worker command line is always started
Found a typo or a hole in the documentation and feel like contributing?
Join us on Github!