s0kil / akeneo-cheat-sheet

Unofficial Akeneo Cheat Sheet for Akeneo integrators

Akeneo Cheat Sheet

SSH

# generate a new pair of private/public keys
ssh-keygen -t rsa -b 4096 -C "[email protected]"

# start the agent
eval "$(ssh-agent -s)"

# add your private key
ssh-add ~/.ssh/id_rsa

# check access to the PIM enterprise repository
ssh [email protected] -p 443

Docker

docker-compose up -d       # starts containers, pulls them if necesary
docker-compose ps          # lists running containers
docker-compose stop        # stops running containers
docker-compose restart fpm # restarts the container named fpm

Akeneo x Docker

bin/docker/pim-dependencies.sh # installs dependencies (uses composer)
bin/docker/pim-initialize.sh   # installs the PIM
bin/docker/pim-front.sh        # regenerates and deploy all front-end assets

Elasticsearch

curl -XGET 'http://localhost:9200/_cat/indices?v' # list indexes

Available indices (as of 3.0.22)

• akeneo_pim_published_product_and_product_model
• akeneo_pim_product_model
• akeneo_referenceentity_record
• akeneo_pim_published_product
• akeneo_pim_product
• akeneo_pim_product_proposal
• akeneo_pim_product_and_product_model

# show the mapping for a given index
curl -XGET 'http://localhost:9200/akeneo_pim_product/?pretty'

# check document for product with id X
curl -XGET 'http://localhost:9200/akeneo_pim_product/pim_catalog_product/X?pretty'

Use this Postman collection and its environment for other useful requests. Use them only for debugging purposes, never write in ES manually.

Reset all indices and re-index the PIM

bin/console akeneo:elasticsearch:reset-indexes -n --env=prod
bin/console pim:product:index --env=prod  --all
bin/console pim:product-model:index --env=prod  --all
bin/console pimee:product-proposal:index
bin/console pimee:published-product:index  --env=prod

You'll find these commands in scripts/elastic.sh, which you can download and place it somewhere in a folder of your $PATH (/usr/local/bin).

Usage: elastic.sh [use-docker]

Note: use-docker will prefix all commands with docker-compose exec fpm.

Symfony

# list available commands, also recreates the cache
bin/console

# list existing services, append with '| grep service_name' to narrow your request
bin/console debug:container

# list existing parameters, append with '| grep parameter_name' to narrow your request
bin/console debug:container --parameters

# synchronize MySQL schema with your .orm.yml files
bin/console doctrine:schema:update --dump-sql         # diff only
bin/console doctrine:schema:update --dump-sql --force # diff + perform changes

# execute MySQL migrations
bin/console doctrine:migrateion:migrate --env=prod # append with '--dry-run' for a no-risk experience

Akeneo

Installation

# Installation of dependencies
composer update
yarn install

# Installation of the PIM
rm -rf var/cache/*
bin/console --env=prod pim:install --force --clean
yarn run webpack

# (Re)deploy assets
rm -rf var/cache/*
bin/console --env=prod pim:installer:assets --symlink --clean
yarn run webpack
# + clear your browser cache manually

Work with Akeneo

# List filters and operators usable for rules and product query builders
bin/console pim:product:query-help

# Launches the job consumer daemon, append with '--run-once' to execute one job only and terminate
bin/console akeneo:batch:job-queue-consumer-daemon

# Execute one job, bypassing the job consumer, append with '-vvv' for explicit output
bin/console akeneo:batch:job job_code

Akeneo Cloud (PaaS)

# SSH connection
ssh [email protected]

# Clear properly PIM’s cache (doctrine).
# Stop php-fpm and supervisor
# Delete PIM cache folder+warmup
# Start php-fpm and supervisor
partners_clear_cache


# Show status or start/restart php-fpm daemon.
# PHP version number may vary depending on installation
partners_php7.2-fpm [start|status|restart]